{ "openapi": "3.1.0", "info": { "title": "KOBANA API all-versions", "version": "all-versions", "description": "Documentação da API da Kobana", "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" } } } ], "paths": { "/v1/bank_billet_accounts": { "post": { "summary": "Criar Carteira de Cobrança", "tags": [ "Carteiras de Cobrança" ], "security": [ { "bearerAuth": [] } ], "description": "Cria uma nova carteira de cobrança para emissão de boletos bancários. A carteira precisa ser homologada antes de poder ser utilizada em produção.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Carteira de cobrança criada com financial_account_uid", "content": { "application/json": { "example": { "id": 1, "uid": "01a06d8e-530e-7eb2-821e-b8c61a52a94e", "bank_contract_slug": "bb-bs-18-19-7", "financial_account": null, "next_our_number": 1, "agency_number": "4042", "agency_digit": "8", "account_number": "0008873", "account_digit": "0", "extra1": "0229385", "extra1_digit": null, "extra2": null, "extra2_digit": null, "extra3": "0229385", "payment_place": "Pagável em qualquer banco até a data de vencimento.", "contract": "18", "contract_type": "1", "beneficiary_name": "Kobana Tecnologia Ltda.", "beneficiary_cnpj_cpf": "05.813.794/0001-26", "beneficiary_address": "Av. Presidente Vargas, 633, sala 1716, Centro, Rio de Janeiro, RJ, 20071004", "name": "Banco do Brasil 18-19 CC: 8873-0 229385", "status": "pending", "bank_contract": { "bank": { "code": "bb", "name": "Banco do Brasil", "number": "001" }, "slug": "bb-bs-18-19-7", "code": "18", "sufix": "bs-18-19-7", "variation": "19", "name": "18-19 (Convênio com 7 dígitos)" }, "integration": false, "created_via_api": true, "homologated_at": null, "next_remittance_number": 1, "configuration": null, "default": false, "custom_name": "Sicoob 01 CC: 00003666-8 0229385", "kind": "cnab400", "beneficiary_address_street": "Av. Presidente Vargas", "remittance_disabled_at": "2026-09-04T12:53:59-05:00", "beneficiary_address_street_number": "633", "beneficiary_address_complement": "sala 1716", "beneficiary_address_city": "Rio de Janeiro", "beneficiary_address_neighborhood": "Centro", "beneficiary_address_state": "RJ", "beneficiary_address_zipcode": "20071004", "bolepix_enabled_at": "2026-09-04T12:53:59-05:00", "bolepix": { "pix_mode": 2, "pix_account_id": 1, "pix_account": { "id": 1, "uid": "01a06d8e-5352-7302-a100-c2bc3e1403fd", "custom_name": "Bancoob/BB 01 CC: 00003666-8 0229385", "validated_at": null, "enabled_at": "2026-09-04T12:53:59-05:00", "financial_provider_slug": "bb", "key": "pix_key@email.com", "status": "pending", "default": false, "beneficiary": { "document_number": null, "name": "Kobana Tecnologia Ltda.", "address": { "zip_code": "20071004", "street": "Av. Presidente Vargas", "number": "633", "complement": "sala 1716", "neighborhood": "Centro", "city_name": "Rio de Janeiro", "state": "RJ" } }, "configuration": null, "financial_account_uid": null, "created_at": "2026-09-04T12:53:59-05:00", "updated_at": "2026-09-04T12:53:59-05:00" }, "pix_billing_options": null }, "bolepix_key": null, "allow_expiration_on_weekends": false, "allow_duplicate_charge_payments": false, "created_at": "2026-09-04T12:53:59-05:00", "updated_at": "2026-09-04T12:53:59-05:00" }, "schema": { "$ref": "#/components/schemas/v1_bank_billet_account_object" } } } }, "422": { "description": "Carteira inválida - Beneficiário CPF", "content": { "application/json": { "example": { "errors": { "bank_contract_slug": [ "não pode ficar em branco" ], "beneficiary_name": [ "não pode ficar em branco" ], "beneficiary_cnpj_cpf": [ "não é um CNPJ válido" ], "kind": [ "não pode ficar em branco" ], "beneficiary_address_street": [ "não pode ficar em branco" ], "beneficiary_address_city": [ "não pode ficar em branco" ], "beneficiary_address_neighborhood": [ "não pode ficar em branco" ], "beneficiary_address_state": [ "não pode ficar em branco" ], "beneficiary_address_zipcode": [ "não pode ficar em branco" ] } }, "schema": { "$ref": "#/components/schemas/v1_errors_object" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1_new_bank_billet_account_object" } } }, "required": true, "description": "Informações a serem salvas na carteira de cobrança" } }, "get": { "summary": "Listar Carteiras", "tags": [ "Carteiras de Cobrança" ], "security": [ { "bearerAuth": [] } ], "description": "Lista Carteiras.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } } ], "responses": { "200": { "description": "Carteiras Encontradas", "content": { "application/json": { "example": [ { "id": 3, "uid": "01a06d8e-5796-744d-98a6-b916a53858bf", "bank_contract_slug": "sicoob-01", "financial_account": null, "next_our_number": 1, "agency_number": "4327", "agency_digit": "3", "account_number": "00003666", "account_digit": "8", "extra1": "0229385", "extra1_digit": null, "extra2": null, "extra2_digit": null, "extra3": null, "payment_place": "Pagável em qualquer banco até a data de vencimento.", "contract": "1", "contract_type": "1", "beneficiary_name": "Kobana Tecnologia Ltda.", "beneficiary_cnpj_cpf": "05.813.794/0001-26", "beneficiary_address": "Av. Presidente Vargas, 633, sala 1716, Centro, Rio de Janeiro, RJ, 20071004", "name": "Sicoob 01 CC: 3666-8 229385", "status": "pending", "bank_contract": { "bank": { "code": "sicoob", "name": "Sicoob", "number": "756" }, "slug": "sicoob-01", "code": "1", "sufix": "01", "variation": null, "name": "1/01 - Simples Com Registro" }, "integration": false, "created_via_api": false, "homologated_at": null, "next_remittance_number": 1, "configuration": null, "default": false, "custom_name": "Sicoob 01 CC: 3666-8 229385", "kind": "cnab400", "beneficiary_address_street": "Av. Presidente Vargas", "remittance_disabled_at": null, "beneficiary_address_street_number": "633", "beneficiary_address_complement": "sala 1716", "beneficiary_address_city": "Rio de Janeiro", "beneficiary_address_neighborhood": "Centro", "beneficiary_address_state": "RJ", "beneficiary_address_zipcode": "20071004", "bolepix_enabled_at": null, "bolepix": { "pix_mode": 3, "pix_account_id": null, "pix_account": {}, "pix_billing_options": null }, "bolepix_key": null, "allow_expiration_on_weekends": false, "allow_duplicate_charge_payments": false, "created_at": "2026-09-04T12:54:00-05:00", "updated_at": "2026-09-04T12:54:00-05:00" }, { "id": 4, "uid": "01a06d8e-57be-7470-a736-ae7d39267991", "bank_contract_slug": "sicoob-01", "financial_account": null, "next_our_number": 1, "agency_number": "4327", "agency_digit": "3", "account_number": "00003666", "account_digit": "8", "extra1": "0229385", "extra1_digit": null, "extra2": null, "extra2_digit": null, "extra3": null, "payment_place": "Pagável em qualquer banco até a data de vencimento.", "contract": "1", "contract_type": "1", "beneficiary_name": "Kobana Tecnologia Ltda.", "beneficiary_cnpj_cpf": "05.813.794/0001-26", "beneficiary_address": "Av. Presidente Vargas, 633, sala 1716, Centro, Rio de Janeiro, RJ, 20071004", "name": "Sicoob 01 CC: 3666-8 229385", "status": "pending", "bank_contract": { "bank": { "code": "sicoob", "name": "Sicoob", "number": "756" }, "slug": "sicoob-01", "code": "1", "sufix": "01", "variation": null, "name": "1/01 - Simples Com Registro" }, "integration": false, "created_via_api": false, "homologated_at": null, "next_remittance_number": 1, "configuration": null, "default": false, "custom_name": "Sicoob 01 CC: 3666-8 229385", "kind": "cnab400", "beneficiary_address_street": "Av. Presidente Vargas", "remittance_disabled_at": null, "beneficiary_address_street_number": "633", "beneficiary_address_complement": "sala 1716", "beneficiary_address_city": "Rio de Janeiro", "beneficiary_address_neighborhood": "Centro", "beneficiary_address_state": "RJ", "beneficiary_address_zipcode": "20071004", "bolepix_enabled_at": null, "bolepix": { "pix_mode": 3, "pix_account_id": null, "pix_account": {}, "pix_billing_options": null }, "bolepix_key": null, "allow_expiration_on_weekends": false, "allow_duplicate_charge_payments": false, "created_at": "2026-09-04T12:54:00-05:00", "updated_at": "2026-09-04T12:54:00-05:00" }, { "id": 5, "uid": "01a06d8e-57d4-711d-b420-5da1b28ca7dc", "bank_contract_slug": "sicoob-01", "financial_account": null, "next_our_number": 1, "agency_number": "4327", "agency_digit": "3", "account_number": "00003666", "account_digit": "8", "extra1": "0229385", "extra1_digit": null, "extra2": null, "extra2_digit": null, "extra3": null, "payment_place": "Pagável em qualquer banco até a data de vencimento.", "contract": "1", "contract_type": "1", "beneficiary_name": "Kobana Tecnologia Ltda.", "beneficiary_cnpj_cpf": "05.813.794/0001-26", "beneficiary_address": "Av. Presidente Vargas, 633, sala 1716, Centro, Rio de Janeiro, RJ, 20071004", "name": "Sicoob 01 CC: 3666-8 229385", "status": "pending", "bank_contract": { "bank": { "code": "sicoob", "name": "Sicoob", "number": "756" }, "slug": "sicoob-01", "code": "1", "sufix": "01", "variation": null, "name": "1/01 - Simples Com Registro" }, "integration": false, "created_via_api": false, "homologated_at": null, "next_remittance_number": 1, "configuration": null, "default": false, "custom_name": "Sicoob 01 CC: 3666-8 229385", "kind": "cnab400", "beneficiary_address_street": "Av. Presidente Vargas", "remittance_disabled_at": null, "beneficiary_address_street_number": "633", "beneficiary_address_complement": "sala 1716", "beneficiary_address_city": "Rio de Janeiro", "beneficiary_address_neighborhood": "Centro", "beneficiary_address_state": "RJ", "beneficiary_address_zipcode": "20071004", "bolepix_enabled_at": null, "bolepix": { "pix_mode": 3, "pix_account_id": null, "pix_account": {}, "pix_billing_options": null }, "bolepix_key": null, "allow_expiration_on_weekends": false, "allow_duplicate_charge_payments": false, "created_at": "2026-09-04T12:54:00-05:00", "updated_at": "2026-09-04T12:54:00-05:00" } ], "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1_bank_billet_account_object" } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/bank_billet_accounts/{id}": { "get": { "summary": "Informações da Carteira", "tags": [ "Carteiras de Cobrança" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de uma Carteira", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "id", "in": "path", "required": true, "description": "ID da Carteira", "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Carteira encontrada", "content": { "application/json": { "example": { "id": 6, "uid": "01a06d8e-59a4-7619-801a-09823765bce1", "bank_contract_slug": "sicoob-01", "financial_account": null, "next_our_number": 1, "agency_number": "4327", "agency_digit": "3", "account_number": "00003666", "account_digit": "8", "extra1": "0229385", "extra1_digit": null, "extra2": null, "extra2_digit": null, "extra3": null, "payment_place": "Pagável em qualquer banco até a data de vencimento.", "contract": "1", "contract_type": "1", "beneficiary_name": "Kobana Tecnologia Ltda.", "beneficiary_cnpj_cpf": "05.813.794/0001-26", "beneficiary_address": "Av. Presidente Vargas, 633, sala 1716, Centro, Rio de Janeiro, RJ, 20071004", "name": "Sicoob 01 CC: 3666-8 229385", "status": "active", "bank_contract": { "bank": { "code": "sicoob", "name": "Sicoob", "number": "756" }, "slug": "sicoob-01", "code": "1", "sufix": "01", "variation": null, "name": "1/01 - Simples Com Registro" }, "integration": false, "created_via_api": false, "homologated_at": null, "next_remittance_number": 1, "configuration": null, "default": true, "custom_name": "Sicoob 01 CC: 3666-8 229385", "kind": "cnab400", "beneficiary_address_street": "Av. Presidente Vargas", "remittance_disabled_at": null, "beneficiary_address_street_number": "633", "beneficiary_address_complement": "sala 1716", "beneficiary_address_city": "Rio de Janeiro", "beneficiary_address_neighborhood": "Centro", "beneficiary_address_state": "RJ", "beneficiary_address_zipcode": "20071004", "bolepix_enabled_at": "2026-09-04T12:54:00-05:00", "bolepix": { "pix_mode": 2, "pix_account_id": 2, "pix_account": { "id": 2, "uid": "01a06d8e-5978-7962-bba5-e4d9bd08d94e", "custom_name": "Sicoob", "validated_at": "2026-09-04T12:54:00-05:00", "enabled_at": "2026-09-04T12:54:00-05:00", "financial_provider_slug": "sicoob", "key": "+5522987654321", "status": "active", "default": true, "beneficiary": { "document_number": "427.112.590-30", "name": "Margret Santos Filgueiras", "address": { "zip_code": "24360440", "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "city_name": "Rio de Janeiro", "state": "RJ" } }, "configuration": null, "financial_account_uid": "01a06d8e-5900-7f17-9e9b-5bc0467c67d4", "created_at": "2026-09-04T12:54:00-05:00", "updated_at": "2026-09-04T12:54:00-05:00" }, "pix_billing_options": null }, "bolepix_key": null, "allow_expiration_on_weekends": false, "allow_duplicate_charge_payments": false, "created_at": "2026-09-04T12:54:00-05:00", "updated_at": "2026-09-04T12:54:00-05:00" }, "schema": { "$ref": "#/components/schemas/v1_bank_billet_account_object" } } } }, "404": { "description": "Carteira não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } }, "put": { "summary": "Atualizar a Carteira", "tags": [ "Carteiras de Cobrança" ], "security": [ { "bearerAuth": [] } ], "description": "Atualiza informações específicas de uma Carteira.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "id", "in": "path", "required": true, "description": "ID da Carteira", "example": 999, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Carteira atualizada" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "errors": { "beneficiary_name": [ "não pode ficar em branco" ], "beneficiary_cnpj_cpf": [ "não pode ficar em branco" ], "agency_number": [ "não pode ser alterado. Pois a carteira já se encontra homologada." ], "account_number": [ "não pode ser alterado. Pois a carteira já se encontra homologada." ], "agency_digit": [ "não pode ser alterado. Pois a carteira já se encontra homologada." ], "account_digit": [ "não pode ser alterado. Pois a carteira já se encontra homologada." ], "beneficiary_address_street": [ "não pode ficar em branco" ], "beneficiary_address_city": [ "não pode ficar em branco" ], "beneficiary_address_neighborhood": [ "não pode ficar em branco" ], "beneficiary_address_state": [ "não pode ficar em branco" ], "beneficiary_address_zipcode": [ "não pode ficar em branco" ] } }, "schema": { "$ref": "#/components/schemas/v1_errors_object" } } } }, "404": { "description": "Carteira não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1_bank_billet_account_update_object" } } }, "required": true, "description": "Informações a serem atualizadas na Carteira" } }, "delete": { "summary": "Excluir a Carteira de Cobrança", "tags": [ "Carteiras de Cobrança" ], "security": [ { "bearerAuth": [] } ], "description": "Exclui uma Carteira de Cobrança. Opcionalmente, exclui também a Conta Financeira associada.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "id", "in": "path", "required": true, "description": "ID da Carteira", "example": 999, "schema": { "type": "string" } }, { "name": "delete_financial_account", "in": "query", "required": false, "description": "Quando `true`, exclui também a Conta Financeira associada à Carteira.", "schema": { "type": "boolean", "default": false } } ], "responses": { "204": { "description": "Carteira enfileirada para exclusão (delete_financial_account=false)" }, "202": { "description": "Carteira e Conta Financeira excluídas (delete_financial_account=true)", "content": { "application/json": { "example": { "status": 202, "message": "Carteira enviada para ser excluída! Logo ela será removida definitivamente." } } } }, "404": { "description": "Carteira não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Carteira não possui Conta Financeira associada (delete_financial_account=true)", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Carteira não possui Conta Financeira associada para ser excluída.", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/bank_billet_accounts/{id}/ask": { "get": { "summary": "Solicitar Homologação da Carteira de Cobrança", "tags": [ "Carteiras de Cobrança" ], "security": [ { "bearerAuth": [] } ], "description": "Solicitar homologação da Carteira de Cobrança", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "id", "in": "path", "required": true, "description": "ID da Carteira", "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Solicitação de homologação realizada com sucesso", "content": { "application/json": { "example": { "id": 16, "uid": "01a06d8e-6515-7a8a-8a4c-933f788ea3ff", "bank_contract_slug": "sicoob-01", "financial_account": null, "next_our_number": 2, "agency_number": "4327", "agency_digit": "3", "account_number": "00003666", "account_digit": "8", "extra1": "0229385", "extra1_digit": null, "extra2": null, "extra2_digit": null, "extra3": null, "payment_place": "Pagável em qualquer banco até a data de vencimento.", "contract": "1", "contract_type": "1", "beneficiary_name": "Kobana Tecnologia Ltda.", "beneficiary_cnpj_cpf": "05.813.794/0001-26", "beneficiary_address": "Av. Presidente Vargas, 633, sala 1716, Centro, Rio de Janeiro, RJ, 20071004", "name": "Sicoob 01 CC: 3666-8 229385", "status": "validating", "bank_contract": { "bank": { "code": "sicoob", "name": "Sicoob", "number": "756" }, "slug": "sicoob-01", "code": "1", "sufix": "01", "variation": null, "name": "1/01 - Simples Com Registro" }, "integration": false, "created_via_api": false, "homologated_at": null, "next_remittance_number": 2, "configuration": null, "default": false, "custom_name": "Sicoob 01 CC: 3666-8 229385", "kind": "cnab400", "beneficiary_address_street": "Av. Presidente Vargas", "remittance_disabled_at": null, "beneficiary_address_street_number": "633", "beneficiary_address_complement": "sala 1716", "beneficiary_address_city": "Rio de Janeiro", "beneficiary_address_neighborhood": "Centro", "beneficiary_address_state": "RJ", "beneficiary_address_zipcode": "20071004", "bolepix_enabled_at": "2026-09-04T12:54:03-05:00", "bolepix": { "pix_mode": 2, "pix_account_id": 3, "pix_account": { "id": 3, "uid": "01a06d8e-6506-7367-bf06-c5b4b8a068ea", "custom_name": "Sicoob", "validated_at": "2026-09-04T12:54:03-05:00", "enabled_at": "2026-09-04T12:54:03-05:00", "financial_provider_slug": "sicoob", "key": "+5522987654321", "status": "active", "default": true, "beneficiary": { "document_number": "690.010.171-26", "name": "Margret Santos Filgueiras", "address": { "zip_code": "24360440", "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "city_name": "Rio de Janeiro", "state": "RJ" } }, "configuration": null, "financial_account_uid": "01a06d8e-64c9-74b9-8f3a-75afefdd4e27", "created_at": "2026-09-04T12:54:03-05:00", "updated_at": "2026-09-04T12:54:03-05:00" }, "pix_billing_options": null }, "bolepix_key": null, "allow_expiration_on_weekends": false, "allow_duplicate_charge_payments": false, "created_at": "2026-09-04T12:54:03-05:00", "updated_at": "2026-09-04T12:54:04-05:00" }, "schema": { "$ref": "#/components/schemas/v1_bank_billet_account_object" } } } }, "404": { "description": "Carteira não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "422": { "description": "Carteira já homologada", "content": { "application/json": { "example": { "status": 422, "errors": [ { "title": "Carteira homologada e pronta para uso.", "code": "unprocessable_content" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/bank_billet_accounts/{id}/validate": { "put": { "summary": "Validar Carteira de Cobrança", "tags": [ "Carteiras de Cobrança" ], "security": [ { "bearerAuth": [] } ], "description": "Validar Carteira de Cobrança", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "id", "in": "path", "required": true, "description": "ID da Carteira", "example": 999, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Carteira Homologada com sucesso" }, "404": { "description": "Carteira não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "status": 422, "errors": [ { "title": "Carteira aguardando solicitação de homologação pelo cliente.", "code": "unprocessable_content" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "homologation_amount": { "type": "string", "description": "Valor recebido pelo boleto (R$) Ex.: 1,87" } }, "required": [ "homologation_amount" ] } } }, "required": true } } }, "/v1/bank_billet_accounts/{id}/set_default": { "put": { "summary": "Alterar Carteira de Cobrança padrão", "tags": [ "Carteiras de Cobrança" ], "security": [ { "bearerAuth": [] } ], "description": "Alterar Carteira de Cobrança padrão", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "id", "in": "path", "required": true, "description": "ID da Carteira", "example": 999, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Carteira definida com padrão com sucesso" }, "404": { "description": "Carteira não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "status": 422, "errors": [ { "title": "default não pode ficar em branco", "code": "unprocessable_content" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "default": { "type": "boolean", "description": "Define a Carteira padrão(Default: true) ou deixar de ser padrão(Default: false)" } }, "required": [ "default" ] } } }, "required": true } } }, "/v1/bank_billets": { "post": { "summary": "Criar um Boleto", "tags": [ "Boletos" ], "security": [ { "bearerAuth": [] } ], "description": "Cria um novo boleto bancário para cobrança. O boleto será processado e registrado na instituição financeira de acordo com as configurações da carteira de cobrança utilizada.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Boleto criado", "content": { "application/json": { "example": { "id": 2, "uid": "01a06d8e-6a87-72a3-9f7d-bb932124f45e", "expire_at": "2026-09-14", "paid_at": null, "description": "Serviços prestados", "status": "generating", "registration_status": "pending", "customer_person_name": "Leofutol Bezerra", "customer_cnpj_cpf": "337.539.339-37", "customer_address": "Av. Presidente Vargas", "customer_state": "AP", "customer_neighborhood": "Centro", "customer_zipcode": "20071004", "customer_address_number": "633", "customer_address_complement": "apt 101", "customer_phone_number": "2188887766", "customer_email": "cliente@example.com", "customer_email_cc": "outro@example.com", "customer_ignore_email": false, "customer_ignore_sms": null, "customer_mobile_local_code": "22", "customer_mobile_number": "987654321", "customer_nickname": "Zezin La da Rua", "customer_notes": "Informação sobre o cliente", "created_via_api": true, "customer_city_name": "Macapá", "paid_amount": null, "amount": 34.56, "url": "http://dev.bole.to:5001/2/mq", "formats": { "default": "http://dev.bole.to:5001/2/mq", "png": "http://dev.bole.to:5001/2/mq.png", "pdf": "http://dev.bole.to:5001/2/mq.pdf", "boleto_hibrido": "http://dev.bole.to:5001/2/mq/boleto_hibrido", "boleto_pix": null, "barcode": "http://dev.bole.to:5001/2/mq/barcode", "envelope": "http://dev.bole.to:5001/2/mq/envelope", "letter": "http://dev.bole.to:5001/2/mq/letter", "line": "http://dev.bole.to:5001/2/mq/line", "recibo": "http://dev.bole.to:5001/2/mq/recibo", "pix_qrcode": null }, "meta": null, "fine_for_delay": null, "fine_type": 2, "fine_percentage": null, "fine_value": 4.91, "days_for_fine": 3, "late_payment_interest": null, "interest_type": 1, "interest_daily_value": null, "interest_daily_percentage": null, "interest_monthly_percentage": null, "days_for_interest": 2, "discount_type": 2, "discount_limit_date": "2026-09-11", "discount_value": null, "discount_percentage": 10.0, "days_for_revoke": 30, "notes": "Observações", "payment_count": 4, "bank_billet_account_id": 23, "beneficiary_name": "Kobana Tecnologia Ltda.", "beneficiary_cnpj_cpf": "05.813.794/0001-26", "beneficiary_address": "Av. Presidente Vargas, 633, sala 1716, Centro, Rio de Janeiro, RJ, 20071004", "beneficiary_assignor_code": "4327 / 0229385", "guarantor_name": null, "guarantor_cnpj_cpf": null, "payment_place": "Pagável em qualquer banco até a data de vencimento.", "instructions": null, "document_date": null, "document_type": "02", "document_number": null, "acceptance": "N", "processed_our_number": "00000024", "processed_our_number_raw": "00000024", "bank_contract_slug": "sicoob-01", "agency_number": "4327", "agency_digit": "3", "account_number": "00003666", "account_digit": "8", "extra1": "0229385", "extra1_digit": null, "extra2": null, "extra2_digit": null, "line": "75691.43279 01022.938508 00000.240028 1 15690000003456", "our_number": "2", "customer_subscription_id": null, "installment_total": null, "installment_number": 2, "installment_id": null, "carne_url": null, "bank_billet_layout_id": null, "created_at": "2026-09-04T12:54:05-05:00", "updated_at": "2026-09-04T12:54:05-05:00", "tags": [ "tag1", "tag2", "tag3" ], "tag_list": "tag1,tag2,tag3", "document_type_label": "DM", "addons": null, "ignore_email": true, "ignore_sms": false, "ignore_whatsapp": false, "sue_code": null, "revoke_code": null, "first_instruction": null, "second_instruction": null, "guarantor_address_number": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "guarantor_city_name": null, "guarantor_state": null, "guarantor_zipcode": null, "guarantor_address": null, "guarantor_address_complement": null, "barcode": "75691156900000034561432701022938500000024002", "registered_at": null, "prevent_registration": false, "customer_id": null, "control_number": "01234ABC", "divergent_payment_type": 2, "divergent_payment_value_type": 1, "divergent_payment_maximum_value": 150.01, "divergent_payment_minimum_value": 100.01, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null, "divergent_payment_limit": null, "days_for_discount": 3, "days_for_second_discount": 2, "second_discount_percentage": 5.0, "second_discount_value": null, "days_for_third_discount": 1, "third_discount_percentage": 2.5, "third_discount_value": null, "days_for_sue": 40, "days_for_negativation": null, "interest_percentage": 0.3, "interest_value": null, "interest_days_type": 0, "customer_contact_person": "Zezin 2", "custom_attachment_name": "boleto_{{ bank_billet.id }}", "split_payment": false, "split_payment_type": null, "dispatch_type": 1, "charge_type": 1, "custom_data": { "bank_billet_number": "123_456" }, "issued_at": "2026-09-04T12:54:05-05:00", "shorten_url": "http://dev.bole.to:5001/2/mq", "pix_enabled": false, "pix_qrcode": null, "password_protected_mode": null, "revoked_at": null, "recipient_account": null, "pix_txid": null, "cancel_type": null, "cancellation_reason": null, "prevent_pix": false, "reduction_amount": null, "instructions_mode": 2, "import_id": null, "reduction_type": 3, "reduction_percentage": null, "url_hash": "mq", "external_id": null, "financial_provider_external_id": null, "days_for_sue_type": 0, "credit_bureau": 0, "after_create": [ "sync" ], "sue_history": [], "bank_billet_discharges": [], "bank_billet_remittances": [], "bank_billet_payments": [], "bank_billet_registrations": [], "pix": [], "bank_billet_split_accounts": [] }, "schema": { "$ref": "#/components/schemas/v1_bank_billet_object" } } } }, "422": { "description": "Pagamento parcial Itaú requer tipo de autorização específico", "content": { "application/json": { "example": { "errors": { "divergent_payment_type": [ "não é válido", "deve ser \"aceita acima do mínimo\" quando pagamento parcial está habilitado" ] }, "status": 422 }, "schema": { "$ref": "#/components/schemas/v1_errors_object" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1_bank_billet_object" } } }, "required": true, "description": "Informações a serem salvas no boleto" } }, "get": { "summary": "Listar Boletos", "tags": [ "Boletos" ], "security": [ { "bearerAuth": [] } ], "description": "Lista boletos.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "bank_billet_account_id", "in": "query", "schema": { "type": "string" }, "description": "Filtro por ID da Carteira. Acha todas os registros que tenham o ID.", "example": "999", "required": false }, { "name": "status", "in": "query", "description": "Filtro por Situação. Acha todos os registros com o status.", "required": false, "schema": { "type": "string", "enum": [ "generating", "generation_failed", "validation_failed", "opened", "canceled", "paid", "overdue", "blocked", "chargeback" ] } }, { "name": "our_number", "in": "query", "description": "Filtro por Nosso Número", "example": "000001235", "required": false, "schema": { "type": "string" } }, { "name": "processed_our_number_raw", "in": "query", "description": "Filtro por Nosso Número com DV (limpo).", "example": "00004567844", "required": false, "schema": { "type": "string" } }, { "name": "cnpj_cpf", "in": "query", "description": "Filtro por CPF/CNPJ do cliente. Deve ser formatado com máscara. Acha todos os registros cujo campo seja igual ao string.", "example": "05.813.794/0001-26", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "description": "Data inicial do filtro de data de criação do registro.", "example": "2020-01-01", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "description": "Data final do filtro de data de criação do registro.", "example": "2020-01-01", "required": false, "schema": { "type": "string" } }, { "name": "expire_from", "in": "query", "description": "Data inicial do filtro de data de vencimento", "example": "2020-01-01", "required": false, "schema": { "type": "string" } }, { "name": "expire_to", "in": "query", "description": "Data final do filtro de data de vencimento.", "example": "2020-01-01", "required": false, "schema": { "type": "string" } }, { "name": "paid_from", "in": "query", "description": "Data inicial do filtro de data de pagamento.", "example": "2020-01-01", "required": false, "schema": { "type": "string" } }, { "name": "paid_to", "in": "query", "description": "Data final do filtro de data de pagamento.", "example": "2020-01-01", "required": false, "schema": { "type": "string" } }, { "name": "registered_to", "in": "query", "description": "Data inicial do filtro de data de registro.", "example": "2020-01-01", "required": false, "schema": { "type": "string" } }, { "name": "registered_from", "in": "query", "description": "Data final do filtro de data de registro.", "example": "2020-01-01", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "updated_from", "in": "query", "description": "Data inicial do filtro de data de atualização do registro.", "example": "2020-01-01", "required": false, "schema": { "type": "string" } }, { "name": "updated_to", "in": "query", "description": "Data final do filtro de data de atualização do registro.", "example": "2020-01-01", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso na listagem de boletos", "content": { "application/json": { "example": [ { "id": 5, "uid": "01a06d8e-6d57-7d18-83ef-ec2af7f0f4cf", "expire_at": "2026-09-08", "paid_at": null, "description": "Serviço de criação de site\\r\\nExpira em: 08/09/2026", "status": "opened", "registration_status": "pending", "customer_person_name": "José da Silva", "customer_cnpj_cpf": "399.881.072-26", "customer_address": "Av. Burkhard Hehn Simões", "customer_state": "RJ", "customer_neighborhood": "São Francisco", "customer_zipcode": "24360440", "customer_address_number": "111", "customer_address_complement": "709", "customer_phone_number": "2199999999", "customer_email": "cliente@example.com", "customer_email_cc": "john_cc@example.com", "customer_ignore_email": null, "customer_ignore_sms": false, "customer_mobile_local_code": null, "customer_mobile_number": null, "customer_nickname": null, "customer_notes": null, "created_via_api": false, "customer_city_name": "Rio de Janeiro", "paid_amount": null, "amount": 50.0, "url": "http://dev.bole.to:5001/2/qb", "formats": { "default": "http://dev.bole.to:5001/2/qb", "png": "http://dev.bole.to:5001/2/qb.png", "pdf": "http://dev.bole.to:5001/2/qb.pdf", "boleto_hibrido": "http://dev.bole.to:5001/2/qb/boleto_hibrido", "boleto_pix": null, "barcode": "http://dev.bole.to:5001/2/qb/barcode", "envelope": "http://dev.bole.to:5001/2/qb/envelope", "letter": "http://dev.bole.to:5001/2/qb/letter", "line": "http://dev.bole.to:5001/2/qb/line", "recibo": "http://dev.bole.to:5001/2/qb/recibo", "pix_qrcode": null }, "meta": null, "fine_for_delay": null, "fine_type": 0, "fine_percentage": null, "fine_value": null, "days_for_fine": null, "late_payment_interest": null, "interest_type": 0, "interest_daily_value": null, "interest_daily_percentage": null, "interest_monthly_percentage": null, "days_for_interest": null, "discount_type": 0, "discount_limit_date": null, "discount_value": null, "discount_percentage": null, "days_for_revoke": null, "notes": null, "payment_count": 1, "bank_billet_account_id": 27, "beneficiary_name": "Kobana Tecnologia Ltda.", "beneficiary_cnpj_cpf": "05.813.794/0001-26", "beneficiary_address": "Av. Presidente Vargas, 633, sala 1716, Centro, Rio de Janeiro, RJ, 20071004", "beneficiary_assignor_code": "4327 / 0229385", "guarantor_name": null, "guarantor_cnpj_cpf": null, "payment_place": "Pagável em qualquer banco até a data de vencimento.", "instructions": null, "document_date": null, "document_type": "02", "document_number": null, "acceptance": "N", "processed_our_number": "00400030", "processed_our_number_raw": "00400030", "bank_contract_slug": "sicoob-01", "agency_number": "4327", "agency_digit": "3", "account_number": "00003666", "account_digit": "8", "extra1": "0229385", "extra1_digit": null, "extra2": null, "extra2_digit": null, "line": "75691.43279 01022.938508 04000.300014 7 15630000005000", "our_number": "40003", "customer_subscription_id": null, "installment_total": null, "installment_number": null, "installment_id": null, "carne_url": null, "bank_billet_layout_id": null, "created_at": "2026-09-04T12:54:05-05:00", "updated_at": "2026-09-04T12:54:05-05:00", "tags": [ "tag 1", "tag2", "tag 3" ], "tag_list": "tag 1,tag2,tag 3", "document_type_label": "DM", "addons": null, "ignore_email": false, "ignore_sms": false, "ignore_whatsapp": false, "sue_code": null, "revoke_code": null, "first_instruction": null, "second_instruction": null, "guarantor_address_number": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "guarantor_city_name": null, "guarantor_state": null, "guarantor_zipcode": null, "guarantor_address": null, "guarantor_address_complement": null, "barcode": "75697156300000050001432701022938500400030001", "registered_at": null, "prevent_registration": false, "customer_id": 4, "control_number": null, "divergent_payment_type": null, "divergent_payment_value_type": null, "divergent_payment_maximum_value": null, "divergent_payment_minimum_value": null, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null, "divergent_payment_limit": null, "days_for_discount": null, "days_for_second_discount": null, "second_discount_percentage": null, "second_discount_value": null, "days_for_third_discount": null, "third_discount_percentage": null, "third_discount_value": null, "days_for_sue": null, "days_for_negativation": null, "interest_percentage": null, "interest_value": null, "interest_days_type": 0, "customer_contact_person": null, "custom_attachment_name": null, "split_payment": false, "split_payment_type": null, "dispatch_type": 1, "charge_type": 1, "custom_data": null, "issued_at": "2026-09-04T12:54:05-05:00", "shorten_url": "http://dev.bole.to:5001/2/qb", "pix_enabled": false, "pix_qrcode": null, "password_protected_mode": null, "revoked_at": null, "recipient_account": null, "pix_txid": null, "cancel_type": null, "cancellation_reason": null, "prevent_pix": false, "reduction_amount": null, "instructions_mode": 1, "import_id": null, "reduction_type": 3, "reduction_percentage": null, "url_hash": "qb", "external_id": null, "financial_provider_external_id": null, "days_for_sue_type": null, "credit_bureau": null, "after_create": [], "sue_history": [], "bank_billet_discharges": [], "bank_billet_remittances": [], "bank_billet_payments": [], "bank_billet_registrations": [], "bank_billet_split_accounts": [], "pix": [], "payments": [] }, { "id": 4, "uid": "01a06d8e-6d41-7494-ae63-e25b774f9054", "expire_at": "2026-09-08", "paid_at": null, "description": "Serviço de criação de site\\r\\nExpira em: 08/09/2026", "status": "opened", "registration_status": "pending", "customer_person_name": "José da Silva", "customer_cnpj_cpf": "399.881.072-26", "customer_address": "Av. Burkhard Hehn Simões", "customer_state": "RJ", "customer_neighborhood": "São Francisco", "customer_zipcode": "24360440", "customer_address_number": "111", "customer_address_complement": "709", "customer_phone_number": "2199999999", "customer_email": "cliente@example.com", "customer_email_cc": "john_cc@example.com", "customer_ignore_email": null, "customer_ignore_sms": false, "customer_mobile_local_code": null, "customer_mobile_number": null, "customer_nickname": null, "customer_notes": null, "created_via_api": false, "customer_city_name": "Rio de Janeiro", "paid_amount": null, "amount": 50.0, "url": "http://dev.bole.to:5001/2/zq", "formats": { "default": "http://dev.bole.to:5001/2/zq", "png": "http://dev.bole.to:5001/2/zq.png", "pdf": "http://dev.bole.to:5001/2/zq.pdf", "boleto_hibrido": "http://dev.bole.to:5001/2/zq/boleto_hibrido", "boleto_pix": null, "barcode": "http://dev.bole.to:5001/2/zq/barcode", "envelope": "http://dev.bole.to:5001/2/zq/envelope", "letter": "http://dev.bole.to:5001/2/zq/letter", "line": "http://dev.bole.to:5001/2/zq/line", "recibo": "http://dev.bole.to:5001/2/zq/recibo", "pix_qrcode": null }, "meta": null, "fine_for_delay": null, "fine_type": 0, "fine_percentage": null, "fine_value": null, "days_for_fine": null, "late_payment_interest": null, "interest_type": 0, "interest_daily_value": null, "interest_daily_percentage": null, "interest_monthly_percentage": null, "days_for_interest": null, "discount_type": 0, "discount_limit_date": null, "discount_value": null, "discount_percentage": null, "days_for_revoke": null, "notes": null, "payment_count": 1, "bank_billet_account_id": 27, "beneficiary_name": "Kobana Tecnologia Ltda.", "beneficiary_cnpj_cpf": "05.813.794/0001-26", "beneficiary_address": "Av. Presidente Vargas, 633, sala 1716, Centro, Rio de Janeiro, RJ, 20071004", "beneficiary_assignor_code": "4327 / 0229385", "guarantor_name": null, "guarantor_cnpj_cpf": null, "payment_place": "Pagável em qualquer banco até a data de vencimento.", "instructions": null, "document_date": null, "document_type": "02", "document_number": null, "acceptance": "N", "processed_our_number": "00400023", "processed_our_number_raw": "00400023", "bank_contract_slug": "sicoob-01", "agency_number": "4327", "agency_digit": "3", "account_number": "00003666", "account_digit": "8", "extra1": "0229385", "extra1_digit": null, "extra2": null, "extra2_digit": null, "line": "75691.43279 01022.938508 04000.230013 9 15630000005000", "our_number": "40002", "customer_subscription_id": null, "installment_total": null, "installment_number": null, "installment_id": null, "carne_url": null, "bank_billet_layout_id": null, "created_at": "2026-09-04T12:54:05-05:00", "updated_at": "2026-09-04T12:54:05-05:00", "tags": [ "tag 1", "tag2", "tag 3" ], "tag_list": "tag 1,tag2,tag 3", "document_type_label": "DM", "addons": null, "ignore_email": false, "ignore_sms": false, "ignore_whatsapp": false, "sue_code": null, "revoke_code": null, "first_instruction": null, "second_instruction": null, "guarantor_address_number": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "guarantor_city_name": null, "guarantor_state": null, "guarantor_zipcode": null, "guarantor_address": null, "guarantor_address_complement": null, "barcode": "75699156300000050001432701022938500400023001", "registered_at": null, "prevent_registration": false, "customer_id": 3, "control_number": null, "divergent_payment_type": null, "divergent_payment_value_type": null, "divergent_payment_maximum_value": null, "divergent_payment_minimum_value": null, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null, "divergent_payment_limit": null, "days_for_discount": null, "days_for_second_discount": null, "second_discount_percentage": null, "second_discount_value": null, "days_for_third_discount": null, "third_discount_percentage": null, "third_discount_value": null, "days_for_sue": null, "days_for_negativation": null, "interest_percentage": null, "interest_value": null, "interest_days_type": 0, "customer_contact_person": null, "custom_attachment_name": null, "split_payment": false, "split_payment_type": null, "dispatch_type": 1, "charge_type": 1, "custom_data": null, "issued_at": "2026-09-04T12:54:05-05:00", "shorten_url": "http://dev.bole.to:5001/2/zq", "pix_enabled": false, "pix_qrcode": null, "password_protected_mode": null, "revoked_at": null, "recipient_account": null, "pix_txid": null, "cancel_type": null, "cancellation_reason": null, "prevent_pix": false, "reduction_amount": null, "instructions_mode": 1, "import_id": null, "reduction_type": 3, "reduction_percentage": null, "url_hash": "zq", "external_id": null, "financial_provider_external_id": null, "days_for_sue_type": null, "credit_bureau": null, "after_create": [], "sue_history": [], "bank_billet_discharges": [], "bank_billet_remittances": [], "bank_billet_payments": [], "bank_billet_registrations": [], "bank_billet_split_accounts": [], "pix": [], "payments": [] }, { "id": 3, "uid": "01a06d8e-6d2b-7d2d-bb1e-87c71ea07750", "expire_at": "2026-09-08", "paid_at": null, "description": "Serviço de criação de site\\r\\nExpira em: 08/09/2026", "status": "opened", "registration_status": "pending", "customer_person_name": "José da Silva", "customer_cnpj_cpf": "399.881.072-26", "customer_address": "Av. Burkhard Hehn Simões", "customer_state": "RJ", "customer_neighborhood": "São Francisco", "customer_zipcode": "24360440", "customer_address_number": "111", "customer_address_complement": "709", "customer_phone_number": "2199999999", "customer_email": "cliente@example.com", "customer_email_cc": "john_cc@example.com", "customer_ignore_email": null, "customer_ignore_sms": false, "customer_mobile_local_code": null, "customer_mobile_number": null, "customer_nickname": null, "customer_notes": null, "created_via_api": false, "customer_city_name": "Rio de Janeiro", "paid_amount": null, "amount": 50.0, "url": "http://dev.bole.to:5001/2/bl", "formats": { "default": "http://dev.bole.to:5001/2/bl", "png": "http://dev.bole.to:5001/2/bl.png", "pdf": "http://dev.bole.to:5001/2/bl.pdf", "boleto_hibrido": "http://dev.bole.to:5001/2/bl/boleto_hibrido", "boleto_pix": null, "barcode": "http://dev.bole.to:5001/2/bl/barcode", "envelope": "http://dev.bole.to:5001/2/bl/envelope", "letter": "http://dev.bole.to:5001/2/bl/letter", "line": "http://dev.bole.to:5001/2/bl/line", "recibo": "http://dev.bole.to:5001/2/bl/recibo", "pix_qrcode": null }, "meta": null, "fine_for_delay": null, "fine_type": 0, "fine_percentage": null, "fine_value": null, "days_for_fine": null, "late_payment_interest": null, "interest_type": 0, "interest_daily_value": null, "interest_daily_percentage": null, "interest_monthly_percentage": null, "days_for_interest": null, "discount_type": 0, "discount_limit_date": null, "discount_value": null, "discount_percentage": null, "days_for_revoke": null, "notes": null, "payment_count": 1, "bank_billet_account_id": 27, "beneficiary_name": "Kobana Tecnologia Ltda.", "beneficiary_cnpj_cpf": "05.813.794/0001-26", "beneficiary_address": "Av. Presidente Vargas, 633, sala 1716, Centro, Rio de Janeiro, RJ, 20071004", "beneficiary_assignor_code": "4327 / 0229385", "guarantor_name": null, "guarantor_cnpj_cpf": null, "payment_place": "Pagável em qualquer banco até a data de vencimento.", "instructions": null, "document_date": null, "document_type": "02", "document_number": null, "acceptance": "N", "processed_our_number": "00400016", "processed_our_number_raw": "00400016", "bank_contract_slug": "sicoob-01", "agency_number": "4327", "agency_digit": "3", "account_number": "00003666", "account_digit": "8", "extra1": "0229385", "extra1_digit": null, "extra2": null, "extra2_digit": null, "line": "75691.43279 01022.938508 04000.160012 1 15630000005000", "our_number": "40001", "customer_subscription_id": null, "installment_total": null, "installment_number": null, "installment_id": null, "carne_url": null, "bank_billet_layout_id": null, "created_at": "2026-09-04T12:54:05-05:00", "updated_at": "2026-09-04T12:54:05-05:00", "tags": [ "tag 1", "tag2", "tag 3" ], "tag_list": "tag 1,tag2,tag 3", "document_type_label": "DM", "addons": null, "ignore_email": false, "ignore_sms": false, "ignore_whatsapp": false, "sue_code": null, "revoke_code": null, "first_instruction": null, "second_instruction": null, "guarantor_address_number": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "guarantor_city_name": null, "guarantor_state": null, "guarantor_zipcode": null, "guarantor_address": null, "guarantor_address_complement": null, "barcode": "75691156300000050001432701022938500400016001", "registered_at": null, "prevent_registration": false, "customer_id": 2, "control_number": null, "divergent_payment_type": null, "divergent_payment_value_type": null, "divergent_payment_maximum_value": null, "divergent_payment_minimum_value": null, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null, "divergent_payment_limit": null, "days_for_discount": null, "days_for_second_discount": null, "second_discount_percentage": null, "second_discount_value": null, "days_for_third_discount": null, "third_discount_percentage": null, "third_discount_value": null, "days_for_sue": null, "days_for_negativation": null, "interest_percentage": null, "interest_value": null, "interest_days_type": 0, "customer_contact_person": null, "custom_attachment_name": null, "split_payment": false, "split_payment_type": null, "dispatch_type": 1, "charge_type": 1, "custom_data": null, "issued_at": "2026-09-04T12:54:05-05:00", "shorten_url": "http://dev.bole.to:5001/2/bl", "pix_enabled": false, "pix_qrcode": null, "password_protected_mode": null, "revoked_at": null, "recipient_account": null, "pix_txid": null, "cancel_type": null, "cancellation_reason": null, "prevent_pix": false, "reduction_amount": null, "instructions_mode": 1, "import_id": null, "reduction_type": 3, "reduction_percentage": null, "url_hash": "bl", "external_id": null, "financial_provider_external_id": null, "days_for_sue_type": null, "credit_bureau": null, "after_create": [], "sue_history": [], "bank_billet_discharges": [], "bank_billet_remittances": [], "bank_billet_payments": [], "bank_billet_registrations": [], "bank_billet_split_accounts": [], "pix": [], "payments": [] } ], "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1_bank_billet_object" } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/bank_billets/{id}": { "get": { "summary": "Visualizar o Boleto", "tags": [ "Boletos" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de um Boleto.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Boleto", "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Boleto encontrado", "content": { "application/json": { "example": { "id": 6, "uid": "01a06d8e-6e42-70c1-8601-238e86415a10", "expire_at": "2026-09-08", "paid_at": null, "description": "Serviço de criação de site\\r\\nExpira em: 08/09/2026", "status": "opened", "registration_status": "pending", "customer_person_name": "José da Silva", "customer_cnpj_cpf": "399.881.072-26", "customer_address": "Av. Burkhard Hehn Simões", "customer_state": "RJ", "customer_neighborhood": "São Francisco", "customer_zipcode": "24360440", "customer_address_number": "111", "customer_address_complement": "709", "customer_phone_number": "2199999999", "customer_email": "cliente@example.com", "customer_email_cc": "john_cc@example.com", "customer_ignore_email": null, "customer_ignore_sms": false, "customer_mobile_local_code": null, "customer_mobile_number": null, "customer_nickname": null, "customer_notes": null, "created_via_api": false, "customer_city_name": "Rio de Janeiro", "paid_amount": null, "amount": 50.0, "url": "http://dev.bole.to:5001/2/xr", "formats": { "default": "http://dev.bole.to:5001/2/xr", "png": "http://dev.bole.to:5001/2/xr.png", "pdf": "http://dev.bole.to:5001/2/xr.pdf", "boleto_hibrido": "http://dev.bole.to:5001/2/xr/boleto_hibrido", "boleto_pix": null, "barcode": "http://dev.bole.to:5001/2/xr/barcode", "envelope": "http://dev.bole.to:5001/2/xr/envelope", "letter": "http://dev.bole.to:5001/2/xr/letter", "line": "http://dev.bole.to:5001/2/xr/line", "recibo": "http://dev.bole.to:5001/2/xr/recibo", "pix_qrcode": null }, "meta": null, "fine_for_delay": null, "fine_type": 0, "fine_percentage": null, "fine_value": null, "days_for_fine": null, "late_payment_interest": null, "interest_type": 0, "interest_daily_value": null, "interest_daily_percentage": null, "interest_monthly_percentage": null, "days_for_interest": null, "discount_type": 0, "discount_limit_date": null, "discount_value": null, "discount_percentage": null, "days_for_revoke": null, "notes": null, "payment_count": 1, "bank_billet_account_id": 28, "beneficiary_name": "Kobana Tecnologia Ltda.", "beneficiary_cnpj_cpf": "05.813.794/0001-26", "beneficiary_address": "Av. Presidente Vargas, 633, sala 1716, Centro, Rio de Janeiro, RJ, 20071004", "beneficiary_assignor_code": "4327 / 0229385", "guarantor_name": null, "guarantor_cnpj_cpf": null, "payment_place": "Pagável em qualquer banco até a data de vencimento.", "instructions": null, "document_date": null, "document_type": "02", "document_number": null, "acceptance": "N", "processed_our_number": "00400048", "processed_our_number_raw": "00400048", "bank_contract_slug": "sicoob-01", "agency_number": "4327", "agency_digit": "3", "account_number": "00003666", "account_digit": "8", "extra1": "0229385", "extra1_digit": null, "extra2": null, "extra2_digit": null, "line": "75691.43279 01022.938508 04000.480014 5 15630000005000", "our_number": "40004", "customer_subscription_id": null, "installment_total": null, "installment_number": null, "installment_id": null, "carne_url": null, "bank_billet_layout_id": null, "created_at": "2026-09-04T12:54:06-05:00", "updated_at": "2026-09-04T12:54:06-05:00", "tags": [ "tag 1", "tag2", "tag 3" ], "tag_list": "tag 1,tag2,tag 3", "document_type_label": "DM", "addons": null, "ignore_email": false, "ignore_sms": false, "ignore_whatsapp": false, "sue_code": null, "revoke_code": null, "first_instruction": null, "second_instruction": null, "guarantor_address_number": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "guarantor_city_name": null, "guarantor_state": null, "guarantor_zipcode": null, "guarantor_address": null, "guarantor_address_complement": null, "barcode": "75695156300000050001432701022938500400048001", "registered_at": null, "prevent_registration": false, "customer_id": 5, "control_number": null, "divergent_payment_type": null, "divergent_payment_value_type": null, "divergent_payment_maximum_value": null, "divergent_payment_minimum_value": null, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null, "divergent_payment_limit": null, "days_for_discount": null, "days_for_second_discount": null, "second_discount_percentage": null, "second_discount_value": null, "days_for_third_discount": null, "third_discount_percentage": null, "third_discount_value": null, "days_for_sue": null, "days_for_negativation": null, "interest_percentage": null, "interest_value": null, "interest_days_type": 0, "customer_contact_person": null, "custom_attachment_name": null, "split_payment": false, "split_payment_type": null, "dispatch_type": 1, "charge_type": 1, "custom_data": null, "issued_at": "2026-09-04T12:54:06-05:00", "shorten_url": "http://dev.bole.to:5001/2/xr", "pix_enabled": false, "pix_qrcode": null, "password_protected_mode": null, "revoked_at": null, "recipient_account": null, "pix_txid": null, "cancel_type": null, "cancellation_reason": null, "prevent_pix": false, "reduction_amount": null, "instructions_mode": 1, "import_id": null, "reduction_type": 3, "reduction_percentage": null, "url_hash": "xr", "external_id": null, "financial_provider_external_id": null, "days_for_sue_type": null, "credit_bureau": null, "after_create": [], "sue_history": [], "bank_billet_discharges": [], "bank_billet_remittances": [], "bank_billet_payments": [], "bank_billet_registrations": [], "bank_billet_split_accounts": [], "pix": [], "payments": [] }, "schema": { "$ref": "#/components/schemas/v1_bank_billet_object" } } } }, "404": { "description": "Boleto não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } }, "put": { "summary": "Atualizar o Boleto", "tags": [ "Boletos" ], "security": [ { "bearerAuth": [] } ], "description": "Atualiza informações específicas de um Boleto.\n\nVocê pode alterar boletos no status de Aberto(`opened`) ou Vencido(`overdue`)\n\nVocê receberá webhooks `generating` e `opened` para o boleto alterado.\n\nEm carteiras registradas, a alteração irá entrar na remessa e pode ser cobrada taxa bancária.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Boleto", "example": 999, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Boleto atualizado" }, "422": { "description": "Campos não suportados pelo banco", "content": { "application/json": { "example": { "errors": { "discount_value": [ "não suportado pelo banco na alteração." ], "discount_type": [ "não suportado pelo banco na alteração." ], "days_for_discount": [ "não suportado pelo banco na alteração." ] } }, "schema": { "$ref": "#/components/schemas/v1_errors_object" } } } }, "404": { "description": "Boleto não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1_bank_billet_update_object" } } }, "required": true, "description": "Informações a serem atualizadas no boleto" } } }, "/v1/bank_billets/{id}/cancel": { "put": { "summary": "Cancelar o Boleto", "tags": [ "Boletos" ], "security": [ { "bearerAuth": [] } ], "description": "Cancela boletos nos status de Aberto(opened) ou Vencido(overdue)", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Boleto", "example": 999, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Boleto cancelado" }, "422": { "description": "Boleto não pode ser cancelado", "content": { "application/json": { "example": { "status": 422, "errors": [ { "title": "Boleto não pode ser cancelado para o status paid", "code": "unprocessable_content" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "404": { "description": "Boleto não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1_bank_billet_cancel_object" } } }, "description": "Informações de cancelamento de um boleto" } } }, "/v1/bank_billets/{id}/duplicate": { "post": { "summary": "Duplicar Boleto", "tags": [ "Boletos" ], "security": [ { "bearerAuth": [] } ], "description": "Duplica boleto permitindo alterar informações do novo boleto e ou cancelar o boleto duplicado", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Boleto", "example": 999, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Boleto duplicado", "content": { "application/json": { "example": { "id": 12, "uid": "01a06d8e-72f4-72c1-a5c1-1bdcea11653d", "expire_at": "2026-09-11", "paid_at": null, "description": "Serviço de criação de site\\r\\nExpira em: 11/09/2026", "status": "generating", "registration_status": "pending", "customer_person_name": "José da Silva", "customer_cnpj_cpf": "399.881.072-26", "customer_address": "Av. Burkhard Hehn Simões", "customer_state": "RJ", "customer_neighborhood": "São Francisco", "customer_zipcode": "24360440", "customer_address_number": "111", "customer_address_complement": "709", "customer_phone_number": "2199999999", "customer_email": "cliente@example.com", "customer_email_cc": "john_cc@example.com", "customer_ignore_email": null, "customer_ignore_sms": false, "customer_mobile_local_code": null, "customer_mobile_number": null, "customer_nickname": null, "customer_notes": null, "created_via_api": true, "customer_city_name": "Rio de Janeiro", "paid_amount": null, "amount": 1345.56, "url": "http://dev.bole.to:5001/2/gr", "formats": { "default": "http://dev.bole.to:5001/2/gr", "png": "http://dev.bole.to:5001/2/gr.png", "pdf": "http://dev.bole.to:5001/2/gr.pdf", "boleto_hibrido": "http://dev.bole.to:5001/2/gr/boleto_hibrido", "boleto_pix": null, "barcode": "http://dev.bole.to:5001/2/gr/barcode", "envelope": "http://dev.bole.to:5001/2/gr/envelope", "letter": "http://dev.bole.to:5001/2/gr/letter", "line": "http://dev.bole.to:5001/2/gr/line", "recibo": "http://dev.bole.to:5001/2/gr/recibo", "pix_qrcode": null }, "meta": null, "fine_for_delay": null, "fine_type": 0, "fine_percentage": null, "fine_value": null, "days_for_fine": null, "late_payment_interest": null, "interest_type": 0, "interest_daily_value": null, "interest_daily_percentage": null, "interest_monthly_percentage": null, "days_for_interest": null, "discount_type": 0, "discount_limit_date": null, "discount_value": null, "discount_percentage": null, "days_for_revoke": null, "notes": null, "payment_count": 1, "bank_billet_account_id": 34, "beneficiary_name": "Kobana Tecnologia Ltda.", "beneficiary_cnpj_cpf": "05.813.794/0001-26", "beneficiary_address": "Av. Presidente Vargas, 633, sala 1716, Centro, Rio de Janeiro, RJ, 20071004", "beneficiary_assignor_code": "4327 / 0229385", "guarantor_name": null, "guarantor_cnpj_cpf": null, "payment_place": "Pagável em qualquer banco até a data de vencimento.", "instructions": null, "document_date": null, "document_type": "02", "document_number": null, "acceptance": "N", "processed_our_number": "00000024", "processed_our_number_raw": "00000024", "bank_contract_slug": "sicoob-01", "agency_number": "4327", "agency_digit": "3", "account_number": "00003666", "account_digit": "8", "extra1": "0229385", "extra1_digit": null, "extra2": null, "extra2_digit": null, "line": "75691.43279 01022.938508 00000.240010 1 15660000134556", "our_number": "2", "customer_subscription_id": null, "installment_total": null, "installment_number": null, "installment_id": null, "carne_url": null, "bank_billet_layout_id": null, "created_at": "2026-09-04T12:54:07-05:00", "updated_at": "2026-09-04T12:54:07-05:00", "tags": [ "tag 1", "tag2", "tag 3" ], "tag_list": "tag 1,tag2,tag 3", "document_type_label": "DM", "addons": null, "ignore_email": false, "ignore_sms": false, "ignore_whatsapp": false, "sue_code": null, "revoke_code": null, "first_instruction": null, "second_instruction": null, "guarantor_address_number": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "guarantor_city_name": null, "guarantor_state": null, "guarantor_zipcode": null, "guarantor_address": null, "guarantor_address_complement": null, "barcode": "75691156600001345561432701022938500000024001", "registered_at": null, "prevent_registration": false, "customer_id": 10, "control_number": null, "divergent_payment_type": null, "divergent_payment_value_type": null, "divergent_payment_maximum_value": null, "divergent_payment_minimum_value": null, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null, "divergent_payment_limit": null, "days_for_discount": null, "days_for_second_discount": null, "second_discount_percentage": null, "second_discount_value": null, "days_for_third_discount": null, "third_discount_percentage": null, "third_discount_value": null, "days_for_sue": null, "days_for_negativation": null, "interest_percentage": null, "interest_value": null, "interest_days_type": 0, "customer_contact_person": null, "custom_attachment_name": null, "split_payment": false, "split_payment_type": null, "dispatch_type": 1, "charge_type": 1, "custom_data": null, "issued_at": "2026-09-04T12:54:07-05:00", "shorten_url": "http://dev.bole.to:5001/2/gr", "pix_enabled": false, "pix_qrcode": null, "password_protected_mode": null, "revoked_at": null, "recipient_account": null, "pix_txid": null, "cancel_type": null, "cancellation_reason": null, "prevent_pix": false, "reduction_amount": null, "instructions_mode": 1, "import_id": null, "reduction_type": 3, "reduction_percentage": null, "url_hash": "gr", "external_id": null, "financial_provider_external_id": null, "days_for_sue_type": null, "credit_bureau": null, "after_create": [], "sue_history": [], "bank_billet_discharges": [], "bank_billet_remittances": [], "bank_billet_payments": [], "bank_billet_registrations": [], "bank_billet_split_accounts": [], "pix": [], "payments": [] }, "schema": { "$ref": "#/components/schemas/v1_bank_billet_object" } } } }, "404": { "description": "Boleto não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1_bank_billet_duplicate_object" } } }, "description": "É permitido o envio de qualquer outro parâmetro do boleto." } } }, "/v1/bank_billets/{id}/protest/{type}": { "put": { "summary": "Protestar Boleto", "tags": [ "Boletos" ], "security": [ { "bearerAuth": [] } ], "description": "Protesta ou cancela protesto de um boleto vencido. O parâmetro :type na rota é obrigatório: use \"send\" para protestar o boleto ou \"cancel\" para cancelar um protesto existente.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Boleto", "example": 999, "schema": { "type": "string" } }, { "name": "type", "in": "path", "required": true, "description": "Tipo de ação de protesto", "example": "send", "schema": { "type": "string", "enum": [ "send", "cancel" ] } } ], "responses": { "204": { "description": "Boleto protestado com sucesso" }, "422": { "description": "Tipo de protesto inválido", "content": { "application/json": { "example": { "status": 422, "errors": [ { "title": "Invalid protest type: invalid_type. Must be 'send' or 'cancel'", "code": "unprocessable_content" } ] } } } }, "404": { "description": "Boleto não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] } } } } } } }, "/v1/bank_billets/{id}/pay": { "put": { "summary": "Marcar Boleto Como Pago", "tags": [ "Boletos" ], "security": [ { "bearerAuth": [] } ], "description": "Marcar boleto como pago", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Boleto", "example": 999, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Boleto pago" }, "404": { "description": "Boleto não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1_bank_billet_pay_object" } } }, "description": "Informações de pagamento do boleto" } } }, "/v1/bank_billets/cancel_all": { "post": { "summary": "Cancelar Boletos em Lote", "tags": [ "Boletos" ], "security": [ { "bearerAuth": [] } ], "description": "Cancelar boletos em lote", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": { "200": { "description": "Solicitação realizada com sucesso", "content": { "application/json": { "example": { "message": "Solicitação de cancelamento enviada para processamento" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "status": 422, "errors": [ { "title": "Parâmetros para o cancelamento não encontrados", "code": "unprocessable_content" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1_bank_billet_cancel_all_object" } } }, "description": "Pelo menos um parâmetro é obrigatório na chamada. Os parâmetros podem ser combinados." } } }, "/v1/bank_billets/{id}/send_email": { "post": { "summary": "Enviar Boleto por E-mail", "tags": [ "Boletos" ], "security": [ { "bearerAuth": [] } ], "description": "Enviar boleto por e-mail", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Boleto", "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "E-mail enviado com sucesso", "content": { "application/json": { "example": { "message": "Boleto enviado para o email bar@gmail.com com sucesso." } } } }, "400": { "description": "Falha ao enviar o e-mail", "content": { "application/json": { "example": { "message": "Falha ao enviar o Boleto para email.", "errors": [ "Template de e-mail não pode ficar em branco" ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1_bank_billet_send_email_object" } } }, "description": "Envio de boleto por e-mail" } } }, "/v1/bank_billets/{id}/send_sms": { "post": { "summary": "Enviar Boleto por SMS", "tags": [ "Boletos" ], "security": [ { "bearerAuth": [] } ], "description": "Enviar boleto por sms", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Boleto", "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SMS enviado com sucesso", "content": { "application/json": { "example": { "message": "Sms enviado para 2199999999 com sucesso." } } } }, "400": { "description": "Falha ao enviar o sms", "content": { "application/json": { "example": { "message": "Falha ao enviar o Boleto pelo sms.", "errors": [ "Conta de SMS é obrigatório(a)" ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1_bank_billet_send_sms_object" } } }, "description": "Envio de boleto por sms" } } }, "/v1/customer_subscriptions": { "post": { "summary": "Criar uma Assinatura", "tags": [ "Assinaturas" ], "description": "Cria uma nova assinatura recorrente para cobrança automática de clientes com boletos bancários.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Assinatura criada", "content": { "application/json": { "example": { "id": 1, "uid": "01a06d8e-7cfb-7cc5-a9d0-2423662e6fed", "amount": 34.56, "cycle": "monthly", "next_billing": "2026-10-04", "end_at": null, "instructions": null, "customer_id": 27, "customer_person_name": "Leofutol Bezerra", "customer_cnpj_cpf": "337.539.339-37", "customer_address": "Av. Presidente Vargas", "customer_state": "AP", "customer_neighborhood": "Centro", "customer_zipcode": "20071004", "customer_address_number": "633", "customer_address_complement": "apt 101", "customer_phone_number": "2188887766", "customer_email": "cliente@example.com", "customer_city_name": "Macapá", "customer_email_cc": "outro@example.com", "customer_ignore_email": false, "customer_ignore_sms": null, "customer_mobile_local_code": "22", "customer_mobile_number": "987654321", "customer_nickname": "Zezin La da Rua", "customer_notes": "Informação sobre o cliente", "description": "Serviços prestados", "created_at": "2026-09-04T12:54:09-05:00", "updated_at": "2026-09-04T12:54:09-05:00", "created_via_api": true, "days_in_advance": 7, "bank_billet_account_id": 47, "fine_for_delay": null, "fine_type": 2, "fine_percentage": null, "fine_value": 4.91, "days_for_fine": 3, "late_payment_interest": null, "interest_type": 1, "interest_daily_value": null, "interest_daily_percentage": null, "interest_monthly_percentage": null, "days_for_interest": 2, "discount_type": 2, "days_for_discount": 2, "discount_value": null, "discount_percentage": 10.0, "email": null, "bank_billet_layout_id": null, "bank_billet_ids": [], "notes": "Observações", "payment_count": 4, "tags": [ "tag1", "tag2", "tag3" ], "tag_list": "tag1,tag2,tag3", "prevent_registration": false, "divergent_payment_type": 2, "divergent_payment_value_type": 1, "divergent_payment_maximum_value": 150.01, "divergent_payment_minimum_value": 100.01, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null, "divergent_payment_limit": null, "days_for_second_discount": 1, "second_discount_percentage": 5.0, "second_discount_value": null, "days_for_third_discount": 0, "third_discount_percentage": 2.5, "third_discount_value": null, "days_for_revoke": 30, "days_for_sue": 40, "days_for_negativation": null, "interest_percentage": 0.3, "interest_value": null, "interest_days_type": 0, "customer_contact_person": "Zezin 2", "custom_attachment_name": "boleto_{{ bank_billet.id }}", "guarantor_name": null, "guarantor_cnpj_cpf": null, "guarantor_address_number": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "guarantor_city_name": null, "guarantor_state": null, "guarantor_zipcode": null, "guarantor_address": null, "guarantor_address_complement": null, "import_id": null, "ignore_whatsapp": false, "days_for_sue_type": 0 }, "schema": { "$ref": "#/components/schemas/v1_customer_subscription_object" } } } }, "422": { "description": "Assinatura inválida", "content": { "application/json": { "example": { "errors": { "customer_person_name": [ "não pode ficar em branco" ], "customer_cnpj_cpf": [ "não é um CNPJ ou CPF válido" ], "customer_zipcode": [ "não pode ficar em branco" ], "amount": [ "não pode ficar em branco" ], "customer_address": [ "não pode ficar em branco" ], "customer_neighborhood": [ "não pode ficar em branco" ], "customer_city_name": [ "não pode ficar em branco" ], "customer_state": [ "não está incluído na lista" ] } }, "schema": { "$ref": "#/components/schemas/v1_errors_object" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1_customer_subscription_object" } } }, "required": true, "description": "Informações a serem salvas na assinatura" } }, "get": { "summary": "Listar Assinaturas", "tags": [ "Assinaturas" ], "security": [ { "bearerAuth": [] } ], "description": "Lista assinaturas.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "customer_person_name", "in": "query", "description": "Filtro por Nome/Razão Social.", "example": "Kevin Mitnick", "required": false, "schema": { "type": "string" } }, { "name": "customer_cnpj_cpf", "in": "query", "description": "Filtro por CPF/CNPJ da assinatura. Deve ser formatado com máscara. Acha todos os registros cujo campo seja igual ao string.", "example": "05.813.794/0001-26", "required": false, "schema": { "type": "string" } }, { "name": "customer_email", "in": "query", "description": "Filtro por e-mail do cliente. Acha todos os registros cujo campo seja igual ao string.", "example": "cliente@example.com", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } } ], "responses": { "200": { "description": "Sucesso na listagem de assinaturas", "content": { "application/json": { "example": [ { "id": 2, "uid": "01a06d8e-7e52-7a33-8a8e-19b52d9501cb", "amount": 150.0, "cycle": "monthly", "next_billing": "2026-10-04", "end_at": null, "instructions": "Não receber após o vencimento", "customer_id": 28, "customer_person_name": "Margret Santos Filgueiras", "customer_cnpj_cpf": "886.195.890-75", "customer_address": "Av. Burkhard Hehn Simões", "customer_state": "RJ", "customer_neighborhood": "São Francisco", "customer_zipcode": "24360440", "customer_address_number": "120", "customer_address_complement": "709", "customer_phone_number": "2199999999", "customer_email": "glen_mckenzie@greenfelder-yost.example", "customer_city_name": "Rio de Janeiro", "customer_email_cc": "john_cc@example.com", "customer_ignore_email": null, "customer_ignore_sms": false, "customer_mobile_local_code": null, "customer_mobile_number": null, "customer_nickname": null, "customer_notes": null, "description": "Cliente especial", "created_at": "2026-09-04T12:54:10-05:00", "updated_at": "2026-09-04T12:54:10-05:00", "created_via_api": false, "days_in_advance": 7, "bank_billet_account_id": 49, "fine_for_delay": null, "fine_type": 0, "fine_percentage": null, "fine_value": null, "days_for_fine": null, "late_payment_interest": null, "interest_type": 0, "interest_daily_value": null, "interest_daily_percentage": null, "interest_monthly_percentage": null, "days_for_interest": null, "discount_type": 0, "days_for_discount": null, "discount_value": null, "discount_percentage": null, "email": null, "bank_billet_layout_id": null, "bank_billet_ids": [], "notes": null, "payment_count": 1, "tags": [ "tag 1", "tag2", "tag 3" ], "tag_list": "tag 1,tag2,tag 3", "prevent_registration": false, "divergent_payment_type": null, "divergent_payment_value_type": null, "divergent_payment_maximum_value": null, "divergent_payment_minimum_value": null, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null, "divergent_payment_limit": null, "days_for_second_discount": null, "second_discount_percentage": null, "second_discount_value": null, "days_for_third_discount": null, "third_discount_percentage": null, "third_discount_value": null, "days_for_revoke": null, "days_for_sue": null, "days_for_negativation": null, "interest_percentage": null, "interest_value": null, "interest_days_type": 0, "customer_contact_person": null, "custom_attachment_name": null, "guarantor_name": null, "guarantor_cnpj_cpf": null, "guarantor_address_number": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "guarantor_city_name": null, "guarantor_state": null, "guarantor_zipcode": null, "guarantor_address": null, "guarantor_address_complement": null, "import_id": null, "ignore_whatsapp": false, "days_for_sue_type": null }, { "id": 3, "uid": "01a06d8e-7e65-7a58-8fd9-858414fe00b1", "amount": 150.0, "cycle": "monthly", "next_billing": "2026-10-04", "end_at": null, "instructions": "Não receber após o vencimento", "customer_id": 29, "customer_person_name": "Margret Santos Filgueiras", "customer_cnpj_cpf": "941.807.303-08", "customer_address": "Av. Burkhard Hehn Simões", "customer_state": "RJ", "customer_neighborhood": "São Francisco", "customer_zipcode": "24360440", "customer_address_number": "120", "customer_address_complement": "709", "customer_phone_number": "2199999999", "customer_email": "joaquin_rutherford@ratke.example", "customer_city_name": "Rio de Janeiro", "customer_email_cc": "john_cc@example.com", "customer_ignore_email": null, "customer_ignore_sms": false, "customer_mobile_local_code": null, "customer_mobile_number": null, "customer_nickname": null, "customer_notes": null, "description": "Cliente especial", "created_at": "2026-09-04T12:54:10-05:00", "updated_at": "2026-09-04T12:54:10-05:00", "created_via_api": false, "days_in_advance": 7, "bank_billet_account_id": 49, "fine_for_delay": null, "fine_type": 0, "fine_percentage": null, "fine_value": null, "days_for_fine": null, "late_payment_interest": null, "interest_type": 0, "interest_daily_value": null, "interest_daily_percentage": null, "interest_monthly_percentage": null, "days_for_interest": null, "discount_type": 0, "days_for_discount": null, "discount_value": null, "discount_percentage": null, "email": null, "bank_billet_layout_id": null, "bank_billet_ids": [], "notes": null, "payment_count": 1, "tags": [ "tag 1", "tag2", "tag 3" ], "tag_list": "tag 1,tag2,tag 3", "prevent_registration": false, "divergent_payment_type": null, "divergent_payment_value_type": null, "divergent_payment_maximum_value": null, "divergent_payment_minimum_value": null, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null, "divergent_payment_limit": null, "days_for_second_discount": null, "second_discount_percentage": null, "second_discount_value": null, "days_for_third_discount": null, "third_discount_percentage": null, "third_discount_value": null, "days_for_revoke": null, "days_for_sue": null, "days_for_negativation": null, "interest_percentage": null, "interest_value": null, "interest_days_type": 0, "customer_contact_person": null, "custom_attachment_name": null, "guarantor_name": null, "guarantor_cnpj_cpf": null, "guarantor_address_number": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "guarantor_city_name": null, "guarantor_state": null, "guarantor_zipcode": null, "guarantor_address": null, "guarantor_address_complement": null, "import_id": null, "ignore_whatsapp": false, "days_for_sue_type": null }, { "id": 4, "uid": "01a06d8e-7e79-755b-b762-13b6e9ce01f3", "amount": 150.0, "cycle": "monthly", "next_billing": "2026-10-04", "end_at": null, "instructions": "Não receber após o vencimento", "customer_id": 30, "customer_person_name": "Margret Santos Filgueiras", "customer_cnpj_cpf": "021.787.890-30", "customer_address": "Av. Burkhard Hehn Simões", "customer_state": "RJ", "customer_neighborhood": "São Francisco", "customer_zipcode": "24360440", "customer_address_number": "120", "customer_address_complement": "709", "customer_phone_number": "2199999999", "customer_email": "rupert@gislason-greenholt.example", "customer_city_name": "Rio de Janeiro", "customer_email_cc": "john_cc@example.com", "customer_ignore_email": null, "customer_ignore_sms": false, "customer_mobile_local_code": null, "customer_mobile_number": null, "customer_nickname": null, "customer_notes": null, "description": "Cliente especial", "created_at": "2026-09-04T12:54:10-05:00", "updated_at": "2026-09-04T12:54:10-05:00", "created_via_api": false, "days_in_advance": 7, "bank_billet_account_id": 49, "fine_for_delay": null, "fine_type": 0, "fine_percentage": null, "fine_value": null, "days_for_fine": null, "late_payment_interest": null, "interest_type": 0, "interest_daily_value": null, "interest_daily_percentage": null, "interest_monthly_percentage": null, "days_for_interest": null, "discount_type": 0, "days_for_discount": null, "discount_value": null, "discount_percentage": null, "email": null, "bank_billet_layout_id": null, "bank_billet_ids": [], "notes": null, "payment_count": 1, "tags": [ "tag 1", "tag2", "tag 3" ], "tag_list": "tag 1,tag2,tag 3", "prevent_registration": false, "divergent_payment_type": null, "divergent_payment_value_type": null, "divergent_payment_maximum_value": null, "divergent_payment_minimum_value": null, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null, "divergent_payment_limit": null, "days_for_second_discount": null, "second_discount_percentage": null, "second_discount_value": null, "days_for_third_discount": null, "third_discount_percentage": null, "third_discount_value": null, "days_for_revoke": null, "days_for_sue": null, "days_for_negativation": null, "interest_percentage": null, "interest_value": null, "interest_days_type": 0, "customer_contact_person": null, "custom_attachment_name": null, "guarantor_name": null, "guarantor_cnpj_cpf": null, "guarantor_address_number": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "guarantor_city_name": null, "guarantor_state": null, "guarantor_zipcode": null, "guarantor_address": null, "guarantor_address_complement": null, "import_id": null, "ignore_whatsapp": false, "days_for_sue_type": null } ], "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1_customer_subscription_object" } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/customer_subscriptions/{id}": { "get": { "summary": "Informações da Assinatura", "tags": [ "Assinaturas" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de uma Assinatura.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "id", "in": "path", "required": true, "description": "ID da Assinatura", "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Assinatura encontrada", "content": { "application/json": { "example": { "id": 5, "uid": "01a06d8e-7f19-75fc-bf1f-3c79c7bed886", "amount": 150.0, "cycle": "monthly", "next_billing": "2026-10-04", "end_at": null, "instructions": "Não receber após o vencimento", "customer_id": 31, "customer_person_name": "Margret Santos Filgueiras", "customer_cnpj_cpf": "198.120.607-82", "customer_address": "Av. Burkhard Hehn Simões", "customer_state": "RJ", "customer_neighborhood": "São Francisco", "customer_zipcode": "24360440", "customer_address_number": "120", "customer_address_complement": "709", "customer_phone_number": "2199999999", "customer_email": "jefferey_wyman@tillman.test", "customer_city_name": "Rio de Janeiro", "customer_email_cc": "john_cc@example.com", "customer_ignore_email": null, "customer_ignore_sms": false, "customer_mobile_local_code": null, "customer_mobile_number": null, "customer_nickname": null, "customer_notes": null, "description": "Cliente especial", "created_at": "2026-09-04T12:54:10-05:00", "updated_at": "2026-09-04T12:54:10-05:00", "created_via_api": false, "days_in_advance": 7, "bank_billet_account_id": 50, "fine_for_delay": null, "fine_type": 0, "fine_percentage": null, "fine_value": null, "days_for_fine": null, "late_payment_interest": null, "interest_type": 0, "interest_daily_value": null, "interest_daily_percentage": null, "interest_monthly_percentage": null, "days_for_interest": null, "discount_type": 0, "days_for_discount": null, "discount_value": null, "discount_percentage": null, "email": null, "bank_billet_layout_id": null, "bank_billet_ids": [], "notes": null, "payment_count": 1, "tags": [ "tag 1", "tag2", "tag 3" ], "tag_list": "tag 1,tag2,tag 3", "prevent_registration": false, "divergent_payment_type": null, "divergent_payment_value_type": null, "divergent_payment_maximum_value": null, "divergent_payment_minimum_value": null, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null, "divergent_payment_limit": null, "days_for_second_discount": null, "second_discount_percentage": null, "second_discount_value": null, "days_for_third_discount": null, "third_discount_percentage": null, "third_discount_value": null, "days_for_revoke": null, "days_for_sue": null, "days_for_negativation": null, "interest_percentage": null, "interest_value": null, "interest_days_type": 0, "customer_contact_person": null, "custom_attachment_name": null, "guarantor_name": null, "guarantor_cnpj_cpf": null, "guarantor_address_number": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "guarantor_city_name": null, "guarantor_state": null, "guarantor_zipcode": null, "guarantor_address": null, "guarantor_address_complement": null, "import_id": null, "ignore_whatsapp": false, "days_for_sue_type": null }, "schema": { "$ref": "#/components/schemas/v1_customer_subscription_object" } } } }, "404": { "description": "Assinatura não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } }, "put": { "summary": "Atualizar a Assinatura", "tags": [ "Assinaturas" ], "security": [ { "bearerAuth": [] } ], "description": "Atualiza informações específicas de uma Assinatura", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Assinatura", "example": 999, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Assinatura atualizado" }, "404": { "description": "Assinatura não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1_customer_subscription_object" } } }, "required": true, "description": "Informações a serem salvas na assinatura" } }, "delete": { "summary": "Excluir a Assinatura", "tags": [ "Assinaturas" ], "security": [ { "bearerAuth": [] } ], "description": "Exclui uma Assinatura.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "id", "in": "path", "required": true, "description": "ID da Assinatura", "example": 999, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Assinatura excluída" }, "404": { "description": "Assinatura não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/customer_subscriptions/{id}/next_charge": { "post": { "summary": "Gerar Próxima Cobrança", "tags": [ "Assinaturas" ], "security": [ { "bearerAuth": [] } ], "description": "Gera a próxima cobrança.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Assinatura", "example": 999, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Próxima cobrança gerada", "content": { "application/json": { "example": { "id": 8, "uid": "01a06d8e-81e9-7156-9967-6d1ccb83003d", "amount": 150.0, "cycle": "monthly", "next_billing": "2026-11-04", "end_at": null, "instructions": "Não receber após o vencimento", "customer_id": 34, "customer_person_name": "Margret Santos Filgueiras", "customer_cnpj_cpf": "684.947.011-69", "customer_address": "Av. Burkhard Hehn Simões", "customer_state": "RJ", "customer_neighborhood": "São Francisco", "customer_zipcode": "24360440", "customer_address_number": "120", "customer_address_complement": "709", "customer_phone_number": "2199999999", "customer_email": "marna_gutmann@hirthe-bartell.test", "customer_city_name": "Rio de Janeiro", "customer_email_cc": "john_cc@example.com", "customer_ignore_email": null, "customer_ignore_sms": false, "customer_mobile_local_code": null, "customer_mobile_number": null, "customer_nickname": null, "customer_notes": null, "description": "Cliente especial", "created_at": "2026-09-04T12:54:11-05:00", "updated_at": "2026-09-04T12:54:11-05:00", "created_via_api": false, "days_in_advance": 7, "bank_billet_account_id": 53, "fine_for_delay": null, "fine_type": 0, "fine_percentage": null, "fine_value": null, "days_for_fine": null, "late_payment_interest": null, "interest_type": 0, "interest_daily_value": null, "interest_daily_percentage": null, "interest_monthly_percentage": null, "days_for_interest": null, "discount_type": 0, "days_for_discount": null, "discount_value": null, "discount_percentage": null, "email": null, "bank_billet_layout_id": null, "bank_billet_ids": [ 29 ], "notes": null, "payment_count": 1, "tags": [ "tag 1", "tag2", "tag 3" ], "tag_list": "tag 1,tag2,tag 3", "prevent_registration": false, "divergent_payment_type": null, "divergent_payment_value_type": null, "divergent_payment_maximum_value": null, "divergent_payment_minimum_value": null, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null, "divergent_payment_limit": null, "days_for_second_discount": null, "second_discount_percentage": null, "second_discount_value": null, "days_for_third_discount": null, "third_discount_percentage": null, "third_discount_value": null, "days_for_revoke": null, "days_for_sue": null, "days_for_negativation": null, "interest_percentage": null, "interest_value": null, "interest_days_type": 0, "customer_contact_person": null, "custom_attachment_name": null, "guarantor_name": null, "guarantor_cnpj_cpf": null, "guarantor_address_number": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "guarantor_city_name": null, "guarantor_state": null, "guarantor_zipcode": null, "guarantor_address": null, "guarantor_address_complement": null, "import_id": null, "ignore_whatsapp": false, "days_for_sue_type": null }, "schema": { "$ref": "#/components/schemas/v1_customer_subscription_object" } } } }, "404": { "description": "Assinatura não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/customers": { "post": { "summary": "Criar um Cliente", "tags": [ "Clientes" ], "security": [ { "bearerAuth": [] } ], "description": "Cria um novo cliente para associação com cobranças, boletos e assinaturas.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Cliente criado", "content": { "application/json": { "example": { "id": 35, "uid": "01a06d8e-82f6-7552-88aa-c2c9754f4624", "city_name": "Minas Gerais", "person_name": "Jonh Doe", "nickname": null, "address": "Av. Presidente Vargas", "address_complement": null, "address_number": "633", "mobile_number": "994912999", "cnpj_cpf": "399.881.072-26", "email": "john@example.com", "neighborhood": "Centro", "phone_number": null, "zipcode": "20071004", "mobile_local_code": "21", "notes": "Observações", "state": "MG", "created_via_api": true, "created_at": "2026-09-04T12:54:11-05:00", "updated_at": "2026-09-04T12:54:11-05:00", "ignore_email": null, "ignore_sms": false, "ignore_whatsapp": false, "email_cc": "john_cc@example.com", "contact_person": "Johnny Doe", "truncated_address": "Av. Presidente Vargas, 633", "external_code": "12345678", "tags": [], "tag_list": null, "custom_data": null, "portal_password": "KqPQaoxu", "birthday": "1978-06-12", "ignore_credit_restriction": false, "credit_restriction_status": 0, "ignore_credit_restriction_limit_at": null, "ignore_credit_restriction_reason": null, "credit_restriction_responsable_email": null, "ignore_credit_restriction_included_at": null }, "schema": { "$ref": "#/components/schemas/v1_customer_object" } } } }, "422": { "description": "Cliente inválido", "content": { "application/json": { "example": { "errors": { "person_name": [ "não pode ficar em branco" ], "zipcode": [ "não pode ficar em branco" ], "address": [ "não pode ficar em branco" ], "neighborhood": [ "não pode ficar em branco" ], "city_name": [ "não pode ficar em branco" ], "cnpj_cpf": [ "não é um CNPJ ou CPF válido" ], "state": [ "não está incluído na lista" ] } }, "schema": { "$ref": "#/components/schemas/v1_errors_object" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1_customer_object" } } }, "required": true, "description": "Informações a serem salvas no cliente" } }, "get": { "summary": "Listar Clientes", "tags": [ "Clientes" ], "security": [ { "bearerAuth": [] } ], "description": "Lista clientes.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso na listagem de clientes", "content": { "application/json": { "example": [ { "id": 37, "uid": "01a06d8e-83ec-7824-9539-a442cb9b23fe", "city_name": "Rio de Janeiro", "person_name": "Margret Santos Filgueiras", "nickname": null, "address": "Av. Burkhard Hehn Simões", "address_complement": "709", "address_number": "120", "mobile_number": null, "cnpj_cpf": "911.241.251-16", "email": "merle@streich.example", "neighborhood": "São Francisco", "phone_number": "2199999999", "zipcode": "24360440", "mobile_local_code": null, "notes": null, "state": "RJ", "created_via_api": false, "created_at": "2026-09-04T12:54:11-05:00", "updated_at": "2026-09-04T12:54:11-05:00", "ignore_email": null, "ignore_sms": false, "ignore_whatsapp": false, "email_cc": "john_cc@example.com", "contact_person": null, "truncated_address": "Av. Burkhard Hehn Simões, 120", "external_code": null, "tags": [ "omnis", "ipsum", "eveniet" ], "tag_list": "omnis,ipsum,eveniet", "custom_data": { "numero_cliente": 63126 }, "portal_password": "effrYb8C", "birthday": "1978-06-12", "ignore_credit_restriction": false, "credit_restriction_status": 0, "ignore_credit_restriction_limit_at": null, "ignore_credit_restriction_reason": null, "credit_restriction_responsable_email": null, "ignore_credit_restriction_included_at": null }, { "id": 38, "uid": "01a06d8e-83f0-7b3a-9e06-d01d66ac0842", "city_name": "Rio de Janeiro", "person_name": "Margret Santos Filgueiras", "nickname": null, "address": "Av. Burkhard Hehn Simões", "address_complement": "709", "address_number": "120", "mobile_number": null, "cnpj_cpf": "256.774.832-65", "email": "val@breitenberg.test", "neighborhood": "São Francisco", "phone_number": "2199999999", "zipcode": "24360440", "mobile_local_code": null, "notes": null, "state": "RJ", "created_via_api": false, "created_at": "2026-09-04T12:54:11-05:00", "updated_at": "2026-09-04T12:54:11-05:00", "ignore_email": null, "ignore_sms": false, "ignore_whatsapp": false, "email_cc": "john_cc@example.com", "contact_person": null, "truncated_address": "Av. Burkhard Hehn Simões, 120", "external_code": null, "tags": [ "non", "accusantium", "vero" ], "tag_list": "non,accusantium,vero", "custom_data": { "numero_cliente": 63126 }, "portal_password": "2ngraNQS", "birthday": "1978-06-12", "ignore_credit_restriction": false, "credit_restriction_status": 0, "ignore_credit_restriction_limit_at": null, "ignore_credit_restriction_reason": null, "credit_restriction_responsable_email": null, "ignore_credit_restriction_included_at": null }, { "id": 39, "uid": "01a06d8e-83f5-7097-a3a4-e9847d5dbd40", "city_name": "Rio de Janeiro", "person_name": "Margret Santos Filgueiras", "nickname": null, "address": "Av. Burkhard Hehn Simões", "address_complement": "709", "address_number": "120", "mobile_number": null, "cnpj_cpf": "840.250.621-60", "email": "martin@nader.example", "neighborhood": "São Francisco", "phone_number": "2199999999", "zipcode": "24360440", "mobile_local_code": null, "notes": null, "state": "RJ", "created_via_api": false, "created_at": "2026-09-04T12:54:11-05:00", "updated_at": "2026-09-04T12:54:11-05:00", "ignore_email": null, "ignore_sms": false, "ignore_whatsapp": false, "email_cc": "john_cc@example.com", "contact_person": null, "truncated_address": "Av. Burkhard Hehn Simões, 120", "external_code": null, "tags": [ "necessitatibus", "cupiditate", "alias" ], "tag_list": "necessitatibus,cupiditate,alias", "custom_data": { "numero_cliente": 63126 }, "portal_password": "feNjQ5Cv", "birthday": "1978-06-12", "ignore_credit_restriction": false, "credit_restriction_status": 0, "ignore_credit_restriction_limit_at": null, "ignore_credit_restriction_reason": null, "credit_restriction_responsable_email": null, "ignore_credit_restriction_included_at": null } ], "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1_customer_object" } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/customers/{id}": { "get": { "summary": "Visualizar o Cliente", "tags": [ "Clientes" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de um Cliente.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Cliente", "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Cliente encontrado", "content": { "application/json": { "example": { "id": 40, "uid": "01a06d8e-8467-7265-8b6e-a3fc8cb6aae6", "city_name": "Rio de Janeiro", "person_name": "Margret Santos Filgueiras", "nickname": null, "address": "Av. Burkhard Hehn Simões", "address_complement": "709", "address_number": "120", "mobile_number": null, "cnpj_cpf": "576.707.994-39", "email": "brice@cassin.example", "neighborhood": "São Francisco", "phone_number": "2199999999", "zipcode": "24360440", "mobile_local_code": null, "notes": null, "state": "RJ", "created_via_api": false, "created_at": "2026-09-04T12:54:11-05:00", "updated_at": "2026-09-04T12:54:11-05:00", "ignore_email": null, "ignore_sms": false, "ignore_whatsapp": false, "email_cc": "john_cc@example.com", "contact_person": null, "truncated_address": "Av. Burkhard Hehn Simões, 120", "external_code": null, "tags": [ "praesentium", "sed", "omnis" ], "tag_list": "praesentium,sed,omnis", "custom_data": { "numero_cliente": 63126 }, "portal_password": "gDKAVdFu", "birthday": "1978-06-12", "ignore_credit_restriction": false, "credit_restriction_status": 0, "ignore_credit_restriction_limit_at": null, "ignore_credit_restriction_reason": null, "credit_restriction_responsable_email": null, "ignore_credit_restriction_included_at": null }, "schema": { "$ref": "#/components/schemas/v1_customer_object" } } } }, "404": { "description": "Cliente não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } }, "put": { "summary": "Atualizar Cliente", "tags": [ "Clientes" ], "security": [ { "bearerAuth": [] } ], "description": "Atualiza informações específicas de um Cliente.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID do Cliente", "example": 999, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Cliente atualizado" }, "404": { "description": "Cliente não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1_customer_update_object" } } }, "required": true, "description": "Informações a serem atualizadas no cliente" } } }, "/v1/customers/cnpj_cpf": { "get": { "summary": "Busca Cliente por CNPJ/CPF", "tags": [ "Clientes" ], "security": [ { "bearerAuth": [] } ], "description": "Visualizar um cliente buscando por cnpj ou cpf.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "q", "in": "query", "required": true, "description": "CNPJ/CPF do cliente", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Cliente encontrado", "content": { "application/json": { "example": { "id": 42, "uid": "01a06d8e-85e0-76a1-a3f5-5c345ef77c3e", "city_name": "Rio de Janeiro", "person_name": "Margret Santos Filgueiras", "nickname": null, "address": "Av. Burkhard Hehn Simões", "address_complement": "709", "address_number": "120", "mobile_number": null, "cnpj_cpf": "399.881.072-26", "email": "reginia.feest@ryan-bruen.test", "neighborhood": "São Francisco", "phone_number": "2199999999", "zipcode": "24360440", "mobile_local_code": null, "notes": null, "state": "RJ", "created_via_api": false, "created_at": "2026-09-04T12:54:12-05:00", "updated_at": "2026-09-04T12:54:12-05:00", "ignore_email": null, "ignore_sms": false, "ignore_whatsapp": false, "email_cc": "john_cc@example.com", "contact_person": null, "truncated_address": "Av. Burkhard Hehn Simões, 120", "external_code": null, "tags": [ "vel", "dolores", "deleniti" ], "tag_list": "vel,dolores,deleniti", "custom_data": { "numero_cliente": 63126 }, "portal_password": "swl0JnmF", "birthday": "1978-06-12", "ignore_credit_restriction": false, "credit_restriction_status": 0, "ignore_credit_restriction_limit_at": null, "ignore_credit_restriction_reason": null, "credit_restriction_responsable_email": null, "ignore_credit_restriction_included_at": null }, "schema": { "$ref": "#/components/schemas/v1_customer_object" } } } }, "404": { "description": "Cliente não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/customers/email": { "get": { "summary": "Busca Cliente por E-mail", "tags": [ "Clientes" ], "security": [ { "bearerAuth": [] } ], "description": "Visualizar um cliente buscando por e-mail.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "q", "in": "query", "required": true, "description": "E-mail do cliente", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Cliente encontrado", "content": { "application/json": { "example": { "id": 43, "uid": "01a06d8e-86ab-7b55-ba2d-132ae93837e6", "city_name": "Rio de Janeiro", "person_name": "Margret Santos Filgueiras", "nickname": null, "address": "Av. Burkhard Hehn Simões", "address_complement": "709", "address_number": "120", "mobile_number": null, "cnpj_cpf": "257.674.450-87", "email": "search@example.com", "neighborhood": "São Francisco", "phone_number": "2199999999", "zipcode": "24360440", "mobile_local_code": null, "notes": null, "state": "RJ", "created_via_api": false, "created_at": "2026-09-04T12:54:12-05:00", "updated_at": "2026-09-04T12:54:12-05:00", "ignore_email": null, "ignore_sms": false, "ignore_whatsapp": false, "email_cc": "john_cc@example.com", "contact_person": null, "truncated_address": "Av. Burkhard Hehn Simões, 120", "external_code": null, "tags": [ "repudiandae", "a", "aliquid" ], "tag_list": "repudiandae,a,aliquid", "custom_data": { "numero_cliente": 63126 }, "portal_password": "WVdFjUKm", "birthday": "1978-06-12", "ignore_credit_restriction": false, "credit_restriction_status": 0, "ignore_credit_restriction_limit_at": null, "ignore_credit_restriction_reason": null, "credit_restriction_responsable_email": null, "ignore_credit_restriction_included_at": null }, "schema": { "$ref": "#/components/schemas/v1_customer_object" } } } }, "404": { "description": "Cliente não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/installments": { "get": { "summary": "Listar Carnês", "tags": [ "Carnês" ], "security": [ { "bearerAuth": [] } ], "description": "Lista Carnês.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } } ], "responses": { "200": { "description": "Sucesso na listagem de carnês", "content": { "application/json": { "example": [ { "id": 5, "uid": "01a06d8e-8919-7539-8f0a-303a9c7e15e7", "amount": 133.54, "cycle": "monthly", "start_at": "2026-09-04", "end_at": "2027-08-04", "instructions": null, "customer_id": 48, "description": "Cliente especial", "created_at": "2026-09-04T12:54:12-05:00", "updated_at": "2026-09-04T12:54:12-05:00", "customer_person_name": "Margret Santos Filgueiras", "customer_cnpj_cpf": "909.566.384-14", "customer_address": "Av. Burkhard Hehn Simões", "customer_state": "RJ", "customer_neighborhood": "São Francisco", "customer_zipcode": "24360440", "customer_address_number": "120", "customer_address_complement": "709", "customer_phone_number": "2199999999", "customer_email": "nolan.armstrong@glover.example", "customer_city_name": "Rio de Janeiro", "customer_email_cc": "john_cc@example.com", "customer_ignore_email": null, "customer_ignore_sms": false, "customer_mobile_local_code": null, "customer_mobile_number": null, "customer_nickname": null, "customer_notes": null, "created_via_api": false, "total": 12, "bank_billet_account_id": 54, "status": "created", "fine_for_delay": null, "fine_type": 0, "fine_percentage": null, "fine_value": null, "days_for_fine": null, "late_payment_interest": null, "interest_type": 0, "interest_daily_value": null, "interest_daily_percentage": null, "interest_monthly_percentage": null, "days_for_interest": null, "discount_type": 0, "days_for_discount": null, "discount_value": null, "discount_percentage": null, "bank_billet_layout_id": null, "url": null, "bank_billet_ids": [], "bank_billets": [], "notes": null, "payment_count": 1, "tags": [ "tag 1", "tag2", "tag 3" ], "tag_list": "tag 1,tag2,tag 3", "prevent_registration": false, "divergent_payment_type": null, "divergent_payment_value_type": null, "divergent_payment_maximum_value": null, "divergent_payment_minimum_value": null, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null, "divergent_payment_limit": null, "days_for_second_discount": null, "second_discount_percentage": null, "second_discount_value": null, "days_for_third_discount": null, "third_discount_percentage": null, "third_discount_value": null, "days_for_revoke": null, "days_for_sue": null, "days_for_negativation": null, "interest_percentage": null, "interest_value": null, "interest_days_type": 0, "customer_contact_person": null, "custom_attachment_name": null, "guarantor_name": null, "guarantor_cnpj_cpf": null, "guarantor_address_number": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "guarantor_city_name": null, "guarantor_state": null, "guarantor_zipcode": null, "guarantor_address": null, "guarantor_address_complement": null, "document_number": null, "document_date": null, "document_type": "02", "import_id": null, "ignore_whatsapp": false, "days_for_sue_type": null }, { "id": 4, "uid": "01a06d8e-8906-70cf-b0e4-29122d046b23", "amount": 133.54, "cycle": "monthly", "start_at": "2026-09-04", "end_at": "2027-08-04", "instructions": null, "customer_id": 47, "description": "Cliente especial", "created_at": "2026-09-04T12:54:12-05:00", "updated_at": "2026-09-04T12:54:12-05:00", "customer_person_name": "Margret Santos Filgueiras", "customer_cnpj_cpf": "902.848.189-33", "customer_address": "Av. Burkhard Hehn Simões", "customer_state": "RJ", "customer_neighborhood": "São Francisco", "customer_zipcode": "24360440", "customer_address_number": "120", "customer_address_complement": "709", "customer_phone_number": "2199999999", "customer_email": "zelma@jerde-sawayn.test", "customer_city_name": "Rio de Janeiro", "customer_email_cc": "john_cc@example.com", "customer_ignore_email": null, "customer_ignore_sms": false, "customer_mobile_local_code": null, "customer_mobile_number": null, "customer_nickname": null, "customer_notes": null, "created_via_api": false, "total": 12, "bank_billet_account_id": 54, "status": "created", "fine_for_delay": null, "fine_type": 0, "fine_percentage": null, "fine_value": null, "days_for_fine": null, "late_payment_interest": null, "interest_type": 0, "interest_daily_value": null, "interest_daily_percentage": null, "interest_monthly_percentage": null, "days_for_interest": null, "discount_type": 0, "days_for_discount": null, "discount_value": null, "discount_percentage": null, "bank_billet_layout_id": null, "url": null, "bank_billet_ids": [], "bank_billets": [], "notes": null, "payment_count": 1, "tags": [ "tag 1", "tag2", "tag 3" ], "tag_list": "tag 1,tag2,tag 3", "prevent_registration": false, "divergent_payment_type": null, "divergent_payment_value_type": null, "divergent_payment_maximum_value": null, "divergent_payment_minimum_value": null, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null, "divergent_payment_limit": null, "days_for_second_discount": null, "second_discount_percentage": null, "second_discount_value": null, "days_for_third_discount": null, "third_discount_percentage": null, "third_discount_value": null, "days_for_revoke": null, "days_for_sue": null, "days_for_negativation": null, "interest_percentage": null, "interest_value": null, "interest_days_type": 0, "customer_contact_person": null, "custom_attachment_name": null, "guarantor_name": null, "guarantor_cnpj_cpf": null, "guarantor_address_number": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "guarantor_city_name": null, "guarantor_state": null, "guarantor_zipcode": null, "guarantor_address": null, "guarantor_address_complement": null, "document_number": null, "document_date": null, "document_type": "02", "import_id": null, "ignore_whatsapp": false, "days_for_sue_type": null }, { "id": 3, "uid": "01a06d8e-88f4-7681-b8c6-3b2abf60ddc8", "amount": 133.54, "cycle": "monthly", "start_at": "2026-09-04", "end_at": "2027-08-04", "instructions": null, "customer_id": 46, "description": "Cliente especial", "created_at": "2026-09-04T12:54:12-05:00", "updated_at": "2026-09-04T12:54:12-05:00", "customer_person_name": "Margret Santos Filgueiras", "customer_cnpj_cpf": "881.322.964-00", "customer_address": "Av. Burkhard Hehn Simões", "customer_state": "RJ", "customer_neighborhood": "São Francisco", "customer_zipcode": "24360440", "customer_address_number": "120", "customer_address_complement": "709", "customer_phone_number": "2199999999", "customer_email": "faye@aufderhar.example", "customer_city_name": "Rio de Janeiro", "customer_email_cc": "john_cc@example.com", "customer_ignore_email": null, "customer_ignore_sms": false, "customer_mobile_local_code": null, "customer_mobile_number": null, "customer_nickname": null, "customer_notes": null, "created_via_api": false, "total": 12, "bank_billet_account_id": 54, "status": "created", "fine_for_delay": null, "fine_type": 0, "fine_percentage": null, "fine_value": null, "days_for_fine": null, "late_payment_interest": null, "interest_type": 0, "interest_daily_value": null, "interest_daily_percentage": null, "interest_monthly_percentage": null, "days_for_interest": null, "discount_type": 0, "days_for_discount": null, "discount_value": null, "discount_percentage": null, "bank_billet_layout_id": null, "url": null, "bank_billet_ids": [], "bank_billets": [], "notes": null, "payment_count": 1, "tags": [ "tag 1", "tag2", "tag 3" ], "tag_list": "tag 1,tag2,tag 3", "prevent_registration": false, "divergent_payment_type": null, "divergent_payment_value_type": null, "divergent_payment_maximum_value": null, "divergent_payment_minimum_value": null, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null, "divergent_payment_limit": null, "days_for_second_discount": null, "second_discount_percentage": null, "second_discount_value": null, "days_for_third_discount": null, "third_discount_percentage": null, "third_discount_value": null, "days_for_revoke": null, "days_for_sue": null, "days_for_negativation": null, "interest_percentage": null, "interest_value": null, "interest_days_type": 0, "customer_contact_person": null, "custom_attachment_name": null, "guarantor_name": null, "guarantor_cnpj_cpf": null, "guarantor_address_number": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "guarantor_city_name": null, "guarantor_state": null, "guarantor_zipcode": null, "guarantor_address": null, "guarantor_address_complement": null, "document_number": null, "document_date": null, "document_type": "02", "import_id": null, "ignore_whatsapp": false, "days_for_sue_type": null }, { "id": 2, "uid": "01a06d8e-88e1-7c36-8412-3318b6a6ef10", "amount": 133.54, "cycle": "monthly", "start_at": "2026-09-04", "end_at": "2027-08-04", "instructions": null, "customer_id": 45, "description": "Cliente especial", "created_at": "2026-09-04T12:54:12-05:00", "updated_at": "2026-09-04T12:54:12-05:00", "customer_person_name": "Margret Santos Filgueiras", "customer_cnpj_cpf": "009.059.854-78", "customer_address": "Av. Burkhard Hehn Simões", "customer_state": "RJ", "customer_neighborhood": "São Francisco", "customer_zipcode": "24360440", "customer_address_number": "120", "customer_address_complement": "709", "customer_phone_number": "2199999999", "customer_email": "winifred@heidenreich.test", "customer_city_name": "Rio de Janeiro", "customer_email_cc": "john_cc@example.com", "customer_ignore_email": null, "customer_ignore_sms": false, "customer_mobile_local_code": null, "customer_mobile_number": null, "customer_nickname": null, "customer_notes": null, "created_via_api": false, "total": 12, "bank_billet_account_id": 54, "status": "created", "fine_for_delay": null, "fine_type": 0, "fine_percentage": null, "fine_value": null, "days_for_fine": null, "late_payment_interest": null, "interest_type": 0, "interest_daily_value": null, "interest_daily_percentage": null, "interest_monthly_percentage": null, "days_for_interest": null, "discount_type": 0, "days_for_discount": null, "discount_value": null, "discount_percentage": null, "bank_billet_layout_id": null, "url": null, "bank_billet_ids": [], "bank_billets": [], "notes": null, "payment_count": 1, "tags": [ "tag 1", "tag2", "tag 3" ], "tag_list": "tag 1,tag2,tag 3", "prevent_registration": false, "divergent_payment_type": null, "divergent_payment_value_type": null, "divergent_payment_maximum_value": null, "divergent_payment_minimum_value": null, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null, "divergent_payment_limit": null, "days_for_second_discount": null, "second_discount_percentage": null, "second_discount_value": null, "days_for_third_discount": null, "third_discount_percentage": null, "third_discount_value": null, "days_for_revoke": null, "days_for_sue": null, "days_for_negativation": null, "interest_percentage": null, "interest_value": null, "interest_days_type": 0, "customer_contact_person": null, "custom_attachment_name": null, "guarantor_name": null, "guarantor_cnpj_cpf": null, "guarantor_address_number": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "guarantor_city_name": null, "guarantor_state": null, "guarantor_zipcode": null, "guarantor_address": null, "guarantor_address_complement": null, "document_number": null, "document_date": null, "document_type": "02", "import_id": null, "ignore_whatsapp": false, "days_for_sue_type": null }, { "id": 1, "uid": "01a06d8e-88ca-76aa-a03b-392f4cc1c829", "amount": 133.54, "cycle": "monthly", "start_at": "2026-09-04", "end_at": "2027-08-04", "instructions": null, "customer_id": 44, "description": "Cliente especial", "created_at": "2026-09-04T12:54:12-05:00", "updated_at": "2026-09-04T12:54:12-05:00", "customer_person_name": "Margret Santos Filgueiras", "customer_cnpj_cpf": "806.695.865-01", "customer_address": "Av. Burkhard Hehn Simões", "customer_state": "RJ", "customer_neighborhood": "São Francisco", "customer_zipcode": "24360440", "customer_address_number": "120", "customer_address_complement": "709", "customer_phone_number": "2199999999", "customer_email": "luciano.rodriguez@lebsack.test", "customer_city_name": "Rio de Janeiro", "customer_email_cc": "john_cc@example.com", "customer_ignore_email": null, "customer_ignore_sms": false, "customer_mobile_local_code": null, "customer_mobile_number": null, "customer_nickname": null, "customer_notes": null, "created_via_api": false, "total": 12, "bank_billet_account_id": 54, "status": "created", "fine_for_delay": null, "fine_type": 0, "fine_percentage": null, "fine_value": null, "days_for_fine": null, "late_payment_interest": null, "interest_type": 0, "interest_daily_value": null, "interest_daily_percentage": null, "interest_monthly_percentage": null, "days_for_interest": null, "discount_type": 0, "days_for_discount": null, "discount_value": null, "discount_percentage": null, "bank_billet_layout_id": null, "url": null, "bank_billet_ids": [], "bank_billets": [], "notes": null, "payment_count": 1, "tags": [ "tag 1", "tag2", "tag 3" ], "tag_list": "tag 1,tag2,tag 3", "prevent_registration": false, "divergent_payment_type": null, "divergent_payment_value_type": null, "divergent_payment_maximum_value": null, "divergent_payment_minimum_value": null, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null, "divergent_payment_limit": null, "days_for_second_discount": null, "second_discount_percentage": null, "second_discount_value": null, "days_for_third_discount": null, "third_discount_percentage": null, "third_discount_value": null, "days_for_revoke": null, "days_for_sue": null, "days_for_negativation": null, "interest_percentage": null, "interest_value": null, "interest_days_type": 0, "customer_contact_person": null, "custom_attachment_name": null, "guarantor_name": null, "guarantor_cnpj_cpf": null, "guarantor_address_number": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "guarantor_city_name": null, "guarantor_state": null, "guarantor_zipcode": null, "guarantor_address": null, "guarantor_address_complement": null, "document_number": null, "document_date": null, "document_type": "02", "import_id": null, "ignore_whatsapp": false, "days_for_sue_type": null } ], "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1_installment_object" } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } }, "post": { "summary": "Criar um Carnê", "tags": [ "Carnês" ], "description": "Cria um carnê para geração de múltiplos boletos com vencimentos periódicos.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Carnê Criado", "content": { "application/json": { "example": { "id": 6, "uid": "01a06d8e-89e8-7694-85bc-da7f5d9abde4", "amount": 133.54, "cycle": "biweekly", "start_at": "2026-09-08", "end_at": "2027-02-20", "instructions": null, "customer_id": null, "description": "Serviços prestados", "created_at": "2026-09-04T12:54:13-05:00", "updated_at": "2026-09-04T12:54:13-05:00", "customer_person_name": "Leofutol Bezerra", "customer_cnpj_cpf": "337.539.339-37", "customer_address": "Av. Presidente Vargas", "customer_state": "AP", "customer_neighborhood": "Centro", "customer_zipcode": "20071004", "customer_address_number": "633", "customer_address_complement": "apt 101", "customer_phone_number": "2188887766", "customer_email": "cliente@example.com", "customer_city_name": "Macapá", "customer_email_cc": "outro@example.com", "customer_ignore_email": false, "customer_ignore_sms": null, "customer_mobile_local_code": "22", "customer_mobile_number": "987654321", "customer_nickname": "Zezin La da Rua", "customer_notes": "Informação sobre o cliente", "created_via_api": true, "total": 12, "bank_billet_account_id": 55, "status": "created", "fine_for_delay": null, "fine_type": 2, "fine_percentage": null, "fine_value": 4.91, "days_for_fine": 3, "late_payment_interest": null, "interest_type": 1, "interest_daily_value": null, "interest_daily_percentage": null, "interest_monthly_percentage": null, "days_for_interest": 2, "discount_type": 2, "days_for_discount": 2, "discount_value": null, "discount_percentage": 10.0, "bank_billet_layout_id": null, "url": null, "bank_billet_ids": [], "bank_billets": [], "notes": "Observações", "payment_count": 4, "tags": [ "tag1", "tag2", "tag3" ], "tag_list": "tag1,tag2,tag3", "prevent_registration": false, "divergent_payment_type": 2, "divergent_payment_value_type": 1, "divergent_payment_maximum_value": 150.01, "divergent_payment_minimum_value": 100.01, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null, "divergent_payment_limit": null, "days_for_second_discount": 1, "second_discount_percentage": 5.0, "second_discount_value": null, "days_for_third_discount": 0, "third_discount_percentage": 2.5, "third_discount_value": null, "days_for_revoke": 30, "days_for_sue": 40, "days_for_negativation": null, "interest_percentage": 0.3, "interest_value": null, "interest_days_type": 0, "customer_contact_person": "Zezin 2", "custom_attachment_name": null, "guarantor_name": null, "guarantor_cnpj_cpf": null, "guarantor_address_number": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "guarantor_city_name": null, "guarantor_state": null, "guarantor_zipcode": null, "guarantor_address": null, "guarantor_address_complement": null, "document_number": null, "document_date": null, "document_type": "02", "import_id": null, "ignore_whatsapp": false, "days_for_sue_type": 0 }, "schema": { "$ref": "#/components/schemas/v1_installment_object" } } } }, "422": { "description": "Carnê inválido", "content": { "application/json": { "example": { "errors": { "customer_person_name": [ "não pode ficar em branco" ], "customer_cnpj_cpf": [ "não é um CNPJ ou CPF válido" ], "customer_zipcode": [ "não pode ficar em branco" ], "total": [ "não pode ficar em branco", "não é um número" ], "start_at": [ "não pode ficar em branco" ], "amount": [ "não pode ficar em branco" ], "customer_address": [ "não pode ficar em branco" ], "customer_neighborhood": [ "não pode ficar em branco" ], "customer_city_name": [ "não pode ficar em branco" ], "customer_state": [ "não está incluído na lista" ], "end_at": [ "não é uma data válida" ] } }, "schema": { "$ref": "#/components/schemas/v1_errors_object" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1_installment_object" } } }, "required": true, "description": "Informações a serem salvas no carnê" } } }, "/v1/installments/{id}": { "get": { "summary": "Informações do Carnê", "tags": [ "Carnês" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de um Carnê.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Carnê", "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Carnê encontrado com sucesso", "content": { "application/json": { "example": { "id": 7, "uid": "01a06d8e-8aff-7035-9b60-4c3cc5f1b143", "amount": 133.54, "cycle": "monthly", "start_at": "2026-09-04", "end_at": "2027-08-04", "instructions": null, "customer_id": 49, "description": "Cliente especial", "created_at": "2026-09-04T12:54:13-05:00", "updated_at": "2026-09-04T12:54:13-05:00", "customer_person_name": "Margret Santos Filgueiras", "customer_cnpj_cpf": "169.353.103-85", "customer_address": "Av. Burkhard Hehn Simões", "customer_state": "RJ", "customer_neighborhood": "São Francisco", "customer_zipcode": "24360440", "customer_address_number": "120", "customer_address_complement": "709", "customer_phone_number": "2199999999", "customer_email": "marguerite_gislason@keebler-buckridge.test", "customer_city_name": "Rio de Janeiro", "customer_email_cc": "john_cc@example.com", "customer_ignore_email": null, "customer_ignore_sms": false, "customer_mobile_local_code": null, "customer_mobile_number": null, "customer_nickname": null, "customer_notes": null, "created_via_api": false, "total": 12, "bank_billet_account_id": 57, "status": "created", "fine_for_delay": null, "fine_type": 0, "fine_percentage": null, "fine_value": null, "days_for_fine": null, "late_payment_interest": null, "interest_type": 0, "interest_daily_value": null, "interest_daily_percentage": null, "interest_monthly_percentage": null, "days_for_interest": null, "discount_type": 0, "days_for_discount": null, "discount_value": null, "discount_percentage": null, "bank_billet_layout_id": null, "url": null, "bank_billet_ids": [], "bank_billets": [], "notes": null, "payment_count": 1, "tags": [ "tag 1", "tag2", "tag 3" ], "tag_list": "tag 1,tag2,tag 3", "prevent_registration": false, "divergent_payment_type": null, "divergent_payment_value_type": null, "divergent_payment_maximum_value": null, "divergent_payment_minimum_value": null, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null, "divergent_payment_limit": null, "days_for_second_discount": null, "second_discount_percentage": null, "second_discount_value": null, "days_for_third_discount": null, "third_discount_percentage": null, "third_discount_value": null, "days_for_revoke": null, "days_for_sue": null, "days_for_negativation": null, "interest_percentage": null, "interest_value": null, "interest_days_type": 0, "customer_contact_person": null, "custom_attachment_name": null, "guarantor_name": null, "guarantor_cnpj_cpf": null, "guarantor_address_number": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "guarantor_city_name": null, "guarantor_state": null, "guarantor_zipcode": null, "guarantor_address": null, "guarantor_address_complement": null, "document_number": null, "document_date": null, "document_type": "02", "import_id": null, "ignore_whatsapp": false, "days_for_sue_type": null }, "schema": { "$ref": "#/components/schemas/v1_installment_object" } } } }, "404": { "description": "Carnê não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } }, "delete": { "summary": "Excluir o Carnê", "tags": [ "Carnês" ], "security": [ { "bearerAuth": [] } ], "description": "Exclui um Carnê específico. Nenhum boleto gerado pela carnê será excluído.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Carnê", "example": 999, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Carnê cancelado" }, "404": { "description": "Carnê não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/email_deliveries": { "get": { "summary": "Listar E-mails Enviados", "tags": [ "Histórico de E-mails" ], "security": [ { "bearerAuth": [] } ], "description": "Listar e-mails enviados\n\nO `ID do Objeto` vai retornar todos e qualquer tipo de objeto que tenha o ID enviado, ou seja, se você enviar 1, poderá retornar boletos, clientes e etc. Caso queira um filtro mais refinado, combine o `ID do Objeto` com o `Código do evento`.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "resource_owner_id", "in": "query", "description": "ID do objeto que gerou o evento. Ex. ID do boleto.", "required": false, "schema": { "type": "integer" } }, { "name": "event_code", "in": "query", "description": "Código do evento.", "required": false, "schema": { "type": "string", "enum": [ "ping", "access_token.db.created", "access_token.db.updated", "access_token.db.deleted", "access_token.reminder", "access_token.expired", "account.updated", "account.blocked", "account.bank_billet_creation_blocked", "bank_billet.created", "bank_billet.updated", "bank_billet.generated", "bank_billet.canceled", "bank_billet.blocked", "bank_billet.overdue", "bank_billet.paid", "bank_billet.due_date", "bank_billet.rejected", "bank_billet.cancel.requested", "bank_billet.cancel.confirmed", "bank_billet.cancel.failed", "bank_billet.cancel.error", "bank_billet.register.requested", "bank_billet.register.confirmed", "bank_billet.register.failed", "bank_billet.register.error", "bank_billet.update.requested", "bank_billet.update.confirmed", "bank_billet.update.failed", "bank_billet.update.error", "bank_billet.registered", "bank_billet.deleted", "bank_billet.sync.requested", "bank_billet.sync.confirmed", "bank_billet.sync.failed", "bank_billet.sync.error", "bank_billet.get.requested", "bank_billet.get.confirmed", "bank_billet.get.failed", "bank_billet.get.error", "bank_billet.get_child.requested", "bank_billet.get_child.confirmed", "bank_billet.get_child.failed", "bank_billet.get_child.error", "bank_billet.find.requested", "bank_billet.find.confirmed", "bank_billet.find.failed", "bank_billet.find.error", "bank_billet.add_pix.requested", "bank_billet.add_pix.confirmed", "bank_billet.add_pix.failed", "bank_billet.add_pix.error", "bank_billet.get_pix.requested", "bank_billet.get_pix.confirmed", "bank_billet.get_pix.failed", "bank_billet.get_pix.error", "bank_billet.protest.requested", "bank_billet.protest.confirmed", "bank_billet.protest.failed", "bank_billet.protest.error", "bank_billet_discharge.created", "bank_billet_discharge.updated", "bank_billet_discharge.deleted", "bank_billet_remittance.created", "bank_billet_remittance.updated", "bank_billet_remittance.deleted", "bank_billet_registration.created", "bank_billet_registration.updated", "bank_billet_registration.deleted", "bank_billet_payment.created", "bank_billet_payment.updated", "bank_billet_payment.deleted", "customer.created", "customer.updated", "customer.portal_password_updated", "customer.deleted", "transaction.created", "transaction.updated", "transaction.processed", "withdrawal.transferred", "withdrawal.requested", "addon.activated", "addon.removed", "plan_subscription.activated", "plan_subscription.removed", "plan_subscription.fee", "plan_subscription.updated", "user.created", "user.updated", "user.deleted", "remittance.created", "remittance.processed", "remittance.downloaded", "remittance.sent", "remittance.deleted", "remittance.line.db.created", "remittance.line.db.updated", "remittance.line.db.deleted", "discharge.created", "discharge.processed", "discharge.deleted", "bank_billet_account.created", "bank_billet_account.homologated", "bank_billet_account.homologation_failed", "bank_billet_account.homologation_started", "bank_billet_account.validated", "bank_billet_account.validation_released", "bank_billet_account.activated", "bank_billet_account.updated", "bank_billet_account.deleted", "edi.remittance_line.created", "edi.remittance_line.updated", "edi.remittance_line.deleted", "edi.edi_box.activated", "edi.edi_box.db.created", "edi.edi_box.db.deleted", "edi.edi_box.db.updated", "edi.edi_box.generated", "edi.edi_box.demand_received", "edi.edi_box.confirming_at_bank", "edi.edi_box.testing_by_customer", "edi.edi_box.waiting_for_validations", "customer_subscription.created", "customer_subscription.updated", "customer_subscription.deleted", "installment.created", "installment.processed", "installment.generated", "installment.deleted", "import.created", "import.processed", "import.deleted", "export.db.created", "export.db.updated", "export.db.deleted", "pix.db.created", "pix.db.updated", "pix.db.deleted", "pix.register.requested", "pix.register.confirmed", "pix.register.failed", "pix.register.error", "pix.update.requested", "pix.update.confirmed", "pix.update.failed", "pix.update.error", "pix.paid", "pix.overdue", "pix.cancel.requested", "pix.cancel.confirmed", "pix.cancel.failed", "pix.cancel.error", "pix.sync.requested", "pix.sync.confirmed", "pix.sync.failed", "pix.sync.error", "pix.get.requested", "pix.get.confirmed", "pix.get.failed", "pix.get.error", "financial.account.balance_sync.requested", "financial.account.balance_sync.confirmed", "financial.account.balance_sync.failed", "financial.account.balance_sync.error", "financial.account.statement_sync.requested", "financial.account.statement_sync.confirmed", "financial.account.statement_sync.failed", "financial.account.statement_sync.error", "financial.account.db.created", "financial.account.db.updated", "financial.account.db.deleted", "financial.account.statement.updated", "financial.account.balance.updated", "financial.account_balance.db.created", "transfer.batch.db.created", "transfer.batch.db.updated", "transfer.batch.db.deleted", "transfer.batch.awaiting_approval", "transfer.pix_batch.awaiting_approval", "transfer.pix_batch.get.requested", "transfer.pix_batch.get.confirmed", "transfer.pix_batch.get.failed", "transfer.pix_batch.get.error", "transfer.pix_batch.sync.requested", "transfer.pix_batch.sync.confirmed", "transfer.pix_batch.sync.failed", "transfer.pix_batch.sync.error", "transfer.pix_batch.register.requested", "transfer.pix_batch.register.confirmed", "transfer.pix_batch.register.failed", "transfer.pix_batch.register.error", "transfer.pix_batch.approve.requested", "transfer.pix_batch.approve.confirmed", "transfer.pix_batch.approve.failed", "transfer.pix_batch.approve.error", "transfer.pix_batch.reprove.requested", "transfer.pix_batch.reprove.confirmed", "transfer.pix_batch.reprove.failed", "transfer.pix_batch.reprove.error", "transfer.pix_batch.cancel.requested", "transfer.pix_batch.cancel.confirmed", "transfer.pix_batch.cancel.failed", "transfer.pix_batch.cancel.error", "transfer.ted_batch.awaiting_approval", "transfer.ted_batch.get.requested", "transfer.ted_batch.get.confirmed", "transfer.ted_batch.get.failed", "transfer.ted_batch.get.error", "transfer.ted_batch.sync.requested", "transfer.ted_batch.sync.confirmed", "transfer.ted_batch.sync.failed", "transfer.ted_batch.sync.error", "transfer.ted_batch.register.requested", "transfer.ted_batch.register.confirmed", "transfer.ted_batch.register.failed", "transfer.ted_batch.register.error", "transfer.ted_batch.approve.requested", "transfer.ted_batch.approve.confirmed", "transfer.ted_batch.approve.failed", "transfer.ted_batch.approve.error", "transfer.ted_batch.reprove.requested", "transfer.ted_batch.reprove.confirmed", "transfer.ted_batch.reprove.failed", "transfer.ted_batch.reprove.error", "transfer.ted_batch.cancel.requested", "transfer.ted_batch.cancel.confirmed", "transfer.ted_batch.cancel.failed", "transfer.ted_batch.cancel.error", "transfer.internal_batch.awaiting_approval", "transfer.internal_batch.get.requested", "transfer.internal_batch.get.confirmed", "transfer.internal_batch.get.failed", "transfer.internal_batch.get.error", "transfer.internal_batch.sync.requested", "transfer.internal_batch.sync.confirmed", "transfer.internal_batch.sync.failed", "transfer.internal_batch.sync.error", "transfer.internal_batch.register.requested", "transfer.internal_batch.register.confirmed", "transfer.internal_batch.register.failed", "transfer.internal_batch.register.error", "transfer.internal_batch.approve.requested", "transfer.internal_batch.approve.confirmed", "transfer.internal_batch.approve.failed", "transfer.internal_batch.approve.error", "transfer.internal_batch.reprove.requested", "transfer.internal_batch.reprove.confirmed", "transfer.internal_batch.reprove.failed", "transfer.internal_batch.reprove.error", "transfer.internal_batch.cancel.requested", "transfer.internal_batch.cancel.confirmed", "transfer.internal_batch.cancel.failed", "transfer.internal_batch.cancel.error", "transfer.db.created", "transfer.db.updated", "transfer.db.deleted", "transfer.pix.register.requested", "transfer.pix.register.confirmed", "transfer.pix.register.failed", "transfer.pix.register.error", "transfer.pix.reschedule.requested", "transfer.pix.reschedule.confirmed", "transfer.pix.reschedule.failed", "transfer.pix.reschedule.error", "transfer.pix.approve.requested", "transfer.pix.approve.confirmed", "transfer.pix.approve.failed", "transfer.pix.approve.error", "transfer.pix.reprove.requested", "transfer.pix.reprove.confirmed", "transfer.pix.reprove.failed", "transfer.pix.reprove.error", "transfer.pix.cancel.requested", "transfer.pix.cancel.confirmed", "transfer.pix.cancel.failed", "transfer.pix.cancel.error", "transfer.pix.get.requested", "transfer.pix.get.confirmed", "transfer.pix.get.failed", "transfer.pix.get.error", "transfer.pix.sync.requested", "transfer.pix.sync.confirmed", "transfer.pix.sync.failed", "transfer.pix.sync.error", "transfer.ted.register.requested", "transfer.ted.register.confirmed", "transfer.ted.register.failed", "transfer.ted.register.error", "transfer.ted.reschedule.requested", "transfer.ted.reschedule.confirmed", "transfer.ted.reschedule.failed", "transfer.ted.reschedule.error", "transfer.ted.approve.requested", "transfer.ted.approve.confirmed", "transfer.ted.approve.failed", "transfer.ted.approve.error", "transfer.ted.reprove.requested", "transfer.ted.reprove.confirmed", "transfer.ted.reprove.failed", "transfer.ted.reprove.error", "transfer.ted.cancel.requested", "transfer.ted.cancel.confirmed", "transfer.ted.cancel.failed", "transfer.ted.cancel.error", "transfer.ted.get.requested", "transfer.ted.get.confirmed", "transfer.ted.get.failed", "transfer.ted.get.error", "transfer.ted.sync.requested", "transfer.ted.sync.confirmed", "transfer.ted.sync.failed", "transfer.ted.sync.error", "transfer.internal.register.requested", "transfer.internal.register.confirmed", "transfer.internal.register.failed", "transfer.internal.register.error", "transfer.internal.reschedule.requested", "transfer.internal.reschedule.confirmed", "transfer.internal.reschedule.failed", "transfer.internal.reschedule.error", "transfer.internal.approve.requested", "transfer.internal.approve.confirmed", "transfer.internal.approve.failed", "transfer.internal.approve.error", "transfer.internal.reprove.requested", "transfer.internal.reprove.confirmed", "transfer.internal.reprove.failed", "transfer.internal.reprove.error", "transfer.internal.cancel.requested", "transfer.internal.cancel.confirmed", "transfer.internal.cancel.failed", "transfer.internal.cancel.error", "transfer.internal.get.requested", "transfer.internal.get.confirmed", "transfer.internal.get.failed", "transfer.internal.get.error", "transfer.internal.sync.requested", "transfer.internal.sync.confirmed", "transfer.internal.sync.failed", "transfer.internal.sync.error", "payment.db.created", "payment.db.updated", "payment.db.deleted", "payment.bank_billet.register.requested", "payment.bank_billet.register.confirmed", "payment.bank_billet.register.failed", "payment.bank_billet.register.error", "payment.bank_billet.approve.requested", "payment.bank_billet.approve.confirmed", "payment.bank_billet.approve.failed", "payment.bank_billet.approve.error", "payment.bank_billet.reprove.requested", "payment.bank_billet.reprove.confirmed", "payment.bank_billet.reprove.failed", "payment.bank_billet.reprove.error", "payment.bank_billet.reschedule.requested", "payment.bank_billet.reschedule.confirmed", "payment.bank_billet.reschedule.failed", "payment.bank_billet.reschedule.error", "payment.bank_billet.cancel.requested", "payment.bank_billet.cancel.confirmed", "payment.bank_billet.cancel.failed", "payment.bank_billet.cancel.error", "payment.bank_billet.get.requested", "payment.bank_billet.get.confirmed", "payment.bank_billet.get.failed", "payment.bank_billet.get.error", "payment.bank_billet.sync.requested", "payment.bank_billet.sync.confirmed", "payment.bank_billet.sync.failed", "payment.bank_billet.sync.error", "payment.darf.register.requested", "payment.darf.register.confirmed", "payment.darf.register.failed", "payment.darf.register.error", "payment.darf.approve.requested", "payment.darf.approve.confirmed", "payment.darf.approve.failed", "payment.darf.approve.error", "payment.darf.reprove.requested", "payment.darf.reprove.confirmed", "payment.darf.reprove.failed", "payment.darf.reprove.error", "payment.darf.reschedule.requested", "payment.darf.reschedule.confirmed", "payment.darf.reschedule.failed", "payment.darf.reschedule.error", "payment.darf.cancel.requested", "payment.darf.cancel.confirmed", "payment.darf.cancel.failed", "payment.darf.cancel.error", "payment.darf.get.requested", "payment.darf.get.confirmed", "payment.darf.get.failed", "payment.darf.get.error", "payment.darf.sync.requested", "payment.darf.sync.confirmed", "payment.darf.sync.failed", "payment.darf.sync.error", "payment.utility.register.requested", "payment.utility.register.confirmed", "payment.utility.register.failed", "payment.utility.register.error", "payment.utility.approve.requested", "payment.utility.approve.confirmed", "payment.utility.approve.failed", "payment.utility.approve.error", "payment.utility.reprove.requested", "payment.utility.reprove.confirmed", "payment.utility.reprove.failed", "payment.utility.reprove.error", "payment.utility.reschedule.requested", "payment.utility.reschedule.confirmed", "payment.utility.reschedule.failed", "payment.utility.reschedule.error", "payment.utility.cancel.requested", "payment.utility.cancel.confirmed", "payment.utility.cancel.failed", "payment.utility.cancel.error", "payment.utility.get.requested", "payment.utility.get.confirmed", "payment.utility.get.failed", "payment.utility.get.error", "payment.utility.sync.requested", "payment.utility.sync.confirmed", "payment.utility.sync.failed", "payment.utility.sync.error", "payment.gru.register.requested", "payment.gru.register.confirmed", "payment.gru.register.failed", "payment.gru.register.error", "payment.gru.approve.requested", "payment.gru.approve.confirmed", "payment.gru.approve.failed", "payment.gru.approve.error", "payment.gru.reprove.requested", "payment.gru.reprove.confirmed", "payment.gru.reprove.failed", "payment.gru.reprove.error", "payment.gru.reschedule.requested", "payment.gru.reschedule.confirmed", "payment.gru.reschedule.failed", "payment.gru.reschedule.error", "payment.gru.cancel.requested", "payment.gru.cancel.confirmed", "payment.gru.cancel.failed", "payment.gru.cancel.error", "payment.gru.get.requested", "payment.gru.get.confirmed", "payment.gru.get.failed", "payment.gru.get.error", "payment.gru.sync.requested", "payment.gru.sync.confirmed", "payment.gru.sync.failed", "payment.gru.sync.error", "payment.pix.register.requested", "payment.pix.register.confirmed", "payment.pix.register.failed", "payment.pix.register.error", "payment.pix.approve.requested", "payment.pix.approve.confirmed", "payment.pix.approve.failed", "payment.pix.approve.error", "payment.pix.reprove.requested", "payment.pix.reprove.confirmed", "payment.pix.reprove.failed", "payment.pix.reprove.error", "payment.pix.reschedule.requested", "payment.pix.reschedule.confirmed", "payment.pix.reschedule.failed", "payment.pix.reschedule.error", "payment.pix.cancel.requested", "payment.pix.cancel.confirmed", "payment.pix.cancel.failed", "payment.pix.cancel.error", "payment.pix.get.requested", "payment.pix.get.confirmed", "payment.pix.get.failed", "payment.pix.get.error", "payment.pix.sync.requested", "payment.pix.sync.confirmed", "payment.pix.sync.failed", "payment.pix.sync.error", "payment.tax.register.requested", "payment.tax.register.confirmed", "payment.tax.register.failed", "payment.tax.register.error", "payment.tax.approve.requested", "payment.tax.approve.confirmed", "payment.tax.approve.failed", "payment.tax.approve.error", "payment.tax.reprove.requested", "payment.tax.reprove.confirmed", "payment.tax.reprove.failed", "payment.tax.reprove.error", "payment.tax.reschedule.requested", "payment.tax.reschedule.confirmed", "payment.tax.reschedule.failed", "payment.tax.reschedule.error", "payment.tax.cancel.requested", "payment.tax.cancel.confirmed", "payment.tax.cancel.failed", "payment.tax.cancel.error", "payment.tax.get.requested", "payment.tax.get.confirmed", "payment.tax.get.failed", "payment.tax.get.error", "payment.tax.sync.requested", "payment.tax.sync.confirmed", "payment.tax.sync.failed", "payment.tax.sync.error", "payment.batch.db.created", "payment.batch.db.updated", "payment.batch.db.deleted", "payment.batch.awaiting_approval", "payment.bank_billet_batch.awaiting_approval", "payment.bank_billet_batch.get.requested", "payment.bank_billet_batch.get.confirmed", "payment.bank_billet_batch.get.failed", "payment.bank_billet_batch.get.error", "payment.bank_billet_batch.sync.requested", "payment.bank_billet_batch.sync.confirmed", "payment.bank_billet_batch.sync.failed", "payment.bank_billet_batch.sync.error", "payment.bank_billet_batch.register.requested", "payment.bank_billet_batch.register.confirmed", "payment.bank_billet_batch.register.failed", "payment.bank_billet_batch.register.error", "payment.bank_billet_batch.approve.requested", "payment.bank_billet_batch.approve.confirmed", "payment.bank_billet_batch.approve.failed", "payment.bank_billet_batch.approve.error", "payment.bank_billet_batch.reprove.requested", "payment.bank_billet_batch.reprove.confirmed", "payment.bank_billet_batch.reprove.failed", "payment.bank_billet_batch.reprove.error", "payment.bank_billet_batch.cancel.requested", "payment.bank_billet_batch.cancel.confirmed", "payment.bank_billet_batch.cancel.failed", "payment.bank_billet_batch.cancel.error", "payment.darf_batch.awaiting_approval", "payment.darf_batch.get.requested", "payment.darf_batch.get.confirmed", "payment.darf_batch.get.failed", "payment.darf_batch.get.error", "payment.darf_batch.sync.requested", "payment.darf_batch.sync.confirmed", "payment.darf_batch.sync.failed", "payment.darf_batch.sync.error", "payment.darf_batch.register.requested", "payment.darf_batch.register.confirmed", "payment.darf_batch.register.failed", "payment.darf_batch.register.error", "payment.darf_batch.approve.requested", "payment.darf_batch.approve.confirmed", "payment.darf_batch.approve.failed", "payment.darf_batch.approve.error", "payment.darf_batch.reprove.requested", "payment.darf_batch.reprove.confirmed", "payment.darf_batch.reprove.failed", "payment.darf_batch.reprove.error", "payment.darf_batch.cancel.requested", "payment.darf_batch.cancel.confirmed", "payment.darf_batch.cancel.failed", "payment.darf_batch.cancel.error", "payment.utility_batch.awaiting_approval", "payment.utility_batch.get.requested", "payment.utility_batch.get.confirmed", "payment.utility_batch.get.failed", "payment.utility_batch.get.error", "payment.utility_batch.sync.requested", "payment.utility_batch.sync.confirmed", "payment.utility_batch.sync.failed", "payment.utility_batch.sync.error", "payment.utility_batch.register.requested", "payment.utility_batch.register.confirmed", "payment.utility_batch.register.failed", "payment.utility_batch.register.error", "payment.utility_batch.approve.requested", "payment.utility_batch.approve.confirmed", "payment.utility_batch.approve.failed", "payment.utility_batch.approve.error", "payment.utility_batch.reprove.requested", "payment.utility_batch.reprove.confirmed", "payment.utility_batch.reprove.failed", "payment.utility_batch.reprove.error", "payment.utility_batch.cancel.requested", "payment.utility_batch.cancel.confirmed", "payment.utility_batch.cancel.failed", "payment.utility_batch.cancel.error", "payment.gru_batch.awaiting_approval", "payment.gru_batch.get.requested", "payment.gru_batch.get.confirmed", "payment.gru_batch.get.failed", "payment.gru_batch.get.error", "payment.gru_batch.sync.requested", "payment.gru_batch.sync.confirmed", "payment.gru_batch.sync.failed", "payment.gru_batch.sync.error", "payment.gru_batch.register.requested", "payment.gru_batch.register.confirmed", "payment.gru_batch.register.failed", "payment.gru_batch.register.error", "payment.gru_batch.approve.requested", "payment.gru_batch.approve.confirmed", "payment.gru_batch.approve.failed", "payment.gru_batch.approve.error", "payment.gru_batch.reprove.requested", "payment.gru_batch.reprove.confirmed", "payment.gru_batch.reprove.failed", "payment.gru_batch.reprove.error", "payment.gru_batch.cancel.requested", "payment.gru_batch.cancel.confirmed", "payment.gru_batch.cancel.failed", "payment.gru_batch.cancel.error", "payment.pix_batch.awaiting_approval", "payment.pix_batch.get.requested", "payment.pix_batch.get.confirmed", "payment.pix_batch.get.failed", "payment.pix_batch.get.error", "payment.pix_batch.sync.requested", "payment.pix_batch.sync.confirmed", "payment.pix_batch.sync.failed", "payment.pix_batch.sync.error", "payment.pix_batch.register.requested", "payment.pix_batch.register.confirmed", "payment.pix_batch.register.failed", "payment.pix_batch.register.error", "payment.pix_batch.approve.requested", "payment.pix_batch.approve.confirmed", "payment.pix_batch.approve.failed", "payment.pix_batch.approve.error", "payment.pix_batch.reprove.requested", "payment.pix_batch.reprove.confirmed", "payment.pix_batch.reprove.failed", "payment.pix_batch.reprove.error", "payment.pix_batch.cancel.requested", "payment.pix_batch.cancel.confirmed", "payment.pix_batch.cancel.failed", "payment.pix_batch.cancel.error", "payment.tax_batch.awaiting_approval", "payment.tax_batch.get.requested", "payment.tax_batch.get.confirmed", "payment.tax_batch.get.failed", "payment.tax_batch.get.error", "payment.tax_batch.sync.requested", "payment.tax_batch.sync.confirmed", "payment.tax_batch.sync.failed", "payment.tax_batch.sync.error", "payment.tax_batch.register.requested", "payment.tax_batch.register.confirmed", "payment.tax_batch.register.failed", "payment.tax_batch.register.error", "payment.tax_batch.approve.requested", "payment.tax_batch.approve.confirmed", "payment.tax_batch.approve.failed", "payment.tax_batch.approve.error", "payment.tax_batch.reprove.requested", "payment.tax_batch.reprove.confirmed", "payment.tax_batch.reprove.failed", "payment.tax_batch.reprove.error", "payment.tax_batch.cancel.requested", "payment.tax_batch.cancel.confirmed", "payment.tax_batch.cancel.failed", "payment.tax_batch.cancel.error", "payment.dda.account.db.created", "payment.dda.account.register.requested", "payment.dda.account.register.failed", "payment.dda.account.register.error", "payment.dda.account.register.confirmed", "payment.dda.account.bank_billets_sync.requested", "payment.dda.account.bank_billets_sync.failed", "payment.dda.account.bank_billets_sync.error", "payment.dda.account.bank_billets_sync.confirmed", "payment.dda.account.unregister.requested", "payment.dda.account.unregister.failed", "payment.dda.account.unregister.error", "payment.dda.account.unregister.confirmed", "payment.dda.bank_billet.db.created", "payment.dda.bank_billet.db.updated", "payment.dda.bank_billet.external_status_changed", "payment.dda.bank_billet.get.requested", "payment.dda.bank_billet.get.confirmed", "payment.dda.bank_billet.get.failed", "payment.dda.bank_billet.get.error", "payment.dda.bank_billet.sync.requested", "payment.dda.bank_billet.sync.confirmed", "payment.dda.bank_billet.sync.failed", "payment.dda.bank_billet.sync.error", "payment.dda.account.db.updated", "payment.dda.account.db.deleted", "payment.dda.account.letter.pending", "payment.dda.account.letter.waiting_signatures", "payment.dda.account.letter.signed", "payment.dda.account.letter.failed", "payment.dda.account.confirmed", "payment.dda.account.rejected", "payment.dda.account.failed", "payment.dda.account.disabled", "payment.dda.account.enabled", "credit.restriction.add.requested", "credit.restriction.add.failed", "credit.restriction.add.error", "credit.restriction.add.confirmed", "credit.restriction.remove.requested", "credit.restriction.remove.confirmed", "credit.restriction.remove.failed", "credit.restriction.remove.error", "charge.automatic_pix.account.db.created", "charge.automatic_pix.account.db.updated", "charge.automatic_pix.account.db.deleted", "charge.automatic_pix.recurrence.db.created", "charge.automatic_pix.recurrence.db.updated", "charge.automatic_pix.recurrence.db.deleted", "charge.automatic_pix.recurrence.cancel.requested", "charge.automatic_pix.recurrence.cancel.confirmed", "charge.automatic_pix.recurrence.cancel.failed", "charge.automatic_pix.recurrence.cancel.error", "charge.automatic_pix.recurrence.register.requested", "charge.automatic_pix.recurrence.register.confirmed", "charge.automatic_pix.recurrence.register.failed", "charge.automatic_pix.recurrence.register.error", "charge.automatic_pix.recurrence.update.requested", "charge.automatic_pix.recurrence.update.confirmed", "charge.automatic_pix.recurrence.update.failed", "charge.automatic_pix.recurrence.update.error", "charge.automatic_pix.recurrence.pending", "charge.automatic_pix.recurrence.created", "charge.automatic_pix.recurrence.approved", "charge.automatic_pix.recurrence.rejected", "charge.automatic_pix.recurrence.expired", "charge.automatic_pix.recurrence.canceled", "charge.automatic_pix.request.db.created", "charge.automatic_pix.request.db.updated", "charge.automatic_pix.request.db.deleted", "charge.automatic_pix.request.cancel.requested", "charge.automatic_pix.request.cancel.confirmed", "charge.automatic_pix.request.cancel.failed", "charge.automatic_pix.request.cancel.error", "charge.automatic_pix.request.register.requested", "charge.automatic_pix.request.register.confirmed", "charge.automatic_pix.request.register.failed", "charge.automatic_pix.request.register.error", "charge.automatic_pix.request.pending", "charge.automatic_pix.request.created", "charge.automatic_pix.request.sent", "charge.automatic_pix.request.received", "charge.automatic_pix.request.rejected", "charge.automatic_pix.request.accepted", "charge.automatic_pix.request.expired", "charge.automatic_pix.request.canceled", "charge.automatic_pix.pix.db.created", "charge.automatic_pix.pix.db.updated", "charge.automatic_pix.pix.db.deleted", "charge.automatic_pix.pix.cancel.requested", "charge.automatic_pix.pix.cancel.confirmed", "charge.automatic_pix.pix.cancel.failed", "charge.automatic_pix.pix.cancel.error", "charge.automatic_pix.pix.register.requested", "charge.automatic_pix.pix.register.confirmed", "charge.automatic_pix.pix.register.failed", "charge.automatic_pix.pix.register.error", "charge.automatic_pix.pix.update.requested", "charge.automatic_pix.pix.update.confirmed", "charge.automatic_pix.pix.update.failed", "charge.automatic_pix.pix.update.error", "charge.automatic_pix.pix.pending", "charge.automatic_pix.pix.created", "charge.automatic_pix.pix.active", "charge.automatic_pix.pix.paid", "charge.automatic_pix.pix.expired", "charge.automatic_pix.pix.rejected", "charge.automatic_pix.pix.canceled", "charge.automatic_pix.location.db.created", "charge.automatic_pix.location.db.updated", "charge.automatic_pix.location.db.deleted", "charge.automatic_pix.location.register.requested", "charge.automatic_pix.location.register.confirmed", "charge.automatic_pix.location.register.failed", "charge.automatic_pix.location.register.error", "charge.payment.db.created", "charge.payment.db.updated", "charge.payment.db.deleted", "charge.payment.notified", "charge.payment.canceled", "charge.payment.confirmed", "charge.payment.duplicated", "charge.bank_billet.payment.notified", "charge.bank_billet.payment.canceled", "charge.bank_billet.payment.confirmed", "data.bank_billet_query.success", "data.bank_billet_query.error", "data.bank_billet_query.db.created", "data.bank_billet_query.db.updated", "data.bank_billet_query.db.deleted", "data.pix_qrcode_query.success", "data.pix_qrcode_query.error", "data.pix_qrcode_query.db.created", "data.pix_qrcode_query.db.updated", "data.pix_qrcode_query.db.deleted", "mailbox.entry.db.created", "mailbox.entry.db.updated", "mailbox.entry.db.deleted", "mailbox.entry.file.received", "mailbox.entry.file.sent", "mailbox.file.db.created", "mailbox.file.db.updated", "mailbox.file.db.deleted", "mailbox.channel.s3.db.created", "mailbox.channel.s3.db.updated", "mailbox.channel.s3.db.deleted", "mailbox.channel.s3.fetch_all", "mailbox.channel.email.db.created", "mailbox.channel.email.db.updated", "mailbox.channel.email.db.deleted", "mailbox.channel.whatsapp.db.created", "mailbox.channel.whatsapp.db.updated", "mailbox.channel.whatsapp.db.deleted", "mailbox.channel.sftp.db.created", "mailbox.channel.sftp.db.updated", "mailbox.channel.sftp.db.deleted", "mailbox.channel.sftp.fetch_all", "mailbox.channel.syncthing.db.created", "mailbox.channel.syncthing.db.updated", "mailbox.channel.syncthing.db.deleted", "email_account.db.created", "email_account.db.updated", "email_account.db.deleted", "email_account.identity.pending", "email_account.identity.created", "email_account.identity.error", "email_account.identity.failure", "email_account.dns.not_ready", "email_account.dns.awaiting", "email_account.dns.validated", "email_account.dns.error", "email_account.dns.failure", "integration.connection.db.created", "integration.connection.db.updated", "integration.connection.db.deleted", "webhook.db.created", "webhook.db.updated", "webhook.db.deleted", "enotas.nfe.generated" ] } }, { "name": "status", "in": "query", "description": "Status do e-mail enviado", "required": false, "schema": { "type": "integer", "description": "Situação:\n* `0` Pendente\n* `1` Enviado para o Servidor de E-mail\n* `2` Falha no Envio para o Servidor de E-mail\n* `3` Lido pelo Destinatário\n* `4` Link Acessado pelo Destinatário", "enum": [ "0", "1", "2", "3", "4" ] } } ], "responses": { "200": { "description": "Sucesso na listagem dos e-mails enviados", "content": { "application/json": { "example": [ { "id": 6, "uid": "01a06d8e-8e2e-7b24-ace8-7e88dfeb9e66", "event_code": "bank_billet.created", "sent_error": null, "delivered_at": null, "failed_at": null, "resource_owner_id": 34, "status": "pending", "bank_billet_account_id": null, "status_occurred_at": null, "email_notification_id": 5, "last_clicked_at": null, "last_read_at": null, "clicked_at": null, "click_count": 0, "read_at": null, "read_count": 0, "to": "cliente@example.com,quintin.senger@macejkovic.test", "subject": "Assunto de email", "email_account_id": 7, "email_template_id": 10, "bank_billet_in_pdf": false, "bcc": null, "cc": "john_cc@example.com", "from_address": "Sender Name ", "reply_to_address": null, "customer_id": null, "customer_external_code": null, "created_at": "2026-09-04T12:54:14-05:00", "updated_at": "2026-09-04T12:54:14-05:00", "resource_owner": { "uid": "01a06d8e-8e59-7f88-866f-fe5d108b6901", "type": "bank_billet" }, "resource_base": { "uid": "01a06d8e-8e59-7f88-866f-fe5d108b6901", "type": "bank_billet" } }, { "id": 5, "uid": "01a06d8e-8de5-7c77-b330-5e2dc83c1a99", "event_code": "bank_billet.created", "sent_error": null, "delivered_at": null, "failed_at": null, "resource_owner_id": 33, "status": "pending", "bank_billet_account_id": null, "status_occurred_at": null, "email_notification_id": 4, "last_clicked_at": null, "last_read_at": null, "clicked_at": null, "click_count": 0, "read_at": null, "read_count": 0, "to": "cliente@example.com,tayna@skiles-gleichner.example", "subject": "Assunto de email", "email_account_id": 6, "email_template_id": 8, "bank_billet_in_pdf": false, "bcc": null, "cc": "john_cc@example.com", "from_address": "Sender Name ", "reply_to_address": null, "customer_id": null, "customer_external_code": null, "created_at": "2026-09-04T12:54:14-05:00", "updated_at": "2026-09-04T12:54:14-05:00", "resource_owner": { "uid": "01a06d8e-8e10-783f-91d6-fd43a18754c7", "type": "bank_billet" }, "resource_base": { "uid": "01a06d8e-8e10-783f-91d6-fd43a18754c7", "type": "bank_billet" } }, { "id": 4, "uid": "01a06d8e-8d9a-7557-9812-6be6be78796b", "event_code": "bank_billet.created", "sent_error": null, "delivered_at": null, "failed_at": null, "resource_owner_id": 32, "status": "pending", "bank_billet_account_id": null, "status_occurred_at": null, "email_notification_id": 3, "last_clicked_at": null, "last_read_at": null, "clicked_at": null, "click_count": 0, "read_at": null, "read_count": 0, "to": "cliente@example.com,gino_stark@hand-sauer.test", "subject": "Assunto de email", "email_account_id": 5, "email_template_id": 6, "bank_billet_in_pdf": false, "bcc": null, "cc": "john_cc@example.com", "from_address": "Sender Name ", "reply_to_address": null, "customer_id": null, "customer_external_code": null, "created_at": "2026-09-04T12:54:14-05:00", "updated_at": "2026-09-04T12:54:14-05:00", "resource_owner": { "uid": "01a06d8e-8dc7-7086-9c82-6a550f227e88", "type": "bank_billet" }, "resource_base": { "uid": "01a06d8e-8dc7-7086-9c82-6a550f227e88", "type": "bank_billet" } }, { "id": 3, "uid": "01a06d8e-8d46-7bbf-a439-59964b15108e", "event_code": "bank_billet.created", "sent_error": null, "delivered_at": null, "failed_at": null, "resource_owner_id": 31, "status": "pending", "bank_billet_account_id": null, "status_occurred_at": null, "email_notification_id": 2, "last_clicked_at": null, "last_read_at": null, "clicked_at": null, "click_count": 0, "read_at": null, "read_count": 0, "to": "cliente@example.com,karole@welch.example", "subject": "Assunto de email", "email_account_id": 4, "email_template_id": 4, "bank_billet_in_pdf": false, "bcc": null, "cc": "john_cc@example.com", "from_address": "Sender Name ", "reply_to_address": null, "customer_id": null, "customer_external_code": null, "created_at": "2026-09-04T12:54:14-05:00", "updated_at": "2026-09-04T12:54:14-05:00", "resource_owner": { "uid": "01a06d8e-8d78-74e3-9e37-0fddca3e09ca", "type": "bank_billet" }, "resource_base": { "uid": "01a06d8e-8d78-74e3-9e37-0fddca3e09ca", "type": "bank_billet" } }, { "id": 2, "uid": "01a06d8e-8cc5-7a13-8a2e-91b60f7b5ac8", "event_code": "bank_billet.created", "sent_error": null, "delivered_at": null, "failed_at": null, "resource_owner_id": 30, "status": "pending", "bank_billet_account_id": null, "status_occurred_at": null, "email_notification_id": 1, "last_clicked_at": null, "last_read_at": null, "clicked_at": null, "click_count": 0, "read_at": null, "read_count": 0, "to": "cliente@example.com,malcom@prosacco-ondricka.test", "subject": "Assunto de email", "email_account_id": 3, "email_template_id": 2, "bank_billet_in_pdf": false, "bcc": null, "cc": "john_cc@example.com", "from_address": "Sender Name ", "reply_to_address": null, "customer_id": null, "customer_external_code": null, "created_at": "2026-09-04T12:54:13-05:00", "updated_at": "2026-09-04T12:54:13-05:00", "resource_owner": { "uid": "01a06d8e-8d1c-7c61-bf21-17a0ee7c15ed", "type": "bank_billet" }, "resource_base": { "uid": "01a06d8e-8d1c-7c61-bf21-17a0ee7c15ed", "type": "bank_billet" } } ], "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1_email_delivery_object" } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/email_deliveries/{id}": { "get": { "summary": "Informações do E-mail Enviado", "tags": [ "Histórico de E-mails" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de um e-mail enviado", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "ID do E-mail", "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "E-mail encontrado com sucesso", "content": { "application/json": { "example": { "id": 7, "uid": "01a06d8e-8ef2-783c-9e31-8261fd5e1dbd", "event_code": "bank_billet.created", "sent_error": null, "delivered_at": null, "failed_at": null, "resource_owner_id": 35, "status": "pending", "bank_billet_account_id": null, "status_occurred_at": null, "email_notification_id": 6, "last_clicked_at": null, "last_read_at": null, "clicked_at": null, "click_count": 0, "read_at": null, "read_count": 0, "to": "cliente@example.com,garth@grant-larson.test", "subject": "Assunto de email", "email_account_id": 8, "email_template_id": 12, "bank_billet_in_pdf": false, "bcc": null, "cc": "john_cc@example.com", "from_address": "Sender Name ", "reply_to_address": null, "customer_id": null, "customer_external_code": null, "created_at": "2026-09-04T12:54:14-05:00", "updated_at": "2026-09-04T12:54:14-05:00", "resource_owner": { "uid": "01a06d8e-8f27-7ff9-9537-eef29a3a0835", "type": "bank_billet" }, "resource_base": { "uid": "01a06d8e-8f27-7ff9-9537-eef29a3a0835", "type": "bank_billet" } }, "schema": { "$ref": "#/components/schemas/v1_email_delivery_object" } } } }, "404": { "description": "E-mail não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/email_deliveries/{id}/resend": { "put": { "summary": "Reenviar E-mail Enviado", "tags": [ "Histórico de E-mails" ], "security": [ { "bearerAuth": [] } ], "description": "Você pode reenviar e-mails enviados.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "ID do E-mail enviado", "example": 999, "schema": { "type": "string" } } ], "responses": { "204": { "description": "E-mail reeenviado com sucesso" }, "404": { "description": "E-email não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/events": { "get": { "summary": "Listar Eventos", "tags": [ "Eventos" ], "security": [ { "bearerAuth": [] } ], "description": "Lista Eventos.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "resource_owner_id", "in": "query", "description": "ID do objeto que gerou o evento. Ex. ID do boleto.", "required": false, "schema": { "type": "integer" } }, { "name": "code", "in": "query", "description": "Código do evento.", "required": false, "schema": { "type": "string", "enum": [ "ping", "access_token.db.created", "access_token.db.updated", "access_token.db.deleted", "access_token.reminder", "access_token.expired", "account.updated", "account.blocked", "account.bank_billet_creation_blocked", "bank_billet.created", "bank_billet.updated", "bank_billet.generated", "bank_billet.canceled", "bank_billet.blocked", "bank_billet.overdue", "bank_billet.paid", "bank_billet.due_date", "bank_billet.rejected", "bank_billet.cancel.requested", "bank_billet.cancel.confirmed", "bank_billet.cancel.failed", "bank_billet.cancel.error", "bank_billet.register.requested", "bank_billet.register.confirmed", "bank_billet.register.failed", "bank_billet.register.error", "bank_billet.update.requested", "bank_billet.update.confirmed", "bank_billet.update.failed", "bank_billet.update.error", "bank_billet.registered", "bank_billet.deleted", "bank_billet.sync.requested", "bank_billet.sync.confirmed", "bank_billet.sync.failed", "bank_billet.sync.error", "bank_billet.get.requested", "bank_billet.get.confirmed", "bank_billet.get.failed", "bank_billet.get.error", "bank_billet.get_child.requested", "bank_billet.get_child.confirmed", "bank_billet.get_child.failed", "bank_billet.get_child.error", "bank_billet.find.requested", "bank_billet.find.confirmed", "bank_billet.find.failed", "bank_billet.find.error", "bank_billet.add_pix.requested", "bank_billet.add_pix.confirmed", "bank_billet.add_pix.failed", "bank_billet.add_pix.error", "bank_billet.get_pix.requested", "bank_billet.get_pix.confirmed", "bank_billet.get_pix.failed", "bank_billet.get_pix.error", "bank_billet.protest.requested", "bank_billet.protest.confirmed", "bank_billet.protest.failed", "bank_billet.protest.error", "bank_billet_discharge.created", "bank_billet_discharge.updated", "bank_billet_discharge.deleted", "bank_billet_remittance.created", "bank_billet_remittance.updated", "bank_billet_remittance.deleted", "bank_billet_registration.created", "bank_billet_registration.updated", "bank_billet_registration.deleted", "bank_billet_payment.created", "bank_billet_payment.updated", "bank_billet_payment.deleted", "customer.created", "customer.updated", "customer.portal_password_updated", "customer.deleted", "transaction.created", "transaction.updated", "transaction.processed", "withdrawal.transferred", "withdrawal.requested", "addon.activated", "addon.removed", "plan_subscription.activated", "plan_subscription.removed", "plan_subscription.fee", "plan_subscription.updated", "user.created", "user.updated", "user.deleted", "remittance.created", "remittance.processed", "remittance.downloaded", "remittance.sent", "remittance.deleted", "remittance.line.db.created", "remittance.line.db.updated", "remittance.line.db.deleted", "discharge.created", "discharge.processed", "discharge.deleted", "bank_billet_account.created", "bank_billet_account.homologated", "bank_billet_account.homologation_failed", "bank_billet_account.homologation_started", "bank_billet_account.validated", "bank_billet_account.validation_released", "bank_billet_account.activated", "bank_billet_account.updated", "bank_billet_account.deleted", "edi.remittance_line.created", "edi.remittance_line.updated", "edi.remittance_line.deleted", "edi.edi_box.activated", "edi.edi_box.db.created", "edi.edi_box.db.deleted", "edi.edi_box.db.updated", "edi.edi_box.generated", "edi.edi_box.demand_received", "edi.edi_box.confirming_at_bank", "edi.edi_box.testing_by_customer", "edi.edi_box.waiting_for_validations", "customer_subscription.created", "customer_subscription.updated", "customer_subscription.deleted", "installment.created", "installment.processed", "installment.generated", "installment.deleted", "import.created", "import.processed", "import.deleted", "export.db.created", "export.db.updated", "export.db.deleted", "pix.db.created", "pix.db.updated", "pix.db.deleted", "pix.register.requested", "pix.register.confirmed", "pix.register.failed", "pix.register.error", "pix.update.requested", "pix.update.confirmed", "pix.update.failed", "pix.update.error", "pix.paid", "pix.overdue", "pix.cancel.requested", "pix.cancel.confirmed", "pix.cancel.failed", "pix.cancel.error", "pix.sync.requested", "pix.sync.confirmed", "pix.sync.failed", "pix.sync.error", "pix.get.requested", "pix.get.confirmed", "pix.get.failed", "pix.get.error", "financial.account.balance_sync.requested", "financial.account.balance_sync.confirmed", "financial.account.balance_sync.failed", "financial.account.balance_sync.error", "financial.account.statement_sync.requested", "financial.account.statement_sync.confirmed", "financial.account.statement_sync.failed", "financial.account.statement_sync.error", "financial.account.db.created", "financial.account.db.updated", "financial.account.db.deleted", "financial.account.statement.updated", "financial.account.balance.updated", "financial.account_balance.db.created", "transfer.batch.db.created", "transfer.batch.db.updated", "transfer.batch.db.deleted", "transfer.batch.awaiting_approval", "transfer.pix_batch.awaiting_approval", "transfer.pix_batch.get.requested", "transfer.pix_batch.get.confirmed", "transfer.pix_batch.get.failed", "transfer.pix_batch.get.error", "transfer.pix_batch.sync.requested", "transfer.pix_batch.sync.confirmed", "transfer.pix_batch.sync.failed", "transfer.pix_batch.sync.error", "transfer.pix_batch.register.requested", "transfer.pix_batch.register.confirmed", "transfer.pix_batch.register.failed", "transfer.pix_batch.register.error", "transfer.pix_batch.approve.requested", "transfer.pix_batch.approve.confirmed", "transfer.pix_batch.approve.failed", "transfer.pix_batch.approve.error", "transfer.pix_batch.reprove.requested", "transfer.pix_batch.reprove.confirmed", "transfer.pix_batch.reprove.failed", "transfer.pix_batch.reprove.error", "transfer.pix_batch.cancel.requested", "transfer.pix_batch.cancel.confirmed", "transfer.pix_batch.cancel.failed", "transfer.pix_batch.cancel.error", "transfer.ted_batch.awaiting_approval", "transfer.ted_batch.get.requested", "transfer.ted_batch.get.confirmed", "transfer.ted_batch.get.failed", "transfer.ted_batch.get.error", "transfer.ted_batch.sync.requested", "transfer.ted_batch.sync.confirmed", "transfer.ted_batch.sync.failed", "transfer.ted_batch.sync.error", "transfer.ted_batch.register.requested", "transfer.ted_batch.register.confirmed", "transfer.ted_batch.register.failed", "transfer.ted_batch.register.error", "transfer.ted_batch.approve.requested", "transfer.ted_batch.approve.confirmed", "transfer.ted_batch.approve.failed", "transfer.ted_batch.approve.error", "transfer.ted_batch.reprove.requested", "transfer.ted_batch.reprove.confirmed", "transfer.ted_batch.reprove.failed", "transfer.ted_batch.reprove.error", "transfer.ted_batch.cancel.requested", "transfer.ted_batch.cancel.confirmed", "transfer.ted_batch.cancel.failed", "transfer.ted_batch.cancel.error", "transfer.internal_batch.awaiting_approval", "transfer.internal_batch.get.requested", "transfer.internal_batch.get.confirmed", "transfer.internal_batch.get.failed", "transfer.internal_batch.get.error", "transfer.internal_batch.sync.requested", "transfer.internal_batch.sync.confirmed", "transfer.internal_batch.sync.failed", "transfer.internal_batch.sync.error", "transfer.internal_batch.register.requested", "transfer.internal_batch.register.confirmed", "transfer.internal_batch.register.failed", "transfer.internal_batch.register.error", "transfer.internal_batch.approve.requested", "transfer.internal_batch.approve.confirmed", "transfer.internal_batch.approve.failed", "transfer.internal_batch.approve.error", "transfer.internal_batch.reprove.requested", "transfer.internal_batch.reprove.confirmed", "transfer.internal_batch.reprove.failed", "transfer.internal_batch.reprove.error", "transfer.internal_batch.cancel.requested", "transfer.internal_batch.cancel.confirmed", "transfer.internal_batch.cancel.failed", "transfer.internal_batch.cancel.error", "transfer.db.created", "transfer.db.updated", "transfer.db.deleted", "transfer.pix.register.requested", "transfer.pix.register.confirmed", "transfer.pix.register.failed", "transfer.pix.register.error", "transfer.pix.reschedule.requested", "transfer.pix.reschedule.confirmed", "transfer.pix.reschedule.failed", "transfer.pix.reschedule.error", "transfer.pix.approve.requested", "transfer.pix.approve.confirmed", "transfer.pix.approve.failed", "transfer.pix.approve.error", "transfer.pix.reprove.requested", "transfer.pix.reprove.confirmed", "transfer.pix.reprove.failed", "transfer.pix.reprove.error", "transfer.pix.cancel.requested", "transfer.pix.cancel.confirmed", "transfer.pix.cancel.failed", "transfer.pix.cancel.error", "transfer.pix.get.requested", "transfer.pix.get.confirmed", "transfer.pix.get.failed", "transfer.pix.get.error", "transfer.pix.sync.requested", "transfer.pix.sync.confirmed", "transfer.pix.sync.failed", "transfer.pix.sync.error", "transfer.ted.register.requested", "transfer.ted.register.confirmed", "transfer.ted.register.failed", "transfer.ted.register.error", "transfer.ted.reschedule.requested", "transfer.ted.reschedule.confirmed", "transfer.ted.reschedule.failed", "transfer.ted.reschedule.error", "transfer.ted.approve.requested", "transfer.ted.approve.confirmed", "transfer.ted.approve.failed", "transfer.ted.approve.error", "transfer.ted.reprove.requested", "transfer.ted.reprove.confirmed", "transfer.ted.reprove.failed", "transfer.ted.reprove.error", "transfer.ted.cancel.requested", "transfer.ted.cancel.confirmed", "transfer.ted.cancel.failed", "transfer.ted.cancel.error", "transfer.ted.get.requested", "transfer.ted.get.confirmed", "transfer.ted.get.failed", "transfer.ted.get.error", "transfer.ted.sync.requested", "transfer.ted.sync.confirmed", "transfer.ted.sync.failed", "transfer.ted.sync.error", "transfer.internal.register.requested", "transfer.internal.register.confirmed", "transfer.internal.register.failed", "transfer.internal.register.error", "transfer.internal.reschedule.requested", "transfer.internal.reschedule.confirmed", "transfer.internal.reschedule.failed", "transfer.internal.reschedule.error", "transfer.internal.approve.requested", "transfer.internal.approve.confirmed", "transfer.internal.approve.failed", "transfer.internal.approve.error", "transfer.internal.reprove.requested", "transfer.internal.reprove.confirmed", "transfer.internal.reprove.failed", "transfer.internal.reprove.error", "transfer.internal.cancel.requested", "transfer.internal.cancel.confirmed", "transfer.internal.cancel.failed", "transfer.internal.cancel.error", "transfer.internal.get.requested", "transfer.internal.get.confirmed", "transfer.internal.get.failed", "transfer.internal.get.error", "transfer.internal.sync.requested", "transfer.internal.sync.confirmed", "transfer.internal.sync.failed", "transfer.internal.sync.error", "payment.db.created", "payment.db.updated", "payment.db.deleted", "payment.bank_billet.register.requested", "payment.bank_billet.register.confirmed", "payment.bank_billet.register.failed", "payment.bank_billet.register.error", "payment.bank_billet.approve.requested", "payment.bank_billet.approve.confirmed", "payment.bank_billet.approve.failed", "payment.bank_billet.approve.error", "payment.bank_billet.reprove.requested", "payment.bank_billet.reprove.confirmed", "payment.bank_billet.reprove.failed", "payment.bank_billet.reprove.error", "payment.bank_billet.reschedule.requested", "payment.bank_billet.reschedule.confirmed", "payment.bank_billet.reschedule.failed", "payment.bank_billet.reschedule.error", "payment.bank_billet.cancel.requested", "payment.bank_billet.cancel.confirmed", "payment.bank_billet.cancel.failed", "payment.bank_billet.cancel.error", "payment.bank_billet.get.requested", "payment.bank_billet.get.confirmed", "payment.bank_billet.get.failed", "payment.bank_billet.get.error", "payment.bank_billet.sync.requested", "payment.bank_billet.sync.confirmed", "payment.bank_billet.sync.failed", "payment.bank_billet.sync.error", "payment.darf.register.requested", "payment.darf.register.confirmed", "payment.darf.register.failed", "payment.darf.register.error", "payment.darf.approve.requested", "payment.darf.approve.confirmed", "payment.darf.approve.failed", "payment.darf.approve.error", "payment.darf.reprove.requested", "payment.darf.reprove.confirmed", "payment.darf.reprove.failed", "payment.darf.reprove.error", "payment.darf.reschedule.requested", "payment.darf.reschedule.confirmed", "payment.darf.reschedule.failed", "payment.darf.reschedule.error", "payment.darf.cancel.requested", "payment.darf.cancel.confirmed", "payment.darf.cancel.failed", "payment.darf.cancel.error", "payment.darf.get.requested", "payment.darf.get.confirmed", "payment.darf.get.failed", "payment.darf.get.error", "payment.darf.sync.requested", "payment.darf.sync.confirmed", "payment.darf.sync.failed", "payment.darf.sync.error", "payment.utility.register.requested", "payment.utility.register.confirmed", "payment.utility.register.failed", "payment.utility.register.error", "payment.utility.approve.requested", "payment.utility.approve.confirmed", "payment.utility.approve.failed", "payment.utility.approve.error", "payment.utility.reprove.requested", "payment.utility.reprove.confirmed", "payment.utility.reprove.failed", "payment.utility.reprove.error", "payment.utility.reschedule.requested", "payment.utility.reschedule.confirmed", "payment.utility.reschedule.failed", "payment.utility.reschedule.error", "payment.utility.cancel.requested", "payment.utility.cancel.confirmed", "payment.utility.cancel.failed", "payment.utility.cancel.error", "payment.utility.get.requested", "payment.utility.get.confirmed", "payment.utility.get.failed", "payment.utility.get.error", "payment.utility.sync.requested", "payment.utility.sync.confirmed", "payment.utility.sync.failed", "payment.utility.sync.error", "payment.gru.register.requested", "payment.gru.register.confirmed", "payment.gru.register.failed", "payment.gru.register.error", "payment.gru.approve.requested", "payment.gru.approve.confirmed", "payment.gru.approve.failed", "payment.gru.approve.error", "payment.gru.reprove.requested", "payment.gru.reprove.confirmed", "payment.gru.reprove.failed", "payment.gru.reprove.error", "payment.gru.reschedule.requested", "payment.gru.reschedule.confirmed", "payment.gru.reschedule.failed", "payment.gru.reschedule.error", "payment.gru.cancel.requested", "payment.gru.cancel.confirmed", "payment.gru.cancel.failed", "payment.gru.cancel.error", "payment.gru.get.requested", "payment.gru.get.confirmed", "payment.gru.get.failed", "payment.gru.get.error", "payment.gru.sync.requested", "payment.gru.sync.confirmed", "payment.gru.sync.failed", "payment.gru.sync.error", "payment.pix.register.requested", "payment.pix.register.confirmed", "payment.pix.register.failed", "payment.pix.register.error", "payment.pix.approve.requested", "payment.pix.approve.confirmed", "payment.pix.approve.failed", "payment.pix.approve.error", "payment.pix.reprove.requested", "payment.pix.reprove.confirmed", "payment.pix.reprove.failed", "payment.pix.reprove.error", "payment.pix.reschedule.requested", "payment.pix.reschedule.confirmed", "payment.pix.reschedule.failed", "payment.pix.reschedule.error", "payment.pix.cancel.requested", "payment.pix.cancel.confirmed", "payment.pix.cancel.failed", "payment.pix.cancel.error", "payment.pix.get.requested", "payment.pix.get.confirmed", "payment.pix.get.failed", "payment.pix.get.error", "payment.pix.sync.requested", "payment.pix.sync.confirmed", "payment.pix.sync.failed", "payment.pix.sync.error", "payment.tax.register.requested", "payment.tax.register.confirmed", "payment.tax.register.failed", "payment.tax.register.error", "payment.tax.approve.requested", "payment.tax.approve.confirmed", "payment.tax.approve.failed", "payment.tax.approve.error", "payment.tax.reprove.requested", "payment.tax.reprove.confirmed", "payment.tax.reprove.failed", "payment.tax.reprove.error", "payment.tax.reschedule.requested", "payment.tax.reschedule.confirmed", "payment.tax.reschedule.failed", "payment.tax.reschedule.error", "payment.tax.cancel.requested", "payment.tax.cancel.confirmed", "payment.tax.cancel.failed", "payment.tax.cancel.error", "payment.tax.get.requested", "payment.tax.get.confirmed", "payment.tax.get.failed", "payment.tax.get.error", "payment.tax.sync.requested", "payment.tax.sync.confirmed", "payment.tax.sync.failed", "payment.tax.sync.error", "payment.batch.db.created", "payment.batch.db.updated", "payment.batch.db.deleted", "payment.batch.awaiting_approval", "payment.bank_billet_batch.awaiting_approval", "payment.bank_billet_batch.get.requested", "payment.bank_billet_batch.get.confirmed", "payment.bank_billet_batch.get.failed", "payment.bank_billet_batch.get.error", "payment.bank_billet_batch.sync.requested", "payment.bank_billet_batch.sync.confirmed", "payment.bank_billet_batch.sync.failed", "payment.bank_billet_batch.sync.error", "payment.bank_billet_batch.register.requested", "payment.bank_billet_batch.register.confirmed", "payment.bank_billet_batch.register.failed", "payment.bank_billet_batch.register.error", "payment.bank_billet_batch.approve.requested", "payment.bank_billet_batch.approve.confirmed", "payment.bank_billet_batch.approve.failed", "payment.bank_billet_batch.approve.error", "payment.bank_billet_batch.reprove.requested", "payment.bank_billet_batch.reprove.confirmed", "payment.bank_billet_batch.reprove.failed", "payment.bank_billet_batch.reprove.error", "payment.bank_billet_batch.cancel.requested", "payment.bank_billet_batch.cancel.confirmed", "payment.bank_billet_batch.cancel.failed", "payment.bank_billet_batch.cancel.error", "payment.darf_batch.awaiting_approval", "payment.darf_batch.get.requested", "payment.darf_batch.get.confirmed", "payment.darf_batch.get.failed", "payment.darf_batch.get.error", "payment.darf_batch.sync.requested", "payment.darf_batch.sync.confirmed", "payment.darf_batch.sync.failed", "payment.darf_batch.sync.error", "payment.darf_batch.register.requested", "payment.darf_batch.register.confirmed", "payment.darf_batch.register.failed", "payment.darf_batch.register.error", "payment.darf_batch.approve.requested", "payment.darf_batch.approve.confirmed", "payment.darf_batch.approve.failed", "payment.darf_batch.approve.error", "payment.darf_batch.reprove.requested", "payment.darf_batch.reprove.confirmed", "payment.darf_batch.reprove.failed", "payment.darf_batch.reprove.error", "payment.darf_batch.cancel.requested", "payment.darf_batch.cancel.confirmed", "payment.darf_batch.cancel.failed", "payment.darf_batch.cancel.error", "payment.utility_batch.awaiting_approval", "payment.utility_batch.get.requested", "payment.utility_batch.get.confirmed", "payment.utility_batch.get.failed", "payment.utility_batch.get.error", "payment.utility_batch.sync.requested", "payment.utility_batch.sync.confirmed", "payment.utility_batch.sync.failed", "payment.utility_batch.sync.error", "payment.utility_batch.register.requested", "payment.utility_batch.register.confirmed", "payment.utility_batch.register.failed", "payment.utility_batch.register.error", "payment.utility_batch.approve.requested", "payment.utility_batch.approve.confirmed", "payment.utility_batch.approve.failed", "payment.utility_batch.approve.error", "payment.utility_batch.reprove.requested", "payment.utility_batch.reprove.confirmed", "payment.utility_batch.reprove.failed", "payment.utility_batch.reprove.error", "payment.utility_batch.cancel.requested", "payment.utility_batch.cancel.confirmed", "payment.utility_batch.cancel.failed", "payment.utility_batch.cancel.error", "payment.gru_batch.awaiting_approval", "payment.gru_batch.get.requested", "payment.gru_batch.get.confirmed", "payment.gru_batch.get.failed", "payment.gru_batch.get.error", "payment.gru_batch.sync.requested", "payment.gru_batch.sync.confirmed", "payment.gru_batch.sync.failed", "payment.gru_batch.sync.error", "payment.gru_batch.register.requested", "payment.gru_batch.register.confirmed", "payment.gru_batch.register.failed", "payment.gru_batch.register.error", "payment.gru_batch.approve.requested", "payment.gru_batch.approve.confirmed", "payment.gru_batch.approve.failed", "payment.gru_batch.approve.error", "payment.gru_batch.reprove.requested", "payment.gru_batch.reprove.confirmed", "payment.gru_batch.reprove.failed", "payment.gru_batch.reprove.error", "payment.gru_batch.cancel.requested", "payment.gru_batch.cancel.confirmed", "payment.gru_batch.cancel.failed", "payment.gru_batch.cancel.error", "payment.pix_batch.awaiting_approval", "payment.pix_batch.get.requested", "payment.pix_batch.get.confirmed", "payment.pix_batch.get.failed", "payment.pix_batch.get.error", "payment.pix_batch.sync.requested", "payment.pix_batch.sync.confirmed", "payment.pix_batch.sync.failed", "payment.pix_batch.sync.error", "payment.pix_batch.register.requested", "payment.pix_batch.register.confirmed", "payment.pix_batch.register.failed", "payment.pix_batch.register.error", "payment.pix_batch.approve.requested", "payment.pix_batch.approve.confirmed", "payment.pix_batch.approve.failed", "payment.pix_batch.approve.error", "payment.pix_batch.reprove.requested", "payment.pix_batch.reprove.confirmed", "payment.pix_batch.reprove.failed", "payment.pix_batch.reprove.error", "payment.pix_batch.cancel.requested", "payment.pix_batch.cancel.confirmed", "payment.pix_batch.cancel.failed", "payment.pix_batch.cancel.error", "payment.tax_batch.awaiting_approval", "payment.tax_batch.get.requested", "payment.tax_batch.get.confirmed", "payment.tax_batch.get.failed", "payment.tax_batch.get.error", "payment.tax_batch.sync.requested", "payment.tax_batch.sync.confirmed", "payment.tax_batch.sync.failed", "payment.tax_batch.sync.error", "payment.tax_batch.register.requested", "payment.tax_batch.register.confirmed", "payment.tax_batch.register.failed", "payment.tax_batch.register.error", "payment.tax_batch.approve.requested", "payment.tax_batch.approve.confirmed", "payment.tax_batch.approve.failed", "payment.tax_batch.approve.error", "payment.tax_batch.reprove.requested", "payment.tax_batch.reprove.confirmed", "payment.tax_batch.reprove.failed", "payment.tax_batch.reprove.error", "payment.tax_batch.cancel.requested", "payment.tax_batch.cancel.confirmed", "payment.tax_batch.cancel.failed", "payment.tax_batch.cancel.error", "payment.dda.account.db.created", "payment.dda.account.register.requested", "payment.dda.account.register.failed", "payment.dda.account.register.error", "payment.dda.account.register.confirmed", "payment.dda.account.bank_billets_sync.requested", "payment.dda.account.bank_billets_sync.failed", "payment.dda.account.bank_billets_sync.error", "payment.dda.account.bank_billets_sync.confirmed", "payment.dda.account.unregister.requested", "payment.dda.account.unregister.failed", "payment.dda.account.unregister.error", "payment.dda.account.unregister.confirmed", "payment.dda.bank_billet.db.created", "payment.dda.bank_billet.db.updated", "payment.dda.bank_billet.external_status_changed", "payment.dda.bank_billet.get.requested", "payment.dda.bank_billet.get.confirmed", "payment.dda.bank_billet.get.failed", "payment.dda.bank_billet.get.error", "payment.dda.bank_billet.sync.requested", "payment.dda.bank_billet.sync.confirmed", "payment.dda.bank_billet.sync.failed", "payment.dda.bank_billet.sync.error", "payment.dda.account.db.updated", "payment.dda.account.db.deleted", "payment.dda.account.letter.pending", "payment.dda.account.letter.waiting_signatures", "payment.dda.account.letter.signed", "payment.dda.account.letter.failed", "payment.dda.account.confirmed", "payment.dda.account.rejected", "payment.dda.account.failed", "payment.dda.account.disabled", "payment.dda.account.enabled", "credit.restriction.add.requested", "credit.restriction.add.failed", "credit.restriction.add.error", "credit.restriction.add.confirmed", "credit.restriction.remove.requested", "credit.restriction.remove.confirmed", "credit.restriction.remove.failed", "credit.restriction.remove.error", "charge.automatic_pix.account.db.created", "charge.automatic_pix.account.db.updated", "charge.automatic_pix.account.db.deleted", "charge.automatic_pix.recurrence.db.created", "charge.automatic_pix.recurrence.db.updated", "charge.automatic_pix.recurrence.db.deleted", "charge.automatic_pix.recurrence.cancel.requested", "charge.automatic_pix.recurrence.cancel.confirmed", "charge.automatic_pix.recurrence.cancel.failed", "charge.automatic_pix.recurrence.cancel.error", "charge.automatic_pix.recurrence.register.requested", "charge.automatic_pix.recurrence.register.confirmed", "charge.automatic_pix.recurrence.register.failed", "charge.automatic_pix.recurrence.register.error", "charge.automatic_pix.recurrence.update.requested", "charge.automatic_pix.recurrence.update.confirmed", "charge.automatic_pix.recurrence.update.failed", "charge.automatic_pix.recurrence.update.error", "charge.automatic_pix.recurrence.pending", "charge.automatic_pix.recurrence.created", "charge.automatic_pix.recurrence.approved", "charge.automatic_pix.recurrence.rejected", "charge.automatic_pix.recurrence.expired", "charge.automatic_pix.recurrence.canceled", "charge.automatic_pix.request.db.created", "charge.automatic_pix.request.db.updated", "charge.automatic_pix.request.db.deleted", "charge.automatic_pix.request.cancel.requested", "charge.automatic_pix.request.cancel.confirmed", "charge.automatic_pix.request.cancel.failed", "charge.automatic_pix.request.cancel.error", "charge.automatic_pix.request.register.requested", "charge.automatic_pix.request.register.confirmed", "charge.automatic_pix.request.register.failed", "charge.automatic_pix.request.register.error", "charge.automatic_pix.request.pending", "charge.automatic_pix.request.created", "charge.automatic_pix.request.sent", "charge.automatic_pix.request.received", "charge.automatic_pix.request.rejected", "charge.automatic_pix.request.accepted", "charge.automatic_pix.request.expired", "charge.automatic_pix.request.canceled", "charge.automatic_pix.pix.db.created", "charge.automatic_pix.pix.db.updated", "charge.automatic_pix.pix.db.deleted", "charge.automatic_pix.pix.cancel.requested", "charge.automatic_pix.pix.cancel.confirmed", "charge.automatic_pix.pix.cancel.failed", "charge.automatic_pix.pix.cancel.error", "charge.automatic_pix.pix.register.requested", "charge.automatic_pix.pix.register.confirmed", "charge.automatic_pix.pix.register.failed", "charge.automatic_pix.pix.register.error", "charge.automatic_pix.pix.update.requested", "charge.automatic_pix.pix.update.confirmed", "charge.automatic_pix.pix.update.failed", "charge.automatic_pix.pix.update.error", "charge.automatic_pix.pix.pending", "charge.automatic_pix.pix.created", "charge.automatic_pix.pix.active", "charge.automatic_pix.pix.paid", "charge.automatic_pix.pix.expired", "charge.automatic_pix.pix.rejected", "charge.automatic_pix.pix.canceled", "charge.automatic_pix.location.db.created", "charge.automatic_pix.location.db.updated", "charge.automatic_pix.location.db.deleted", "charge.automatic_pix.location.register.requested", "charge.automatic_pix.location.register.confirmed", "charge.automatic_pix.location.register.failed", "charge.automatic_pix.location.register.error", "charge.payment.db.created", "charge.payment.db.updated", "charge.payment.db.deleted", "charge.payment.notified", "charge.payment.canceled", "charge.payment.confirmed", "charge.payment.duplicated", "charge.bank_billet.payment.notified", "charge.bank_billet.payment.canceled", "charge.bank_billet.payment.confirmed", "data.bank_billet_query.success", "data.bank_billet_query.error", "data.bank_billet_query.db.created", "data.bank_billet_query.db.updated", "data.bank_billet_query.db.deleted", "data.pix_qrcode_query.success", "data.pix_qrcode_query.error", "data.pix_qrcode_query.db.created", "data.pix_qrcode_query.db.updated", "data.pix_qrcode_query.db.deleted", "mailbox.entry.db.created", "mailbox.entry.db.updated", "mailbox.entry.db.deleted", "mailbox.entry.file.received", "mailbox.entry.file.sent", "mailbox.file.db.created", "mailbox.file.db.updated", "mailbox.file.db.deleted", "mailbox.channel.s3.db.created", "mailbox.channel.s3.db.updated", "mailbox.channel.s3.db.deleted", "mailbox.channel.s3.fetch_all", "mailbox.channel.email.db.created", "mailbox.channel.email.db.updated", "mailbox.channel.email.db.deleted", "mailbox.channel.whatsapp.db.created", "mailbox.channel.whatsapp.db.updated", "mailbox.channel.whatsapp.db.deleted", "mailbox.channel.sftp.db.created", "mailbox.channel.sftp.db.updated", "mailbox.channel.sftp.db.deleted", "mailbox.channel.sftp.fetch_all", "mailbox.channel.syncthing.db.created", "mailbox.channel.syncthing.db.updated", "mailbox.channel.syncthing.db.deleted", "email_account.db.created", "email_account.db.updated", "email_account.db.deleted", "email_account.identity.pending", "email_account.identity.created", "email_account.identity.error", "email_account.identity.failure", "email_account.dns.not_ready", "email_account.dns.awaiting", "email_account.dns.validated", "email_account.dns.error", "email_account.dns.failure", "integration.connection.db.created", "integration.connection.db.updated", "integration.connection.db.deleted", "webhook.db.created", "webhook.db.updated", "webhook.db.deleted", "enotas.nfe.generated" ] } }, { "name": "occurred_at_from", "in": "query", "description": "Início da data de ocorrência do evento. Se omitido, aplica filtro padrão de últimos 30 dias. O intervalo máximo entre occurred_at_from e occurred_at_to é de 60 dias.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "occurred_at_to", "in": "query", "description": "Fim da data de ocorrência do evento. Se omitido junto com occurred_at_from, aplica filtro padrão de últimos 30 dias. O intervalo máximo permitido é de 60 dias.", "example": "2020-01-31", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Sucesso na listagem dos eventos", "content": { "application/json": { "example": [ { "resource_owner": { "uid": "01a06d8e-917f-7fab-a8ac-d8d605b6575e", "type": "bank_billet" }, "resource_base": { "uid": "01a06d8e-917f-7fab-a8ac-d8d605b6575e", "type": "bank_billet" }, "uid": "01a06d8e-9193-7e9f-bb1c-4871bd8ba97a", "code": "ping", "data": { "object": { "id": 37, "pix": [], "uid": "01a06d8e-917f-7fab-a8ac-d8d605b6575e", "url": "http://dev.bole.to:5001/2/bwl", "line": "75691.43279 01022.938508 04003.310010 9 82900000005000", "meta": null, "tags": [ "tag 1", "tag2", "tag 3" ], "notes": null, "addons": null, "amount": 50.0, "extra1": "0229385", "extra2": null, "status": "generating", "barcode": "75699829000000050001432701022938500400331001", "formats": { "pdf": "http://dev.bole.to:5001/2/bwl.pdf", "png": "http://dev.bole.to:5001/2/bwl.png", "line": "http://dev.bole.to:5001/2/bwl/line", "letter": "http://dev.bole.to:5001/2/bwl/letter", "recibo": "http://dev.bole.to:5001/2/bwl/recibo", "barcode": "http://dev.bole.to:5001/2/bwl/barcode", "default": "http://dev.bole.to:5001/2/bwl", "envelope": "http://dev.bole.to:5001/2/bwl/envelope", "boleto_pix": null, "pix_qrcode": null, "boleto_hibrido": "http://dev.bole.to:5001/2/bwl/boleto_hibrido" }, "paid_at": null, "payments": [], "pix_txid": null, "sue_code": null, "tag_list": "tag 1,tag2,tag 3", "url_hash": "bwl", "carne_url": null, "expire_at": "2020-06-18", "fine_type": 0, "import_id": null, "issued_at": "2020-06-15T07:00:00-05:00", "acceptance": "N", "created_at": "2020-06-15T07:00:00-05:00", "fine_value": null, "ignore_sms": false, "our_number": "40033", "pix_qrcode": null, "revoked_at": null, "updated_at": "2020-06-15T07:00:00-05:00", "cancel_type": null, "charge_type": 1, "custom_data": null, "customer_id": 58, "description": "Serviço de criação de site\\r\\nExpira em: 18/06/2020", "external_id": null, "paid_amount": null, "pix_enabled": false, "prevent_pix": false, "revoke_code": null, "shorten_url": "http://dev.bole.to:5001/2/bwl", "sue_history": [], "after_create": [], "agency_digit": "3", "days_for_sue": null, "extra1_digit": null, "extra2_digit": null, "ignore_email": false, "instructions": null, "account_digit": "8", "agency_number": "4327", "credit_bureau": null, "days_for_fine": null, "discount_type": 0, "dispatch_type": 1, "document_date": null, "document_type": "02", "interest_type": 0, "payment_count": 1, "payment_place": "Pagável em qualquer banco até a data de vencimento.", "registered_at": null, "split_payment": false, "account_number": "00003666", "control_number": null, "customer_email": "cliente@example.com", "customer_notes": null, "customer_state": "RJ", "discount_value": null, "fine_for_delay": null, "guarantor_name": null, "installment_id": null, "interest_value": null, "reduction_type": 3, "created_via_api": false, "days_for_revoke": null, "document_number": null, "fine_percentage": null, "guarantor_state": null, "ignore_whatsapp": false, "beneficiary_name": "Kobana Tecnologia Ltda.", "customer_address": "Av. Burkhard Hehn Simões", "customer_zipcode": "24360440", "reduction_amount": null, "customer_cnpj_cpf": "399.881.072-26", "customer_email_cc": "john_cc@example.com", "customer_nickname": null, "days_for_discount": null, "days_for_interest": null, "days_for_sue_type": null, "first_instruction": null, "guarantor_address": null, "guarantor_zipcode": null, "installment_total": null, "instructions_mode": 1, "recipient_account": null, "bank_contract_slug": "sicoob-01", "customer_city_name": "Rio de Janeiro", "guarantor_cnpj_cpf": null, "installment_number": null, "interest_days_type": 0, "second_instruction": null, "split_payment_type": null, "beneficiary_address": "Av. Presidente Vargas, 633, sala 1716, Centro, Rio de Janeiro, RJ, 20071004", "cancellation_reason": null, "customer_ignore_sms": false, "discount_limit_date": null, "discount_percentage": null, "document_type_label": "DM", "guarantor_city_name": null, "interest_percentage": null, "registration_status": "pending", "bank_billet_payments": [], "beneficiary_cnpj_cpf": "05.813.794/0001-26", "customer_person_name": "José da Silva", "interest_daily_value": null, "prevent_registration": false, "processed_our_number": "00400331", "reduction_percentage": null, "third_discount_value": null, "bank_billet_layout_id": null, "customer_ignore_email": null, "customer_neighborhood": "São Francisco", "customer_phone_number": "2199999999", "days_for_negativation": null, "late_payment_interest": null, "second_discount_value": null, "bank_billet_account_id": 66, "bank_billet_discharges": [], "custom_attachment_name": null, "customer_mobile_number": null, "divergent_payment_type": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "bank_billet_remittances": [], "customer_address_number": "111", "customer_contact_person": null, "days_for_third_discount": null, "divergent_payment_limit": null, "password_protected_mode": null, "customer_subscription_id": null, "days_for_second_discount": null, "guarantor_address_number": null, "processed_our_number_raw": "00400331", "bank_billet_registrations": [], "beneficiary_assignor_code": "4327 / 0229385", "interest_daily_percentage": null, "third_discount_percentage": null, "bank_billet_split_accounts": [], "customer_mobile_local_code": null, "second_discount_percentage": null, "customer_address_complement": "709", "interest_monthly_percentage": null, "divergent_payment_value_type": null, "guarantor_address_complement": null, "financial_provider_external_id": null, "divergent_payment_maximum_value": null, "divergent_payment_minimum_value": null, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null } }, "occurred_at": "2020-06-15T07:00:00-05:00", "created_at": "2020-06-15T07:00:00-05:00", "updated_at": "2020-06-15T07:00:00-05:00" }, { "resource_owner": { "uid": "01a06d8e-91ba-70c2-9df0-a74cd3dbf108", "type": "bank_billet" }, "resource_base": { "uid": "01a06d8e-91ba-70c2-9df0-a74cd3dbf108", "type": "bank_billet" }, "uid": "01a06d8e-91cf-7999-a534-af5949613c12", "code": "ping", "data": { "object": { "id": 38, "pix": [], "uid": "01a06d8e-91ba-70c2-9df0-a74cd3dbf108", "url": "http://dev.bole.to:5001/2/zkq", "line": "75691.43279 01022.938508 04003.490010 7 82900000005000", "meta": null, "tags": [ "tag 1", "tag2", "tag 3" ], "notes": null, "addons": null, "amount": 50.0, "extra1": "0229385", "extra2": null, "status": "generating", "barcode": "75697829000000050001432701022938500400349001", "formats": { "pdf": "http://dev.bole.to:5001/2/zkq.pdf", "png": "http://dev.bole.to:5001/2/zkq.png", "line": "http://dev.bole.to:5001/2/zkq/line", "letter": "http://dev.bole.to:5001/2/zkq/letter", "recibo": "http://dev.bole.to:5001/2/zkq/recibo", "barcode": "http://dev.bole.to:5001/2/zkq/barcode", "default": "http://dev.bole.to:5001/2/zkq", "envelope": "http://dev.bole.to:5001/2/zkq/envelope", "boleto_pix": null, "pix_qrcode": null, "boleto_hibrido": "http://dev.bole.to:5001/2/zkq/boleto_hibrido" }, "paid_at": null, "payments": [], "pix_txid": null, "sue_code": null, "tag_list": "tag 1,tag2,tag 3", "url_hash": "zkq", "carne_url": null, "expire_at": "2020-06-18", "fine_type": 0, "import_id": null, "issued_at": "2020-06-15T07:00:00-05:00", "acceptance": "N", "created_at": "2020-06-15T07:00:00-05:00", "fine_value": null, "ignore_sms": false, "our_number": "40034", "pix_qrcode": null, "revoked_at": null, "updated_at": "2020-06-15T07:00:00-05:00", "cancel_type": null, "charge_type": 1, "custom_data": null, "customer_id": 59, "description": "Serviço de criação de site\\r\\nExpira em: 18/06/2020", "external_id": null, "paid_amount": null, "pix_enabled": false, "prevent_pix": false, "revoke_code": null, "shorten_url": "http://dev.bole.to:5001/2/zkq", "sue_history": [], "after_create": [], "agency_digit": "3", "days_for_sue": null, "extra1_digit": null, "extra2_digit": null, "ignore_email": false, "instructions": null, "account_digit": "8", "agency_number": "4327", "credit_bureau": null, "days_for_fine": null, "discount_type": 0, "dispatch_type": 1, "document_date": null, "document_type": "02", "interest_type": 0, "payment_count": 1, "payment_place": "Pagável em qualquer banco até a data de vencimento.", "registered_at": null, "split_payment": false, "account_number": "00003666", "control_number": null, "customer_email": "cliente@example.com", "customer_notes": null, "customer_state": "RJ", "discount_value": null, "fine_for_delay": null, "guarantor_name": null, "installment_id": null, "interest_value": null, "reduction_type": 3, "created_via_api": false, "days_for_revoke": null, "document_number": null, "fine_percentage": null, "guarantor_state": null, "ignore_whatsapp": false, "beneficiary_name": "Kobana Tecnologia Ltda.", "customer_address": "Av. Burkhard Hehn Simões", "customer_zipcode": "24360440", "reduction_amount": null, "customer_cnpj_cpf": "399.881.072-26", "customer_email_cc": "john_cc@example.com", "customer_nickname": null, "days_for_discount": null, "days_for_interest": null, "days_for_sue_type": null, "first_instruction": null, "guarantor_address": null, "guarantor_zipcode": null, "installment_total": null, "instructions_mode": 1, "recipient_account": null, "bank_contract_slug": "sicoob-01", "customer_city_name": "Rio de Janeiro", "guarantor_cnpj_cpf": null, "installment_number": null, "interest_days_type": 0, "second_instruction": null, "split_payment_type": null, "beneficiary_address": "Av. Presidente Vargas, 633, sala 1716, Centro, Rio de Janeiro, RJ, 20071004", "cancellation_reason": null, "customer_ignore_sms": false, "discount_limit_date": null, "discount_percentage": null, "document_type_label": "DM", "guarantor_city_name": null, "interest_percentage": null, "registration_status": "pending", "bank_billet_payments": [], "beneficiary_cnpj_cpf": "05.813.794/0001-26", "customer_person_name": "José da Silva", "interest_daily_value": null, "prevent_registration": false, "processed_our_number": "00400349", "reduction_percentage": null, "third_discount_value": null, "bank_billet_layout_id": null, "customer_ignore_email": null, "customer_neighborhood": "São Francisco", "customer_phone_number": "2199999999", "days_for_negativation": null, "late_payment_interest": null, "second_discount_value": null, "bank_billet_account_id": 67, "bank_billet_discharges": [], "custom_attachment_name": null, "customer_mobile_number": null, "divergent_payment_type": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "bank_billet_remittances": [], "customer_address_number": "111", "customer_contact_person": null, "days_for_third_discount": null, "divergent_payment_limit": null, "password_protected_mode": null, "customer_subscription_id": null, "days_for_second_discount": null, "guarantor_address_number": null, "processed_our_number_raw": "00400349", "bank_billet_registrations": [], "beneficiary_assignor_code": "4327 / 0229385", "interest_daily_percentage": null, "third_discount_percentage": null, "bank_billet_split_accounts": [], "customer_mobile_local_code": null, "second_discount_percentage": null, "customer_address_complement": "709", "interest_monthly_percentage": null, "divergent_payment_value_type": null, "guarantor_address_complement": null, "financial_provider_external_id": null, "divergent_payment_maximum_value": null, "divergent_payment_minimum_value": null, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null } }, "occurred_at": "2020-06-15T07:00:00-05:00", "created_at": "2020-06-15T07:00:00-05:00", "updated_at": "2020-06-15T07:00:00-05:00" }, { "resource_owner": { "uid": "01a06d8e-91f8-7333-900f-2bd670d96793", "type": "bank_billet" }, "resource_base": { "uid": "01a06d8e-91f8-7333-900f-2bd670d96793", "type": "bank_billet" }, "uid": "01a06d8e-920c-7e47-a641-5dcb634d1b5c", "code": "ping", "data": { "object": { "id": 39, "pix": [], "uid": "01a06d8e-91f8-7333-900f-2bd670d96793", "url": "http://dev.bole.to:5001/2/qdb", "line": "75691.43279 01022.938508 04003.560010 5 82900000005000", "meta": null, "tags": [ "tag 1", "tag2", "tag 3" ], "notes": null, "addons": null, "amount": 50.0, "extra1": "0229385", "extra2": null, "status": "generating", "barcode": "75695829000000050001432701022938500400356001", "formats": { "pdf": "http://dev.bole.to:5001/2/qdb.pdf", "png": "http://dev.bole.to:5001/2/qdb.png", "line": "http://dev.bole.to:5001/2/qdb/line", "letter": "http://dev.bole.to:5001/2/qdb/letter", "recibo": "http://dev.bole.to:5001/2/qdb/recibo", "barcode": "http://dev.bole.to:5001/2/qdb/barcode", "default": "http://dev.bole.to:5001/2/qdb", "envelope": "http://dev.bole.to:5001/2/qdb/envelope", "boleto_pix": null, "pix_qrcode": null, "boleto_hibrido": "http://dev.bole.to:5001/2/qdb/boleto_hibrido" }, "paid_at": null, "payments": [], "pix_txid": null, "sue_code": null, "tag_list": "tag 1,tag2,tag 3", "url_hash": "qdb", "carne_url": null, "expire_at": "2020-06-18", "fine_type": 0, "import_id": null, "issued_at": "2020-06-15T07:00:00-05:00", "acceptance": "N", "created_at": "2020-06-15T07:00:00-05:00", "fine_value": null, "ignore_sms": false, "our_number": "40035", "pix_qrcode": null, "revoked_at": null, "updated_at": "2020-06-15T07:00:00-05:00", "cancel_type": null, "charge_type": 1, "custom_data": null, "customer_id": 60, "description": "Serviço de criação de site\\r\\nExpira em: 18/06/2020", "external_id": null, "paid_amount": null, "pix_enabled": false, "prevent_pix": false, "revoke_code": null, "shorten_url": "http://dev.bole.to:5001/2/qdb", "sue_history": [], "after_create": [], "agency_digit": "3", "days_for_sue": null, "extra1_digit": null, "extra2_digit": null, "ignore_email": false, "instructions": null, "account_digit": "8", "agency_number": "4327", "credit_bureau": null, "days_for_fine": null, "discount_type": 0, "dispatch_type": 1, "document_date": null, "document_type": "02", "interest_type": 0, "payment_count": 1, "payment_place": "Pagável em qualquer banco até a data de vencimento.", "registered_at": null, "split_payment": false, "account_number": "00003666", "control_number": null, "customer_email": "cliente@example.com", "customer_notes": null, "customer_state": "RJ", "discount_value": null, "fine_for_delay": null, "guarantor_name": null, "installment_id": null, "interest_value": null, "reduction_type": 3, "created_via_api": false, "days_for_revoke": null, "document_number": null, "fine_percentage": null, "guarantor_state": null, "ignore_whatsapp": false, "beneficiary_name": "Kobana Tecnologia Ltda.", "customer_address": "Av. Burkhard Hehn Simões", "customer_zipcode": "24360440", "reduction_amount": null, "customer_cnpj_cpf": "399.881.072-26", "customer_email_cc": "john_cc@example.com", "customer_nickname": null, "days_for_discount": null, "days_for_interest": null, "days_for_sue_type": null, "first_instruction": null, "guarantor_address": null, "guarantor_zipcode": null, "installment_total": null, "instructions_mode": 1, "recipient_account": null, "bank_contract_slug": "sicoob-01", "customer_city_name": "Rio de Janeiro", "guarantor_cnpj_cpf": null, "installment_number": null, "interest_days_type": 0, "second_instruction": null, "split_payment_type": null, "beneficiary_address": "Av. Presidente Vargas, 633, sala 1716, Centro, Rio de Janeiro, RJ, 20071004", "cancellation_reason": null, "customer_ignore_sms": false, "discount_limit_date": null, "discount_percentage": null, "document_type_label": "DM", "guarantor_city_name": null, "interest_percentage": null, "registration_status": "pending", "bank_billet_payments": [], "beneficiary_cnpj_cpf": "05.813.794/0001-26", "customer_person_name": "José da Silva", "interest_daily_value": null, "prevent_registration": false, "processed_our_number": "00400356", "reduction_percentage": null, "third_discount_value": null, "bank_billet_layout_id": null, "customer_ignore_email": null, "customer_neighborhood": "São Francisco", "customer_phone_number": "2199999999", "days_for_negativation": null, "late_payment_interest": null, "second_discount_value": null, "bank_billet_account_id": 68, "bank_billet_discharges": [], "custom_attachment_name": null, "customer_mobile_number": null, "divergent_payment_type": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "bank_billet_remittances": [], "customer_address_number": "111", "customer_contact_person": null, "days_for_third_discount": null, "divergent_payment_limit": null, "password_protected_mode": null, "customer_subscription_id": null, "days_for_second_discount": null, "guarantor_address_number": null, "processed_our_number_raw": "00400356", "bank_billet_registrations": [], "beneficiary_assignor_code": "4327 / 0229385", "interest_daily_percentage": null, "third_discount_percentage": null, "bank_billet_split_accounts": [], "customer_mobile_local_code": null, "second_discount_percentage": null, "customer_address_complement": "709", "interest_monthly_percentage": null, "divergent_payment_value_type": null, "guarantor_address_complement": null, "financial_provider_external_id": null, "divergent_payment_maximum_value": null, "divergent_payment_minimum_value": null, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null } }, "occurred_at": "2020-06-15T07:00:00-05:00", "created_at": "2020-06-15T07:00:00-05:00", "updated_at": "2020-06-15T07:00:00-05:00" }, { "resource_owner": { "uid": "01a06d8e-9232-7284-8262-b6e6b4a5ee92", "type": "bank_billet" }, "resource_base": { "uid": "01a06d8e-9232-7284-8262-b6e6b4a5ee92", "type": "bank_billet" }, "uid": "01a06d8e-924b-7e39-a6a7-56266fed4fc6", "code": "ping", "data": { "object": { "id": 40, "pix": [], "uid": "01a06d8e-9232-7284-8262-b6e6b4a5ee92", "url": "http://dev.bole.to:5001/2/xzr", "line": "75691.43279 01022.938508 04003.630011 3 82900000005000", "meta": null, "tags": [ "tag 1", "tag2", "tag 3" ], "notes": null, "addons": null, "amount": 50.0, "extra1": "0229385", "extra2": null, "status": "generating", "barcode": "75693829000000050001432701022938500400363001", "formats": { "pdf": "http://dev.bole.to:5001/2/xzr.pdf", "png": "http://dev.bole.to:5001/2/xzr.png", "line": "http://dev.bole.to:5001/2/xzr/line", "letter": "http://dev.bole.to:5001/2/xzr/letter", "recibo": "http://dev.bole.to:5001/2/xzr/recibo", "barcode": "http://dev.bole.to:5001/2/xzr/barcode", "default": "http://dev.bole.to:5001/2/xzr", "envelope": "http://dev.bole.to:5001/2/xzr/envelope", "boleto_pix": null, "pix_qrcode": null, "boleto_hibrido": "http://dev.bole.to:5001/2/xzr/boleto_hibrido" }, "paid_at": null, "payments": [], "pix_txid": null, "sue_code": null, "tag_list": "tag 1,tag2,tag 3", "url_hash": "xzr", "carne_url": null, "expire_at": "2020-06-18", "fine_type": 0, "import_id": null, "issued_at": "2020-06-15T07:00:00-05:00", "acceptance": "N", "created_at": "2020-06-15T07:00:00-05:00", "fine_value": null, "ignore_sms": false, "our_number": "40036", "pix_qrcode": null, "revoked_at": null, "updated_at": "2020-06-15T07:00:00-05:00", "cancel_type": null, "charge_type": 1, "custom_data": null, "customer_id": 61, "description": "Serviço de criação de site\\r\\nExpira em: 18/06/2020", "external_id": null, "paid_amount": null, "pix_enabled": false, "prevent_pix": false, "revoke_code": null, "shorten_url": "http://dev.bole.to:5001/2/xzr", "sue_history": [], "after_create": [], "agency_digit": "3", "days_for_sue": null, "extra1_digit": null, "extra2_digit": null, "ignore_email": false, "instructions": null, "account_digit": "8", "agency_number": "4327", "credit_bureau": null, "days_for_fine": null, "discount_type": 0, "dispatch_type": 1, "document_date": null, "document_type": "02", "interest_type": 0, "payment_count": 1, "payment_place": "Pagável em qualquer banco até a data de vencimento.", "registered_at": null, "split_payment": false, "account_number": "00003666", "control_number": null, "customer_email": "cliente@example.com", "customer_notes": null, "customer_state": "RJ", "discount_value": null, "fine_for_delay": null, "guarantor_name": null, "installment_id": null, "interest_value": null, "reduction_type": 3, "created_via_api": false, "days_for_revoke": null, "document_number": null, "fine_percentage": null, "guarantor_state": null, "ignore_whatsapp": false, "beneficiary_name": "Kobana Tecnologia Ltda.", "customer_address": "Av. Burkhard Hehn Simões", "customer_zipcode": "24360440", "reduction_amount": null, "customer_cnpj_cpf": "399.881.072-26", "customer_email_cc": "john_cc@example.com", "customer_nickname": null, "days_for_discount": null, "days_for_interest": null, "days_for_sue_type": null, "first_instruction": null, "guarantor_address": null, "guarantor_zipcode": null, "installment_total": null, "instructions_mode": 1, "recipient_account": null, "bank_contract_slug": "sicoob-01", "customer_city_name": "Rio de Janeiro", "guarantor_cnpj_cpf": null, "installment_number": null, "interest_days_type": 0, "second_instruction": null, "split_payment_type": null, "beneficiary_address": "Av. Presidente Vargas, 633, sala 1716, Centro, Rio de Janeiro, RJ, 20071004", "cancellation_reason": null, "customer_ignore_sms": false, "discount_limit_date": null, "discount_percentage": null, "document_type_label": "DM", "guarantor_city_name": null, "interest_percentage": null, "registration_status": "pending", "bank_billet_payments": [], "beneficiary_cnpj_cpf": "05.813.794/0001-26", "customer_person_name": "José da Silva", "interest_daily_value": null, "prevent_registration": false, "processed_our_number": "00400363", "reduction_percentage": null, "third_discount_value": null, "bank_billet_layout_id": null, "customer_ignore_email": null, "customer_neighborhood": "São Francisco", "customer_phone_number": "2199999999", "days_for_negativation": null, "late_payment_interest": null, "second_discount_value": null, "bank_billet_account_id": 69, "bank_billet_discharges": [], "custom_attachment_name": null, "customer_mobile_number": null, "divergent_payment_type": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "bank_billet_remittances": [], "customer_address_number": "111", "customer_contact_person": null, "days_for_third_discount": null, "divergent_payment_limit": null, "password_protected_mode": null, "customer_subscription_id": null, "days_for_second_discount": null, "guarantor_address_number": null, "processed_our_number_raw": "00400363", "bank_billet_registrations": [], "beneficiary_assignor_code": "4327 / 0229385", "interest_daily_percentage": null, "third_discount_percentage": null, "bank_billet_split_accounts": [], "customer_mobile_local_code": null, "second_discount_percentage": null, "customer_address_complement": "709", "interest_monthly_percentage": null, "divergent_payment_value_type": null, "guarantor_address_complement": null, "financial_provider_external_id": null, "divergent_payment_maximum_value": null, "divergent_payment_minimum_value": null, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null } }, "occurred_at": "2020-06-15T07:00:00-05:00", "created_at": "2020-06-15T07:00:00-05:00", "updated_at": "2020-06-15T07:00:00-05:00" }, { "resource_owner": { "uid": "01a06d8e-9273-7519-9991-45a1354d8de7", "type": "bank_billet" }, "resource_base": { "uid": "01a06d8e-9273-7519-9991-45a1354d8de7", "type": "bank_billet" }, "uid": "01a06d8e-9288-7b06-8ef9-a5b5f0625f2e", "code": "ping", "data": { "object": { "id": 41, "pix": [], "uid": "01a06d8e-9273-7519-9991-45a1354d8de7", "url": "http://dev.bole.to:5001/2/rgn", "line": "75691.43279 01022.938508 04003.700012 1 82900000005000", "meta": null, "tags": [ "tag 1", "tag2", "tag 3" ], "notes": null, "addons": null, "amount": 50.0, "extra1": "0229385", "extra2": null, "status": "generating", "barcode": "75691829000000050001432701022938500400370001", "formats": { "pdf": "http://dev.bole.to:5001/2/rgn.pdf", "png": "http://dev.bole.to:5001/2/rgn.png", "line": "http://dev.bole.to:5001/2/rgn/line", "letter": "http://dev.bole.to:5001/2/rgn/letter", "recibo": "http://dev.bole.to:5001/2/rgn/recibo", "barcode": "http://dev.bole.to:5001/2/rgn/barcode", "default": "http://dev.bole.to:5001/2/rgn", "envelope": "http://dev.bole.to:5001/2/rgn/envelope", "boleto_pix": null, "pix_qrcode": null, "boleto_hibrido": "http://dev.bole.to:5001/2/rgn/boleto_hibrido" }, "paid_at": null, "payments": [], "pix_txid": null, "sue_code": null, "tag_list": "tag 1,tag2,tag 3", "url_hash": "rgn", "carne_url": null, "expire_at": "2020-06-18", "fine_type": 0, "import_id": null, "issued_at": "2020-06-15T07:00:00-05:00", "acceptance": "N", "created_at": "2020-06-15T07:00:00-05:00", "fine_value": null, "ignore_sms": false, "our_number": "40037", "pix_qrcode": null, "revoked_at": null, "updated_at": "2020-06-15T07:00:00-05:00", "cancel_type": null, "charge_type": 1, "custom_data": null, "customer_id": 62, "description": "Serviço de criação de site\\r\\nExpira em: 18/06/2020", "external_id": null, "paid_amount": null, "pix_enabled": false, "prevent_pix": false, "revoke_code": null, "shorten_url": "http://dev.bole.to:5001/2/rgn", "sue_history": [], "after_create": [], "agency_digit": "3", "days_for_sue": null, "extra1_digit": null, "extra2_digit": null, "ignore_email": false, "instructions": null, "account_digit": "8", "agency_number": "4327", "credit_bureau": null, "days_for_fine": null, "discount_type": 0, "dispatch_type": 1, "document_date": null, "document_type": "02", "interest_type": 0, "payment_count": 1, "payment_place": "Pagável em qualquer banco até a data de vencimento.", "registered_at": null, "split_payment": false, "account_number": "00003666", "control_number": null, "customer_email": "cliente@example.com", "customer_notes": null, "customer_state": "RJ", "discount_value": null, "fine_for_delay": null, "guarantor_name": null, "installment_id": null, "interest_value": null, "reduction_type": 3, "created_via_api": false, "days_for_revoke": null, "document_number": null, "fine_percentage": null, "guarantor_state": null, "ignore_whatsapp": false, "beneficiary_name": "Kobana Tecnologia Ltda.", "customer_address": "Av. Burkhard Hehn Simões", "customer_zipcode": "24360440", "reduction_amount": null, "customer_cnpj_cpf": "399.881.072-26", "customer_email_cc": "john_cc@example.com", "customer_nickname": null, "days_for_discount": null, "days_for_interest": null, "days_for_sue_type": null, "first_instruction": null, "guarantor_address": null, "guarantor_zipcode": null, "installment_total": null, "instructions_mode": 1, "recipient_account": null, "bank_contract_slug": "sicoob-01", "customer_city_name": "Rio de Janeiro", "guarantor_cnpj_cpf": null, "installment_number": null, "interest_days_type": 0, "second_instruction": null, "split_payment_type": null, "beneficiary_address": "Av. Presidente Vargas, 633, sala 1716, Centro, Rio de Janeiro, RJ, 20071004", "cancellation_reason": null, "customer_ignore_sms": false, "discount_limit_date": null, "discount_percentage": null, "document_type_label": "DM", "guarantor_city_name": null, "interest_percentage": null, "registration_status": "pending", "bank_billet_payments": [], "beneficiary_cnpj_cpf": "05.813.794/0001-26", "customer_person_name": "José da Silva", "interest_daily_value": null, "prevent_registration": false, "processed_our_number": "00400370", "reduction_percentage": null, "third_discount_value": null, "bank_billet_layout_id": null, "customer_ignore_email": null, "customer_neighborhood": "São Francisco", "customer_phone_number": "2199999999", "days_for_negativation": null, "late_payment_interest": null, "second_discount_value": null, "bank_billet_account_id": 70, "bank_billet_discharges": [], "custom_attachment_name": null, "customer_mobile_number": null, "divergent_payment_type": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "bank_billet_remittances": [], "customer_address_number": "111", "customer_contact_person": null, "days_for_third_discount": null, "divergent_payment_limit": null, "password_protected_mode": null, "customer_subscription_id": null, "days_for_second_discount": null, "guarantor_address_number": null, "processed_our_number_raw": "00400370", "bank_billet_registrations": [], "beneficiary_assignor_code": "4327 / 0229385", "interest_daily_percentage": null, "third_discount_percentage": null, "bank_billet_split_accounts": [], "customer_mobile_local_code": null, "second_discount_percentage": null, "customer_address_complement": "709", "interest_monthly_percentage": null, "divergent_payment_value_type": null, "guarantor_address_complement": null, "financial_provider_external_id": null, "divergent_payment_maximum_value": null, "divergent_payment_minimum_value": null, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null } }, "occurred_at": "2020-06-15T07:00:00-05:00", "created_at": "2020-06-15T07:00:00-05:00", "updated_at": "2020-06-15T07:00:00-05:00" } ], "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1_event_object" } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "400": { "description": "Intervalo de datas excede o limite máximo de 60 dias", "content": { "application/json": { "example": { "error": "O intervalo de datas não pode ser maior que 60 dias. Por favor, ajuste seu filtro." }, "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "O intervalo de datas não pode ser maior que 60 dias. Por favor, ajuste seu filtro." } } } } } } } } }, "/v1/events/{id}": { "get": { "summary": "Informações do Evento", "tags": [ "Eventos" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de um Evento.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "UID do Evento (UUID)", "example": "e596865f-07a4-4458-88c1-fbb4ffd196e1", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Evento encontrado com sucesso", "content": { "application/json": { "example": { "resource_owner": { "uid": "01a06d8e-9361-71c3-8130-b525ccaaec23", "type": "bank_billet" }, "resource_base": { "uid": "01a06d8e-9361-71c3-8130-b525ccaaec23", "type": "bank_billet" }, "uid": "01a06d8e-9374-7a93-b0b7-177c4f2f2a30", "code": "ping", "data": { "object": { "id": 42, "pix": [], "uid": "01a06d8e-9361-71c3-8130-b525ccaaec23", "url": "http://dev.bole.to:5001/2/ejv", "line": "75691.43279 01022.938508 04003.880012 1 82900000005000", "meta": null, "tags": [ "tag 1", "tag2", "tag 3" ], "notes": null, "addons": null, "amount": 50.0, "extra1": "0229385", "extra2": null, "status": "generating", "barcode": "75691829000000050001432701022938500400388001", "formats": { "pdf": "http://dev.bole.to:5001/2/ejv.pdf", "png": "http://dev.bole.to:5001/2/ejv.png", "line": "http://dev.bole.to:5001/2/ejv/line", "letter": "http://dev.bole.to:5001/2/ejv/letter", "recibo": "http://dev.bole.to:5001/2/ejv/recibo", "barcode": "http://dev.bole.to:5001/2/ejv/barcode", "default": "http://dev.bole.to:5001/2/ejv", "envelope": "http://dev.bole.to:5001/2/ejv/envelope", "boleto_pix": null, "pix_qrcode": null, "boleto_hibrido": "http://dev.bole.to:5001/2/ejv/boleto_hibrido" }, "paid_at": null, "payments": [], "pix_txid": null, "sue_code": null, "tag_list": "tag 1,tag2,tag 3", "url_hash": "ejv", "carne_url": null, "expire_at": "2020-06-18", "fine_type": 0, "import_id": null, "issued_at": "2020-06-15T07:00:00-05:00", "acceptance": "N", "created_at": "2020-06-15T07:00:00-05:00", "fine_value": null, "ignore_sms": false, "our_number": "40038", "pix_qrcode": null, "revoked_at": null, "updated_at": "2020-06-15T07:00:00-05:00", "cancel_type": null, "charge_type": 1, "custom_data": null, "customer_id": 63, "description": "Serviço de criação de site\\r\\nExpira em: 18/06/2020", "external_id": null, "paid_amount": null, "pix_enabled": false, "prevent_pix": false, "revoke_code": null, "shorten_url": "http://dev.bole.to:5001/2/ejv", "sue_history": [], "after_create": [], "agency_digit": "3", "days_for_sue": null, "extra1_digit": null, "extra2_digit": null, "ignore_email": false, "instructions": null, "account_digit": "8", "agency_number": "4327", "credit_bureau": null, "days_for_fine": null, "discount_type": 0, "dispatch_type": 1, "document_date": null, "document_type": "02", "interest_type": 0, "payment_count": 1, "payment_place": "Pagável em qualquer banco até a data de vencimento.", "registered_at": null, "split_payment": false, "account_number": "00003666", "control_number": null, "customer_email": "cliente@example.com", "customer_notes": null, "customer_state": "RJ", "discount_value": null, "fine_for_delay": null, "guarantor_name": null, "installment_id": null, "interest_value": null, "reduction_type": 3, "created_via_api": false, "days_for_revoke": null, "document_number": null, "fine_percentage": null, "guarantor_state": null, "ignore_whatsapp": false, "beneficiary_name": "Kobana Tecnologia Ltda.", "customer_address": "Av. Burkhard Hehn Simões", "customer_zipcode": "24360440", "reduction_amount": null, "customer_cnpj_cpf": "399.881.072-26", "customer_email_cc": "john_cc@example.com", "customer_nickname": null, "days_for_discount": null, "days_for_interest": null, "days_for_sue_type": null, "first_instruction": null, "guarantor_address": null, "guarantor_zipcode": null, "installment_total": null, "instructions_mode": 1, "recipient_account": null, "bank_contract_slug": "sicoob-01", "customer_city_name": "Rio de Janeiro", "guarantor_cnpj_cpf": null, "installment_number": null, "interest_days_type": 0, "second_instruction": null, "split_payment_type": null, "beneficiary_address": "Av. Presidente Vargas, 633, sala 1716, Centro, Rio de Janeiro, RJ, 20071004", "cancellation_reason": null, "customer_ignore_sms": false, "discount_limit_date": null, "discount_percentage": null, "document_type_label": "DM", "guarantor_city_name": null, "interest_percentage": null, "registration_status": "pending", "bank_billet_payments": [], "beneficiary_cnpj_cpf": "05.813.794/0001-26", "customer_person_name": "José da Silva", "interest_daily_value": null, "prevent_registration": false, "processed_our_number": "00400388", "reduction_percentage": null, "third_discount_value": null, "bank_billet_layout_id": null, "customer_ignore_email": null, "customer_neighborhood": "São Francisco", "customer_phone_number": "2199999999", "days_for_negativation": null, "late_payment_interest": null, "second_discount_value": null, "bank_billet_account_id": 71, "bank_billet_discharges": [], "custom_attachment_name": null, "customer_mobile_number": null, "divergent_payment_type": null, "guarantor_neighborhood": null, "guarantor_phone_number": null, "bank_billet_remittances": [], "customer_address_number": "111", "customer_contact_person": null, "days_for_third_discount": null, "divergent_payment_limit": null, "password_protected_mode": null, "customer_subscription_id": null, "days_for_second_discount": null, "guarantor_address_number": null, "processed_our_number_raw": "00400388", "bank_billet_registrations": [], "beneficiary_assignor_code": "4327 / 0229385", "interest_daily_percentage": null, "third_discount_percentage": null, "bank_billet_split_accounts": [], "customer_mobile_local_code": null, "second_discount_percentage": null, "customer_address_complement": "709", "interest_monthly_percentage": null, "divergent_payment_value_type": null, "guarantor_address_complement": null, "financial_provider_external_id": null, "divergent_payment_maximum_value": null, "divergent_payment_minimum_value": null, "divergent_payment_maximum_percentage": null, "divergent_payment_minimum_percentage": null } }, "occurred_at": "2020-06-15T07:00:00-05:00", "created_at": "2020-06-15T07:00:00-05:00", "updated_at": "2020-06-15T07:00:00-05:00" }, "schema": { "$ref": "#/components/schemas/v1_event_object" } } } }, "404": { "description": "Evento não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/sms_deliveries": { "get": { "summary": "Listar SMS Enviados", "tags": [ "Histórico de SMS" ], "security": [ { "bearerAuth": [] } ], "description": "Listar SMS enviados", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "resource_owner_id", "in": "query", "description": "ID do objeto que gerou o evento. Ex. ID do boleto.", "required": false, "schema": { "type": "integer" } }, { "name": "event_code", "in": "query", "description": "Código do evento.", "required": false, "schema": { "type": "string", "enum": [ "ping", "access_token.db.created", "access_token.db.updated", "access_token.db.deleted", "access_token.reminder", "access_token.expired", "account.updated", "account.blocked", "account.bank_billet_creation_blocked", "bank_billet.created", "bank_billet.updated", "bank_billet.generated", "bank_billet.canceled", "bank_billet.blocked", "bank_billet.overdue", "bank_billet.paid", "bank_billet.due_date", "bank_billet.rejected", "bank_billet.cancel.requested", "bank_billet.cancel.confirmed", "bank_billet.cancel.failed", "bank_billet.cancel.error", "bank_billet.register.requested", "bank_billet.register.confirmed", "bank_billet.register.failed", "bank_billet.register.error", "bank_billet.update.requested", "bank_billet.update.confirmed", "bank_billet.update.failed", "bank_billet.update.error", "bank_billet.registered", "bank_billet.deleted", "bank_billet.sync.requested", "bank_billet.sync.confirmed", "bank_billet.sync.failed", "bank_billet.sync.error", "bank_billet.get.requested", "bank_billet.get.confirmed", "bank_billet.get.failed", "bank_billet.get.error", "bank_billet.get_child.requested", "bank_billet.get_child.confirmed", "bank_billet.get_child.failed", "bank_billet.get_child.error", "bank_billet.find.requested", "bank_billet.find.confirmed", "bank_billet.find.failed", "bank_billet.find.error", "bank_billet.add_pix.requested", "bank_billet.add_pix.confirmed", "bank_billet.add_pix.failed", "bank_billet.add_pix.error", "bank_billet.get_pix.requested", "bank_billet.get_pix.confirmed", "bank_billet.get_pix.failed", "bank_billet.get_pix.error", "bank_billet.protest.requested", "bank_billet.protest.confirmed", "bank_billet.protest.failed", "bank_billet.protest.error", "bank_billet_discharge.created", "bank_billet_discharge.updated", "bank_billet_discharge.deleted", "bank_billet_remittance.created", "bank_billet_remittance.updated", "bank_billet_remittance.deleted", "bank_billet_registration.created", "bank_billet_registration.updated", "bank_billet_registration.deleted", "bank_billet_payment.created", "bank_billet_payment.updated", "bank_billet_payment.deleted", "customer.created", "customer.updated", "customer.portal_password_updated", "customer.deleted", "transaction.created", "transaction.updated", "transaction.processed", "withdrawal.transferred", "withdrawal.requested", "addon.activated", "addon.removed", "plan_subscription.activated", "plan_subscription.removed", "plan_subscription.fee", "plan_subscription.updated", "user.created", "user.updated", "user.deleted", "remittance.created", "remittance.processed", "remittance.downloaded", "remittance.sent", "remittance.deleted", "remittance.line.db.created", "remittance.line.db.updated", "remittance.line.db.deleted", "discharge.created", "discharge.processed", "discharge.deleted", "bank_billet_account.created", "bank_billet_account.homologated", "bank_billet_account.homologation_failed", "bank_billet_account.homologation_started", "bank_billet_account.validated", "bank_billet_account.validation_released", "bank_billet_account.activated", "bank_billet_account.updated", "bank_billet_account.deleted", "edi.remittance_line.created", "edi.remittance_line.updated", "edi.remittance_line.deleted", "edi.edi_box.activated", "edi.edi_box.db.created", "edi.edi_box.db.deleted", "edi.edi_box.db.updated", "edi.edi_box.generated", "edi.edi_box.demand_received", "edi.edi_box.confirming_at_bank", "edi.edi_box.testing_by_customer", "edi.edi_box.waiting_for_validations", "customer_subscription.created", "customer_subscription.updated", "customer_subscription.deleted", "installment.created", "installment.processed", "installment.generated", "installment.deleted", "import.created", "import.processed", "import.deleted", "export.db.created", "export.db.updated", "export.db.deleted", "pix.db.created", "pix.db.updated", "pix.db.deleted", "pix.register.requested", "pix.register.confirmed", "pix.register.failed", "pix.register.error", "pix.update.requested", "pix.update.confirmed", "pix.update.failed", "pix.update.error", "pix.paid", "pix.overdue", "pix.cancel.requested", "pix.cancel.confirmed", "pix.cancel.failed", "pix.cancel.error", "pix.sync.requested", "pix.sync.confirmed", "pix.sync.failed", "pix.sync.error", "pix.get.requested", "pix.get.confirmed", "pix.get.failed", "pix.get.error", "financial.account.balance_sync.requested", "financial.account.balance_sync.confirmed", "financial.account.balance_sync.failed", "financial.account.balance_sync.error", "financial.account.statement_sync.requested", "financial.account.statement_sync.confirmed", "financial.account.statement_sync.failed", "financial.account.statement_sync.error", "financial.account.db.created", "financial.account.db.updated", "financial.account.db.deleted", "financial.account.statement.updated", "financial.account.balance.updated", "financial.account_balance.db.created", "transfer.batch.db.created", "transfer.batch.db.updated", "transfer.batch.db.deleted", "transfer.batch.awaiting_approval", "transfer.pix_batch.awaiting_approval", "transfer.pix_batch.get.requested", "transfer.pix_batch.get.confirmed", "transfer.pix_batch.get.failed", "transfer.pix_batch.get.error", "transfer.pix_batch.sync.requested", "transfer.pix_batch.sync.confirmed", "transfer.pix_batch.sync.failed", "transfer.pix_batch.sync.error", "transfer.pix_batch.register.requested", "transfer.pix_batch.register.confirmed", "transfer.pix_batch.register.failed", "transfer.pix_batch.register.error", "transfer.pix_batch.approve.requested", "transfer.pix_batch.approve.confirmed", "transfer.pix_batch.approve.failed", "transfer.pix_batch.approve.error", "transfer.pix_batch.reprove.requested", "transfer.pix_batch.reprove.confirmed", "transfer.pix_batch.reprove.failed", "transfer.pix_batch.reprove.error", "transfer.pix_batch.cancel.requested", "transfer.pix_batch.cancel.confirmed", "transfer.pix_batch.cancel.failed", "transfer.pix_batch.cancel.error", "transfer.ted_batch.awaiting_approval", "transfer.ted_batch.get.requested", "transfer.ted_batch.get.confirmed", "transfer.ted_batch.get.failed", "transfer.ted_batch.get.error", "transfer.ted_batch.sync.requested", "transfer.ted_batch.sync.confirmed", "transfer.ted_batch.sync.failed", "transfer.ted_batch.sync.error", "transfer.ted_batch.register.requested", "transfer.ted_batch.register.confirmed", "transfer.ted_batch.register.failed", "transfer.ted_batch.register.error", "transfer.ted_batch.approve.requested", "transfer.ted_batch.approve.confirmed", "transfer.ted_batch.approve.failed", "transfer.ted_batch.approve.error", "transfer.ted_batch.reprove.requested", "transfer.ted_batch.reprove.confirmed", "transfer.ted_batch.reprove.failed", "transfer.ted_batch.reprove.error", "transfer.ted_batch.cancel.requested", "transfer.ted_batch.cancel.confirmed", "transfer.ted_batch.cancel.failed", "transfer.ted_batch.cancel.error", "transfer.internal_batch.awaiting_approval", "transfer.internal_batch.get.requested", "transfer.internal_batch.get.confirmed", "transfer.internal_batch.get.failed", "transfer.internal_batch.get.error", "transfer.internal_batch.sync.requested", "transfer.internal_batch.sync.confirmed", "transfer.internal_batch.sync.failed", "transfer.internal_batch.sync.error", "transfer.internal_batch.register.requested", "transfer.internal_batch.register.confirmed", "transfer.internal_batch.register.failed", "transfer.internal_batch.register.error", "transfer.internal_batch.approve.requested", "transfer.internal_batch.approve.confirmed", "transfer.internal_batch.approve.failed", "transfer.internal_batch.approve.error", "transfer.internal_batch.reprove.requested", "transfer.internal_batch.reprove.confirmed", "transfer.internal_batch.reprove.failed", "transfer.internal_batch.reprove.error", "transfer.internal_batch.cancel.requested", "transfer.internal_batch.cancel.confirmed", "transfer.internal_batch.cancel.failed", "transfer.internal_batch.cancel.error", "transfer.db.created", "transfer.db.updated", "transfer.db.deleted", "transfer.pix.register.requested", "transfer.pix.register.confirmed", "transfer.pix.register.failed", "transfer.pix.register.error", "transfer.pix.reschedule.requested", "transfer.pix.reschedule.confirmed", "transfer.pix.reschedule.failed", "transfer.pix.reschedule.error", "transfer.pix.approve.requested", "transfer.pix.approve.confirmed", "transfer.pix.approve.failed", "transfer.pix.approve.error", "transfer.pix.reprove.requested", "transfer.pix.reprove.confirmed", "transfer.pix.reprove.failed", "transfer.pix.reprove.error", "transfer.pix.cancel.requested", "transfer.pix.cancel.confirmed", "transfer.pix.cancel.failed", "transfer.pix.cancel.error", "transfer.pix.get.requested", "transfer.pix.get.confirmed", "transfer.pix.get.failed", "transfer.pix.get.error", "transfer.pix.sync.requested", "transfer.pix.sync.confirmed", "transfer.pix.sync.failed", "transfer.pix.sync.error", "transfer.ted.register.requested", "transfer.ted.register.confirmed", "transfer.ted.register.failed", "transfer.ted.register.error", "transfer.ted.reschedule.requested", "transfer.ted.reschedule.confirmed", "transfer.ted.reschedule.failed", "transfer.ted.reschedule.error", "transfer.ted.approve.requested", "transfer.ted.approve.confirmed", "transfer.ted.approve.failed", "transfer.ted.approve.error", "transfer.ted.reprove.requested", "transfer.ted.reprove.confirmed", "transfer.ted.reprove.failed", "transfer.ted.reprove.error", "transfer.ted.cancel.requested", "transfer.ted.cancel.confirmed", "transfer.ted.cancel.failed", "transfer.ted.cancel.error", "transfer.ted.get.requested", "transfer.ted.get.confirmed", "transfer.ted.get.failed", "transfer.ted.get.error", "transfer.ted.sync.requested", "transfer.ted.sync.confirmed", "transfer.ted.sync.failed", "transfer.ted.sync.error", "transfer.internal.register.requested", "transfer.internal.register.confirmed", "transfer.internal.register.failed", "transfer.internal.register.error", "transfer.internal.reschedule.requested", "transfer.internal.reschedule.confirmed", "transfer.internal.reschedule.failed", "transfer.internal.reschedule.error", "transfer.internal.approve.requested", "transfer.internal.approve.confirmed", "transfer.internal.approve.failed", "transfer.internal.approve.error", "transfer.internal.reprove.requested", "transfer.internal.reprove.confirmed", "transfer.internal.reprove.failed", "transfer.internal.reprove.error", "transfer.internal.cancel.requested", "transfer.internal.cancel.confirmed", "transfer.internal.cancel.failed", "transfer.internal.cancel.error", "transfer.internal.get.requested", "transfer.internal.get.confirmed", "transfer.internal.get.failed", "transfer.internal.get.error", "transfer.internal.sync.requested", "transfer.internal.sync.confirmed", "transfer.internal.sync.failed", "transfer.internal.sync.error", "payment.db.created", "payment.db.updated", "payment.db.deleted", "payment.bank_billet.register.requested", "payment.bank_billet.register.confirmed", "payment.bank_billet.register.failed", "payment.bank_billet.register.error", "payment.bank_billet.approve.requested", "payment.bank_billet.approve.confirmed", "payment.bank_billet.approve.failed", "payment.bank_billet.approve.error", "payment.bank_billet.reprove.requested", "payment.bank_billet.reprove.confirmed", "payment.bank_billet.reprove.failed", "payment.bank_billet.reprove.error", "payment.bank_billet.reschedule.requested", "payment.bank_billet.reschedule.confirmed", "payment.bank_billet.reschedule.failed", "payment.bank_billet.reschedule.error", "payment.bank_billet.cancel.requested", "payment.bank_billet.cancel.confirmed", "payment.bank_billet.cancel.failed", "payment.bank_billet.cancel.error", "payment.bank_billet.get.requested", "payment.bank_billet.get.confirmed", "payment.bank_billet.get.failed", "payment.bank_billet.get.error", "payment.bank_billet.sync.requested", "payment.bank_billet.sync.confirmed", "payment.bank_billet.sync.failed", "payment.bank_billet.sync.error", "payment.darf.register.requested", "payment.darf.register.confirmed", "payment.darf.register.failed", "payment.darf.register.error", "payment.darf.approve.requested", "payment.darf.approve.confirmed", "payment.darf.approve.failed", "payment.darf.approve.error", "payment.darf.reprove.requested", "payment.darf.reprove.confirmed", "payment.darf.reprove.failed", "payment.darf.reprove.error", "payment.darf.reschedule.requested", "payment.darf.reschedule.confirmed", "payment.darf.reschedule.failed", "payment.darf.reschedule.error", "payment.darf.cancel.requested", "payment.darf.cancel.confirmed", "payment.darf.cancel.failed", "payment.darf.cancel.error", "payment.darf.get.requested", "payment.darf.get.confirmed", "payment.darf.get.failed", "payment.darf.get.error", "payment.darf.sync.requested", "payment.darf.sync.confirmed", "payment.darf.sync.failed", "payment.darf.sync.error", "payment.utility.register.requested", "payment.utility.register.confirmed", "payment.utility.register.failed", "payment.utility.register.error", "payment.utility.approve.requested", "payment.utility.approve.confirmed", "payment.utility.approve.failed", "payment.utility.approve.error", "payment.utility.reprove.requested", "payment.utility.reprove.confirmed", "payment.utility.reprove.failed", "payment.utility.reprove.error", "payment.utility.reschedule.requested", "payment.utility.reschedule.confirmed", "payment.utility.reschedule.failed", "payment.utility.reschedule.error", "payment.utility.cancel.requested", "payment.utility.cancel.confirmed", "payment.utility.cancel.failed", "payment.utility.cancel.error", "payment.utility.get.requested", "payment.utility.get.confirmed", "payment.utility.get.failed", "payment.utility.get.error", "payment.utility.sync.requested", "payment.utility.sync.confirmed", "payment.utility.sync.failed", "payment.utility.sync.error", "payment.gru.register.requested", "payment.gru.register.confirmed", "payment.gru.register.failed", "payment.gru.register.error", "payment.gru.approve.requested", "payment.gru.approve.confirmed", "payment.gru.approve.failed", "payment.gru.approve.error", "payment.gru.reprove.requested", "payment.gru.reprove.confirmed", "payment.gru.reprove.failed", "payment.gru.reprove.error", "payment.gru.reschedule.requested", "payment.gru.reschedule.confirmed", "payment.gru.reschedule.failed", "payment.gru.reschedule.error", "payment.gru.cancel.requested", "payment.gru.cancel.confirmed", "payment.gru.cancel.failed", "payment.gru.cancel.error", "payment.gru.get.requested", "payment.gru.get.confirmed", "payment.gru.get.failed", "payment.gru.get.error", "payment.gru.sync.requested", "payment.gru.sync.confirmed", "payment.gru.sync.failed", "payment.gru.sync.error", "payment.pix.register.requested", "payment.pix.register.confirmed", "payment.pix.register.failed", "payment.pix.register.error", "payment.pix.approve.requested", "payment.pix.approve.confirmed", "payment.pix.approve.failed", "payment.pix.approve.error", "payment.pix.reprove.requested", "payment.pix.reprove.confirmed", "payment.pix.reprove.failed", "payment.pix.reprove.error", "payment.pix.reschedule.requested", "payment.pix.reschedule.confirmed", "payment.pix.reschedule.failed", "payment.pix.reschedule.error", "payment.pix.cancel.requested", "payment.pix.cancel.confirmed", "payment.pix.cancel.failed", "payment.pix.cancel.error", "payment.pix.get.requested", "payment.pix.get.confirmed", "payment.pix.get.failed", "payment.pix.get.error", "payment.pix.sync.requested", "payment.pix.sync.confirmed", "payment.pix.sync.failed", "payment.pix.sync.error", "payment.tax.register.requested", "payment.tax.register.confirmed", "payment.tax.register.failed", "payment.tax.register.error", "payment.tax.approve.requested", "payment.tax.approve.confirmed", "payment.tax.approve.failed", "payment.tax.approve.error", "payment.tax.reprove.requested", "payment.tax.reprove.confirmed", "payment.tax.reprove.failed", "payment.tax.reprove.error", "payment.tax.reschedule.requested", "payment.tax.reschedule.confirmed", "payment.tax.reschedule.failed", "payment.tax.reschedule.error", "payment.tax.cancel.requested", "payment.tax.cancel.confirmed", "payment.tax.cancel.failed", "payment.tax.cancel.error", "payment.tax.get.requested", "payment.tax.get.confirmed", "payment.tax.get.failed", "payment.tax.get.error", "payment.tax.sync.requested", "payment.tax.sync.confirmed", "payment.tax.sync.failed", "payment.tax.sync.error", "payment.batch.db.created", "payment.batch.db.updated", "payment.batch.db.deleted", "payment.batch.awaiting_approval", "payment.bank_billet_batch.awaiting_approval", "payment.bank_billet_batch.get.requested", "payment.bank_billet_batch.get.confirmed", "payment.bank_billet_batch.get.failed", "payment.bank_billet_batch.get.error", "payment.bank_billet_batch.sync.requested", "payment.bank_billet_batch.sync.confirmed", "payment.bank_billet_batch.sync.failed", "payment.bank_billet_batch.sync.error", "payment.bank_billet_batch.register.requested", "payment.bank_billet_batch.register.confirmed", "payment.bank_billet_batch.register.failed", "payment.bank_billet_batch.register.error", "payment.bank_billet_batch.approve.requested", "payment.bank_billet_batch.approve.confirmed", "payment.bank_billet_batch.approve.failed", "payment.bank_billet_batch.approve.error", "payment.bank_billet_batch.reprove.requested", "payment.bank_billet_batch.reprove.confirmed", "payment.bank_billet_batch.reprove.failed", "payment.bank_billet_batch.reprove.error", "payment.bank_billet_batch.cancel.requested", "payment.bank_billet_batch.cancel.confirmed", "payment.bank_billet_batch.cancel.failed", "payment.bank_billet_batch.cancel.error", "payment.darf_batch.awaiting_approval", "payment.darf_batch.get.requested", "payment.darf_batch.get.confirmed", "payment.darf_batch.get.failed", "payment.darf_batch.get.error", "payment.darf_batch.sync.requested", "payment.darf_batch.sync.confirmed", "payment.darf_batch.sync.failed", "payment.darf_batch.sync.error", "payment.darf_batch.register.requested", "payment.darf_batch.register.confirmed", "payment.darf_batch.register.failed", "payment.darf_batch.register.error", "payment.darf_batch.approve.requested", "payment.darf_batch.approve.confirmed", "payment.darf_batch.approve.failed", "payment.darf_batch.approve.error", "payment.darf_batch.reprove.requested", "payment.darf_batch.reprove.confirmed", "payment.darf_batch.reprove.failed", "payment.darf_batch.reprove.error", "payment.darf_batch.cancel.requested", "payment.darf_batch.cancel.confirmed", "payment.darf_batch.cancel.failed", "payment.darf_batch.cancel.error", "payment.utility_batch.awaiting_approval", "payment.utility_batch.get.requested", "payment.utility_batch.get.confirmed", "payment.utility_batch.get.failed", "payment.utility_batch.get.error", "payment.utility_batch.sync.requested", "payment.utility_batch.sync.confirmed", "payment.utility_batch.sync.failed", "payment.utility_batch.sync.error", "payment.utility_batch.register.requested", "payment.utility_batch.register.confirmed", "payment.utility_batch.register.failed", "payment.utility_batch.register.error", "payment.utility_batch.approve.requested", "payment.utility_batch.approve.confirmed", "payment.utility_batch.approve.failed", "payment.utility_batch.approve.error", "payment.utility_batch.reprove.requested", "payment.utility_batch.reprove.confirmed", "payment.utility_batch.reprove.failed", "payment.utility_batch.reprove.error", "payment.utility_batch.cancel.requested", "payment.utility_batch.cancel.confirmed", "payment.utility_batch.cancel.failed", "payment.utility_batch.cancel.error", "payment.gru_batch.awaiting_approval", "payment.gru_batch.get.requested", "payment.gru_batch.get.confirmed", "payment.gru_batch.get.failed", "payment.gru_batch.get.error", "payment.gru_batch.sync.requested", "payment.gru_batch.sync.confirmed", "payment.gru_batch.sync.failed", "payment.gru_batch.sync.error", "payment.gru_batch.register.requested", "payment.gru_batch.register.confirmed", "payment.gru_batch.register.failed", "payment.gru_batch.register.error", "payment.gru_batch.approve.requested", "payment.gru_batch.approve.confirmed", "payment.gru_batch.approve.failed", "payment.gru_batch.approve.error", "payment.gru_batch.reprove.requested", "payment.gru_batch.reprove.confirmed", "payment.gru_batch.reprove.failed", "payment.gru_batch.reprove.error", "payment.gru_batch.cancel.requested", "payment.gru_batch.cancel.confirmed", "payment.gru_batch.cancel.failed", "payment.gru_batch.cancel.error", "payment.pix_batch.awaiting_approval", "payment.pix_batch.get.requested", "payment.pix_batch.get.confirmed", "payment.pix_batch.get.failed", "payment.pix_batch.get.error", "payment.pix_batch.sync.requested", "payment.pix_batch.sync.confirmed", "payment.pix_batch.sync.failed", "payment.pix_batch.sync.error", "payment.pix_batch.register.requested", "payment.pix_batch.register.confirmed", "payment.pix_batch.register.failed", "payment.pix_batch.register.error", "payment.pix_batch.approve.requested", "payment.pix_batch.approve.confirmed", "payment.pix_batch.approve.failed", "payment.pix_batch.approve.error", "payment.pix_batch.reprove.requested", "payment.pix_batch.reprove.confirmed", "payment.pix_batch.reprove.failed", "payment.pix_batch.reprove.error", "payment.pix_batch.cancel.requested", "payment.pix_batch.cancel.confirmed", "payment.pix_batch.cancel.failed", "payment.pix_batch.cancel.error", "payment.tax_batch.awaiting_approval", "payment.tax_batch.get.requested", "payment.tax_batch.get.confirmed", "payment.tax_batch.get.failed", "payment.tax_batch.get.error", "payment.tax_batch.sync.requested", "payment.tax_batch.sync.confirmed", "payment.tax_batch.sync.failed", "payment.tax_batch.sync.error", "payment.tax_batch.register.requested", "payment.tax_batch.register.confirmed", "payment.tax_batch.register.failed", "payment.tax_batch.register.error", "payment.tax_batch.approve.requested", "payment.tax_batch.approve.confirmed", "payment.tax_batch.approve.failed", "payment.tax_batch.approve.error", "payment.tax_batch.reprove.requested", "payment.tax_batch.reprove.confirmed", "payment.tax_batch.reprove.failed", "payment.tax_batch.reprove.error", "payment.tax_batch.cancel.requested", "payment.tax_batch.cancel.confirmed", "payment.tax_batch.cancel.failed", "payment.tax_batch.cancel.error", "payment.dda.account.db.created", "payment.dda.account.register.requested", "payment.dda.account.register.failed", "payment.dda.account.register.error", "payment.dda.account.register.confirmed", "payment.dda.account.bank_billets_sync.requested", "payment.dda.account.bank_billets_sync.failed", "payment.dda.account.bank_billets_sync.error", "payment.dda.account.bank_billets_sync.confirmed", "payment.dda.account.unregister.requested", "payment.dda.account.unregister.failed", "payment.dda.account.unregister.error", "payment.dda.account.unregister.confirmed", "payment.dda.bank_billet.db.created", "payment.dda.bank_billet.db.updated", "payment.dda.bank_billet.external_status_changed", "payment.dda.bank_billet.get.requested", "payment.dda.bank_billet.get.confirmed", "payment.dda.bank_billet.get.failed", "payment.dda.bank_billet.get.error", "payment.dda.bank_billet.sync.requested", "payment.dda.bank_billet.sync.confirmed", "payment.dda.bank_billet.sync.failed", "payment.dda.bank_billet.sync.error", "payment.dda.account.db.updated", "payment.dda.account.db.deleted", "payment.dda.account.letter.pending", "payment.dda.account.letter.waiting_signatures", "payment.dda.account.letter.signed", "payment.dda.account.letter.failed", "payment.dda.account.confirmed", "payment.dda.account.rejected", "payment.dda.account.failed", "payment.dda.account.disabled", "payment.dda.account.enabled", "credit.restriction.add.requested", "credit.restriction.add.failed", "credit.restriction.add.error", "credit.restriction.add.confirmed", "credit.restriction.remove.requested", "credit.restriction.remove.confirmed", "credit.restriction.remove.failed", "credit.restriction.remove.error", "charge.automatic_pix.account.db.created", "charge.automatic_pix.account.db.updated", "charge.automatic_pix.account.db.deleted", "charge.automatic_pix.recurrence.db.created", "charge.automatic_pix.recurrence.db.updated", "charge.automatic_pix.recurrence.db.deleted", "charge.automatic_pix.recurrence.cancel.requested", "charge.automatic_pix.recurrence.cancel.confirmed", "charge.automatic_pix.recurrence.cancel.failed", "charge.automatic_pix.recurrence.cancel.error", "charge.automatic_pix.recurrence.register.requested", "charge.automatic_pix.recurrence.register.confirmed", "charge.automatic_pix.recurrence.register.failed", "charge.automatic_pix.recurrence.register.error", "charge.automatic_pix.recurrence.update.requested", "charge.automatic_pix.recurrence.update.confirmed", "charge.automatic_pix.recurrence.update.failed", "charge.automatic_pix.recurrence.update.error", "charge.automatic_pix.recurrence.pending", "charge.automatic_pix.recurrence.created", "charge.automatic_pix.recurrence.approved", "charge.automatic_pix.recurrence.rejected", "charge.automatic_pix.recurrence.expired", "charge.automatic_pix.recurrence.canceled", "charge.automatic_pix.request.db.created", "charge.automatic_pix.request.db.updated", "charge.automatic_pix.request.db.deleted", "charge.automatic_pix.request.cancel.requested", "charge.automatic_pix.request.cancel.confirmed", "charge.automatic_pix.request.cancel.failed", "charge.automatic_pix.request.cancel.error", "charge.automatic_pix.request.register.requested", "charge.automatic_pix.request.register.confirmed", "charge.automatic_pix.request.register.failed", "charge.automatic_pix.request.register.error", "charge.automatic_pix.request.pending", "charge.automatic_pix.request.created", "charge.automatic_pix.request.sent", "charge.automatic_pix.request.received", "charge.automatic_pix.request.rejected", "charge.automatic_pix.request.accepted", "charge.automatic_pix.request.expired", "charge.automatic_pix.request.canceled", "charge.automatic_pix.pix.db.created", "charge.automatic_pix.pix.db.updated", "charge.automatic_pix.pix.db.deleted", "charge.automatic_pix.pix.cancel.requested", "charge.automatic_pix.pix.cancel.confirmed", "charge.automatic_pix.pix.cancel.failed", "charge.automatic_pix.pix.cancel.error", "charge.automatic_pix.pix.register.requested", "charge.automatic_pix.pix.register.confirmed", "charge.automatic_pix.pix.register.failed", "charge.automatic_pix.pix.register.error", "charge.automatic_pix.pix.update.requested", "charge.automatic_pix.pix.update.confirmed", "charge.automatic_pix.pix.update.failed", "charge.automatic_pix.pix.update.error", "charge.automatic_pix.pix.pending", "charge.automatic_pix.pix.created", "charge.automatic_pix.pix.active", "charge.automatic_pix.pix.paid", "charge.automatic_pix.pix.expired", "charge.automatic_pix.pix.rejected", "charge.automatic_pix.pix.canceled", "charge.automatic_pix.location.db.created", "charge.automatic_pix.location.db.updated", "charge.automatic_pix.location.db.deleted", "charge.automatic_pix.location.register.requested", "charge.automatic_pix.location.register.confirmed", "charge.automatic_pix.location.register.failed", "charge.automatic_pix.location.register.error", "charge.payment.db.created", "charge.payment.db.updated", "charge.payment.db.deleted", "charge.payment.notified", "charge.payment.canceled", "charge.payment.confirmed", "charge.payment.duplicated", "charge.bank_billet.payment.notified", "charge.bank_billet.payment.canceled", "charge.bank_billet.payment.confirmed", "data.bank_billet_query.success", "data.bank_billet_query.error", "data.bank_billet_query.db.created", "data.bank_billet_query.db.updated", "data.bank_billet_query.db.deleted", "data.pix_qrcode_query.success", "data.pix_qrcode_query.error", "data.pix_qrcode_query.db.created", "data.pix_qrcode_query.db.updated", "data.pix_qrcode_query.db.deleted", "mailbox.entry.db.created", "mailbox.entry.db.updated", "mailbox.entry.db.deleted", "mailbox.entry.file.received", "mailbox.entry.file.sent", "mailbox.file.db.created", "mailbox.file.db.updated", "mailbox.file.db.deleted", "mailbox.channel.s3.db.created", "mailbox.channel.s3.db.updated", "mailbox.channel.s3.db.deleted", "mailbox.channel.s3.fetch_all", "mailbox.channel.email.db.created", "mailbox.channel.email.db.updated", "mailbox.channel.email.db.deleted", "mailbox.channel.whatsapp.db.created", "mailbox.channel.whatsapp.db.updated", "mailbox.channel.whatsapp.db.deleted", "mailbox.channel.sftp.db.created", "mailbox.channel.sftp.db.updated", "mailbox.channel.sftp.db.deleted", "mailbox.channel.sftp.fetch_all", "mailbox.channel.syncthing.db.created", "mailbox.channel.syncthing.db.updated", "mailbox.channel.syncthing.db.deleted", "email_account.db.created", "email_account.db.updated", "email_account.db.deleted", "email_account.identity.pending", "email_account.identity.created", "email_account.identity.error", "email_account.identity.failure", "email_account.dns.not_ready", "email_account.dns.awaiting", "email_account.dns.validated", "email_account.dns.error", "email_account.dns.failure", "integration.connection.db.created", "integration.connection.db.updated", "integration.connection.db.deleted", "webhook.db.created", "webhook.db.updated", "webhook.db.deleted", "enotas.nfe.generated" ] } }, { "name": "status", "in": "query", "description": "Status do SMS enviado", "required": false, "schema": { "type": "integer", "description": "Situação:\n* `0` Pendente\n* `1` Submetido para o Gateway\n* `2` Falha ao Enviar para o Gateway\n* `3` Rejeitado pelo Gateway\n* `4` Enviado pelo Gateway\n* `5` Recebido pelo Destinatário\n* `6` Não Recebido pelo Destinatário\n* `7` Lido pelo Destinatário\n* `8` Sendo Auditado para Liberação\n* `9` Link Acessado pelo Destinatário", "enum": [ "0", "1", "2", "3", "4", "5", "6", "7", "8", "9" ] } } ], "responses": { "200": { "description": "Sucesso na listagem dos SMS enviados", "content": { "application/json": { "example": [ { "id": 6, "uid": "01a06d8e-975d-7134-991f-ce22c9b06fe4", "event_code": "bank_billet.created", "message": "MyText", "phone_to": "+5522987654321", "sent_error": null, "delivered_at": null, "failed_at": null, "resource_owner_id": 47, "status": "pending", "bank_billet_account_id": null, "sms_notification_id": 6, "customer_id": 68, "customer_external_code": null, "created_at": "2026-09-04T12:54:16-05:00", "updated_at": "2026-09-04T12:54:16-05:00", "resource_owner": { "uid": "01a06d8e-9788-76ea-8eb7-dde54aa8513f", "type": "bank_billet" }, "resource_base": { "uid": "01a06d8e-9788-76ea-8eb7-dde54aa8513f", "type": "bank_billet" } }, { "id": 5, "uid": "01a06d8e-96d7-7bc9-89b4-b55e0c448941", "event_code": "bank_billet.created", "message": "MyText", "phone_to": "+5522987654321", "sent_error": null, "delivered_at": null, "failed_at": null, "resource_owner_id": 46, "status": "pending", "bank_billet_account_id": null, "sms_notification_id": 5, "customer_id": 67, "customer_external_code": null, "created_at": "2026-09-04T12:54:16-05:00", "updated_at": "2026-09-04T12:54:16-05:00", "resource_owner": { "uid": "01a06d8e-9713-7980-bb2f-88776b3cab59", "type": "bank_billet" }, "resource_base": { "uid": "01a06d8e-9713-7980-bb2f-88776b3cab59", "type": "bank_billet" } }, { "id": 4, "uid": "01a06d8e-964c-714c-ab53-523ddc7ab8f2", "event_code": "bank_billet.created", "message": "MyText", "phone_to": "+5522987654321", "sent_error": null, "delivered_at": null, "failed_at": null, "resource_owner_id": 45, "status": "pending", "bank_billet_account_id": null, "sms_notification_id": 4, "customer_id": 66, "customer_external_code": null, "created_at": "2026-09-04T12:54:16-05:00", "updated_at": "2026-09-04T12:54:16-05:00", "resource_owner": { "uid": "01a06d8e-9681-76e1-b463-4c1ed7afbadc", "type": "bank_billet" }, "resource_base": { "uid": "01a06d8e-9681-76e1-b463-4c1ed7afbadc", "type": "bank_billet" } }, { "id": 3, "uid": "01a06d8e-95d7-7ce7-a063-a97c66fbdc8a", "event_code": "bank_billet.created", "message": "MyText", "phone_to": "+5522987654321", "sent_error": null, "delivered_at": null, "failed_at": null, "resource_owner_id": 44, "status": "pending", "bank_billet_account_id": null, "sms_notification_id": 3, "customer_id": 65, "customer_external_code": null, "created_at": "2026-09-04T12:54:16-05:00", "updated_at": "2026-09-04T12:54:16-05:00", "resource_owner": { "uid": "01a06d8e-960d-760e-a5a2-fdcf986165b1", "type": "bank_billet" }, "resource_base": { "uid": "01a06d8e-960d-760e-a5a2-fdcf986165b1", "type": "bank_billet" } }, { "id": 2, "uid": "01a06d8e-9546-744b-becf-8903f88a846b", "event_code": "bank_billet.created", "message": "MyText", "phone_to": "+5522987654321", "sent_error": null, "delivered_at": null, "failed_at": null, "resource_owner_id": 43, "status": "pending", "bank_billet_account_id": null, "sms_notification_id": 2, "customer_id": 64, "customer_external_code": null, "created_at": "2026-09-04T12:54:16-05:00", "updated_at": "2026-09-04T12:54:16-05:00", "resource_owner": { "uid": "01a06d8e-9590-7202-abff-9ddbd0ba3ba6", "type": "bank_billet" }, "resource_base": { "uid": "01a06d8e-9590-7202-abff-9ddbd0ba3ba6", "type": "bank_billet" } } ], "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1_sms_delivery_object" } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/sms_deliveries/{id}": { "get": { "summary": "Informações do SMS Enviado", "tags": [ "Histórico de SMS" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de um SMS enviado", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "ID do SMS", "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SMS encontrado com sucesso", "content": { "application/json": { "example": { "id": 7, "uid": "01a06d8e-98a7-79c9-b824-1d190112b434", "event_code": "bank_billet.created", "message": "MyText", "phone_to": "+5522987654321", "sent_error": null, "delivered_at": null, "failed_at": null, "resource_owner_id": 48, "status": "pending", "bank_billet_account_id": null, "sms_notification_id": 7, "customer_id": 69, "customer_external_code": null, "created_at": "2026-09-04T12:54:16-05:00", "updated_at": "2026-09-04T12:54:16-05:00", "resource_owner": { "uid": "01a06d8e-98cf-7dd0-9eec-10dc5ffbe820", "type": "bank_billet" }, "resource_base": { "uid": "01a06d8e-98cf-7dd0-9eec-10dc5ffbe820", "type": "bank_billet" } }, "schema": { "$ref": "#/components/schemas/v1_sms_delivery_object" } } } }, "404": { "description": "SMS não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/sms_deliveries/{id}/resend": { "put": { "summary": "Reenviar SMS Enviado", "tags": [ "Histórico de SMS" ], "security": [ { "bearerAuth": [] } ], "description": "Você pode reenviar SMS enviados.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "ID do SMS enviado", "example": 999, "schema": { "type": "string" } } ], "responses": { "204": { "description": "SMS reeenviado com sucesso" }, "404": { "description": "SMS não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/userinfo": { "get": { "summary": "Informações do Usuário (descontinuado)", "tags": [ "Usuário Autenticado (descontinuado)" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações da conta acessada.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Usuário encontrado", "content": { "application/json": { "example": { "id": 138, "email": "e4ba917ae8ebf09cef31a60096039f7c@franecki.example", "account_type": "individual", "first_name": "Margret", "middle_name": "Simões", "last_name": "Gonçalo", "full_name": "Margret Simões Gonçalo", "cpf": "758.487.848-25", "date_of_birth": "1970-03-01", "mother_name": "Lenadra Simões Gonçalo", "father_name": "José Simões Gonçalo", "created_at": "2026-09-04T12:54:17-05:00", "updated_at": "2026-09-04T12:54:17-05:00", "address_street_name": "Av. Burkhard Hehn Simões", "address_number": "120", "address_complement": "709", "address_neighborhood": "São Francisco", "address_postal_code": "24360440", "address_city_name": "Rio de Janeiro", "address_state": "RJ", "phone_number": "2199999999", "business_name": null, "business_cnpj": null, "business_legal_name": null, "simple_opting": false, "balance_cents": 10000 }, "schema": { "$ref": "#/components/schemas/v1_user_object" } } } }, "404": { "description": "Usuário não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/webhook_deliveries": { "get": { "summary": "Listar Webhooks Enviados", "tags": [ "Log de Webhooks" ], "security": [ { "bearerAuth": [] } ], "description": "Listar webhooks enviados\n\nO `ID do Objeto` vai retornar todos e qualquer tipo de objeto que tenha o ID enviado, ou seja, se você enviar 1, poderá retornar boletos, clientes e etc. Caso queira um filtro mais refinado, combine o `ID do Objeto` com o `Código do evento`.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "resource_owner_id", "in": "query", "description": "ID do objeto.", "required": false, "schema": { "type": "integer" } }, { "name": "webhook_id", "in": "query", "description": "ID do Webhook", "required": false, "schema": { "type": "integer" } }, { "name": "uid", "in": "query", "description": "UID usado no cabeçalho da requisição", "required": false, "schema": { "type": "string" } }, { "name": "response_code", "in": "query", "description": "Código HTTP da resposta. [Leia mais](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes)", "required": false, "schema": { "type": "integer" } }, { "name": "event_code", "in": "query", "description": "Código do evento.", "required": false, "schema": { "type": "string", "enum": [ "ping", "access_token.db.created", "access_token.db.updated", "access_token.db.deleted", "access_token.reminder", "access_token.expired", "account.updated", "account.blocked", "account.bank_billet_creation_blocked", "bank_billet.created", "bank_billet.updated", "bank_billet.generated", "bank_billet.canceled", "bank_billet.blocked", "bank_billet.overdue", "bank_billet.paid", "bank_billet.due_date", "bank_billet.rejected", "bank_billet.cancel.requested", "bank_billet.cancel.confirmed", "bank_billet.cancel.failed", "bank_billet.cancel.error", "bank_billet.register.requested", "bank_billet.register.confirmed", "bank_billet.register.failed", "bank_billet.register.error", "bank_billet.update.requested", "bank_billet.update.confirmed", "bank_billet.update.failed", "bank_billet.update.error", "bank_billet.registered", "bank_billet.deleted", "bank_billet.sync.requested", "bank_billet.sync.confirmed", "bank_billet.sync.failed", "bank_billet.sync.error", "bank_billet.get.requested", "bank_billet.get.confirmed", "bank_billet.get.failed", "bank_billet.get.error", "bank_billet.get_child.requested", "bank_billet.get_child.confirmed", "bank_billet.get_child.failed", "bank_billet.get_child.error", "bank_billet.find.requested", "bank_billet.find.confirmed", "bank_billet.find.failed", "bank_billet.find.error", "bank_billet.add_pix.requested", "bank_billet.add_pix.confirmed", "bank_billet.add_pix.failed", "bank_billet.add_pix.error", "bank_billet.get_pix.requested", "bank_billet.get_pix.confirmed", "bank_billet.get_pix.failed", "bank_billet.get_pix.error", "bank_billet.protest.requested", "bank_billet.protest.confirmed", "bank_billet.protest.failed", "bank_billet.protest.error", "bank_billet_discharge.created", "bank_billet_discharge.updated", "bank_billet_discharge.deleted", "bank_billet_remittance.created", "bank_billet_remittance.updated", "bank_billet_remittance.deleted", "bank_billet_registration.created", "bank_billet_registration.updated", "bank_billet_registration.deleted", "bank_billet_payment.created", "bank_billet_payment.updated", "bank_billet_payment.deleted", "customer.created", "customer.updated", "customer.portal_password_updated", "customer.deleted", "transaction.created", "transaction.updated", "transaction.processed", "withdrawal.transferred", "withdrawal.requested", "addon.activated", "addon.removed", "plan_subscription.activated", "plan_subscription.removed", "plan_subscription.fee", "plan_subscription.updated", "user.created", "user.updated", "user.deleted", "remittance.created", "remittance.processed", "remittance.downloaded", "remittance.sent", "remittance.deleted", "remittance.line.db.created", "remittance.line.db.updated", "remittance.line.db.deleted", "discharge.created", "discharge.processed", "discharge.deleted", "bank_billet_account.created", "bank_billet_account.homologated", "bank_billet_account.homologation_failed", "bank_billet_account.homologation_started", "bank_billet_account.validated", "bank_billet_account.validation_released", "bank_billet_account.activated", "bank_billet_account.updated", "bank_billet_account.deleted", "edi.remittance_line.created", "edi.remittance_line.updated", "edi.remittance_line.deleted", "edi.edi_box.activated", "edi.edi_box.db.created", "edi.edi_box.db.deleted", "edi.edi_box.db.updated", "edi.edi_box.generated", "edi.edi_box.demand_received", "edi.edi_box.confirming_at_bank", "edi.edi_box.testing_by_customer", "edi.edi_box.waiting_for_validations", "customer_subscription.created", "customer_subscription.updated", "customer_subscription.deleted", "installment.created", "installment.processed", "installment.generated", "installment.deleted", "import.created", "import.processed", "import.deleted", "export.db.created", "export.db.updated", "export.db.deleted", "pix.db.created", "pix.db.updated", "pix.db.deleted", "pix.register.requested", "pix.register.confirmed", "pix.register.failed", "pix.register.error", "pix.update.requested", "pix.update.confirmed", "pix.update.failed", "pix.update.error", "pix.paid", "pix.overdue", "pix.cancel.requested", "pix.cancel.confirmed", "pix.cancel.failed", "pix.cancel.error", "pix.sync.requested", "pix.sync.confirmed", "pix.sync.failed", "pix.sync.error", "pix.get.requested", "pix.get.confirmed", "pix.get.failed", "pix.get.error", "financial.account.balance_sync.requested", "financial.account.balance_sync.confirmed", "financial.account.balance_sync.failed", "financial.account.balance_sync.error", "financial.account.statement_sync.requested", "financial.account.statement_sync.confirmed", "financial.account.statement_sync.failed", "financial.account.statement_sync.error", "financial.account.db.created", "financial.account.db.updated", "financial.account.db.deleted", "financial.account.statement.updated", "financial.account.balance.updated", "financial.account_balance.db.created", "transfer.batch.db.created", "transfer.batch.db.updated", "transfer.batch.db.deleted", "transfer.batch.awaiting_approval", "transfer.pix_batch.awaiting_approval", "transfer.pix_batch.get.requested", "transfer.pix_batch.get.confirmed", "transfer.pix_batch.get.failed", "transfer.pix_batch.get.error", "transfer.pix_batch.sync.requested", "transfer.pix_batch.sync.confirmed", "transfer.pix_batch.sync.failed", "transfer.pix_batch.sync.error", "transfer.pix_batch.register.requested", "transfer.pix_batch.register.confirmed", "transfer.pix_batch.register.failed", "transfer.pix_batch.register.error", "transfer.pix_batch.approve.requested", "transfer.pix_batch.approve.confirmed", "transfer.pix_batch.approve.failed", "transfer.pix_batch.approve.error", "transfer.pix_batch.reprove.requested", "transfer.pix_batch.reprove.confirmed", "transfer.pix_batch.reprove.failed", "transfer.pix_batch.reprove.error", "transfer.pix_batch.cancel.requested", "transfer.pix_batch.cancel.confirmed", "transfer.pix_batch.cancel.failed", "transfer.pix_batch.cancel.error", "transfer.ted_batch.awaiting_approval", "transfer.ted_batch.get.requested", "transfer.ted_batch.get.confirmed", "transfer.ted_batch.get.failed", "transfer.ted_batch.get.error", "transfer.ted_batch.sync.requested", "transfer.ted_batch.sync.confirmed", "transfer.ted_batch.sync.failed", "transfer.ted_batch.sync.error", "transfer.ted_batch.register.requested", "transfer.ted_batch.register.confirmed", "transfer.ted_batch.register.failed", "transfer.ted_batch.register.error", "transfer.ted_batch.approve.requested", "transfer.ted_batch.approve.confirmed", "transfer.ted_batch.approve.failed", "transfer.ted_batch.approve.error", "transfer.ted_batch.reprove.requested", "transfer.ted_batch.reprove.confirmed", "transfer.ted_batch.reprove.failed", "transfer.ted_batch.reprove.error", "transfer.ted_batch.cancel.requested", "transfer.ted_batch.cancel.confirmed", "transfer.ted_batch.cancel.failed", "transfer.ted_batch.cancel.error", "transfer.internal_batch.awaiting_approval", "transfer.internal_batch.get.requested", "transfer.internal_batch.get.confirmed", "transfer.internal_batch.get.failed", "transfer.internal_batch.get.error", "transfer.internal_batch.sync.requested", "transfer.internal_batch.sync.confirmed", "transfer.internal_batch.sync.failed", "transfer.internal_batch.sync.error", "transfer.internal_batch.register.requested", "transfer.internal_batch.register.confirmed", "transfer.internal_batch.register.failed", "transfer.internal_batch.register.error", "transfer.internal_batch.approve.requested", "transfer.internal_batch.approve.confirmed", "transfer.internal_batch.approve.failed", "transfer.internal_batch.approve.error", "transfer.internal_batch.reprove.requested", "transfer.internal_batch.reprove.confirmed", "transfer.internal_batch.reprove.failed", "transfer.internal_batch.reprove.error", "transfer.internal_batch.cancel.requested", "transfer.internal_batch.cancel.confirmed", "transfer.internal_batch.cancel.failed", "transfer.internal_batch.cancel.error", "transfer.db.created", "transfer.db.updated", "transfer.db.deleted", "transfer.pix.register.requested", "transfer.pix.register.confirmed", "transfer.pix.register.failed", "transfer.pix.register.error", "transfer.pix.reschedule.requested", "transfer.pix.reschedule.confirmed", "transfer.pix.reschedule.failed", "transfer.pix.reschedule.error", "transfer.pix.approve.requested", "transfer.pix.approve.confirmed", "transfer.pix.approve.failed", "transfer.pix.approve.error", "transfer.pix.reprove.requested", "transfer.pix.reprove.confirmed", "transfer.pix.reprove.failed", "transfer.pix.reprove.error", "transfer.pix.cancel.requested", "transfer.pix.cancel.confirmed", "transfer.pix.cancel.failed", "transfer.pix.cancel.error", "transfer.pix.get.requested", "transfer.pix.get.confirmed", "transfer.pix.get.failed", "transfer.pix.get.error", "transfer.pix.sync.requested", "transfer.pix.sync.confirmed", "transfer.pix.sync.failed", "transfer.pix.sync.error", "transfer.ted.register.requested", "transfer.ted.register.confirmed", "transfer.ted.register.failed", "transfer.ted.register.error", "transfer.ted.reschedule.requested", "transfer.ted.reschedule.confirmed", "transfer.ted.reschedule.failed", "transfer.ted.reschedule.error", "transfer.ted.approve.requested", "transfer.ted.approve.confirmed", "transfer.ted.approve.failed", "transfer.ted.approve.error", "transfer.ted.reprove.requested", "transfer.ted.reprove.confirmed", "transfer.ted.reprove.failed", "transfer.ted.reprove.error", "transfer.ted.cancel.requested", "transfer.ted.cancel.confirmed", "transfer.ted.cancel.failed", "transfer.ted.cancel.error", "transfer.ted.get.requested", "transfer.ted.get.confirmed", "transfer.ted.get.failed", "transfer.ted.get.error", "transfer.ted.sync.requested", "transfer.ted.sync.confirmed", "transfer.ted.sync.failed", "transfer.ted.sync.error", "transfer.internal.register.requested", "transfer.internal.register.confirmed", "transfer.internal.register.failed", "transfer.internal.register.error", "transfer.internal.reschedule.requested", "transfer.internal.reschedule.confirmed", "transfer.internal.reschedule.failed", "transfer.internal.reschedule.error", "transfer.internal.approve.requested", "transfer.internal.approve.confirmed", "transfer.internal.approve.failed", "transfer.internal.approve.error", "transfer.internal.reprove.requested", "transfer.internal.reprove.confirmed", "transfer.internal.reprove.failed", "transfer.internal.reprove.error", "transfer.internal.cancel.requested", "transfer.internal.cancel.confirmed", "transfer.internal.cancel.failed", "transfer.internal.cancel.error", "transfer.internal.get.requested", "transfer.internal.get.confirmed", "transfer.internal.get.failed", "transfer.internal.get.error", "transfer.internal.sync.requested", "transfer.internal.sync.confirmed", "transfer.internal.sync.failed", "transfer.internal.sync.error", "payment.db.created", "payment.db.updated", "payment.db.deleted", "payment.bank_billet.register.requested", "payment.bank_billet.register.confirmed", "payment.bank_billet.register.failed", "payment.bank_billet.register.error", "payment.bank_billet.approve.requested", "payment.bank_billet.approve.confirmed", "payment.bank_billet.approve.failed", "payment.bank_billet.approve.error", "payment.bank_billet.reprove.requested", "payment.bank_billet.reprove.confirmed", "payment.bank_billet.reprove.failed", "payment.bank_billet.reprove.error", "payment.bank_billet.reschedule.requested", "payment.bank_billet.reschedule.confirmed", "payment.bank_billet.reschedule.failed", "payment.bank_billet.reschedule.error", "payment.bank_billet.cancel.requested", "payment.bank_billet.cancel.confirmed", "payment.bank_billet.cancel.failed", "payment.bank_billet.cancel.error", "payment.bank_billet.get.requested", "payment.bank_billet.get.confirmed", "payment.bank_billet.get.failed", "payment.bank_billet.get.error", "payment.bank_billet.sync.requested", "payment.bank_billet.sync.confirmed", "payment.bank_billet.sync.failed", "payment.bank_billet.sync.error", "payment.darf.register.requested", "payment.darf.register.confirmed", "payment.darf.register.failed", "payment.darf.register.error", "payment.darf.approve.requested", "payment.darf.approve.confirmed", "payment.darf.approve.failed", "payment.darf.approve.error", "payment.darf.reprove.requested", "payment.darf.reprove.confirmed", "payment.darf.reprove.failed", "payment.darf.reprove.error", "payment.darf.reschedule.requested", "payment.darf.reschedule.confirmed", "payment.darf.reschedule.failed", "payment.darf.reschedule.error", "payment.darf.cancel.requested", "payment.darf.cancel.confirmed", "payment.darf.cancel.failed", "payment.darf.cancel.error", "payment.darf.get.requested", "payment.darf.get.confirmed", "payment.darf.get.failed", "payment.darf.get.error", "payment.darf.sync.requested", "payment.darf.sync.confirmed", "payment.darf.sync.failed", "payment.darf.sync.error", "payment.utility.register.requested", "payment.utility.register.confirmed", "payment.utility.register.failed", "payment.utility.register.error", "payment.utility.approve.requested", "payment.utility.approve.confirmed", "payment.utility.approve.failed", "payment.utility.approve.error", "payment.utility.reprove.requested", "payment.utility.reprove.confirmed", "payment.utility.reprove.failed", "payment.utility.reprove.error", "payment.utility.reschedule.requested", "payment.utility.reschedule.confirmed", "payment.utility.reschedule.failed", "payment.utility.reschedule.error", "payment.utility.cancel.requested", "payment.utility.cancel.confirmed", "payment.utility.cancel.failed", "payment.utility.cancel.error", "payment.utility.get.requested", "payment.utility.get.confirmed", "payment.utility.get.failed", "payment.utility.get.error", "payment.utility.sync.requested", "payment.utility.sync.confirmed", "payment.utility.sync.failed", "payment.utility.sync.error", "payment.gru.register.requested", "payment.gru.register.confirmed", "payment.gru.register.failed", "payment.gru.register.error", "payment.gru.approve.requested", "payment.gru.approve.confirmed", "payment.gru.approve.failed", "payment.gru.approve.error", "payment.gru.reprove.requested", "payment.gru.reprove.confirmed", "payment.gru.reprove.failed", "payment.gru.reprove.error", "payment.gru.reschedule.requested", "payment.gru.reschedule.confirmed", "payment.gru.reschedule.failed", "payment.gru.reschedule.error", "payment.gru.cancel.requested", "payment.gru.cancel.confirmed", "payment.gru.cancel.failed", "payment.gru.cancel.error", "payment.gru.get.requested", "payment.gru.get.confirmed", "payment.gru.get.failed", "payment.gru.get.error", "payment.gru.sync.requested", "payment.gru.sync.confirmed", "payment.gru.sync.failed", "payment.gru.sync.error", "payment.pix.register.requested", "payment.pix.register.confirmed", "payment.pix.register.failed", "payment.pix.register.error", "payment.pix.approve.requested", "payment.pix.approve.confirmed", "payment.pix.approve.failed", "payment.pix.approve.error", "payment.pix.reprove.requested", "payment.pix.reprove.confirmed", "payment.pix.reprove.failed", "payment.pix.reprove.error", "payment.pix.reschedule.requested", "payment.pix.reschedule.confirmed", "payment.pix.reschedule.failed", "payment.pix.reschedule.error", "payment.pix.cancel.requested", "payment.pix.cancel.confirmed", "payment.pix.cancel.failed", "payment.pix.cancel.error", "payment.pix.get.requested", "payment.pix.get.confirmed", "payment.pix.get.failed", "payment.pix.get.error", "payment.pix.sync.requested", "payment.pix.sync.confirmed", "payment.pix.sync.failed", "payment.pix.sync.error", "payment.tax.register.requested", "payment.tax.register.confirmed", "payment.tax.register.failed", "payment.tax.register.error", "payment.tax.approve.requested", "payment.tax.approve.confirmed", "payment.tax.approve.failed", "payment.tax.approve.error", "payment.tax.reprove.requested", "payment.tax.reprove.confirmed", "payment.tax.reprove.failed", "payment.tax.reprove.error", "payment.tax.reschedule.requested", "payment.tax.reschedule.confirmed", "payment.tax.reschedule.failed", "payment.tax.reschedule.error", "payment.tax.cancel.requested", "payment.tax.cancel.confirmed", "payment.tax.cancel.failed", "payment.tax.cancel.error", "payment.tax.get.requested", "payment.tax.get.confirmed", "payment.tax.get.failed", "payment.tax.get.error", "payment.tax.sync.requested", "payment.tax.sync.confirmed", "payment.tax.sync.failed", "payment.tax.sync.error", "payment.batch.db.created", "payment.batch.db.updated", "payment.batch.db.deleted", "payment.batch.awaiting_approval", "payment.bank_billet_batch.awaiting_approval", "payment.bank_billet_batch.get.requested", "payment.bank_billet_batch.get.confirmed", "payment.bank_billet_batch.get.failed", "payment.bank_billet_batch.get.error", "payment.bank_billet_batch.sync.requested", "payment.bank_billet_batch.sync.confirmed", "payment.bank_billet_batch.sync.failed", "payment.bank_billet_batch.sync.error", "payment.bank_billet_batch.register.requested", "payment.bank_billet_batch.register.confirmed", "payment.bank_billet_batch.register.failed", "payment.bank_billet_batch.register.error", "payment.bank_billet_batch.approve.requested", "payment.bank_billet_batch.approve.confirmed", "payment.bank_billet_batch.approve.failed", "payment.bank_billet_batch.approve.error", "payment.bank_billet_batch.reprove.requested", "payment.bank_billet_batch.reprove.confirmed", "payment.bank_billet_batch.reprove.failed", "payment.bank_billet_batch.reprove.error", "payment.bank_billet_batch.cancel.requested", "payment.bank_billet_batch.cancel.confirmed", "payment.bank_billet_batch.cancel.failed", "payment.bank_billet_batch.cancel.error", "payment.darf_batch.awaiting_approval", "payment.darf_batch.get.requested", "payment.darf_batch.get.confirmed", "payment.darf_batch.get.failed", "payment.darf_batch.get.error", "payment.darf_batch.sync.requested", "payment.darf_batch.sync.confirmed", "payment.darf_batch.sync.failed", "payment.darf_batch.sync.error", "payment.darf_batch.register.requested", "payment.darf_batch.register.confirmed", "payment.darf_batch.register.failed", "payment.darf_batch.register.error", "payment.darf_batch.approve.requested", "payment.darf_batch.approve.confirmed", "payment.darf_batch.approve.failed", "payment.darf_batch.approve.error", "payment.darf_batch.reprove.requested", "payment.darf_batch.reprove.confirmed", "payment.darf_batch.reprove.failed", "payment.darf_batch.reprove.error", "payment.darf_batch.cancel.requested", "payment.darf_batch.cancel.confirmed", "payment.darf_batch.cancel.failed", "payment.darf_batch.cancel.error", "payment.utility_batch.awaiting_approval", "payment.utility_batch.get.requested", "payment.utility_batch.get.confirmed", "payment.utility_batch.get.failed", "payment.utility_batch.get.error", "payment.utility_batch.sync.requested", "payment.utility_batch.sync.confirmed", "payment.utility_batch.sync.failed", "payment.utility_batch.sync.error", "payment.utility_batch.register.requested", "payment.utility_batch.register.confirmed", "payment.utility_batch.register.failed", "payment.utility_batch.register.error", "payment.utility_batch.approve.requested", "payment.utility_batch.approve.confirmed", "payment.utility_batch.approve.failed", "payment.utility_batch.approve.error", "payment.utility_batch.reprove.requested", "payment.utility_batch.reprove.confirmed", "payment.utility_batch.reprove.failed", "payment.utility_batch.reprove.error", "payment.utility_batch.cancel.requested", "payment.utility_batch.cancel.confirmed", "payment.utility_batch.cancel.failed", "payment.utility_batch.cancel.error", "payment.gru_batch.awaiting_approval", "payment.gru_batch.get.requested", "payment.gru_batch.get.confirmed", "payment.gru_batch.get.failed", "payment.gru_batch.get.error", "payment.gru_batch.sync.requested", "payment.gru_batch.sync.confirmed", "payment.gru_batch.sync.failed", "payment.gru_batch.sync.error", "payment.gru_batch.register.requested", "payment.gru_batch.register.confirmed", "payment.gru_batch.register.failed", "payment.gru_batch.register.error", "payment.gru_batch.approve.requested", "payment.gru_batch.approve.confirmed", "payment.gru_batch.approve.failed", "payment.gru_batch.approve.error", "payment.gru_batch.reprove.requested", "payment.gru_batch.reprove.confirmed", "payment.gru_batch.reprove.failed", "payment.gru_batch.reprove.error", "payment.gru_batch.cancel.requested", "payment.gru_batch.cancel.confirmed", "payment.gru_batch.cancel.failed", "payment.gru_batch.cancel.error", "payment.pix_batch.awaiting_approval", "payment.pix_batch.get.requested", "payment.pix_batch.get.confirmed", "payment.pix_batch.get.failed", "payment.pix_batch.get.error", "payment.pix_batch.sync.requested", "payment.pix_batch.sync.confirmed", "payment.pix_batch.sync.failed", "payment.pix_batch.sync.error", "payment.pix_batch.register.requested", "payment.pix_batch.register.confirmed", "payment.pix_batch.register.failed", "payment.pix_batch.register.error", "payment.pix_batch.approve.requested", "payment.pix_batch.approve.confirmed", "payment.pix_batch.approve.failed", "payment.pix_batch.approve.error", "payment.pix_batch.reprove.requested", "payment.pix_batch.reprove.confirmed", "payment.pix_batch.reprove.failed", "payment.pix_batch.reprove.error", "payment.pix_batch.cancel.requested", "payment.pix_batch.cancel.confirmed", "payment.pix_batch.cancel.failed", "payment.pix_batch.cancel.error", "payment.tax_batch.awaiting_approval", "payment.tax_batch.get.requested", "payment.tax_batch.get.confirmed", "payment.tax_batch.get.failed", "payment.tax_batch.get.error", "payment.tax_batch.sync.requested", "payment.tax_batch.sync.confirmed", "payment.tax_batch.sync.failed", "payment.tax_batch.sync.error", "payment.tax_batch.register.requested", "payment.tax_batch.register.confirmed", "payment.tax_batch.register.failed", "payment.tax_batch.register.error", "payment.tax_batch.approve.requested", "payment.tax_batch.approve.confirmed", "payment.tax_batch.approve.failed", "payment.tax_batch.approve.error", "payment.tax_batch.reprove.requested", "payment.tax_batch.reprove.confirmed", "payment.tax_batch.reprove.failed", "payment.tax_batch.reprove.error", "payment.tax_batch.cancel.requested", "payment.tax_batch.cancel.confirmed", "payment.tax_batch.cancel.failed", "payment.tax_batch.cancel.error", "payment.dda.account.db.created", "payment.dda.account.register.requested", "payment.dda.account.register.failed", "payment.dda.account.register.error", "payment.dda.account.register.confirmed", "payment.dda.account.bank_billets_sync.requested", "payment.dda.account.bank_billets_sync.failed", "payment.dda.account.bank_billets_sync.error", "payment.dda.account.bank_billets_sync.confirmed", "payment.dda.account.unregister.requested", "payment.dda.account.unregister.failed", "payment.dda.account.unregister.error", "payment.dda.account.unregister.confirmed", "payment.dda.bank_billet.db.created", "payment.dda.bank_billet.db.updated", "payment.dda.bank_billet.external_status_changed", "payment.dda.bank_billet.get.requested", "payment.dda.bank_billet.get.confirmed", "payment.dda.bank_billet.get.failed", "payment.dda.bank_billet.get.error", "payment.dda.bank_billet.sync.requested", "payment.dda.bank_billet.sync.confirmed", "payment.dda.bank_billet.sync.failed", "payment.dda.bank_billet.sync.error", "payment.dda.account.db.updated", "payment.dda.account.db.deleted", "payment.dda.account.letter.pending", "payment.dda.account.letter.waiting_signatures", "payment.dda.account.letter.signed", "payment.dda.account.letter.failed", "payment.dda.account.confirmed", "payment.dda.account.rejected", "payment.dda.account.failed", "payment.dda.account.disabled", "payment.dda.account.enabled", "credit.restriction.add.requested", "credit.restriction.add.failed", "credit.restriction.add.error", "credit.restriction.add.confirmed", "credit.restriction.remove.requested", "credit.restriction.remove.confirmed", "credit.restriction.remove.failed", "credit.restriction.remove.error", "charge.automatic_pix.account.db.created", "charge.automatic_pix.account.db.updated", "charge.automatic_pix.account.db.deleted", "charge.automatic_pix.recurrence.db.created", "charge.automatic_pix.recurrence.db.updated", "charge.automatic_pix.recurrence.db.deleted", "charge.automatic_pix.recurrence.cancel.requested", "charge.automatic_pix.recurrence.cancel.confirmed", "charge.automatic_pix.recurrence.cancel.failed", "charge.automatic_pix.recurrence.cancel.error", "charge.automatic_pix.recurrence.register.requested", "charge.automatic_pix.recurrence.register.confirmed", "charge.automatic_pix.recurrence.register.failed", "charge.automatic_pix.recurrence.register.error", "charge.automatic_pix.recurrence.update.requested", "charge.automatic_pix.recurrence.update.confirmed", "charge.automatic_pix.recurrence.update.failed", "charge.automatic_pix.recurrence.update.error", "charge.automatic_pix.recurrence.pending", "charge.automatic_pix.recurrence.created", "charge.automatic_pix.recurrence.approved", "charge.automatic_pix.recurrence.rejected", "charge.automatic_pix.recurrence.expired", "charge.automatic_pix.recurrence.canceled", "charge.automatic_pix.request.db.created", "charge.automatic_pix.request.db.updated", "charge.automatic_pix.request.db.deleted", "charge.automatic_pix.request.cancel.requested", "charge.automatic_pix.request.cancel.confirmed", "charge.automatic_pix.request.cancel.failed", "charge.automatic_pix.request.cancel.error", "charge.automatic_pix.request.register.requested", "charge.automatic_pix.request.register.confirmed", "charge.automatic_pix.request.register.failed", "charge.automatic_pix.request.register.error", "charge.automatic_pix.request.pending", "charge.automatic_pix.request.created", "charge.automatic_pix.request.sent", "charge.automatic_pix.request.received", "charge.automatic_pix.request.rejected", "charge.automatic_pix.request.accepted", "charge.automatic_pix.request.expired", "charge.automatic_pix.request.canceled", "charge.automatic_pix.pix.db.created", "charge.automatic_pix.pix.db.updated", "charge.automatic_pix.pix.db.deleted", "charge.automatic_pix.pix.cancel.requested", "charge.automatic_pix.pix.cancel.confirmed", "charge.automatic_pix.pix.cancel.failed", "charge.automatic_pix.pix.cancel.error", "charge.automatic_pix.pix.register.requested", "charge.automatic_pix.pix.register.confirmed", "charge.automatic_pix.pix.register.failed", "charge.automatic_pix.pix.register.error", "charge.automatic_pix.pix.update.requested", "charge.automatic_pix.pix.update.confirmed", "charge.automatic_pix.pix.update.failed", "charge.automatic_pix.pix.update.error", "charge.automatic_pix.pix.pending", "charge.automatic_pix.pix.created", "charge.automatic_pix.pix.active", "charge.automatic_pix.pix.paid", "charge.automatic_pix.pix.expired", "charge.automatic_pix.pix.rejected", "charge.automatic_pix.pix.canceled", "charge.automatic_pix.location.db.created", "charge.automatic_pix.location.db.updated", "charge.automatic_pix.location.db.deleted", "charge.automatic_pix.location.register.requested", "charge.automatic_pix.location.register.confirmed", "charge.automatic_pix.location.register.failed", "charge.automatic_pix.location.register.error", "charge.payment.db.created", "charge.payment.db.updated", "charge.payment.db.deleted", "charge.payment.notified", "charge.payment.canceled", "charge.payment.confirmed", "charge.payment.duplicated", "charge.bank_billet.payment.notified", "charge.bank_billet.payment.canceled", "charge.bank_billet.payment.confirmed", "data.bank_billet_query.success", "data.bank_billet_query.error", "data.bank_billet_query.db.created", "data.bank_billet_query.db.updated", "data.bank_billet_query.db.deleted", "data.pix_qrcode_query.success", "data.pix_qrcode_query.error", "data.pix_qrcode_query.db.created", "data.pix_qrcode_query.db.updated", "data.pix_qrcode_query.db.deleted", "mailbox.entry.db.created", "mailbox.entry.db.updated", "mailbox.entry.db.deleted", "mailbox.entry.file.received", "mailbox.entry.file.sent", "mailbox.file.db.created", "mailbox.file.db.updated", "mailbox.file.db.deleted", "mailbox.channel.s3.db.created", "mailbox.channel.s3.db.updated", "mailbox.channel.s3.db.deleted", "mailbox.channel.s3.fetch_all", "mailbox.channel.email.db.created", "mailbox.channel.email.db.updated", "mailbox.channel.email.db.deleted", "mailbox.channel.whatsapp.db.created", "mailbox.channel.whatsapp.db.updated", "mailbox.channel.whatsapp.db.deleted", "mailbox.channel.sftp.db.created", "mailbox.channel.sftp.db.updated", "mailbox.channel.sftp.db.deleted", "mailbox.channel.sftp.fetch_all", "mailbox.channel.syncthing.db.created", "mailbox.channel.syncthing.db.updated", "mailbox.channel.syncthing.db.deleted", "email_account.db.created", "email_account.db.updated", "email_account.db.deleted", "email_account.identity.pending", "email_account.identity.created", "email_account.identity.error", "email_account.identity.failure", "email_account.dns.not_ready", "email_account.dns.awaiting", "email_account.dns.validated", "email_account.dns.error", "email_account.dns.failure", "integration.connection.db.created", "integration.connection.db.updated", "integration.connection.db.deleted", "webhook.db.created", "webhook.db.updated", "webhook.db.deleted", "enotas.nfe.generated" ] } }, { "name": "status", "in": "query", "description": "Situação do webhook delivery", "required": false, "schema": { "type": "integer", "description": "Situação:\n* `0` Pendente\n* `1` Entregue\n* `2` Falhou", "enum": [ "0", "1", "2" ] } } ], "responses": { "200": { "description": "Sucesso na listagem dos webhooks enviados", "content": { "application/json": { "example": [ { "id": 5, "uid": "caa5d13b-a7db-47e2-a4d6-2c9523a2d69b", "url": null, "duration": null, "request_headers": null, "request_payload": { "event_code": "bank_billet.created", "webhook": { "id": 5, "url": "http://dev.bole.to:5001", "first_try": "2026-09-04T12:54:17-05:00" } }, "request_error": null, "response_body": null, "response_code": null, "response_headers": null, "response_message": null, "delivered_at": null, "first_try": null, "fails_count": 0, "failed_at": null, "status": "pending", "bank_billet_account_id": null, "content_type": null, "webhook_id": 5, "event_code": "bank_billet.created", "resource_owner_id": 54, "created_at": "2026-09-04T12:54:17-05:00", "updated_at": "2026-09-04T12:54:17-05:00", "resource_owner": { "uid": "01a06d8e-9c55-729c-a2aa-a211f7869e8d", "type": "bank_billet" }, "resource_base": { "uid": "01a06d8e-9c55-729c-a2aa-a211f7869e8d", "type": "bank_billet" } }, { "id": 4, "uid": "9a9dc71b-ff8b-4dc5-bf21-f128afeb0928", "url": null, "duration": null, "request_headers": null, "request_payload": { "event_code": "bank_billet.created", "webhook": { "id": 4, "url": "http://dev.bole.to:5001", "first_try": "2026-09-04T12:54:17-05:00" } }, "request_error": null, "response_body": null, "response_code": null, "response_headers": null, "response_message": null, "delivered_at": null, "first_try": null, "fails_count": 0, "failed_at": null, "status": "pending", "bank_billet_account_id": null, "content_type": null, "webhook_id": 4, "event_code": "bank_billet.created", "resource_owner_id": 53, "created_at": "2026-09-04T12:54:17-05:00", "updated_at": "2026-09-04T12:54:17-05:00", "resource_owner": { "uid": "01a06d8e-9c1c-7649-9506-17f9f0ba5277", "type": "bank_billet" }, "resource_base": { "uid": "01a06d8e-9c1c-7649-9506-17f9f0ba5277", "type": "bank_billet" } }, { "id": 3, "uid": "1756bd7f-9d6f-4cdb-b7bd-5efa78aa6ac2", "url": null, "duration": null, "request_headers": null, "request_payload": { "event_code": "bank_billet.created", "webhook": { "id": 3, "url": "http://dev.bole.to:5001", "first_try": "2026-09-04T12:54:17-05:00" } }, "request_error": null, "response_body": null, "response_code": null, "response_headers": null, "response_message": null, "delivered_at": null, "first_try": null, "fails_count": 0, "failed_at": null, "status": "pending", "bank_billet_account_id": null, "content_type": null, "webhook_id": 3, "event_code": "bank_billet.created", "resource_owner_id": 52, "created_at": "2026-09-04T12:54:17-05:00", "updated_at": "2026-09-04T12:54:17-05:00", "resource_owner": { "uid": "01a06d8e-9be5-7c2f-96a8-8ddf6339c89f", "type": "bank_billet" }, "resource_base": { "uid": "01a06d8e-9be5-7c2f-96a8-8ddf6339c89f", "type": "bank_billet" } }, { "id": 2, "uid": "f33caf2d-2929-4446-b72a-0f03e668794b", "url": null, "duration": null, "request_headers": null, "request_payload": { "event_code": "bank_billet.created", "webhook": { "id": 2, "url": "http://dev.bole.to:5001", "first_try": "2026-09-04T12:54:17-05:00" } }, "request_error": null, "response_body": null, "response_code": null, "response_headers": null, "response_message": null, "delivered_at": null, "first_try": null, "fails_count": 0, "failed_at": null, "status": "pending", "bank_billet_account_id": null, "content_type": null, "webhook_id": 2, "event_code": "bank_billet.created", "resource_owner_id": 51, "created_at": "2026-09-04T12:54:17-05:00", "updated_at": "2026-09-04T12:54:17-05:00", "resource_owner": { "uid": "01a06d8e-9bab-710b-9d61-c97974c11450", "type": "bank_billet" }, "resource_base": { "uid": "01a06d8e-9bab-710b-9d61-c97974c11450", "type": "bank_billet" } }, { "id": 1, "uid": "db04547f-2bfa-4598-9ad0-698c0a4e54f4", "url": null, "duration": null, "request_headers": null, "request_payload": { "event_code": "bank_billet.created", "webhook": { "id": 1, "url": "http://dev.bole.to:5001", "first_try": "2026-09-04T12:54:18-05:00" } }, "request_error": null, "response_body": null, "response_code": null, "response_headers": null, "response_message": null, "delivered_at": null, "first_try": null, "fails_count": 0, "failed_at": null, "status": "pending", "bank_billet_account_id": null, "content_type": null, "webhook_id": 1, "event_code": "bank_billet.created", "resource_owner_id": 50, "created_at": "2026-09-04T12:54:17-05:00", "updated_at": "2026-09-04T12:54:17-05:00", "resource_owner": { "uid": "01a06d8e-9b70-7750-99f7-322a11032f53", "type": "bank_billet" }, "resource_base": { "uid": "01a06d8e-9b70-7750-99f7-322a11032f53", "type": "bank_billet" } } ], "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1_webhook_delivery_object" } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/webhook_deliveries/{id}": { "get": { "summary": "Informações do Webhook Enviado", "tags": [ "Log de Webhooks" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de um webhook enviado", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "ID do webhook", "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Webhook encontrado com sucesso", "content": { "application/json": { "example": { "id": 6, "uid": "e4d254b6-c9a4-42f2-be05-3db508dfc162", "url": null, "duration": null, "request_headers": null, "request_payload": { "event_code": "bank_billet.created", "webhook": { "id": 6, "url": "http://dev.bole.to:5001", "first_try": "2026-09-04T12:54:18-05:00" } }, "request_error": null, "response_body": null, "response_code": null, "response_headers": null, "response_message": null, "delivered_at": null, "first_try": null, "fails_count": 0, "failed_at": null, "status": "pending", "bank_billet_account_id": null, "content_type": null, "webhook_id": 6, "event_code": "bank_billet.created", "resource_owner_id": 55, "created_at": "2026-09-04T12:54:18-05:00", "updated_at": "2026-09-04T12:54:18-05:00", "resource_owner": { "uid": "01a06d8e-9dad-7b8d-9368-1c22b3da5901", "type": "bank_billet" }, "resource_base": { "uid": "01a06d8e-9dad-7b8d-9368-1c22b3da5901", "type": "bank_billet" } }, "schema": { "$ref": "#/components/schemas/v1_webhook_delivery_object" } } } }, "404": { "description": "Webhook não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/webhook_deliveries/resend": { "put": { "summary": "Reenviar Webhooks Enviados", "tags": [ "Log de Webhooks" ], "security": [ { "bearerAuth": [] } ], "description": "Reenviar webhooks enviados.\n\nEstá limitado aos primeiros 1000 encontrados na busca conforme os parâmetros.\n\nO `ID do Objeto` vai retornar todos e qualquer tipo de objeto que tenha o ID enviado, ou seja, se você enviar 1, poderá retornar boletos, clientes e etc. Caso queira um filtro mais refinado, combine o `ID do Objeto` com o `Código do evento`.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Webhooks reeenviados com sucesso", "content": { "application/json": { "example": { "message": "Solicitação de reenvio de webhook deliveries enviada para processamento" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1_webhook_delivery_resend_object" } } }, "required": true, "description": "Informações para filtrar os webhooks a serem reenviados" } } }, "/v1/webhooks": { "post": { "summary": "Criar Webhook", "tags": [ "Webhooks" ], "security": [ { "bearerAuth": [] } ], "description": "Cria um webhook para receber notificações de eventos do sistema via HTTP.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Webhook criado com Basic Auth", "content": { "application/json": { "example": { "id": 13, "uid": "01a06d8e-a05a-7658-b7bb-2972991d5e1e", "name": null, "url": "http://example.com/new", "content_type": "application/json", "events": [ "bank_billet.created" ], "ssl_verification_enabled": true, "active": true, "concurrency_limit": 10, "subaccounts": false, "auth_kind": "basic_auth", "created_at": "2026-09-04T12:54:18-05:00", "updated_at": "2026-09-04T12:54:18-05:00", "secret_key": "05eba3ed3d598d8533095e9ef1574309b54d5f97878910690659c747b6888faa" }, "schema": { "$ref": "#/components/schemas/v1_webhook_object" } } } }, "422": { "description": "Webhook inválido", "content": { "application/json": { "example": { "errors": { "url": [ "não pode ficar em branco" ], "event_codes": [ "não pode ficar em branco" ] } }, "schema": { "$ref": "#/components/schemas/v1_errors_object" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1_webhook_object" } } }, "required": true, "description": "Informações a serem salvas no webhook" } }, "get": { "summary": "Listar Webhooks", "tags": [ "Webhooks" ], "security": [ { "bearerAuth": [] } ], "description": "Lista webhooks.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } } ], "responses": { "200": { "description": "Sucesso na listagem de webhooks", "content": { "application/json": { "example": [ { "id": 18, "uid": "01a06d8e-a167-7b24-b0d8-eeaf52cc9b40", "name": "Nome do Webhook", "url": "http://dev.bole.to:5001", "content_type": "application/json", "events": [ "bank_billet.created" ], "ssl_verification_enabled": true, "active": true, "concurrency_limit": 10, "subaccounts": false, "auth_kind": "none", "created_at": "2026-09-04T12:54:19-05:00", "updated_at": "2026-09-04T12:54:19-05:00" }, { "id": 17, "uid": "01a06d8e-a15f-7659-a897-f57a35f69b65", "name": "Nome do Webhook", "url": "http://dev.bole.to:5001", "content_type": "application/json", "events": [ "bank_billet.created" ], "ssl_verification_enabled": true, "active": true, "concurrency_limit": 10, "subaccounts": false, "auth_kind": "none", "created_at": "2026-09-04T12:54:19-05:00", "updated_at": "2026-09-04T12:54:19-05:00" }, { "id": 16, "uid": "01a06d8e-a157-7873-b9fc-b4a505aec711", "name": "Nome do Webhook", "url": "http://dev.bole.to:5001", "content_type": "application/json", "events": [ "bank_billet.created" ], "ssl_verification_enabled": true, "active": true, "concurrency_limit": 10, "subaccounts": false, "auth_kind": "none", "created_at": "2026-09-04T12:54:19-05:00", "updated_at": "2026-09-04T12:54:19-05:00" }, { "id": 15, "uid": "01a06d8e-a14f-7572-aaac-a0e2795de329", "name": "Nome do Webhook", "url": "http://dev.bole.to:5001", "content_type": "application/json", "events": [ "bank_billet.created" ], "ssl_verification_enabled": true, "active": true, "concurrency_limit": 10, "subaccounts": false, "auth_kind": "none", "created_at": "2026-09-04T12:54:19-05:00", "updated_at": "2026-09-04T12:54:19-05:00" }, { "id": 14, "uid": "01a06d8e-a147-7053-9cbb-e5f0bdacb008", "name": "Nome do Webhook", "url": "http://dev.bole.to:5001", "content_type": "application/json", "events": [ "bank_billet.created" ], "ssl_verification_enabled": true, "active": true, "concurrency_limit": 10, "subaccounts": false, "auth_kind": "none", "created_at": "2026-09-04T12:54:19-05:00", "updated_at": "2026-09-04T12:54:19-05:00" } ], "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1_webhook_object" } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/webhooks/{id}": { "get": { "summary": "Informações do Webhook", "tags": [ "Webhooks" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de um Webhook.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "ID do webhook", "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Webhook encontrado", "content": { "application/json": { "example": { "id": 19, "uid": "01a06d8e-a1e1-7fd5-9760-0acd56108ba8", "name": "Nome do Webhook", "url": "http://dev.bole.to:5001", "content_type": "application/json", "events": [ "bank_billet.created" ], "ssl_verification_enabled": true, "active": true, "concurrency_limit": 10, "subaccounts": false, "auth_kind": "none", "created_at": "2026-09-04T12:54:19-05:00", "updated_at": "2026-09-04T12:54:19-05:00" }, "schema": { "$ref": "#/components/schemas/v1_webhook_object" } } } }, "404": { "description": "Webhook não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } }, "put": { "summary": "Atualizar Webhook", "tags": [ "Webhooks" ], "security": [ { "bearerAuth": [] } ], "description": "Atualiza informações específicas de um webhook.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID do webhook", "example": 999, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Atualização parcial de auth preserva campos secretos existentes" }, "404": { "description": "Webhook não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1_webhook_object" } } }, "required": true, "description": "Informações a serem atualizadas no webhook" } }, "delete": { "summary": "Excluir Webhook", "tags": [ "Webhooks" ], "security": [ { "bearerAuth": [] } ], "description": "Exclui um webhook específicos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID do webhook", "example": 999, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Webhook excluido" }, "404": { "description": "Webhook não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/bank_billet_batch_exports/{id}": { "get": { "summary": "Arquivo de Exportação do Lote", "tags": [ "Exportação do Lote" ], "security": [ { "bearerAuth": [] } ], "description": "Arquivo de exportação do lote.\n\nCaso o arquivo ainda não tenha sido processado a resposta será 404. Caso o arquivo já esteja pronto para download a resposta será um redirect para o download do arquivo.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "ID arquivo de exportação do lote", "example": 999, "schema": { "type": "string" } } ], "responses": { "302": { "description": "Exportação de lote gerada com sucesso" }, "404": { "description": "Exportação de lote não processada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/bank_billet_batches": { "post": { "summary": "Criar Lote", "tags": [ "Lotes" ], "security": [ { "bearerAuth": [] } ], "description": "Criar Lote.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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 criado com sucesso", "content": { "application/json": { "example": { "id": 3, "uid": "01a06d8e-a5a6-7a1d-a98d-39ce6f0d31f3", "created_at": "2026-09-04T12:54:20-05:00", "updated_at": "2026-09-04T12:54:20-05:00", "name": "Lote de Boletos", "bank_billet_ids": [ 65, 66 ] }, "schema": { "$ref": "#/components/schemas/v1_bank_billet_batch_object" } } } }, "422": { "description": "Dados inválidos", "content": { "application/json": { "example": { "errors": { "name": [ "não pode ficar em branco" ] } }, "schema": { "$ref": "#/components/schemas/v1_errors_object" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1_bank_billet_batch_create_object" } } }, "required": true, "description": "Dados do pagamento do boleto" } }, "get": { "summary": "Listar Lotes", "tags": [ "Lotes" ], "security": [ { "bearerAuth": [] } ], "description": "Listar Lotes.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } } ], "responses": { "200": { "description": "Sucesso na listagem dos lotes", "content": { "application/json": { "example": [ { "id": 6, "uid": "01a06d8e-a6e2-7f45-9635-dcbff349abbc", "created_at": "2026-09-04T12:54:20-05:00", "updated_at": "2026-09-04T12:54:20-05:00", "name": "Lote", "bank_billet_ids": [ 71, 72 ] }, { "id": 5, "uid": "01a06d8e-a69b-74f8-a007-620dd3010053", "created_at": "2026-09-04T12:54:20-05:00", "updated_at": "2026-09-04T12:54:20-05:00", "name": "Lote", "bank_billet_ids": [ 69, 70 ] }, { "id": 4, "uid": "01a06d8e-a64b-7a0d-9971-1ee16c5fa92d", "created_at": "2026-09-04T12:54:20-05:00", "updated_at": "2026-09-04T12:54:20-05:00", "name": "Lote", "bank_billet_ids": [ 67, 68 ] } ], "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1_bank_billet_batch_object" } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/bank_billet_batches/{id}/": { "get": { "summary": "Informações do Lote", "tags": [ "Lotes" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de um Lote.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Lote", "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Lote encontrado", "content": { "application/json": { "example": { "id": 7, "uid": "01a06d8e-a78e-74b9-a106-2a1a36b4b01a", "created_at": "2026-09-04T12:54:20-05:00", "updated_at": "2026-09-04T12:54:20-05:00", "name": "Lote", "bank_billet_ids": [ 73, 74 ] }, "schema": { "$ref": "#/components/schemas/v1_bank_billet_batch_object" } } } }, "404": { "description": "Lote não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } }, "delete": { "summary": "Excluir o lote", "tags": [ "Lotes" ], "security": [ { "bearerAuth": [] } ], "description": "Excluir lote.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Lote", "example": 999, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Lote excluído" }, "404": { "description": "Lote não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/bank_billet_batches/{id}/add_bank_billets": { "put": { "summary": "Incluir Boletos no Lote", "tags": [ "Lotes" ], "security": [ { "bearerAuth": [] } ], "description": "Incluir boletos no lote.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Lote", "example": 999, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Boletos adicionados com sucesso" }, "404": { "description": "Lote não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "422": { "description": "Dados inválidos", "content": { "application/json": { "example": { "errors": { "bank_billet_batch_associations": [ "não é válido" ] } }, "schema": { "$ref": "#/components/schemas/v1_errors_object" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "bank_billet_ids" ], "properties": { "bank_billet_ids": { "type": "string", "nullable": true, "description": "IDs dos [Boletos](/reference/post_v1-bank-billets-1) separados por vírgula.", "example": null } } } } }, "required": true, "description": "IDs dos Boletos" } } }, "/v1/bank_billet_batches/{id}/remove_bank_billet": { "delete": { "summary": "Excluir Boleto do Lote", "tags": [ "Lotes" ], "security": [ { "bearerAuth": [] } ], "description": "Excluir boleto do lote.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Lote", "example": 999, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Boleto removido com sucesso" }, "404": { "description": "Lote não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "bank_billet_id" ], "properties": { "bank_billet_id": { "type": "integer", "nullable": true, "description": "ID dos [Boleto](/reference/post_v1-bank-billets-1) separados por vírgula.", "example": null } } } } }, "required": true, "description": "ID dos Boleto" } } }, "/v1/bank_billet_batches/{id}/zip": { "post": { "summary": "Exportar Lote no Formato .zip", "tags": [ "Lotes" ], "security": [ { "bearerAuth": [] } ], "description": "Exportar lote no formato .zip.\n\nApós a requisição a exportação entra numa fila para gerar o arquivo do lote. A URL do arquivo do lote será retornada pelo endpoint de [Exportação do Lote](/reference/get_v1-bank-billet-batch-exports-id).", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Lote", "example": 999, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Solicitação de exportação do lote criada com sucesso", "content": { "application/json": { "example": { "id": 3, "account_id": 186, "account_public_id": "01a06d8e-abac-7c87-826b-2f501d83e501", "bank_billet_batch_id": 12, "bank_billet_batch_public_id": "01a06d8e-ac00-7146-aae6-65000739a16c", "created_at": "2026-09-04T12:54:21-05:00", "file_format": "zip", "output_url": null, "processed_at": null, "public_id": "01a06d8e-ac11-79ba-8ae2-45491de06739", "status": "enqueued", "updated_at": "2026-09-04T12:54:21-05:00" }, "schema": { "$ref": "#/components/schemas/v1_bank_billet_batch_export_object" } } } }, "404": { "description": "Lote não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/bank_billet_batches/{id}/pdf": { "post": { "summary": "Exportar Lote no Formato .pdf", "tags": [ "Lotes" ], "security": [ { "bearerAuth": [] } ], "description": "Exportar lote no formato .pdf.\n\nApós a requisição a exportação entra numa fila para gerar o arquivo do lote. A URL do arquivo do lote será retornada pelo endpoint de [Exportação do Lote](/reference/get_v1-bank-billet-batch-exports-id).", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Lote", "example": 999, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Solicitação de exportação do lote criada com sucesso", "content": { "application/json": { "example": { "id": 4, "account_id": 189, "account_public_id": "01a06d8e-ac8f-7b47-97e0-0baead8f8fc8", "bank_billet_batch_id": 13, "bank_billet_batch_public_id": "01a06d8e-acec-7e3f-b346-85772a34fe63", "created_at": "2026-09-04T12:54:22-05:00", "file_format": "pdf", "output_url": null, "processed_at": null, "public_id": "01a06d8e-acfd-74e5-a5f5-fe22b5206b12", "status": "enqueued", "updated_at": "2026-09-04T12:54:22-05:00" }, "schema": { "$ref": "#/components/schemas/v1_bank_billet_batch_export_object" } } } }, "404": { "description": "Lote não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/bank_billet_discharges": { "get": { "summary": "Listar Registros de Retorno", "tags": [ "Registro de Retorno" ], "security": [ { "bearerAuth": [] } ], "description": "Lista registros de retorno.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "processed_from", "in": "query", "description": "A partir da Data de processamento.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "processed_to", "in": "query", "description": "Até a Data de processamento.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "bank_billet_id", "in": "query", "schema": { "type": "string" }, "description": "ID do Boleto.", "example": "999", "required": false }, { "name": "discharge_id", "in": "query", "schema": { "type": "string" }, "description": "ID do Retorno.", "example": "999", "required": false }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "our_occurrence", "in": "query", "required": false, "description": "Código único de operação de retorno dentro da Kobana.", "schema": { "type": "string", "maxLength": 4, "description": "Código único de operação de retorno dentro da Kobana.\n\n| Código | Descrição |\n|---|---|\n| 2001 | Entrada Confirmada |\n| 2002 | Entrada Rejeitada |\n| 2003 | Liquidação |\n| 2004 | Baixa de Título Confirmada |\n| 2005 | Baixa de Título Rejeitada |\n| 2006 | Alteração do Vencimento Confirmada |\n| 2007 | Alteração do Vencimento Rejeitada |\n| 2008 | Baixa Solicitada |\n| 2009 | Títulos em Carteira (em ser) |\n| 2010 | Confirmação de Recebimento de Instrução de Abatimento |\n| 2011 | Confirmação de Recebimento de Instrução de Cancelamento Abatimento |\n| 2012 | Confirmação de Recebimento de Instrução de Alteração de Vencimento |\n| 2013 | Franco de Pagamento |\n| 2014 | Liquidação Após Baixa ou Liquidação Título Não Registrado |\n| 2015 | Confirmação Recebimento Instrução de Protesto |\n| 2016 | Confirmação Recebimento Instrução de Sustação/Cancelamento de Protesto |\n| 2017 | Remessa a Cartório (Aponte em Cartório) |\n| 2018 | Retirada de Cartório e Manutenção em Carteira |\n| 2019 | Protestado e Baixado (Baixa por ter sido Protestado) |\n| 2020 | Instrução Rejeitada |\n| 2021 | Confirmação do Pedido de Alteração de Outros Dados |\n| 2022 | Débito de Tarifas/Custas |\n| 2023 | Ocorrências do Sacado |\n| 2024 | Alteração de Dados Rejeitada |\n| 2025 | Título pago com cheque devolvido |\n| 2026 | Título pago com cheque pendente de compensação |\n| 2027 | Liquidado sem registro |\n| 2028 | Liquidação Normal |\n| 2029 | Liquidação por Conta/Parcial |\n| 2030 | Liquidação por Saldo |\n| 2031 | Transferência de Carteira/Entrada |\n| 2032 | Transferência de Carteira/Baixa |\n| 2033 | Abatimento Concedido |\n| 2034 | Abatimento Cancelado |\n| 2035 | Liquidação em Cartório |\n| 2036 | Confirmação de alteração de juros de mora |\n| 2037 | Débito em Conta |\n| 2038 | Alteração do Nome do Sacado |\n| 2039 | Alteração do Endereço do Sacado |\n| 2040 | Indicação de encaminhamento a cartório |\n| 2041 | Sustar Protesto |\n| 2042 | Dispensar Juros de mora |\n| 2043 | Alteração do número do título dado pelo Cedente (Seu número) – 10 e 15 posições |\n| 2044 | Manutenção de título vencido |\n| 2045 | Conceder desconto |\n| 2046 | Não conceder desconto |\n| 2047 | Retificar desconto |\n| 2048 | Alterar data para desconto |\n| 2049 | Cobrar Multa |\n| 2050 | Dispensar Multa |\n| 2051 | Dispensar Indexador |\n| 2052 | Dispensar prazo limite para recebimento |\n| 2053 | Alterar prazo limite para recebimento |\n| 2054 | Alteração do número do controle do participante (25 posições) |\n| 2055 | Alteração do número do documento do sacado (CNPJ/CPF) |\n| 2056 | Alteração de tipo de cobrança (específico para títulos das carteiras 11 e 17) |\n| 2057 | Confirmação de Instrução de Parâmetro de Pagamento Parcial |\n| 2058 | Despesas de Protesto |\n| 2059 | Despesas de Sustação de Protesto |\n| 2060 | Débito de Custas Antecipadas |\n| 2061 | Confirmação do recebimento da instrução de desconto |\n| 2062 | Confirmação do recebimento do cancelamento do desconto |\n| 2063 | Solicitação de 2a via de instrumento de protesto |\n| 2064 | 2a via de instrumento de protesto emitida pelo cartório |\n| 2065 | Confirmação da alteração dos dados do sacado |\n| 2066 | Confirmação da alteração dos dados do sacador avalista |\n| 2067 | Título DDA reconhecido pelo sacado |\n| 2068 | Título DDA não reconhecido pelo sacado |\n| 2069 | Título DDA recusado pela CIP |\n| 2070 | Instrução de protesto processada |\n| 2071 | Remessa rejeitada |\n| 2072 | Baixa de título liquidado por edital |\n| 2073 | Devolução automática |\n| 2074 | Baixado conforme instruções |\n| 2075 | Arquivo levantamento |\n| 2076 | Pagamento em cartório |\n| 2077 | Alteração de dados |\n| 2078 | Alteração de instruções |\n| 2079 | Aguardando autorização para protesto por edital |\n| 2080 | Protesto sustado por alteração de vencimento e prazo de cartório |\n| 2081 | Confirmação da entrada em cartório |\n| 2082 | cobrança a creditar (liquidação em trânsito) |\n| 2083 | Título em trânsito pago em cartório |\n| 2084 | Reembolso e transferência Desconto e Vendor ou carteira em garantia |\n| 2085 | Reembolso e devolução Desconto e Vendor |\n| 2086 | Reembolso não efetuado por falta de saldo |\n| 2087 | Despesa de aponte |\n| 2088 | Alteração de título |\n| 2089 | Relação de títulos |\n| 2090 | Manutenção mensal |\n| 2091 | Sustação de cartório e envio de título a cartório |\n| 2092 | Fornecimento de formulário pré-impresso |\n| 2093 | Confirmação de entrada – Pagador DDA |\n| 2094 | Acerto dos dados do rateio de crédito |\n| 2095 | Cancelamento dos dados do rateio |\n| 2096 | Pagamento por Conta |\n| 2097 | Baixa Simples |\n| 2098 | Devolvido - Protestado |\n| 2099 | Baixa automática |\n| 2100 | Alteração Depositária |\n| 2101 | Confirmação de Protesto |\n| 2102 | Título Pago em Cheque – Vinculado |\n| 2103 | Acerto de Depositária |\n| 2104 | Acerto do Controle do Participante |\n| 2105 | Título Com Pagamento Cancelado |\n| 2106 | Entrada rejeitada por CEP Irregular |\n| 2107 | Confirmação Receb.Inst.de Protesto Falimentar |\n| 2108 | Ocorrências do Pagador |\n| 2109 | Retirado de Cartório e Manutenção Carteira |\n| 2110 | Desagendamento do débito automático |\n| 2111 | Estorno de pagamento |\n| 2112 | Sustado judicial |\n| 2113 | Solicitação de Impressão de Títulos Confirmada |\n| 2114 | Confirmação de Inclusão Banco de Pagador |\n| 2115 | Confirmação de Alteração Banco de Pagador |\n| 2116 | Confirmação de Exclusão Banco de Pagador |\n| 2117 | Emissão de Boletos de Banco de Pagador |\n| 2118 | Manutenção de Pagador Rejeitada |\n| 2119 | Entrada de Título via Banco de Pagador Rejeitada |\n| 2120 | Manutenção de Banco de Pagador Rejeitada |\n| 2121 | Estorno de Baixa / Liquidação |\n| 2122 | Liquidação On-line |\n| 2123 | Estorno de Liquidação On-line |\n| 2124 | Confirmação de alteração do valor nominal do título |\n| 2125 | Confirmação de alteração do valor/percentual mínimo/máximo |\n| 2126 | Baixa Manual Confirmada |\n| 2127 | Uso da Empresa Alterado |\n| 2128 | Prazo de Protesto Alterado |\n| 2129 | Prazo de Devolução Alterado |\n| 2130 | Alteração com reemissão de Bloqueto Confirmada |\n| 2131 | Alteração da opção de Protesto para Devolução Confirmada |\n| 2132 | Alteração da opção de Devolução para Protesto Confirmada |\n| 2133 | Baixa por Devolução |\n| 2134 | Título enviado para Cartório |\n| 2135 | Estorno de Protesto |\n| 2136 | Estorno de Sustação de Protesto |\n| 2137 | Tarifa sobre Título Vencido |\n| 2138 | Outras Tarifas de Alteração |\n| 2139 | Tarifas Diversas |\n| 2140 | Rejeição do Título |\n| 2141 | Confirmação de Envio de SMS |\n| 2142 | Envio de SMS rejeitado |\n| 2143 | Cancelamento de SMS |\n| 2144 | Liquidação de boleto cooperativa emite e expede |\n| 2145 | Liquidação de boleto após baixa ou não registrado cooperativa emite e expede |\n| 2146 | Título em aberto não enviado ao pagador |\n| 2147 | Inconsistência Negativação Serasa |\n| 2148 | Inclusão Negativação via Serasa |\n| 2149 | Exclusão Negativação Serasa |\n| 2150 | Devolução por Decurso de Prazo |\n| 2151 | Confirmação de Pedido de Exclusão da Serasa |\n| 2152 | Título enviado para negativação |\n| 2153 | Alegação do Sacado |\n| 2154 | Título retirado de cartório |\n| 2155 | Custa de distribuição |\n| 2156 | Custa de sustação |\n| 2157 | Custa de protesto |\n| 2158 | Movimentação CIP |\n| 2159 | Alteração De Dados – Nova Entrada ou Alteração/Exclusão de Dados Acatada |\n| 2160 | Alteração de Dados – Baixa |\n| 2161 | Baixa Por Ter Sido Liquidado |\n| 2162 | Cobrança Contratual – Instruções/Alterações Rejeitadas/Pendentes |\n| 2163 | Confirmação Recebimento de Instrução de Não Protestar |\n| 2164 | Protesto Enviado a Cartório/Tarifa |\n| 2165 | Tarifa de Aviso de Cobrança |\n| 2166 | Tarifa de Extrato Posição |\n| 2167 | Tarifa de Relação das Liquidações |\n| 2168 | Tarifa de Manutenção de Títulos Vencidos |\n| 2169 | Débito Mensal de Tarifas (para entradas e baixas) |\n| 2170 | Custas de Edital |\n| 2171 | Tarifa de Emissão de Boleto/Tarifa de Envio de Duplicata |\n| 2172 | Tarifa de Instrução |\n| 2173 | Tarifa de Ocorrências |\n| 2174 | Tarifa Mensal de Emissão de Boleto/Tarifa Mensal de Envio de Duplicata |\n| 2175 | Débito Mensal de Tarifas – Extrato de Posição (b4ep/b4ox) |\n| 2176 | Débito Mensal de Tarifas – Outras Instruções |\n| 2177 | Débito Mensal de Tarifas – Manutenção de Títulos Vencidos |\n| 2178 | Débito Mensal de Tarifas – Outras Ocorrências |\n| 2179 | Débito Mensal de Tarifas – Protesto |\n| 2180 | Débito Mensal de Tarifas – Sustação de Protesto |\n| 2181 | Baixa Com Transferência Para Desconto |\n| 2182 | Custas de Sustação Judicial |\n| 2183 | Tarifa Mensal Referente A Entradas Bancos Correspondentes Na Carteira |\n| 2184 | Tarifa Mensal Baixas Na Carteira |\n| 2185 | Tarifa Mensal Baixas Em Bancos Correspondentes Na Carteira |\n| 2186 | Tarifa Mensal de Liquidações Na Carteira |\n| 2187 | Tarifa Mensal de Liquidações Em Bancos Correspondentes Na Carteira |\n| 2188 | Custas de Irregularidade |\n| 2189 | Instrução Cancelada |\n| 2190 | Comando Recusado |\n| 2191 | Código de IOF inválido |\n| 2192 | Título não existe |\n| 2193 | Prorrogação de Vencimento |\n| 2194 | Título Já Baixado/Protestado |\n| 2195 | Custas de Cartório |\n| 2196 | Confirmação de envio de e-mail/SMS |\n| 2197 | Envio de e-mail/SMS rejeitado |\n| 2198 | Título pago com cheque compensado |\n| 2199 | Instrução para protesto para fins falimentares confirmada |\n| 2200 | Alteração de contrato de cobrança |\n| 2201 | Confirmação da Instrução de Baixa de Título Negativado sem Protesto |\n| 2202 | Confirmação de Pedido de Dispensa de Multa |\n| 2203 | Confirmação do Pedido de Cobrança de Multa |\n| 2204 | Confirmação do Pedido de Alteração de Cobrança de Juros |\n| 2205 | Confirmação do Pedido de Alteração do Valor/Data de Desconto |\n| 2206 | Confirmação do Pedido de Alteração do Beneficiário do Título |\n| 2207 | Confirmação do Pedido de Dispensa de Juros de Mora |\n| 2208 | Confirmação de instrução de transferência de carteira/modalidade de cobrança |\n| 2209 | Confirmação de Desistência de Protesto |\n| 2210 | Encaminhado a Protesto |\n| 2211 | Baixado automaticamente via arquivo |\n| 2212 | Baixa rejeitada |\n| 2213 | Tarifa |\n| 2214 | Rejeição do pagador |\n| 2215 | Alteração rejeitada |\n| 2216 | Aceite do Pagador |\n| 2217 | Baixa por Crédito em Conta Corrente |\n| 2218 | Entrada Rejeitada Carnê |\n| 2219 | Tarifa Emissão Aviso de Movimentação de Títulos |\n| 2220 | Débito Mensal de Tarifas - Aviso de Movimentação de Títulos |\n| 2221 | Entrada Confirmada com Rateio de Crédito |\n| 2222 | Baixa por Crédito em Conta Corrente sem Título Correspondente |\n| 2223 | Confirmação de Entrada na Cobrança |\n| 2224 | Instrução de Negativação Expressa Rejeitada |\n| 2225 | Confirma o Recebimento de Instrução de Entrada Em Negativação Expressa |\n| 2226 | Confirma o Recebimento de Instrução de Exclusão de Entrada Em Negativação Expressa |\n| 2227 | Confirma o Recebimento de Instrução de Cancelamento de Negativação Expressa |\n| 2228 | Negativação Expressa Informacional |\n| 2229 | Confirma de Entrada Em Negativação Expressa / Tarifa |\n| 2230 | Confirma o Cancelamento Em Negativação Expressa / Tarifa |\n| 2231 | Confirma Exclusão de Entrada Em Negativação Expressa Por Liquidação / Tarifa |\n| 2232 | Tarifa Pacote Cobrança Ativa Eletrônica |\n| 2233 | Tarifa E-mail Cobrança Ativa Eletrônica |\n| 2234 | Tarifa Sms Cobrança Ativa Eletrônica |\n| 2235 | Tarifa Mensal Pacote Cobrança Ativa Eletrônica |\n| 2236 | Tarifa Mensal E-mail Cobrança Ativa Eletrônica |\n| 2237 | Tarifa Mensal Sms Cobrança Ativa Eletrônica |\n| 2238 | Tarifa Mensal de Exclusão de Entrada Em Negativação Expressa |\n| 2239 | Tarifa Mensal de Cancelamento de Negativação Expressa |\n| 2240 | Tarifa Mensal de Exclusão de Negativação Expressa Por Liquidação |\n| 2241 | Confirma Recebimento de Instrução de Não Negativar |\n| 2242 | Transferência de Beneficiário |\n| 2243 | Baixa de Título Protestado |\n| 2244 | Despesa de Cartório |\n| 2245 | Acerto de Data de Emissão |\n| 2246 | Acerto de Código de Espécie Documento |\n| 2247 | Instrução Negativação Aceita |\n| 2248 | Instrução Baixa de Negativação Aceita |\n| 2249 | Instrução Não Negativar Aceita |", "enum": [ "2001", "2002", "2003", "2004", "2005", "2006", "2007", "2008", "2009", "2010", "2011", "2012", "2013", "2014", "2015", "2016", "2017", "2018", "2019", "2020", "2021", "2022", "2023", "2024", "2025", "2026", "2027", "2028", "2029", "2030", "2031", "2032", "2033", "2034", "2035", "2036", "2037", "2038", "2039", "2040", "2041", "2042", "2043", "2044", "2045", "2046", "2047", "2048", "2049", "2050", "2051", "2052", "2053", "2054", "2055", "2056", "2057", "2058", "2059", "2060", "2061", "2062", "2063", "2064", "2065", "2066", "2067", "2068", "2069", "2070", "2071", "2072", "2073", "2074", "2075", "2076", "2077", "2078", "2079", "2080", "2081", "2082", "2083", "2084", "2085", "2086", "2087", "2088", "2089", "2090", "2091", "2092", "2093", "2094", "2095", "2096", "2097", "2098", "2099", "2100", "2101", "2102", "2103", "2104", "2105", "2106", "2107", "2108", "2109", "2110", "2111", "2112", "2113", "2114", "2115", "2116", "2117", "2118", "2119", "2120", "2121", "2122", "2123", "2124", "2125", "2126", "2127", "2128", "2129", "2130", "2131", "2132", "2133", "2134", "2135", "2136", "2137", "2138", "2139", "2140", "2141", "2142", "2143", "2144", "2145", "2146", "2147", "2148", "2149", "2150", "2151", "2152", "2153", "2154", "2155", "2156", "2157", "2158", "2159", "2160", "2161", "2162", "2163", "2164", "2165", "2166", "2167", "2168", "2169", "2170", "2171", "2172", "2173", "2174", "2175", "2176", "2177", "2178", "2179", "2180", "2181", "2182", "2183", "2184", "2185", "2186", "2187", "2188", "2189", "2190", "2191", "2192", "2193", "2194", "2195", "2196", "2197", "2198", "2199", "2200", "2201", "2202", "2203", "2204", "2205", "2206", "2207", "2208", "2209", "2210", "2211", "2212", "2213", "2214", "2215", "2216", "2217", "2218", "2219", "2220", "2221", "2222", "2223", "2224", "2225", "2226", "2227", "2228", "2229", "2230", "2231", "2232", "2233", "2234", "2235", "2236", "2237", "2238", "2239", "2240", "2241", "2242", "2243", "2244", "2245", "2246", "2247", "2248", "2249" ] } } ], "responses": { "200": { "description": "Sucesso na listagem de registros de retorno", "content": { "application/json": { "example": [ { "id": 3, "uid": "01a06d8e-ae86-7f13-908a-8a209a692369", "occurrence": "03", "date_of_occurrence": "2014-03-08", "discharge_id": 3, "bank_billet_id": 88, "occurrence_error": "08", "line_parsed": null, "line_raw": null, "processed_at": null, "occurrence_detail": "Comando Recusado", "occurrence_error_detail": "Nosso Número Inválido", "our_occurrence": "2001", "bank_billet_account_id": null, "bank_number": "756", "created_at": "2026-09-04T12:54:22-05:00", "updated_at": "2026-09-04T12:54:22-05:00", "kind": "400" }, { "id": 2, "uid": "01a06d8e-ae4b-7c01-b17c-b8a0fdabeaba", "occurrence": "03", "date_of_occurrence": "2014-03-08", "discharge_id": 2, "bank_billet_id": 87, "occurrence_error": "08", "line_parsed": null, "line_raw": null, "processed_at": null, "occurrence_detail": "Comando Recusado", "occurrence_error_detail": "Nosso Número Inválido", "our_occurrence": "2001", "bank_billet_account_id": null, "bank_number": "756", "created_at": "2026-09-04T12:54:22-05:00", "updated_at": "2026-09-04T12:54:22-05:00", "kind": "400" }, { "id": 1, "uid": "01a06d8e-ae08-73e3-b55d-8eb136f8b643", "occurrence": "03", "date_of_occurrence": "2014-03-08", "discharge_id": 1, "bank_billet_id": 86, "occurrence_error": "08", "line_parsed": null, "line_raw": null, "processed_at": null, "occurrence_detail": "Comando Recusado", "occurrence_error_detail": "Nosso Número Inválido", "our_occurrence": "2001", "bank_billet_account_id": null, "bank_number": "756", "created_at": "2026-09-04T12:54:22-05:00", "updated_at": "2026-09-04T12:54:22-05:00", "kind": "400" } ], "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1_bank_billet_discharge_object" } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/bank_billet_discharges/{id}": { "get": { "summary": "Informações do Registro de Retorno", "tags": [ "Registro de Retorno" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de um Registro de Retorno.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Registro de Retorno", "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Registro de Retorno encontrado", "content": { "application/json": { "example": { "id": 4, "uid": "01a06d8e-af2e-791e-9c74-444f32473681", "occurrence": "03", "date_of_occurrence": "2014-03-08", "discharge_id": 4, "bank_billet_id": 89, "occurrence_error": "08", "line_parsed": null, "line_raw": null, "processed_at": null, "occurrence_detail": "Comando Recusado", "occurrence_error_detail": "Nosso Número Inválido", "our_occurrence": "2001", "bank_billet_account_id": null, "bank_number": "756", "created_at": "2026-09-04T12:54:22-05:00", "updated_at": "2026-09-04T12:54:22-05:00", "kind": "400" }, "schema": { "$ref": "#/components/schemas/v1_bank_billet_discharge_object" } } } }, "404": { "description": "Registro de retorno não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/bank_billet_payments": { "post": { "summary": "Efetuar Pagamento de Boleto", "tags": [ "Recebimento de Boleto" ], "security": [ { "bearerAuth": [] } ], "description": "Efetuar Pagamento de Boleto.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Pagamento efetuado com sucesso", "content": { "application/json": { "example": { "id": 3, "bank_billet_id": 90, "bank_billet_account_id": 115, "discharge_id": null, "paid_at": "2017-03-13", "paid_amount": 40.01, "bank_rate": 4.02, "paid_bank": "001", "paid_agency": "00001", "paid_agency_number": "0000", "paid_agency_digit": "1", "created_at": "2026-09-04T12:54:22-05:00", "credit_at": null, "direct": false, "created_via_api": false, "line_parsed": null, "paid_by_pix": false, "kind": 0, "financial_provider_external_id": null, "uid": "01a06d8e-b035-78fc-b018-1e62bb0eedb5", "pix_id": null, "document_number": null, "our_number": "40086", "customer_person_name": "José da Silva", "expire_at": "2026-09-08", "amount": 50.0, "updated_at": "2026-09-04T12:54:22-05:00" }, "schema": { "$ref": "#/components/schemas/v1_bank_billet_payment_object" } } } }, "422": { "description": "Dados inválidos", "content": { "application/json": { "example": { "errors": { "paid_amount": [ "não pode ficar em branco" ], "paid_at": [ "não pode ficar em branco", "não é uma data válida" ], "kind": [ "não pode ficar em branco" ] } }, "schema": { "$ref": "#/components/schemas/v1_errors_object" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1_bank_billet_payment_object" } } }, "required": true, "description": "Dados do pagamento do boleto" } }, "get": { "summary": "Listar Pagamentos de Boleto", "tags": [ "Recebimento de Boleto" ], "security": [ { "bearerAuth": [] } ], "description": "Listar Pagamentos de Boleto.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "paid_from", "in": "query", "description": "A partir da Data de pagamento.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "paid_to", "in": "query", "description": "Até a Data de pagamento.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "bank_billet_id", "in": "query", "schema": { "type": "string" }, "description": "ID do Boleto.", "example": "999", "required": false }, { "name": "bank_billet_account_id", "in": "query", "schema": { "type": "string" }, "description": "ID da Carteira.", "example": "999", "required": false } ], "responses": { "200": { "description": "Sucesso na listagem dos pagamentos de boletos", "content": { "application/json": { "example": [ { "id": 4, "bank_billet_id": 91, "bank_billet_account_id": 116, "discharge_id": null, "paid_at": "2026-09-06", "paid_amount": 50.0, "bank_rate": 1.5, "paid_bank": "001", "paid_agency": "0001", "paid_agency_number": "0001", "paid_agency_digit": null, "created_at": "2026-09-04T12:54:23-05:00", "credit_at": null, "direct": null, "created_via_api": false, "line_parsed": null, "paid_by_pix": false, "kind": 1, "financial_provider_external_id": null, "uid": "01a06d8e-b13a-7035-8102-047f0ca6c360", "pix_id": null, "document_number": null, "our_number": "40087", "customer_person_name": "José da Silva", "expire_at": "2026-09-08", "amount": 50.0, "updated_at": "2026-09-04T12:54:23-05:00" } ], "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1_bank_billet_payment_object" } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/bank_billet_payments/{id}": { "get": { "summary": "Informações do Pagamento de Boleto", "tags": [ "Recebimento de Boleto" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de um Pagamento de Boleto.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Pagamento de Boleto", "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Pagamento de boleto encontrado", "content": { "application/json": { "example": { "id": 5, "bank_billet_id": 92, "bank_billet_account_id": 117, "discharge_id": null, "paid_at": "2026-09-06", "paid_amount": 50.0, "bank_rate": 1.5, "paid_bank": "001", "paid_agency": "0001", "paid_agency_number": "0001", "paid_agency_digit": null, "created_at": "2026-09-04T12:54:23-05:00", "credit_at": null, "direct": null, "created_via_api": false, "line_parsed": null, "paid_by_pix": false, "kind": 1, "financial_provider_external_id": null, "uid": "01a06d8e-b1d0-76f8-88b2-eff53fe7c24e", "pix_id": null, "document_number": null, "our_number": "40088", "customer_person_name": "José da Silva", "expire_at": "2026-09-08", "amount": 50.0, "updated_at": "2026-09-04T12:54:23-05:00" }, "schema": { "$ref": "#/components/schemas/v1_bank_billet_payment_object" } } } }, "404": { "description": "Pagamento de boleto não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } }, "delete": { "summary": "Excluir Pagamento de Boleto", "tags": [ "Recebimento de Boleto" ], "security": [ { "bearerAuth": [] } ], "description": "Excluir Pagamento de Boleto.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Pagamento de Boleto", "example": 999, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Pagamento de Boleto excluído" }, "404": { "description": "Pagamento de Boleto não encontrado", "content": { "application/json": { "example": { "title": "Recebimento não encontrado", "detail": "O recebimento não foi encontrado ou não pertence a sua conta" }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/bank_billet_registrations": { "get": { "summary": "Listar Registros de Boleto.", "tags": [ "Registro de Boleto" ], "security": [ { "bearerAuth": [] } ], "description": "Listar Registros de Boleto.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "registered_from", "in": "query", "description": "A partir da Data de registro.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "registered_to", "in": "query", "description": "Até a Data de registro.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "bank_billet_id", "in": "query", "schema": { "type": "string" }, "description": "ID do Boleto.", "example": "999", "required": false }, { "name": "bank_billet_account_id", "in": "query", "schema": { "type": "string" }, "description": "ID da Carteira.", "example": "999", "required": false } ], "responses": { "200": { "description": "Sucesso na listagem de registros de boleto", "content": { "application/json": { "example": [ { "id": 3, "uid": "01a06d8e-b38f-7e3e-8008-f4efa29eda01", "bank_billet_id": 95, "bank_billet_account_id": 120, "created_at": "2026-09-04T12:54:23-05:00", "error_message": null, "failed_at": null, "fails_count": 0, "registered_at": null, "status": "1", "updated_at": "2026-09-04T12:54:23-05:00", "retry_blocked": false }, { "id": 2, "uid": "01a06d8e-b361-7886-b960-2a8d9035476b", "bank_billet_id": 94, "bank_billet_account_id": 119, "created_at": "2026-09-04T12:54:23-05:00", "error_message": null, "failed_at": null, "fails_count": 0, "registered_at": null, "status": "1", "updated_at": "2026-09-04T12:54:23-05:00", "retry_blocked": false }, { "id": 1, "uid": "01a06d8e-b337-7894-a395-fad1d7897221", "bank_billet_id": 93, "bank_billet_account_id": 118, "created_at": "2026-09-04T12:54:23-05:00", "error_message": null, "failed_at": null, "fails_count": 0, "registered_at": null, "status": "1", "updated_at": "2026-09-04T12:54:23-05:00", "retry_blocked": false } ], "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1_bank_billet_registration_object" } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/bank_billet_registrations/{id}": { "get": { "summary": "Informações do Registro de Boleto", "tags": [ "Registro de Boleto" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de um Registro de Boleto.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Registro de Boleto", "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Registro de Boleto encontrado", "content": { "application/json": { "example": { "id": 4, "uid": "01a06d8e-b42c-7d5d-8c0b-1d0e5f67394c", "bank_billet_id": 96, "bank_billet_account_id": 121, "created_at": "2026-09-04T12:54:23-05:00", "error_message": null, "failed_at": null, "fails_count": 0, "registered_at": null, "status": "1", "updated_at": "2026-09-04T12:54:23-05:00", "retry_blocked": false }, "schema": { "$ref": "#/components/schemas/v1_bank_billet_registration_object" } } } }, "404": { "description": "Registro de retorno não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/bank_billet_remittances": { "get": { "summary": "Listar Registros de Remessa", "tags": [ "Registro de Remessa" ], "security": [ { "bearerAuth": [] } ], "description": "Listar Registros de Remessa.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "our_code", "in": "query", "required": false, "description": "Código de operação de registro. Consulte os possíveis valores [para cada banco](/reference/bancos-suportados).", "schema": { "type": "string" } }, { "name": "expire_from", "in": "query", "description": "A partir de Data de vencimento.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "expire_to", "in": "query", "description": "Até Data de vencimento.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "bank_billet_id", "in": "query", "schema": { "type": "string" }, "description": "ID do Boleto.", "example": "999", "required": false }, { "name": "bank_billet_account_id", "in": "query", "schema": { "type": "string" }, "description": "ID da Carteira.", "example": "999", "required": false }, { "name": "remittance_id", "in": "query", "schema": { "type": "string" }, "description": "ID da Remessa.", "example": "999", "required": false } ], "responses": { "200": { "description": "Sucesso na listagem de registros de remessa", "content": { "application/json": { "example": [ { "id": 4, "uid": "01a06d8e-b541-7b2f-9cca-393218dea0b6", "our_code": "1001", "occurrence": "01", "remittance_id": null, "bank_billet_id": 99, "bank_billet_account_id": 124, "processed_at": null, "occurrence_detail": "Entrada de Título", "created_at": "2026-09-04T12:54:24-05:00", "updated_at": "2026-09-04T12:54:24-05:00" }, { "id": 3, "uid": "01a06d8e-b510-727d-b4c6-c520d96ea391", "our_code": "1001", "occurrence": "01", "remittance_id": null, "bank_billet_id": 98, "bank_billet_account_id": 123, "processed_at": null, "occurrence_detail": "Entrada de Título", "created_at": "2026-09-04T12:54:24-05:00", "updated_at": "2026-09-04T12:54:24-05:00" }, { "id": 2, "uid": "01a06d8e-b4eb-726d-b821-371a7fad5af6", "our_code": "1001", "occurrence": "01", "remittance_id": null, "bank_billet_id": 97, "bank_billet_account_id": 122, "processed_at": null, "occurrence_detail": "Entrada de Título", "created_at": "2026-09-04T12:54:24-05:00", "updated_at": "2026-09-04T12:54:24-05:00" } ], "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1_bank_billet_remittance_object" } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/bank_billet_remittances/pending": { "get": { "summary": "Listar Registros de Remessa Pendentes", "tags": [ "Registro de Remessa" ], "security": [ { "bearerAuth": [] } ], "description": "Listar Registros de Remessa pendentes", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "our_code", "in": "query", "required": false, "description": "Código de operação de registro. Consulte os possíveis valores [para cada banco](/reference/bancos-suportados).", "schema": { "type": "string" } }, { "name": "expire_from", "in": "query", "description": "A partir de Data de vencimento.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "expire_to", "in": "query", "description": "Até Data de vencimento.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "bank_billet_id", "in": "query", "schema": { "type": "string" }, "description": "ID do Boleto.", "example": "999", "required": false }, { "name": "bank_billet_account_id", "in": "query", "schema": { "type": "string" }, "description": "ID da Carteira.", "example": "999", "required": false }, { "name": "remittance_id", "in": "query", "schema": { "type": "string" }, "description": "ID da Remessa.", "example": "999", "required": false } ], "responses": { "200": { "description": "Sucesso na listagem de registros de remessa", "content": { "application/json": { "example": [ { "id": 7, "uid": "01a06d8e-b61f-7e3f-9d79-19039a77d576", "our_code": "1001", "occurrence": "01", "remittance_id": null, "bank_billet_id": 102, "bank_billet_account_id": 127, "processed_at": null, "occurrence_detail": "Entrada de Título", "created_at": "2026-09-04T12:54:24-05:00", "updated_at": "2026-09-04T12:54:24-05:00" }, { "id": 6, "uid": "01a06d8e-b5f9-7f5e-bb81-fd9f56e55e24", "our_code": "1001", "occurrence": "01", "remittance_id": null, "bank_billet_id": 101, "bank_billet_account_id": 126, "processed_at": null, "occurrence_detail": "Entrada de Título", "created_at": "2026-09-04T12:54:24-05:00", "updated_at": "2026-09-04T12:54:24-05:00" }, { "id": 5, "uid": "01a06d8e-b5d5-716c-bed7-2380f3797cc6", "our_code": "1001", "occurrence": "01", "remittance_id": null, "bank_billet_id": 100, "bank_billet_account_id": 125, "processed_at": null, "occurrence_detail": "Entrada de Título", "created_at": "2026-09-04T12:54:24-05:00", "updated_at": "2026-09-04T12:54:24-05:00" } ], "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1_bank_billet_remittance_object" } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/bank_billet_remittances/{id}/occurrence/{our_code}": { "post": { "summary": "Criar Pendências", "tags": [ "Registro de Remessa" ], "security": [ { "bearerAuth": [] } ], "description": "Criar pendências.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "ID do BOLETO", "example": 999, "schema": { "type": "string" } }, { "name": "our_code", "in": "path", "required": true, "description": "Código de operação de registro. Consulte os possíveis valores [para cada banco](/reference/bancos-suportados).", "example": 1034, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Pendências criada", "content": { "application/json": { "example": { "message": "Boleto 103 - Operação( Pedido de Baixa ) colocado(a) na lista de envio para o banco." }, "schema": { "$ref": "#/components/schemas/v1_message_object" } } } }, "422": { "description": "Não foi possível processar", "content": { "application/json": { "example": { "status": 422, "errors": [ { "title": "Operação não disponível para este banco.", "code": "unprocessable_content" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/bank_billet_remittances/{id}": { "delete": { "summary": "Excluir Pendências", "tags": [ "Registro de Remessa" ], "security": [ { "bearerAuth": [] } ], "description": "Excluir pendências.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Registro de Remessa", "example": 999, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Pendências excluida" }, "404": { "description": "Retorno de remessa não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } }, "get": { "summary": "Informações do Registro de Remessa", "tags": [ "Registro de Remessa" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de um Registro de Remessa.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "ID do Registro de Remessa", "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Registro de Remessa encontrado", "content": { "application/json": { "example": { "id": 9, "uid": "01a06d8e-b8b6-770b-8168-2f4703072a7f", "our_code": "1001", "occurrence": "01", "remittance_id": null, "bank_billet_id": 106, "bank_billet_account_id": 131, "processed_at": null, "occurrence_detail": "Entrada de Título", "created_at": "2026-09-04T12:54:25-05:00", "updated_at": "2026-09-04T12:54:25-05:00" } } } }, "404": { "description": "Registro de Remessa não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/discharges": { "post": { "summary": "Enviar CNAB", "tags": [ "CNAB (Retorno)" ], "security": [ { "bearerAuth": [] } ], "description": "Envia um arquivo CNAB de retorno bancário para processamento de pagamentos e baixas de boletos.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "CNAB enviado com custom_data e tags", "content": { "application/json": { "example": { "id": 6, "uid": "01a06d8e-b9b8-76a8-b159-bf2b4a21f863", "filename": null, "processed_at": null, "created_via_api": true, "status": "unprocessed", "bank_billet_account_id": null, "created_via_integration": null, "created_at": "2026-09-04T12:54:25-05:00", "updated_at": "2026-09-04T12:54:25-05:00", "external_id": "EXT-DIS-123456", "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2", "tag3" ], "tag_list": "tag1, tag2, tag3", "bank_billet_discharges": [] }, "schema": { "$ref": "#/components/schemas/v1_discharge_object" } } } }, "422": { "description": "Dados inválidos", "content": { "application/json": { "example": { "errors": { "file": [ "não pode ficar em branco" ], "filename": [ "não pode ficar em branco" ] } }, "schema": { "$ref": "#/components/schemas/v1_errors_object" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/v1_discharge_send_cnab_object" } } }, "required": true, "description": "Dados do CNAB a ser enviado" } }, "get": { "summary": "Listar CNABs", "tags": [ "CNAB (Retorno)" ], "security": [ { "bearerAuth": [] } ], "description": "Lista CNABs.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "description": "A partir da Data de criação do Retorno.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "created_to", "in": "query", "description": "Até a Data de criação do Retorno.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "bank_billet_account_id", "in": "query", "schema": { "type": "string" }, "description": "Filtro por ID da Carteira.", "example": "999", "required": false }, { "name": "tags", "in": "query", "schema": { "type": "string" }, "description": "Filtro por tags (separadas por vírgula).", "example": "tag1, tag2", "required": false }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } } ], "responses": { "200": { "description": "Sucesso na listagem de CNABs", "content": { "application/json": { "example": [ { "id": 13, "uid": "01a06d8e-bb9f-72ed-9f37-94197f8d8920", "filename": null, "processed_at": null, "created_via_api": false, "status": "unprocessed", "bank_billet_account_id": 133, "created_via_integration": null, "created_at": "2026-09-04T12:54:25-05:00", "updated_at": "2026-09-04T12:54:25-05:00", "external_id": null, "custom_data": null, "tags": [ "tag1", "tag2", "tag3" ], "tag_list": "tag1, tag2, tag3", "bank_billet_discharges": [] } ], "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1_discharge_object" } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/discharges/{id}": { "get": { "summary": "Informações do CNAB", "tags": [ "CNAB (Retorno)" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de um CNAB.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "ID do CNAB", "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CNAB encontrado", "content": { "application/json": { "example": { "id": 16, "uid": "01a06d8e-bc5d-73a7-bf59-019d59e6ecda", "filename": null, "processed_at": null, "created_via_api": false, "status": "unprocessed", "bank_billet_account_id": 134, "created_via_integration": null, "created_at": "2026-09-04T12:54:26-05:00", "updated_at": "2026-09-04T12:54:26-05:00", "external_id": null, "custom_data": null, "tags": [], "tag_list": "", "bank_billet_discharges": [] }, "schema": { "$ref": "#/components/schemas/v1_discharge_object" } } } }, "404": { "description": "CNAB não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/discharges/{id}/pay_off": { "put": { "summary": "Quitar Boletos", "tags": [ "CNAB (Retorno)" ], "security": [ { "bearerAuth": [] } ], "description": "Quitar boletos.\n\nÉ necessário já ter enviado o CNAB. Todos os boletos que forem identificados dentro do CNAB serão marcados como PAGO e os [Webhooks](/reference/webhooks) serão disparados.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID do CNAB", "example": 999, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Boletos quitados" }, "404": { "description": "CNAB não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/discharges/{id}/reprocess": { "put": { "summary": "Reprocessar CNAB", "tags": [ "CNAB (Retorno)" ], "security": [ { "bearerAuth": [] } ], "description": "Reprocessar CNAB", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID do CNAB", "example": 999, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "204": { "description": "CNAB reprocessada" }, "404": { "description": "CNAB não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/discharges/{id}/download": { "get": { "summary": "Download do CNAB", "tags": [ "CNAB (Retorno)" ], "security": [ { "bearerAuth": [] } ], "description": "Download do CNAB", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID do CNAB", "example": 999, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Download com sucesso" }, "404": { "description": "CNAB não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/imports/{collection_name}": { "get": { "summary": "Listar Importações", "tags": [ "Importações" ], "security": [ { "bearerAuth": [] } ], "description": "Lista as importações realizadas para um tipo específico de recurso (clientes, assinaturas, boletos ou carnês).", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "collection_name", "in": "path", "schema": { "type": "string", "enum": [ "customers", "customer_subscriptions", "bank_billets", "installments" ] }, "required": true, "example": "bank_billets", "description": "Tipo da importação:\n* `customers` Clientes\n* `customer_subscriptions` Assinaturas\n* `bank_billets` Boletos\n* `installments` Carnês" } ], "responses": { "200": { "description": "Importações encontradas", "content": { "application/json": { "example": [ { "id": 2, "uid": "01a06d8e-bf2d-7530-b56e-e51025d45be0", "created_rows": 0, "enqueued_at": null, "started_at": null, "finished_at": null, "processed_at": null, "failed_to_create_rows": 0, "failed_to_update_rows": 0, "import_errors": null, "processed_rows": 0, "total_rows": null, "updated_rows": 0, "source_file_name": "bank_billet_imports.csv", "source_file_size": 4169, "status": "pending", "created_via_api": false, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:54:26-05:00", "updated_at": "2026-09-04T12:54:26-05:00" }, { "id": 1, "uid": "01a06d8e-bf15-7d07-9c67-620e182536da", "created_rows": 0, "enqueued_at": null, "started_at": null, "finished_at": null, "processed_at": null, "failed_to_create_rows": 0, "failed_to_update_rows": 0, "import_errors": null, "processed_rows": 0, "total_rows": null, "updated_rows": 0, "source_file_name": "bank_billet_imports.csv", "source_file_size": 4169, "status": "pending", "created_via_api": false, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:54:26-05:00", "updated_at": "2026-09-04T12:54:26-05:00" } ], "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1_import" } } } } } } }, "post": { "summary": "Importar", "tags": [ "Importações" ], "security": [ { "bearerAuth": [] } ], "description": "Importa recursos (clientes, assinaturas, boletos ou carnês) através de um arquivo CSV. O processamento é realizado de forma assíncrona.\n\n> **Processamento Assíncrono:** Este endpoint é processado assincronamente.\n\nA Importação é feita assincronamente, ou seja, ao receber a requisição,\na nossa API guarda os parâmetros da requisição e processa a importação em segundo plano.\nApós a importação ser processada, os registros serão associados à sua Conta.\nVocê recebe na resposta desta requisição o ID da Importação criada e pode consultá-lo a qualquer momento.\n\n## Eventos de Webhook\n\nQuando a requisição é realizada, um evento `import.created` é disparado.\nO nosso servidor então começa o processamento da importação.\nApós o fim do processamento, o evento `import.processed` é disparado.\n", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "collection_name", "in": "path", "schema": { "type": "string", "enum": [ "customers", "customer_subscriptions", "bank_billets", "installments" ] }, "required": true, "example": "bank_billets", "description": "Tipo da importação:\n* `customers` Clientes\n* `customer_subscriptions` Assinaturas\n* `bank_billets` Boletos\n* `installments` Carnês" } ], "responses": { "201": { "description": "Importação criada", "content": { "application/json": { "example": { "id": 3, "uid": "01a06d8e-bf7d-7b04-82e9-174a195f9ed0", "created_rows": 0, "enqueued_at": null, "started_at": null, "finished_at": null, "processed_at": null, "failed_to_create_rows": 0, "failed_to_update_rows": 0, "import_errors": null, "processed_rows": 0, "total_rows": null, "updated_rows": 0, "source_file_name": "bank_billet_imports.csv", "source_file_size": 4169, "status": "pending", "created_via_api": true, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:54:26-05:00", "updated_at": "2026-09-04T12:54:26-05:00" }, "schema": { "$ref": "#/components/schemas/v1_import" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/v1_import_send" } } }, "required": true, "description": "Parâmetros para criação de uma importação." } } }, "/v1/imports/{collection_name}/{id}": { "get": { "summary": "Visualizar Importação", "tags": [ "Importações" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de uma Importação.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "collection_name", "in": "path", "schema": { "type": "string", "enum": [ "customers", "customer_subscriptions", "bank_billets", "installments" ] }, "required": true, "example": "bank_billets", "description": "Tipo da importação:\n* `customers` Clientes\n* `customer_subscriptions` Assinaturas\n* `bank_billets` Boletos\n* `installments` Carnês" }, { "name": "id", "in": "path", "description": "ID da Importação", "required": true, "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Importação encontrada", "content": { "application/json": { "example": { "id": 4, "uid": "01a06d8e-bfd3-7d2e-87e6-9bf9eef457f7", "created_rows": 0, "enqueued_at": null, "started_at": null, "finished_at": null, "processed_at": null, "failed_to_create_rows": 0, "failed_to_update_rows": 0, "import_errors": null, "processed_rows": 0, "total_rows": null, "updated_rows": 0, "source_file_name": "bank_billet_imports.csv", "source_file_size": 4169, "status": "pending", "created_via_api": false, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:54:26-05:00", "updated_at": "2026-09-04T12:54:26-05:00" }, "schema": { "$ref": "#/components/schemas/v1_import" } } } }, "404": { "description": "Conta não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/remittances": { "post": { "summary": "Criar CNAB", "tags": [ "CNAB (Remessa)" ], "security": [ { "bearerAuth": [] } ], "description": "Criar CNAB.\n\nSerá feita uma solicitação de Remessa. Após a criação da Remessa, ela será processada e ao término do processamento serão emitidas notificações através dos Webhooks.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "CNAB criado com custom_data e tags", "content": { "application/json": { "example": { "id": 3, "uid": "01a06d8e-c0e4-7891-9a51-fb451ba19319", "filename": "2609041.REM", "created_via_api": true, "status": "unprocessed", "bank_billet_account_id": 136, "created_at": "2026-09-04T12:54:27-05:00", "updated_at": "2026-09-04T12:54:27-05:00", "processed_at": null, "url": null, "bank_billet_ids": [ 108 ], "remittance_number": null, "sent_via_integration": null, "generated_by": "kobana", "external_id": "EXT-REM-123456", "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2", "tag3" ], "tag_list": "tag1, tag2, tag3", "bank_billet_remittances": [ { "id": 11, "uid": "01a06d8e-c0cc-7629-9a10-137d130de295", "our_code": "1001", "occurrence": "01", "remittance_id": 3, "bank_billet_id": 108, "bank_billet_account_id": 136, "processed_at": null, "occurrence_detail": "Entrada de Título", "created_at": "2026-09-04T12:54:27-05:00", "updated_at": "2026-09-04T12:54:27-05:00" } ] }, "schema": { "$ref": "#/components/schemas/v1_remittance_object" } } } }, "404": { "description": "Remessa não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1_remittance_create_cnab_object" } } }, "required": true, "description": "Dados do CNAB a ser criado" } }, "get": { "summary": "Listar CNABs", "tags": [ "CNAB (Remessa)" ], "security": [ { "bearerAuth": [] } ], "description": "Lista CNABs.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "expire_from", "in": "query", "description": "A partir da Data de vencimento do boleto.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "expire_to", "in": "query", "description": "Até a Data de vencimento do boleto.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "created_from", "in": "query", "description": "A partir da Data de criação da Remessa.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "created_to", "in": "query", "description": "Até a Data de criação da Remessa.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "bank_billet_account_id", "in": "query", "schema": { "type": "string" }, "description": "Filtro por ID da Carteira.", "example": "999", "required": false }, { "name": "our_code", "in": "query", "schema": { "type": "string" }, "description": "Filtro por Nosso número.", "example": null, "required": false }, { "name": "tags", "in": "query", "schema": { "type": "string" }, "description": "Filtro por tags (separadas por vírgula).", "example": "tag1, tag2", "required": false } ], "responses": { "200": { "description": "Sucesso na listagem de CNABs", "content": { "application/json": { "example": [ { "id": 7, "uid": "01a06d8e-c2c2-7ca5-b2ff-3909f5e3b5f0", "filename": "2609041.REM", "created_via_api": false, "status": "unprocessed", "bank_billet_account_id": 141, "created_at": "2026-09-04T12:54:27-05:00", "updated_at": "2026-09-04T12:54:27-05:00", "processed_at": null, "url": null, "bank_billet_ids": [ 112 ], "remittance_number": null, "sent_via_integration": null, "generated_by": "kobana", "external_id": null, "custom_data": null, "tags": [ "tag1", "tag2", "tag3" ], "tag_list": "tag1, tag2, tag3", "bank_billet_remittances": [ { "id": 15, "uid": "01a06d8e-c2c4-7363-83a4-5191ba86ff21", "our_code": "1001", "occurrence": "01", "remittance_id": 7, "bank_billet_id": 112, "bank_billet_account_id": 141, "processed_at": null, "occurrence_detail": "Entrada de Título", "created_at": "2026-09-04T12:54:27-05:00", "updated_at": "2026-09-04T12:54:27-05:00" } ] } ], "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1_remittance_object" } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/remittances/{id}": { "get": { "summary": "Informações do CNAB", "tags": [ "CNAB (Remessa)" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de um CNAB.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "ID do CNAB", "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CNAB encontrado", "content": { "application/json": { "example": { "id": 10, "uid": "01a06d8e-c3f0-7df2-bf0a-34772d234a55", "filename": "2609041.REM", "created_via_api": false, "status": "unprocessed", "bank_billet_account_id": 145, "created_at": "2026-09-04T12:54:27-05:00", "updated_at": "2026-09-04T12:54:27-05:00", "processed_at": null, "url": null, "bank_billet_ids": [ 115 ], "remittance_number": null, "sent_via_integration": null, "generated_by": "kobana", "external_id": null, "custom_data": null, "tags": [], "tag_list": "", "bank_billet_remittances": [ { "id": 18, "uid": "01a06d8e-c3f2-7464-9a68-41c14dc915d7", "our_code": "1001", "occurrence": "01", "remittance_id": 10, "bank_billet_id": 115, "bank_billet_account_id": 145, "processed_at": null, "occurrence_detail": "Entrada de Título", "created_at": "2026-09-04T12:54:27-05:00", "updated_at": "2026-09-04T12:54:27-05:00" } ] }, "schema": { "$ref": "#/components/schemas/v1_remittance_object" } } } }, "404": { "description": "CNAB não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } }, "delete": { "summary": "Apagar CNAB", "tags": [ "CNAB (Remessa)" ], "security": [ { "bearerAuth": [] } ], "description": "Apagar CNAB.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "ID do CNAB", "example": 999, "schema": { "type": "string" } } ], "responses": { "204": { "description": "CNAB excluído" }, "404": { "description": "CNAB não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/remittances/{id}/raw": { "get": { "summary": "Raw(text/plain) do CNAB", "tags": [ "CNAB (Remessa)" ], "security": [ { "bearerAuth": [] } ], "description": "Raw(text/plain) do CNAB.\n\nSerá disparado o evento remittance.downloaded.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID do CNAB", "example": 999, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Raw do CNAB", "content": { "text/plain": { "example": "anything already processed" } } }, "404": { "description": "CNAB não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "422": { "description": "Remessa aguardando processamento", "content": { "application/json": { "example": { "errors": "Remessa aguardando processamento." } }, "text/plain": { "schema": { "$ref": "#/components/schemas/v1_error_controller" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] } }, "text/plain": { "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/remittances/bulk": { "post": { "summary": "Criar CNABs em Lote", "tags": [ "CNAB (Remessa)" ], "security": [ { "bearerAuth": [] } ], "description": "Criar CNABs em Lote.\n\nSerão feitas solicitações de Remessa de acordo com IDs das ocorrências. Será criada uma solicitação de Remessa para cada carteira associada às ocorrências. Após a criação das Remessas, elas serão processadas e ao término do processamento serão emitidas notificações através dos Webhooks.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "201": { "description": "CNABs criadas", "content": { "application/json": { "example": [ { "id": 14, "uid": "01a06d8e-c73e-7a2b-9df1-225c04407ec7", "filename": "2609041.REM", "created_via_api": true, "status": "unprocessed", "bank_billet_account_id": 152, "created_at": "2026-09-04T12:54:28-05:00", "updated_at": "2026-09-04T12:54:28-05:00", "processed_at": null, "url": null, "bank_billet_ids": [ 119, 119 ], "remittance_number": null, "sent_via_integration": null, "generated_by": "kobana", "external_id": null, "custom_data": null, "tags": null, "tag_list": null, "bank_billet_remittances": [ { "id": 22, "uid": "01a06d8e-c722-7a88-a2eb-f529d7668c3c", "our_code": "1001", "occurrence": "01", "remittance_id": 14, "bank_billet_id": 119, "bank_billet_account_id": 152, "processed_at": null, "occurrence_detail": "Entrada de Título", "created_at": "2026-09-04T12:54:28-05:00", "updated_at": "2026-09-04T12:54:28-05:00" }, { "id": 23, "uid": "01a06d8e-c725-773b-94af-5aaf89c7cab1", "our_code": "1002", "occurrence": "02", "remittance_id": 14, "bank_billet_id": 119, "bank_billet_account_id": 152, "processed_at": null, "occurrence_detail": "Pedido de Baixa", "created_at": "2026-09-04T12:54:28-05:00", "updated_at": "2026-09-04T12:54:28-05:00" } ] } ], "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1_remittance_object" } } } } }, "404": { "description": "Ocorrência não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bank_billet_remittance_ids": { "type": "array", "nullable": true, "example": null, "description": "IDs de [Registros de Remessa](/reference/get_v1-bank-billet-remittances).", "items": { "type": "integer" } } } } } }, "required": true, "description": "IDs de Registros de Remessa" } } }, "/v1/reports/bank_billets": { "get": { "summary": "Contagem de Boletos.", "tags": [ "Relatórios" ], "security": [ { "bearerAuth": [] } ], "description": "Contagem de Boletos.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "expire_from", "in": "query", "description": "A partir da Data de vencimento.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "expire_to", "in": "query", "description": "Até a Data de vencimento.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "paid_from", "in": "query", "description": "A partir da Data de pagamento.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "paid_to", "in": "query", "description": "Até a Data de pagamento.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "registered_from", "in": "query", "description": "A partir da Data de registro.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "registered_to", "in": "query", "description": "Até a Data de registro.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "created_from", "in": "query", "description": "A partir da Data de criação.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "created_to", "in": "query", "description": "Até a Data de criação.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "status", "in": "query", "description": "Status do boleto.", "example": "paid", "required": false, "schema": { "type": "string", "enum": [ "generating", "opened", "paid", "overdue", "canceled", "draft", "generation_failed", "validation_failed", "blocked", "chargeback" ] } } ], "responses": { "200": { "description": "Sucesso na listagem de boletos", "content": { "application/json": { "example": [ { "bank_billet_account_id": 153, "bank_billet_count": 5, "bank_billet_amount": 500.0 } ], "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1_bank_billet_report_object" } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v2/charge/automatic_pix/accounts": { "get": { "summary": "Lista todas as contas PIX automáticas", "tags": [ "Pix Automático - Conta" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todas as contas PIX automáticas do usuário com paginação.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Número da página para paginação", "example": 1, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Quantidade de itens por página (padrão: 50, máximo: 50)", "example": 25, "schema": { "type": "integer" } }, { "name": "external_id", "in": "query", "required": false, "description": "Filtrar por ID externo", "example": "external_id_123", "schema": { "type": "string" } }, { "name": "financial_account_uid", "in": "query", "required": false, "description": "Filtrar por UID da conta financeira", "example": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Lista de contas PIX automáticas filtrada por financial_account_uid", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d8f-000f-79ed-8cd3-0fb32788c8d3", "financial_account_uid": "01a06d8e-ffec-7167-a8d5-be697bacba49", "connection_uid": null, "financial_provider_slug": "sicoob", "custom_name": "Conta Pix Automático", "status": "pending", "external_id": "automatic-pix-account-5", "custom_data": {}, "tags": [], "validated_at": null, "enabled_at": null, "created_at": "2026-09-04T12:54:43-05:00", "updated_at": "2026-09-04T12:54:43-05:00" } ], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`.", "example": 200 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_automatic_pix_account_object" } }, "pagination": { "type": "object", "required": [ "page" ], "properties": { "prev_url": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ], "description": "URL da página anterior.", "examples": [ "https://api.kobana.com.br/v2/bank_billets?page=1", null ] }, "next_url": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ], "description": "URL da próxima página.", "examples": [ "https://api.kobana.com.br/v2/bank_billets?page=3", null ] }, "page": { "type": "integer", "minimum": 1, "description": "Número da página atual.", "examples": [ 1, 2, 10 ] } }, "additionalProperties": false } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "post": { "summary": "Criar nova conta PIX automática", "tags": [ "Pix Automático - Conta" ], "security": [ { "bearerAuth": [] } ], "description": "\nCria uma nova conta PIX automática.\n\n## Importante\n\nApós criar a conta, é necessário associar uma conexão a ela para que o PIX Automático funcione.\n", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Conta PIX automática criada com sucesso", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d8f-0105-77cd-913f-8ccf9f86b95e", "financial_account_uid": "01a06d8f-00e1-7f47-953d-d746341f7e2a", "connection_uid": null, "financial_provider_slug": "sicoob", "custom_name": "Conta Teste", "status": "pending", "external_id": "ext-123", "custom_data": { "key": "value" }, "tags": [ "tag1", "tag2" ], "validated_at": null, "enabled_at": null, "created_at": "2026-09-04T12:54:43-05:00", "updated_at": "2026-09-04T12:54:43-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 201 }, "data": { "$ref": "#/components/schemas/v2_automatic_pix_account_object" } } } } } }, "422": { "description": "Dados inválidos", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "financial_account", "detail": "Conta Financeira é obrigatório(a)" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_automatic_pix_account" } } } } } }, "/v2/charge/automatic_pix/accounts/{uid}": { "parameters": [ { "name": "uid", "in": "path", "description": "UID da conta PIX automática", "required": true, "schema": { "type": "string" } } ], "get": { "summary": "Visualizar conta PIX automática", "tags": [ "Pix Automático - Conta" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Detalhes da conta PIX automática", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d8f-01fa-7d0f-85e0-e8a7eef01d84", "financial_account_uid": "01a06d8f-01d8-76d0-ad5c-3aa528dc464a", "connection_uid": null, "financial_provider_slug": "itau", "custom_name": "Conta Pix Automático", "status": "pending", "external_id": "automatic-pix-account-7", "custom_data": {}, "tags": [], "validated_at": null, "enabled_at": null, "created_at": "2026-09-04T12:54:43-05:00", "updated_at": "2026-09-04T12:54:43-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 200 }, "data": { "$ref": "#/components/schemas/v2_automatic_pix_account_object" } } } } } }, "404": { "description": "Conta PIX automática não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "patch": { "summary": "Atualizar conta PIX automática", "tags": [ "Pix Automático - Conta" ], "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Conta PIX automática atualizada", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d8f-02cd-77aa-ba66-6c6c26216267", "financial_account_uid": "01a06d8f-02ae-7333-8dcf-fb23b5c1cc4f", "connection_uid": null, "financial_provider_slug": "itau", "custom_name": "Nome Novo", "status": "pending", "external_id": "new-ext", "custom_data": { "updated": true }, "tags": [ "new_tag" ], "validated_at": null, "enabled_at": null, "created_at": "2026-09-04T12:54:44-05:00", "updated_at": "2026-09-04T12:54:44-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 200 }, "data": { "$ref": "#/components/schemas/v2_automatic_pix_account_object" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_update_automatic_pix_account" } } } } }, "delete": { "summary": "Excluir conta PIX automática", "tags": [ "Pix Automático - Conta" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Conta PIX automática excluída", "content": { "application/json": { "example": { "status": 200 }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 200 } } } } } }, "422": { "description": "Conta PIX automática possui registros associados (ex: recorrência)", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "base", "detail": "Não é possível excluir o registro pois existem recurrences dependentes" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/charge/automatic_pix/locations": { "get": { "summary": "Lista todas as Locations do Pix Automático", "tags": [ "Pix Automático - Location" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todas as Locations do Pix Automático do usuário com paginação.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Número da página para paginação", "example": 1, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Quantidade de itens por página (padrão: 50, máximo: 50)", "example": 25, "schema": { "type": "integer" } }, { "name": "external_id", "in": "query", "required": false, "description": "Filtrar por ID externo", "example": "external_id_123", "schema": { "type": "string" } }, { "name": "charge_automatic_pix_account_uid", "in": "query", "required": false, "description": "Filtrar por UID da conta Pix Automático", "example": "f47ac10b-58cc-4372-a567-0e02b2c3d480", "schema": { "type": "string" } }, { "name": "financial_provider_external_id", "in": "query", "required": false, "description": "Filtrar por ID externo do provedor financeiro", "example": "provider_loc_123", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Lista de Locations do Pix Automático", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d8f-091c-79b4-910b-991b147e7717", "charge_automatic_pix_account_uid": "01a06d8f-090d-745b-8665-bd98391bb7c5", "location": "api.provider.com/v2/location/FP_EXTERNAL_6", "financial_provider_created_at": "2026-09-03T12:54:45-05:00", "financial_provider_external_id": "FP_EXTERNAL_6", "external_id": "LOC-4", "tags": [ "automatic_pix" ], "tag_list": "automatic_pix", "custom_data": null, "created_at": "2026-09-04T12:54:45-05:00", "updated_at": "2026-09-04T12:54:45-05:00" }, { "uid": "01a06d8f-083b-71aa-b018-ecfc897a91c3", "charge_automatic_pix_account_uid": "01a06d8f-082c-74a5-a75d-4597164e2167", "location": "api.provider.com/v2/location/FP_EXTERNAL_5", "financial_provider_created_at": "2026-09-03T12:54:45-05:00", "financial_provider_external_id": "FP_EXTERNAL_5", "external_id": "LOC-3", "tags": [ "automatic_pix" ], "tag_list": "automatic_pix", "custom_data": null, "created_at": "2026-09-04T12:54:45-05:00", "updated_at": "2026-09-04T12:54:45-05:00" } ], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`.", "example": 200 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_automatic_pix_location_object" } }, "pagination": { "type": "object", "required": [ "page" ], "properties": { "prev_url": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ], "description": "URL da página anterior.", "examples": [ "https://api.kobana.com.br/v2/bank_billets?page=1", null ] }, "next_url": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ], "description": "URL da próxima página.", "examples": [ "https://api.kobana.com.br/v2/bank_billets?page=3", null ] }, "page": { "type": "integer", "minimum": 1, "description": "Número da página atual.", "examples": [ 1, 2, 10 ] } }, "additionalProperties": false } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "post": { "summary": "Criar nova Location do PIX Automático", "tags": [ "Pix Automático - Location" ], "security": [ { "bearerAuth": [] } ], "description": "Cria uma nova Location do PIX Automático.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Location do PIX Automático criada com sucesso", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d8f-0a64-7a29-9986-80b8b452c130", "charge_automatic_pix_account_uid": "01a06d8f-0a56-79e5-8233-1e83c470ee14", "location": null, "financial_provider_created_at": null, "financial_provider_external_id": null, "external_id": "location_123", "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "custom_data": { "key": "value" }, "created_at": "2026-09-04T12:54:45-05:00", "updated_at": "2026-09-04T12:54:45-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `201`.", "example": 201 }, "data": { "$ref": "#/components/schemas/v2_automatic_pix_location_object" } } } } } }, "422": { "description": "Dados inválidos para criação", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "external_id", "detail": "ID Externo já existe para esta conta" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_automatic_pix_location" } } } } } }, "/v2/charge/automatic_pix/locations/{uid}": { "parameters": [ { "name": "uid", "in": "path", "description": "UID da Location do PIX Automático", "required": true, "schema": { "type": "string" } } ], "get": { "summary": "Consulta uma Location do PIX Automático específica", "tags": [ "Pix Automático - Location" ], "security": [ { "bearerAuth": [] } ], "description": "Retorna os detalhes de uma Location do PIX Automático específica.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Location do PIX Automático encontrada", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d8f-0c12-70f2-bfb3-c5e2d5e6148a", "charge_automatic_pix_account_uid": "01a06d8f-0c0a-7223-9f00-1c8584a8564a", "location": "api.provider.com/v2/location/FP_EXTERNAL_8", "financial_provider_created_at": "2026-09-03T12:54:46-05:00", "financial_provider_external_id": "FP_EXTERNAL_8", "external_id": "LOC-5", "tags": [ "automatic_pix" ], "tag_list": "automatic_pix", "custom_data": null, "created_at": "2026-09-04T12:54:46-05:00", "updated_at": "2026-09-04T12:54:46-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`.", "example": 200 }, "data": { "$ref": "#/components/schemas/v2_automatic_pix_location_object" } } } } } }, "404": { "description": "Location do PIX Automático não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/charge/automatic_pix/pix": { "get": { "summary": "Lista todas as cobranças PIX automáticas", "tags": [ "Pix Automático - Cobrança" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todas as cobranças PIX automáticas com paginação.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "automatic_pix_recurrence_uid", "in": "query", "required": false, "description": "Filtrar por UID da recorrência PIX automática", "example": "f47ac10b-58cc-4372-a567-0e02b2c3d481", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "required": false, "description": "Filtrar por ID externo", "example": "pix_123", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Número da página para paginação", "example": 1, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Quantidade de itens por página (padrão: 50, máximo: 50)", "example": 25, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Lista de cobranças PIX automáticas", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d8f-0ffc-732d-99ad-481f9ef98d2c", "automatic_pix_recurrence_uid": "01a06d8f-0fb4-76a7-9a27-459fc837860b", "charge_automatic_pix_account_uid": "01a06d8f-0fa2-7d58-8a02-617cbd157a44", "txid": "TXID00000000000000000000000006", "additional_info": null, "expire_at": "2026-09-05", "amount": 10.0, "next_business_day": false, "retry_policy": "disallow", "financial_provider_created_at": null, "financial_provider_status": "pending", "financial_provider_status_updates": [], "debtor": { "email": "donald@harber.test", "address": { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } }, "recipient_financial_account": { "kind": "checking", "account_number": "12345", "account_digit": "6", "agency_number": "1234" }, "retries": [], "cancellation": null, "rejection": null, "received_pix": [], "external_id": null, "custom_data": {}, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:54:47-05:00", "updated_at": "2026-09-04T12:54:47-05:00" }, { "uid": "01a06d8f-0fdc-760e-bd8a-bb3db4680f7a", "automatic_pix_recurrence_uid": "01a06d8f-0fb4-76a7-9a27-459fc837860b", "charge_automatic_pix_account_uid": "01a06d8f-0fa2-7d58-8a02-617cbd157a44", "txid": "TXID00000000000000000000000005", "additional_info": null, "expire_at": "2026-09-05", "amount": 10.0, "next_business_day": false, "retry_policy": "disallow", "financial_provider_created_at": null, "financial_provider_status": "pending", "financial_provider_status_updates": [], "debtor": { "email": "burton.ledner@kirlin-sauer.test", "address": { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } }, "recipient_financial_account": { "kind": "checking", "account_number": "12345", "account_digit": "6", "agency_number": "1234" }, "retries": [], "cancellation": null, "rejection": null, "received_pix": [], "external_id": null, "custom_data": {}, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:54:47-05:00", "updated_at": "2026-09-04T12:54:47-05:00" } ], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`.", "example": 200 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_automatic_pix_pix_object" } }, "pagination": { "type": "object", "required": [ "page" ], "properties": { "prev_url": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ], "description": "URL da página anterior.", "examples": [ "https://api.kobana.com.br/v2/bank_billets?page=1", null ] }, "next_url": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ], "description": "URL da próxima página.", "examples": [ "https://api.kobana.com.br/v2/bank_billets?page=3", null ] }, "page": { "type": "integer", "minimum": 1, "description": "Número da página atual.", "examples": [ 1, 2, 10 ] } }, "additionalProperties": false } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/charge/automatic_pix/recurrences/{recurrence_uid}/pix": { "post": { "summary": "Criar nova cobrança PIX automática", "tags": [ "Pix Automático - Cobrança" ], "security": [ { "bearerAuth": [] } ], "description": "Cria uma nova cobrança PIX automática para uma recorrência.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "recurrence_uid", "in": "path", "required": true, "description": "UID da recorrência PIX automática", "example": "9e45d2e2-90b7-4908-a013-1e5ea23e5a00", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Cobrança PIX automática criada com txid personalizado", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d8f-123d-7cf4-821f-5183d2a0b047", "automatic_pix_recurrence_uid": "01a06d8f-122a-71fe-94fc-1c9e8ad508e4", "charge_automatic_pix_account_uid": "01a06d8f-1216-7dd0-bbeb-7399a8b7d5d5", "txid": "BSCustomValue12345678901234567", "additional_info": null, "expire_at": "2026-10-04", "amount": 15000.0, "next_business_day": false, "retry_policy": "allow_3r7d", "financial_provider_created_at": null, "financial_provider_status": "pending", "financial_provider_status_updates": [], "debtor": { "email": null, "address": null }, "recipient_financial_account": { "kind": "checking", "account_number": "02605", "account_digit": "3", "agency_number": "6855" }, "retries": [], "cancellation": null, "rejection": null, "received_pix": [], "external_id": null, "custom_data": {}, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:54:48-05:00", "updated_at": "2026-09-04T12:54:48-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `201`.", "example": 201 }, "data": { "$ref": "#/components/schemas/v2_automatic_pix_pix_object" } } } } } }, "422": { "description": "ID Externo duplicado", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "external_id", "detail": "External já existe para esta conta" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_automatic_pix_pix" } } } } } }, "/v2/charge/automatic_pix/pix/{uid}": { "get": { "summary": "Informações da cobrança PIX automática", "tags": [ "Pix Automático - Cobrança" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de uma cobrança PIX automática.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "required": true, "description": "UID da cobrança PIX automática", "example": "9e45d2e2-90b7-4908-a013-1e5ea23e5a00", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Cobrança PIX automática encontrada", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d8f-1516-7e12-84e5-9b839584b8cb", "automatic_pix_recurrence_uid": "01a06d8f-14e2-7a7d-8da8-3d5d75b98164", "charge_automatic_pix_account_uid": "01a06d8f-14d0-7897-b96e-957c3e0bc31d", "txid": "TXID00000000000000000000000008", "additional_info": null, "expire_at": "2026-09-05", "amount": 10.0, "next_business_day": false, "retry_policy": "disallow", "financial_provider_created_at": null, "financial_provider_status": "pending", "financial_provider_status_updates": [], "debtor": { "email": "roland@jast.test", "address": { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } }, "recipient_financial_account": { "kind": "checking", "account_number": "12345", "account_digit": "6", "agency_number": "1234" }, "retries": [], "cancellation": null, "rejection": null, "received_pix": [], "external_id": null, "custom_data": {}, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:54:48-05:00", "updated_at": "2026-09-04T12:54:48-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`.", "example": 200 }, "data": { "$ref": "#/components/schemas/v2_automatic_pix_pix_object" } } } } } }, "404": { "description": "Cobrança PIX automática não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "patch": { "summary": "Atualizar cobrança PIX automática", "tags": [ "Pix Automático - Cobrança" ], "security": [ { "bearerAuth": [] } ], "description": "Atualiza informações de uma cobrança PIX automática existente.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "required": true, "description": "UID da cobrança PIX automática", "example": "9e45d2e2-90b7-4908-a013-1e5ea23e5a00", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Cobrança PIX automática atualizada com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d8f-1660-7e38-9e08-6554ac350cdb", "automatic_pix_recurrence_uid": "01a06d8f-163e-75cd-9c06-fc09231a61c0", "charge_automatic_pix_account_uid": "01a06d8f-162d-75a4-b336-af8507012147", "txid": "TXID00000000000000000000000009", "additional_info": null, "expire_at": "2026-09-05", "amount": 10.0, "next_business_day": false, "retry_policy": "disallow", "financial_provider_created_at": null, "financial_provider_status": "pending", "financial_provider_status_updates": [], "debtor": { "email": "giovanni@crooks.example", "address": { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } }, "recipient_financial_account": { "kind": "checking", "account_number": "12345", "account_digit": "6", "agency_number": "1234" }, "retries": [], "cancellation": null, "rejection": null, "received_pix": [], "external_id": "external-updated", "custom_data": { "key": "value" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "created_at": "2026-09-04T12:54:49-05:00", "updated_at": "2026-09-04T12:54:49-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`.", "example": 200 }, "data": { "$ref": "#/components/schemas/v2_automatic_pix_pix_object" } } } } } }, "422": { "description": "ID Externo duplicado ao atualizar", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "external_id", "detail": "External já existe para esta conta" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Cobrança PIX automática não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_update_automatic_pix_pix" } } } } } }, "/v2/charge/automatic_pix/pix/{uid}/cancel": { "put": { "summary": "Cancelar cobrança PIX automática", "tags": [ "Pix Automático - Cobrança" ], "security": [ { "bearerAuth": [] } ], "description": "Cancela uma cobrança PIX automática existente.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "required": true, "description": "UID da cobrança PIX automática", "example": "9e45d2e2-90b7-4908-a013-1e5ea23e5a00", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Cobrança PIX automática cancelada com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "id": 54, "uid": "01a06d8f-192b-7883-adc9-97b0d188390c", "status": "pending", "operation": "cancel", "resource_type": "Charge::AutomaticPix::Pix", "resource_uid": "01a06d8f-1916-75d8-81ae-f464d4cf2192", "financial_provider_slug": "itau", "params": {}, "payload": null, "created_at": "2026-09-04T12:54:49-05:00", "updated_at": "2026-09-04T12:54:49-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "charge_automatic_pix_pix": { "uid": "01a06d8f-1916-75d8-81ae-f464d4cf2192", "automatic_pix_recurrence_uid": "01a06d8f-18f1-70ab-95f7-4ba959bfce45", "charge_automatic_pix_account_uid": "01a06d8f-18dd-7306-afe5-e15ddb5fa181", "txid": "TXID00000000000000000000000002", "additional_info": null, "expire_at": "2026-09-05", "amount": 10.0, "next_business_day": false, "retry_policy": "disallow", "financial_provider_created_at": null, "financial_provider_status": "created", "financial_provider_status_updates": [], "debtor": { "email": "farrah@schmeler.test", "address": { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } }, "recipient_financial_account": { "kind": "checking", "account_number": "12345", "account_digit": "6", "agency_number": "1234" }, "retries": [], "cancellation": null, "rejection": null, "received_pix": [], "external_id": null, "custom_data": {}, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:54:49-05:00", "updated_at": "2026-09-04T12:54:49-05:00" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`.", "example": 200 }, "data": { "$ref": "#/components/schemas/v2_automatic_pix_pix_command_object" } } } } } }, "422": { "description": "Erro ao cancelar", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Cancelamento de Pix Automático.", "detail": "Estado atual não permite cancelamento." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Cobrança PIX automática não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/charge/automatic_pix/pix/{uid}/retry": { "put": { "summary": "Retentar cobrança PIX automática", "tags": [ "Pix Automático - Cobrança" ], "security": [ { "bearerAuth": [] } ], "description": "Retentar uma cobrança PIX automática que falhou ou expirou.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "required": true, "description": "UID da cobrança PIX automática", "example": "9e45d2e2-90b7-4908-a013-1e5ea23e5a00", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Cobrança PIX automática agendada para retentativa com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "id": 55, "uid": "01a06d8f-1bd8-7435-a91b-76cc4231d139", "status": "pending", "operation": "retry", "resource_type": "Charge::AutomaticPix::Pix", "resource_uid": "01a06d8f-1bc8-7bc2-9ca2-336443c4089a", "financial_provider_slug": "itau", "params": {}, "payload": null, "created_at": "2026-09-04T12:54:50-05:00", "updated_at": "2026-09-04T12:54:50-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "charge_automatic_pix_pix": { "uid": "01a06d8f-1bc8-7bc2-9ca2-336443c4089a", "automatic_pix_recurrence_uid": "01a06d8f-1ba3-79ca-bb77-cce70b69a0f0", "charge_automatic_pix_account_uid": "01a06d8f-1b90-783d-88ec-33729bd1556e", "txid": "TXID00000000000000000000000003", "additional_info": null, "expire_at": "2026-09-05", "amount": 10.0, "next_business_day": false, "retry_policy": "allow_3r7d", "financial_provider_created_at": null, "financial_provider_status": "expired", "financial_provider_status_updates": [], "debtor": { "email": "ethelyn_abshire@abbott.test", "address": { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } }, "recipient_financial_account": { "kind": "checking", "account_number": "12345", "account_digit": "6", "agency_number": "1234" }, "retries": [], "cancellation": null, "rejection": null, "received_pix": [], "external_id": null, "custom_data": {}, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:54:50-05:00", "updated_at": "2026-09-04T12:54:50-05:00" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`.", "example": 200 }, "data": { "$ref": "#/components/schemas/v2_automatic_pix_pix_command_object" } } } } } }, "422": { "description": "Data inválida", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Tentativa de Pix Automático.", "detail": "Data deve ser futura" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Cobrança PIX automática não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "Data para retentar a cobrança." } }, "required": [ "date" ] } } } } } }, "/v2/charge/automatic_pix/recurrences": { "get": { "summary": "Lista todas as recorrências PIX automáticas", "tags": [ "Pix Automático - Recorrência" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todas as recorrências PIX automáticas do usuário com paginação.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Número da página para paginação", "example": 1, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Quantidade de itens por página (padrão: 50, máximo: 50)", "example": 25, "schema": { "type": "integer" } }, { "name": "external_id", "in": "query", "required": false, "description": "Filtrar por ID externo", "example": "external_id_123", "schema": { "type": "string" } }, { "name": "charge_automatic_pix_account_uid", "in": "query", "required": false, "description": "Filtrar por UID da conta Pix Automático", "example": "f47ac10b-58cc-4372-a567-0e02b2c3d480", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Lista de recorrências PIX automáticas", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d8f-2225-76c4-a543-37ca645b330b", "charge_automatic_pix_account_uid": "01a06d8f-2212-7532-8bdb-0d5bf8fe397b", "financial_account_uid": "01a06d8f-21dc-75e9-8d58-26718043eed1", "pix_uid": null, "location_uid": null, "financial_provider_external_id": null, "txid": "TXID00000000000000000000000023", "document": "12345678901", "description": "Descrição da recorrência", "debtor": { "document_type": "CNPJ", "document_number": "U1.N19.J9D/MDOU-08", "kind": "juridical", "name": "Margret Santos Filgueiras" }, "start_at": "2026-09-04", "finish_at": null, "recurrence_term": "indefinite", "cycle": "monthly", "amount_term": "variable", "amount": null, "minimum_amount": null, "agreement_code": "AC1234567890", "retry_policy": "allow_3r7d", "journey": "awaiting", "qrcode": null, "requests": [], "financial_provider_status": "pending", "financial_provider_status_updates": [], "cancellation": null, "rejection": null, "use_line_of_credit": false, "external_id": "external-id-21", "custom_data": {}, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:54:52-05:00", "updated_at": "2026-09-04T12:54:52-05:00" }, { "uid": "01a06d8f-21b6-7026-9479-75404d407dc2", "charge_automatic_pix_account_uid": "01a06d8f-21a4-793b-b2d8-32299764e7e6", "financial_account_uid": "01a06d8f-216f-7414-b59d-838b32a93220", "pix_uid": null, "location_uid": null, "financial_provider_external_id": null, "txid": "TXID00000000000000000000000022", "document": "12345678901", "description": "Descrição da recorrência", "debtor": { "document_type": "CNPJ", "document_number": "0S.X76.GR1/Z2N5-46", "kind": "juridical", "name": "Margret Santos Filgueiras" }, "start_at": "2026-09-04", "finish_at": null, "recurrence_term": "indefinite", "cycle": "monthly", "amount_term": "variable", "amount": null, "minimum_amount": null, "agreement_code": "AC1234567890", "retry_policy": "allow_3r7d", "journey": "awaiting", "qrcode": null, "requests": [], "financial_provider_status": "pending", "financial_provider_status_updates": [], "cancellation": null, "rejection": null, "use_line_of_credit": false, "external_id": "external-id-20", "custom_data": {}, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:54:51-05:00", "updated_at": "2026-09-04T12:54:51-05:00" } ], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`.", "example": 200 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_automatic_pix_recurrence_object" } }, "pagination": { "type": "object", "required": [ "page" ], "properties": { "prev_url": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ], "description": "URL da página anterior.", "examples": [ "https://api.kobana.com.br/v2/bank_billets?page=1", null ] }, "next_url": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ], "description": "URL da próxima página.", "examples": [ "https://api.kobana.com.br/v2/bank_billets?page=3", null ] }, "page": { "type": "integer", "minimum": 1, "description": "Número da página atual.", "examples": [ 1, 2, 10 ] } }, "additionalProperties": false } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "post": { "summary": "Criar nova recorrência PIX automática", "tags": [ "Pix Automático - Recorrência" ], "security": [ { "bearerAuth": [] } ], "description": "Cria uma nova recorrência PIX automática.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Recorrência PIX automática criada com pix_uid e location_uid (JORNADA_3)", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d8f-252b-7024-91c5-9b764b7a2c20", "charge_automatic_pix_account_uid": "01a06d8f-2475-7b56-bcc3-5956f6977b8b", "financial_account_uid": "01a06d8f-2442-7854-8625-932fb7740fb5", "pix_uid": "01a06d8f-24db-7b11-8243-a166f747457f", "location_uid": "01a06d8f-2520-7b2e-a042-2fa5e7679278", "financial_provider_external_id": null, "txid": null, "document": "12345678901", "description": "Recorrência com PIX", "debtor": { "document_type": "CPF", "document_number": "068.231.957-03", "kind": "natural", "name": "João Silva" }, "start_at": "2026-09-05", "finish_at": null, "recurrence_term": "indefinite", "cycle": "monthly", "amount_term": "variable", "amount": null, "minimum_amount": 1000.0, "agreement_code": "AC1234567890", "retry_policy": "allow_3r7d", "journey": "awaiting", "qrcode": null, "requests": [], "financial_provider_status": "pending", "financial_provider_status_updates": [], "cancellation": null, "rejection": null, "use_line_of_credit": false, "external_id": null, "custom_data": {}, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:54:52-05:00", "updated_at": "2026-09-04T12:54:52-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `201`.", "example": 201 }, "data": { "$ref": "#/components/schemas/v2_automatic_pix_recurrence_object" } } } } } }, "422": { "description": "External ID já existe", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "external_id", "detail": "ID Externo já existe para esta conta" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_automatic_pix_recurrence" } } } } } }, "/v2/charge/automatic_pix/recurrences/{uid}": { "get": { "summary": "Informações da recorrência PIX automática", "tags": [ "Pix Automático - Recorrência" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de uma recorrência PIX automática.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "required": true, "description": "UID da recorrência PIX automática", "example": "9e45d2e2-90b7-4908-a013-1e5ea23e5a00", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Recorrência PIX automática encontrada", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d8f-274a-7d97-b571-82b0d8019c56", "charge_automatic_pix_account_uid": "01a06d8f-273a-755b-8706-e7c53d9c8efd", "financial_account_uid": "01a06d8f-2709-7264-9af3-e6f22d354e2f", "pix_uid": null, "location_uid": null, "financial_provider_external_id": null, "txid": "TXID00000000000000000000000025", "document": "12345678901", "description": "Descrição da recorrência", "debtor": { "document_type": "CNPJ", "document_number": "TL.RIU.TZA/WOIQ-48", "kind": "juridical", "name": "Margret Santos Filgueiras" }, "start_at": "2026-09-04", "finish_at": null, "recurrence_term": "indefinite", "cycle": "monthly", "amount_term": "variable", "amount": null, "minimum_amount": null, "agreement_code": "AC1234567890", "retry_policy": "allow_3r7d", "journey": "awaiting", "qrcode": null, "requests": [], "financial_provider_status": "pending", "financial_provider_status_updates": [], "cancellation": null, "rejection": null, "use_line_of_credit": false, "external_id": "external-id-22", "custom_data": {}, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:54:53-05:00", "updated_at": "2026-09-04T12:54:53-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`.", "example": 200 }, "data": { "$ref": "#/components/schemas/v2_automatic_pix_recurrence_object" } } } } } }, "404": { "description": "Recorrência PIX automática não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "patch": { "summary": "Atualizar recorrência PIX automática", "tags": [ "Pix Automático - Recorrência" ], "security": [ { "bearerAuth": [] } ], "description": "Atualiza informações de uma recorrência PIX automática existente.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "required": true, "description": "UID da recorrência PIX automática", "example": "9e45d2e2-90b7-4908-a013-1e5ea23e5a00", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Recorrência PIX automática atualizada com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d8f-28e1-7b78-b905-0380d49c36df", "charge_automatic_pix_account_uid": "01a06d8f-28c5-71b9-8ccc-60a3a2ef33c1", "financial_account_uid": "01a06d8f-288b-799f-8f7a-176f30924a17", "pix_uid": null, "location_uid": null, "financial_provider_external_id": null, "txid": "TXID00000000000000000000000026", "document": "12345678901", "description": "Descrição Original", "debtor": { "document_type": "CNPJ", "document_number": "14.DMZ.PDZ/W7LU-58", "kind": "juridical", "name": "Margret Santos Filgueiras" }, "start_at": "2026-09-04", "finish_at": null, "recurrence_term": "indefinite", "cycle": "monthly", "amount_term": "variable", "amount": null, "minimum_amount": null, "agreement_code": "AC1234567890", "retry_policy": "allow_3r7d", "journey": "awaiting", "qrcode": null, "requests": [], "financial_provider_status": "pending", "financial_provider_status_updates": [], "cancellation": null, "rejection": null, "use_line_of_credit": false, "external_id": "external-updated", "custom_data": { "key": "value" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "created_at": "2026-09-04T12:54:53-05:00", "updated_at": "2026-09-04T12:54:53-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`.", "example": 200 }, "data": { "$ref": "#/components/schemas/v2_automatic_pix_recurrence_object" } } } } } }, "422": { "description": "External ID já existe ao atualizar", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "external_id", "detail": "ID Externo já existe para esta conta" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Recorrência PIX automática não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_update_automatic_pix_recurrence" } } } } } }, "/v2/charge/automatic_pix/recurrences/{uid}/update": { "put": { "summary": "Atualizar recorrência PIX automática via comando", "tags": [ "Pix Automático - Recorrência" ], "security": [ { "bearerAuth": [] } ], "description": "Atualiza informações de uma recorrência PIX automática existente via comando.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "required": true, "description": "UID da recorrência PIX automática", "example": "9e45d2e2-90b7-4908-a013-1e5ea23e5a00", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Recorrência PIX automática reassociada com novo Pix da Jornada 4", "content": { "application/json": { "example": { "status": 200, "data": { "id": 58, "uid": "01a06d8f-2ee5-7425-a71c-2187421fc0f5", "status": "pending", "operation": "sync", "resource_type": "Charge::AutomaticPix::Recurrence", "resource_uid": "01a06d8f-2e98-7400-af6f-5ffc83dbd44b", "financial_provider_slug": "itau", "params": null, "payload": null, "created_at": "2026-09-04T12:54:55-05:00", "updated_at": "2026-09-04T12:54:55-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "charge_automatic_pix_recurrence": { "uid": "01a06d8f-2e98-7400-af6f-5ffc83dbd44b", "charge_automatic_pix_account_uid": "01a06d8f-2e16-7282-b957-bec6de38c2b5", "financial_account_uid": "01a06d8f-2dee-7e8a-bb91-fedf4c94ebf3", "pix_uid": "01a06d8f-2eac-7d54-816d-ebdf2cad4d8f", "location_uid": "01a06d8f-2e8a-706f-9737-ad91edb4c63d", "financial_provider_external_id": "REC123456", "txid": "TXID00000000000000000000000031", "document": "12345678901", "description": "Descrição da recorrência", "debtor": { "document_type": "CNPJ", "document_number": "RX.PTY.T1C/LBNK-71", "kind": "juridical", "name": "Margret Santos Filgueiras" }, "start_at": "2026-09-04", "finish_at": null, "recurrence_term": "indefinite", "cycle": "monthly", "amount_term": "variable", "amount": null, "minimum_amount": null, "agreement_code": "AC1234567890", "retry_policy": "allow_3r7d", "journey": "awaiting", "qrcode": null, "requests": [], "financial_provider_status": "approved", "financial_provider_status_updates": [], "cancellation": null, "rejection": null, "use_line_of_credit": false, "external_id": "external-id-26", "custom_data": {}, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:54:55-05:00", "updated_at": "2026-09-04T12:54:55-05:00" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`.", "example": 200 }, "data": { "$ref": "#/components/schemas/v2_automatic_pix_recurrence_command_object" } } } } } }, "422": { "description": "Dados inválidos", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Atualização de Recorrência Pix Automático.", "detail": "Invalid data" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_command_update_automatic_pix_recurrence" } } } } } }, "/v2/charge/automatic_pix/recurrences/{uid}/cancel": { "put": { "summary": "Cancelar recorrência PIX automática", "tags": [ "Pix Automático - Recorrência" ], "security": [ { "bearerAuth": [] } ], "description": "Cancela uma recorrência PIX automática existente.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "required": true, "description": "UID da recorrência PIX automática", "example": "9e45d2e2-90b7-4908-a013-1e5ea23e5a00", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Recorrência PIX automática cancelada com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "id": 59, "uid": "01a06d8f-311c-71f1-8020-9bc4b1ff0f58", "status": "pending", "operation": "cancel", "resource_type": "Charge::AutomaticPix::Recurrence", "resource_uid": "01a06d8f-30f5-76e8-8448-791fe770a3c9", "financial_provider_slug": "itau", "params": {}, "payload": null, "created_at": "2026-09-04T12:54:55-05:00", "updated_at": "2026-09-04T12:54:55-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "charge_automatic_pix_recurrence": { "uid": "01a06d8f-30f5-76e8-8448-791fe770a3c9", "charge_automatic_pix_account_uid": "01a06d8f-30e3-7165-b96f-c5263053bfe2", "financial_account_uid": "01a06d8f-30ae-7f2d-81c2-1cccc388a2c8", "pix_uid": null, "location_uid": null, "financial_provider_external_id": "REC123456", "txid": "TXID00000000000000000000000033", "document": "12345678901", "description": "Descrição da recorrência", "debtor": { "document_type": "CNPJ", "document_number": "9K.X6P.5Q7/JOKM-89", "kind": "juridical", "name": "Margret Santos Filgueiras" }, "start_at": "2026-09-04", "finish_at": null, "recurrence_term": "indefinite", "cycle": "monthly", "amount_term": "variable", "amount": null, "minimum_amount": null, "agreement_code": "AC1234567890", "retry_policy": "allow_3r7d", "journey": "awaiting", "qrcode": null, "requests": [], "financial_provider_status": "approved", "financial_provider_status_updates": [], "cancellation": null, "rejection": null, "use_line_of_credit": false, "external_id": "external-id-28", "custom_data": {}, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:54:55-05:00", "updated_at": "2026-09-04T12:54:55-05:00" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`.", "example": 200 }, "data": { "$ref": "#/components/schemas/v2_automatic_pix_recurrence_command_object" } } } } } }, "422": { "description": "Erro ao cancelar", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Cancelamento de Recorrência Pix Automático.", "detail": "Estado atual não permite cancelamento." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/charge/automatic_pix/requests": { "get": { "summary": "Lista todas as solicitações PIX automáticas", "tags": [ "Pix Automático - Solicitação" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todas as solicitações PIX automáticas com paginação.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Número da página para paginação", "example": 1, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Quantidade de itens por página (padrão: 50, máximo: 50)", "example": 25, "schema": { "type": "integer" } }, { "name": "automatic_pix_recurrence_uid", "in": "query", "required": false, "description": "Filtrar por UID da recorrência PIX automática", "example": "f47ac10b-58cc-4372-a567-0e02b2c3d481", "schema": { "type": "string" } }, { "name": "charge_automatic_pix_account_uid", "in": "query", "required": false, "description": "Filtrar por UID da conta Pix Automático", "example": "f47ac10b-58cc-4372-a567-0e02b2c3d480", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "required": false, "description": "Filtrar por ID externo", "example": "request_123", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Lista de solicitações PIX automáticas", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d8f-3666-7c7c-9708-d2a51b444709", "automatic_pix_recurrence_uid": "01a06d8f-363d-74c1-9688-127c30fce626", "charge_automatic_pix_account_uid": "01a06d8f-362e-7b04-bec5-335924e43dc7", "addressee_financial_account": { "kind": "checking", "account_number": "12345", "account_digit": "6", "agency_number": "1234", "bank": { "number": "001", "ispb_number": null, "name": "BANCO DO BRASIL S.A." }, "person_info": { "document_type": "CPF", "document_number": "636.947.809-12", "kind": "natural", "name": "João Silva" } }, "expire_at": "2026-09-04T12:54:57-05:00", "financial_provider_external_id": null, "financial_provider_status": "pending", "financial_provider_status_updates": [], "rejection": null, "cancellation": null, "external_id": null, "custom_data": {}, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:54:57-05:00", "updated_at": "2026-09-04T12:54:57-05:00" }, { "uid": "01a06d8f-3654-7b54-aabc-14b320a0c784", "automatic_pix_recurrence_uid": "01a06d8f-363d-74c1-9688-127c30fce626", "charge_automatic_pix_account_uid": "01a06d8f-362e-7b04-bec5-335924e43dc7", "addressee_financial_account": { "kind": "checking", "account_number": "12345", "account_digit": "6", "agency_number": "1234", "bank": { "number": "001", "ispb_number": null, "name": "BANCO DO BRASIL S.A." }, "person_info": { "document_type": "CPF", "document_number": "636.947.809-12", "kind": "natural", "name": "João Silva" } }, "expire_at": "2026-09-04T12:54:57-05:00", "financial_provider_external_id": null, "financial_provider_status": "pending", "financial_provider_status_updates": [], "rejection": null, "cancellation": null, "external_id": null, "custom_data": {}, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:54:57-05:00", "updated_at": "2026-09-04T12:54:57-05:00" } ], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`.", "example": 200 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_automatic_pix_request_object" } }, "pagination": { "type": "object", "required": [ "page" ], "properties": { "prev_url": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ], "description": "URL da página anterior.", "examples": [ "https://api.kobana.com.br/v2/bank_billets?page=1", null ] }, "next_url": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ], "description": "URL da próxima página.", "examples": [ "https://api.kobana.com.br/v2/bank_billets?page=3", null ] }, "page": { "type": "integer", "minimum": 1, "description": "Número da página atual.", "examples": [ 1, 2, 10 ] } }, "additionalProperties": false } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/charge/automatic_pix/recurrences/{recurrence_uid}/requests": { "post": { "summary": "Criar nova solicitação PIX automática", "tags": [ "Pix Automático - Solicitação" ], "security": [ { "bearerAuth": [] } ], "description": "Cria uma nova solicitação PIX automática para uma recorrência.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "recurrence_uid", "in": "path", "required": true, "description": "UID da recorrência PIX automática", "example": "9e45d2e2-90b7-4908-a013-1e5ea23e5a00", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Solicitação PIX automática criada com sucesso", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d8f-375c-716e-8514-fb5567f061b5", "automatic_pix_recurrence_uid": "01a06d8f-3747-77db-8085-520ad9efb0e9", "charge_automatic_pix_account_uid": "01a06d8f-3739-7551-b91e-c3246ce015d4", "addressee_financial_account": { "kind": "checking", "account_number": "12345", "account_digit": "6", "agency_number": "1234", "bank": { "number": "001", "ispb_number": "00000000", "name": "BANCO DO BRASIL S.A." }, "person_info": { "document_type": "CPF", "document_number": "636.947.809-12", "kind": "natural", "name": "João Silva" } }, "expire_at": "2026-09-05T12:54:57-05:00", "financial_provider_external_id": null, "financial_provider_status": "pending", "financial_provider_status_updates": [], "rejection": null, "cancellation": null, "external_id": "EXT_123", "custom_data": { "order_id": "12345", "customer": "John Doe" }, "tags": [ "urgent", "payment" ], "tag_list": "urgent,payment", "created_at": "2026-09-04T12:54:57-05:00", "updated_at": "2026-09-04T12:54:57-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `201`.", "example": 201 }, "data": { "$ref": "#/components/schemas/v2_automatic_pix_request_object" } } } } } }, "422": { "description": "ID Externo duplicado", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "external_id", "detail": "External já existe para esta conta" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_automatic_pix_request" } } } } } }, "/v2/charge/automatic_pix/requests/{uid}": { "get": { "summary": "Informações da solicitação PIX automática", "tags": [ "Pix Automático - Solicitação" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de uma solicitação PIX automática.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "required": true, "description": "UID da solicitação PIX automática", "example": "9e45d2e2-90b7-4908-a013-1e5ea23e5a00", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Solicitação PIX automática encontrada", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d8f-3a91-7d2e-b51b-c3beb9f2d30a", "automatic_pix_recurrence_uid": "01a06d8f-3a76-7b22-9590-eeaa83318b52", "charge_automatic_pix_account_uid": "01a06d8f-3a65-77f4-a085-dad17421265f", "addressee_financial_account": { "kind": "checking", "account_number": "12345", "account_digit": "6", "agency_number": "1234", "bank": { "number": "001", "ispb_number": null, "name": "BANCO DO BRASIL S.A." }, "person_info": { "document_type": "CPF", "document_number": "636.947.809-12", "kind": "natural", "name": "João Silva" } }, "expire_at": "2026-09-04T12:54:58-05:00", "financial_provider_external_id": null, "financial_provider_status": "pending", "financial_provider_status_updates": [], "rejection": null, "cancellation": null, "external_id": null, "custom_data": {}, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:54:58-05:00", "updated_at": "2026-09-04T12:54:58-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`.", "example": 200 }, "data": { "$ref": "#/components/schemas/v2_automatic_pix_request_object" } } } } } }, "404": { "description": "Solicitação PIX automática não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "patch": { "summary": "Atualizar solicitação PIX automática", "tags": [ "Pix Automático - Solicitação" ], "security": [ { "bearerAuth": [] } ], "description": "Atualiza informações de uma solicitação PIX automática existente.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "required": true, "description": "UID da solicitação PIX automática", "example": "9e45d2e2-90b7-4908-a013-1e5ea23e5a00", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Solicitação PIX automática atualizada com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d8f-3bc8-7b5f-b355-77f37dc48edf", "automatic_pix_recurrence_uid": "01a06d8f-3bad-799e-98ca-4ac59c9ef1b2", "charge_automatic_pix_account_uid": "01a06d8f-3b9d-777f-9b92-0a71c4ffe7f3", "addressee_financial_account": { "kind": "checking", "account_number": "12345", "account_digit": "6", "agency_number": "1234", "bank": { "number": "001", "ispb_number": null, "name": "BANCO DO BRASIL S.A." }, "person_info": { "document_type": "CPF", "document_number": "636.947.809-12", "kind": "natural", "name": "João Silva" } }, "expire_at": "2026-09-04T12:54:58-05:00", "financial_provider_external_id": "REQ123456", "financial_provider_status": "created", "financial_provider_status_updates": [], "rejection": null, "cancellation": null, "external_id": "external-updated", "custom_data": { "key": "value" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "created_at": "2026-09-04T12:54:58-05:00", "updated_at": "2026-09-04T12:54:58-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`.", "example": 200 }, "data": { "$ref": "#/components/schemas/v2_automatic_pix_request_object" } } } } } }, "422": { "description": "ID Externo duplicado ao atualizar", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "external_id", "detail": "External já existe para esta conta" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Solicitação PIX automática não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_update_automatic_pix_request" } } } } } }, "/v2/charge/automatic_pix/requests/{uid}/cancel": { "put": { "summary": "Cancelar solicitação PIX automática", "tags": [ "Pix Automático - Solicitação" ], "security": [ { "bearerAuth": [] } ], "description": "Cancela uma solicitação PIX automática existente.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "required": true, "description": "UID da solicitação PIX automática", "example": "9e45d2e2-90b7-4908-a013-1e5ea23e5a00", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Solicitação PIX automática cancelada com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "id": 60, "uid": "01a06d8f-3e4a-7047-ad56-c1e1ec5a73af", "status": "pending", "operation": "cancel", "resource_type": "Charge::AutomaticPix::Request", "resource_uid": "01a06d8f-3e25-7ccb-963d-5a7bfa136d91", "financial_provider_slug": "itau", "params": {}, "payload": null, "created_at": "2026-09-04T12:54:59-05:00", "updated_at": "2026-09-04T12:54:59-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "charge_automatic_pix_request": { "uid": "01a06d8f-3e25-7ccb-963d-5a7bfa136d91", "automatic_pix_recurrence_uid": "01a06d8f-3e0b-74ce-9481-9c27a078293e", "charge_automatic_pix_account_uid": "01a06d8f-3dfb-7d21-abdb-56e616e58a16", "addressee_financial_account": { "kind": "checking", "account_number": "12345", "account_digit": "6", "agency_number": "1234", "bank": { "number": "001", "ispb_number": null, "name": "BANCO DO BRASIL S.A." }, "person_info": { "document_type": "CPF", "document_number": "636.947.809-12", "kind": "natural", "name": "João Silva" } }, "expire_at": "2026-09-04T12:54:59-05:00", "financial_provider_external_id": "REQ123456", "financial_provider_status": "created", "financial_provider_status_updates": [], "rejection": null, "cancellation": null, "external_id": null, "custom_data": {}, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:54:59-05:00", "updated_at": "2026-09-04T12:54:59-05:00" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`.", "example": 200 }, "data": { "$ref": "#/components/schemas/v2_automatic_pix_request_command_object" } } } } } }, "422": { "description": "Erro ao cancelar", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Cancelamento de Solicitação Pix Automática.", "detail": "Estado atual não permite cancelamento." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Solicitação PIX automática não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/charge/payments": { "get": { "summary": "Listar Recebimentos", "tags": [ "Recebimentos" ], "security": [ { "bearerAuth": [] } ], "description": "Listar Recebimentos.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página.", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página.", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "paid_from", "in": "query", "description": "A partir da Data de Recebimento.", "example": "2025-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "paid_to", "in": "query", "description": "Até a Data de Recebimento.", "example": "2025-01-31", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "amount_from", "in": "query", "description": "A partir do Valor do Recebimento.", "example": "10.00", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "amount_to", "in": "query", "description": "Até o Valor do Recebimento.", "example": "100.00", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "kind", "in": "query", "description": "Tipo de Recebimento. Direto ao beneficiario/Em mãos, Boleto (Confirmado pelo banco via arquivo de retorno ou API) ou PIX (Confirmado pelo banco).", "schema": { "type": "string", "enum": [ "direct", "bank_billet", "pix" ] }, "example": "bank_billet", "required": false }, { "name": "payable_type", "in": "query", "description": "Tipo de Recurso Pagável.", "example": "BankBillet", "required": false, "schema": { "type": "string", "enum": [ "BankBillet", "Pix" ] } }, { "name": "payable_public_id", "in": "query", "description": "UID do Recurso Pagável.", "example": "01932fa4-4567-7a3f-9e8a-123456789abc", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Buscando por tipo do recebimento", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d8f-8965-7567-a0e0-8e8b001eb09b", "payable": { "id": 344, "uid": "01a06d8f-895b-79a2-bae3-8b94434b11d5", "type": "BankBillet" }, "debtor": { "is_payer": null, "name": "José da Silva", "document_number": "399.881.072-26" }, "payer": null, "amount": 1.0, "paid_at": "2026-09-04", "credit_at": null, "kind": "direct", "bank": null, "receiving": { "bank": null, "agency": null, "agency_number": null, "agency_digit": null }, "created_via_api": false, "transaction_identifier": null, "status": "confirmed", "duplicated": null, "created_at": "2026-09-04T12:55:18-05:00", "updated_at": "2026-09-04T12:55:18-05:00" } ], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_payment" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "post": { "summary": "Informar Recebimento", "tags": [ "Recebimentos" ], "security": [ { "bearerAuth": [] } ], "description": "Informa um Recebimento.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Recebimento de pix informado com sucesso", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d8f-8ac4-7c15-9e35-7cd6d07324fa", "payable": { "id": 16, "uid": "01a06d8f-8ab0-7b49-8c1a-fc1a13c22b61", "type": "Pix" }, "debtor": { "is_payer": null, "name": "Maria da Silva", "document_number": "39988107226" }, "payer": null, "amount": 25.0, "paid_at": "2026-09-07", "credit_at": null, "kind": "pix", "bank": null, "receiving": { "bank": null, "agency": null, "agency_number": null, "agency_digit": null }, "created_via_api": true, "transaction_identifier": null, "status": "confirmed", "duplicated": null, "created_at": "2026-09-04T12:55:18-05:00", "updated_at": "2026-09-04T12:55:18-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_payment" } } } } } }, "422": { "description": "Erro de validação", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "detail": "Quantia Paga deve ser maior que 0", "param": "amount" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_payment" } } }, "required": true, "description": "Dados do recebimento." } } }, "/v2/charge/payments/{uid}": { "get": { "summary": "Informações do Recebimento", "tags": [ "Recebimentos" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de um Recebimento.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "required": true, "description": "UID do Recebimento", "example": "eaff95d2-ad20-45d6-b3a2-84555c0c5a3b", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Recebimento encontrado", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d8f-8cb0-7cea-a106-0322c4d6462f", "payable": { "id": 348, "uid": "01a06d8f-8ca6-74fd-b9ef-2ea7adc1c895", "type": "BankBillet" }, "debtor": { "is_payer": null, "name": "José da Silva", "document_number": "399.881.072-26" }, "payer": null, "amount": 1.0, "paid_at": "2026-09-04", "credit_at": null, "kind": "direct", "bank": null, "receiving": { "bank": null, "agency": null, "agency_number": null, "agency_digit": null }, "created_via_api": false, "transaction_identifier": null, "status": "confirmed", "duplicated": null, "created_at": "2026-09-04T12:55:19-05:00", "updated_at": "2026-09-04T12:55:19-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_payment" } } } } } }, "404": { "description": "Recebimento não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "delete": { "summary": "Excluir Recebimento", "tags": [ "Recebimentos" ], "security": [ { "bearerAuth": [] } ], "description": "Exclui um Recebimento.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "required": true, "description": "UID do Recebimento", "example": "eaff95d2-ad20-45d6-b3a2-84555c0c5a3b", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Recebimento excluído" }, "404": { "description": "Recebimento não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/charge/pix_accounts": { "get": { "summary": "Listar Contas Pix", "tags": [ "Conta Pix" ], "security": [ { "bearerAuth": [] } ], "description": "Lista as contas Pix cadastradas na conta.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } } ], "responses": { "200": { "description": "Contas Pix encontradas", "content": { "application/json": { "example": { "status": 200, "data": [ { "id": 44, "uid": "01a06d8f-912b-7027-8313-2682bec0b0fa", "custom_name": "Banco do Brasil", "validated_at": "2026-09-04T12:55:20-05:00", "enabled_at": "2026-09-04T12:55:20-05:00", "financial_provider_slug": "bb", "key": "+5522987654321", "status": "active", "default": true, "beneficiary": { "document_number": "067.768.123-22", "name": "Margret Santos Filgueiras", "address": { "zip_code": "24360440", "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "city_name": "Rio de Janeiro", "state": "RJ" } }, "configuration": null, "financial_account_uid": "01a06d8f-9106-70c9-8baf-d64833919140", "created_at": "2026-09-04T12:55:20-05:00", "updated_at": "2026-09-04T12:55:20-05:00" }, { "id": 43, "uid": "01a06d8f-90e4-7ce4-899d-d7c6c612838b", "custom_name": "Banco do Brasil", "validated_at": "2026-09-04T12:55:20-05:00", "enabled_at": "2026-09-04T12:55:20-05:00", "financial_provider_slug": "bb", "key": "+5522987654321", "status": "active", "default": false, "beneficiary": { "document_number": "254.900.588-03", "name": "Margret Santos Filgueiras", "address": { "zip_code": "24360440", "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "city_name": "Rio de Janeiro", "state": "RJ" } }, "configuration": null, "financial_account_uid": "01a06d8f-90be-7bf4-b5c2-45fe3ea03106", "created_at": "2026-09-04T12:55:20-05:00", "updated_at": "2026-09-04T12:55:20-05:00" }, { "id": 42, "uid": "01a06d8f-909d-70d3-8589-421574d37321", "custom_name": "Banco do Brasil", "validated_at": "2026-09-04T12:55:20-05:00", "enabled_at": "2026-09-04T12:55:20-05:00", "financial_provider_slug": "bb", "key": "+5522987654321", "status": "active", "default": false, "beneficiary": { "document_number": "293.983.198-02", "name": "Margret Santos Filgueiras", "address": { "zip_code": "24360440", "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "city_name": "Rio de Janeiro", "state": "RJ" } }, "configuration": null, "financial_account_uid": "01a06d8f-9079-7b58-808a-23749d4e53ed", "created_at": "2026-09-04T12:55:20-05:00", "updated_at": "2026-09-04T12:55:20-05:00" }, { "id": 41, "uid": "01a06d8f-9055-7202-b696-40cd677b1117", "custom_name": "Banco do Brasil", "validated_at": "2026-09-04T12:55:20-05:00", "enabled_at": "2026-09-04T12:55:20-05:00", "financial_provider_slug": "bb", "key": "+5522987654321", "status": "active", "default": false, "beneficiary": { "document_number": "811.558.980-28", "name": "Margret Santos Filgueiras", "address": { "zip_code": "24360440", "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "city_name": "Rio de Janeiro", "state": "RJ" } }, "configuration": null, "financial_account_uid": "01a06d8f-9030-7e53-9bc7-b933806f82be", "created_at": "2026-09-04T12:55:20-05:00", "updated_at": "2026-09-04T12:55:20-05:00" }, { "id": 40, "uid": "01a06d8f-9010-7d1d-94ba-80877846c6fc", "custom_name": "Banco do Brasil", "validated_at": "2026-09-04T12:55:20-05:00", "enabled_at": "2026-09-04T12:55:20-05:00", "financial_provider_slug": "bb", "key": "+5522987654321", "status": "active", "default": false, "beneficiary": { "document_number": "710.210.852-43", "name": "Margret Santos Filgueiras", "address": { "zip_code": "24360440", "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "city_name": "Rio de Janeiro", "state": "RJ" } }, "configuration": null, "financial_account_uid": "01a06d8f-8fea-7e6c-9ee9-4ce91c52581c", "created_at": "2026-09-04T12:55:20-05:00", "updated_at": "2026-09-04T12:55:20-05:00" }, { "id": 39, "uid": "01a06d8f-8fca-7a1a-806d-6f2259dbfdbe", "custom_name": "Banco do Brasil", "validated_at": "2026-09-04T12:55:20-05:00", "enabled_at": "2026-09-04T12:55:20-05:00", "financial_provider_slug": "bb", "key": "+5522987654321", "status": "active", "default": false, "beneficiary": { "document_number": "326.917.902-23", "name": "Margret Santos Filgueiras", "address": { "zip_code": "24360440", "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "city_name": "Rio de Janeiro", "state": "RJ" } }, "configuration": null, "financial_account_uid": "01a06d8f-8fa5-788e-b8cd-b50aa60d9649", "created_at": "2026-09-04T12:55:20-05:00", "updated_at": "2026-09-04T12:55:20-05:00" }, { "id": 38, "uid": "01a06d8f-8f83-7940-b39d-e3473711aea7", "custom_name": "Banco do Brasil", "validated_at": "2026-09-04T12:55:20-05:00", "enabled_at": "2026-09-04T12:55:20-05:00", "financial_provider_slug": "bb", "key": "+5522987654321", "status": "active", "default": false, "beneficiary": { "document_number": "152.127.935-72", "name": "Margret Santos Filgueiras", "address": { "zip_code": "24360440", "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "city_name": "Rio de Janeiro", "state": "RJ" } }, "configuration": null, "financial_account_uid": "01a06d8f-8f5d-7a56-92de-11f6eeaf885a", "created_at": "2026-09-04T12:55:20-05:00", "updated_at": "2026-09-04T12:55:20-05:00" }, { "id": 37, "uid": "01a06d8f-8f39-728d-b49c-0042b067a555", "custom_name": "Banco do Brasil", "validated_at": "2026-09-04T12:55:19-05:00", "enabled_at": "2026-09-04T12:55:19-05:00", "financial_provider_slug": "bb", "key": "+5522987654321", "status": "active", "default": false, "beneficiary": { "document_number": "787.894.177-71", "name": "Margret Santos Filgueiras", "address": { "zip_code": "24360440", "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "city_name": "Rio de Janeiro", "state": "RJ" } }, "configuration": null, "financial_account_uid": "01a06d8f-8f0f-74f3-b416-1c6cba48c44c", "created_at": "2026-09-04T12:55:19-05:00", "updated_at": "2026-09-04T12:55:19-05:00" }, { "id": 36, "uid": "01a06d8f-8eec-7134-8103-87ee4e59644a", "custom_name": "Banco do Brasil", "validated_at": "2026-09-04T12:55:19-05:00", "enabled_at": "2026-09-04T12:55:19-05:00", "financial_provider_slug": "bb", "key": "+5522987654321", "status": "active", "default": false, "beneficiary": { "document_number": "799.423.659-66", "name": "Margret Santos Filgueiras", "address": { "zip_code": "24360440", "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "city_name": "Rio de Janeiro", "state": "RJ" } }, "configuration": null, "financial_account_uid": "01a06d8f-8ec6-706c-b241-c09b66d82d9f", "created_at": "2026-09-04T12:55:19-05:00", "updated_at": "2026-09-04T12:55:19-05:00" }, { "id": 35, "uid": "01a06d8f-8ea6-79ea-a640-d596e5850c76", "custom_name": "Banco do Brasil", "validated_at": "2026-09-04T12:55:19-05:00", "enabled_at": "2026-09-04T12:55:19-05:00", "financial_provider_slug": "bb", "key": "+5522987654321", "status": "active", "default": false, "beneficiary": { "document_number": "045.759.516-76", "name": "Margret Santos Filgueiras", "address": { "zip_code": "24360440", "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "city_name": "Rio de Janeiro", "state": "RJ" } }, "configuration": null, "financial_account_uid": "01a06d8f-8e7e-75ef-ae3d-47a4bb117840", "created_at": "2026-09-04T12:55:19-05:00", "updated_at": "2026-09-04T12:55:19-05:00" } ], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_pix_account" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } } } }, "post": { "summary": "Criar Pix Account", "tags": [ "Conta Pix" ], "security": [ { "bearerAuth": [] } ], "description": "\n Este endpoint é utilizado para cadastrar uma nova conta pix.\n ", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Conta Pix criada", "content": { "application/json": { "example": { "status": 200, "data": { "id": 45, "uid": "01a06d8f-91ba-7346-bed9-d15ae6eaab90", "custom_name": "Pix Account", "validated_at": null, "enabled_at": "2026-09-04T12:55:20-05:00", "financial_provider_slug": "example_bank", "key": "pix@email.com", "status": "pending", "default": true, "beneficiary": { "document_number": "362.143.954-43", "name": "Margret Santos Filgueiras", "address": { "zip_code": "24360440", "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "city_name": "Rio de Janeiro", "state": "RJ" } }, "configuration": null, "financial_account_uid": "01a06d8f-9196-74c8-8b87-ed36190b44aa", "created_at": "2026-09-04T12:55:20-05:00", "updated_at": "2026-09-04T12:55:20-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_pix_account" } } } } } }, "422": { "description": "Conta Pix inválida", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "key", "detail": "Chave Pix não pode ficar em branco" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_pix_account_create" } } }, "required": true, "description": "Informações a serem salvas na conta pix" } } }, "/v2/charge/pix_accounts/{uid}": { "get": { "summary": "Visualizar uma conta Pix", "tags": [ "Conta Pix" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de uma conta Pix.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UID da Conta Pix", "required": true, "example": "360c1b10-981f-490e-a954-1cb966b5f1ee", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Conta Pix encontrada", "content": { "application/json": { "example": { "status": 200, "data": { "id": 46, "uid": "01a06d8f-9285-756e-b3fe-8036e8d075b3", "custom_name": "Banco do Brasil", "validated_at": "2026-09-04T12:55:20-05:00", "enabled_at": "2026-09-04T12:55:20-05:00", "financial_provider_slug": "bb", "key": "+5522987654321", "status": "active", "default": true, "beneficiary": { "document_number": "719.369.209-72", "name": "Margret Santos Filgueiras", "address": { "zip_code": "24360440", "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "city_name": "Rio de Janeiro", "state": "RJ" } }, "configuration": null, "financial_account_uid": "01a06d8f-9263-73e3-96a6-13b3f711aa0f", "created_at": "2026-09-04T12:55:20-05:00", "updated_at": "2026-09-04T12:55:20-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_pix_account" } } } } } }, "404": { "description": "Conta Pix não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Conta Pix não encontrada", "detail": "A conta pix não foi encontrada ou não pertence a sua conta" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "put": { "summary": "Atualizar Pix Account", "tags": [ "Conta Pix" ], "security": [ { "bearerAuth": [] } ], "description": "\n Este endpoint é utilizado para atualizar uma nova conta pix.\n ", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "description": "UID da Conta Pix", "required": true, "example": "360c1b10-981f-490e-a954-1cb966b5f1ee", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Conta Pix atualizada", "content": { "application/json": { "example": { "status": 200, "data": { "id": 47, "uid": "01a06d8f-931b-7480-870e-a453d1ecf719", "custom_name": "Pix Account", "validated_at": "2026-09-04T12:55:20-05:00", "enabled_at": "2026-09-04T12:55:21-05:00", "financial_provider_slug": "bb", "key": "pix@email.com", "status": "active", "default": true, "beneficiary": { "document_number": "327.726.876-43", "name": "Margret Santos Filgueiras", "address": { "zip_code": "24360440", "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "city_name": "Rio de Janeiro", "state": "RJ" } }, "configuration": null, "financial_account_uid": "01a06d8f-92fa-7cf0-8692-135f90cb447f", "created_at": "2026-09-04T12:55:20-05:00", "updated_at": "2026-09-04T12:55:21-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_pix_account" } } } } } }, "422": { "description": "Chave Pix inválida", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "callback_validation_error", "param": "key", "detail": "Falha na validação da chave PIX" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Conta Pix não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Conta Pix não encontrada", "detail": "A conta pix não foi encontrada ou não pertence a sua conta" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_pix_account_update" } } }, "required": true, "description": "Informações a serem atualizadas na conta pix" } }, "delete": { "summary": "Deletar Pix Account", "tags": [ "Conta Pix" ], "security": [ { "bearerAuth": [] } ], "description": "Deleta uma conta Pix.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UID da Conta Pix", "required": true, "example": "360c1b10-981f-490e-a954-1cb966b5f1ee", "schema": { "type": "string" } } ], "responses": { "202": { "description": "Conta Pix deletada", "content": { "application/json": { "example": { "status": 202, "message": "Conta Pix enviada para ser excluída! Logo ela será removida definitivamente." }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_pix_account" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Conta Pix não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Conta Pix não encontrada", "detail": "A conta pix não foi encontrada ou não pertence a sua conta" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/charge/pix": { "get": { "summary": "Listar Pix", "tags": [ "Pix" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todas as cobranças Pix cadastradas. Permite filtrar por status, TXID, data de vencimento, data de pagamento, CNPJ/CPF do pagador e tags.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "txid", "in": "query", "description": "Filtro por TXID do Pix", "example": "KB000000000000000000000001", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Filtro por status do Pix", "example": "paid", "required": false, "schema": { "type": "string" } }, { "name": "pix_account_id", "in": "query", "description": "Filtro por ID da conta do Pix", "example": 1, "required": false, "schema": { "type": "integer" } }, { "name": "expire_from", "in": "query", "description": "Data inicial do filtro de data de vencimento do Pix", "example": "2020-01-01", "required": false, "schema": { "type": "string" } }, { "name": "expire_to", "in": "query", "description": "Data final do filtro de data de vencimento do Pix", "example": "2020-01-01", "required": false, "schema": { "type": "string" } }, { "name": "paid_from", "in": "query", "description": "Data inicial do filtro de data de pagamento do Pix", "example": "2020-01-01", "required": false, "schema": { "type": "string" } }, { "name": "paid_to", "in": "query", "description": "Data final do filtro de data de pagamento do Pix", "example": "2020-01-01", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "description": "Data inicial do filtro de data de criação do Pix", "example": "2020-01-01", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "description": "Data final do filtro de data de criação do Pix", "example": "2020-01-01", "required": false, "schema": { "type": "string" } }, { "name": "cnpj_cpf", "in": "query", "description": "Filtro por CNPJ/CPF do pagador", "example": "81.286.366/0001-70", "required": false, "schema": { "type": "string" } }, { "name": "tags", "in": "query", "description": "Filtro por tags do pix", "example": "Tag 1, Tag 2", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Buscando Pix por tags", "content": { "application/json": { "example": { "status": 200, "data": [ { "id": 47, "uid": "01a06d8f-a138-708d-b882-9414eb6b6de5", "txid": null, "status": "opened", "registration_status": "pending", "pix_account_id": 84, "pix_account_uid": "01a06d8f-a12a-7719-9edf-08e4c4787792", "kind": "instant", "created_at": "2026-09-04T12:55:24-05:00", "updated_at": "2026-09-04T12:55:24-05:00", "expire_at": "2026-09-07T00:00:00-05:00", "canceled_at": null, "registered_at": null, "amount": 25.0, "additional_info": {}, "command_ids": [], "message": "MyText", "message_payer": null, "qrcode": { "emv": null, "png": null }, "payer": { "name": "José da Silva", "document_number": "39988107226" }, "url": "http://dev.kdoc.to:5001/1/90A55XIc8OeX", "formats": { "default": { "html": "http://dev.kdoc.to:5001/1/90A55XIc8OeX", "png": "http://dev.kdoc.to:5001/1/90A55XIc8OeX.png", "pdf": "http://dev.kdoc.to:5001/1/90A55XIc8OeX.pdf" }, "qrcode": { "html": "http://dev.kdoc.to:5001/1/90A55XIc8OeX/qrcode", "png": "http://dev.kdoc.to:5001/1/90A55XIc8OeX/qrcode.png", "pdf": "http://dev.kdoc.to:5001/1/90A55XIc8OeX/qrcode.pdf" } }, "paid_amount": null, "paid_at": null, "end_to_end_id": null, "beneficiary": { "kind": "natural", "name": "Margret Santos Filgueiras", "tags": [ "esse", "ex", "beatae" ], "emails": [ { "label": null, "address": "valentine@emard-jones.test" } ], "phones": [ { "kind": "landline", "number": "30030386", "local_code": "21", "country_code": "55" } ], "addresses": [ { "state": "RJ", "number": "120", "street": "Av. Burkhard Hehn Simões", "zip_code": "24360440", "city_name": "Rio de Janeiro", "complement": "709", "neighborhood": "São Francisco" } ], "legal_name": "Margret Santos Filgueiras", "custom_data": { "numero_erp": 63126 }, "document_type": "CPF", "external_code": "000001", "classification": "person", "document_number": "216.048.083-57" }, "custom_data": null, "external_id": null, "ignore_whatsapp": false, "interest": { "type": null, "amount": null, "percentage": null }, "discounts": { "type": null, "discount_first": { "amount": null, "percentage": null, "days": null }, "discount_second": { "amount": null, "percentage": null, "days": null }, "discount_third": { "amount": null, "percentage": null, "days": null } }, "reduction": { "type": "none", "amount": null, "percentage": null }, "fine": { "type": null, "amount": null, "percentage": null }, "created_via_api": false, "password_protected_mode": null, "financial_provider_external_id": null, "tags": [ "tag 1", "tag 2", "tag 3", "tag 4" ], "tag_list": "tag 1,tag 2,tag 3,tag 4", "revoke_days": null, "payments": [] }, { "id": 46, "uid": "01a06d8f-a0e6-7431-976d-6837ce754274", "txid": null, "status": "opened", "registration_status": "pending", "pix_account_id": 83, "pix_account_uid": "01a06d8f-a0d7-7274-9b57-f19315867499", "kind": "instant", "created_at": "2026-09-04T12:55:24-05:00", "updated_at": "2026-09-04T12:55:24-05:00", "expire_at": "2026-09-07T00:00:00-05:00", "canceled_at": null, "registered_at": null, "amount": 25.0, "additional_info": {}, "command_ids": [], "message": "MyText", "message_payer": null, "qrcode": { "emv": null, "png": null }, "payer": { "name": "José da Silva", "document_number": "39988107226" }, "url": "http://dev.kdoc.to:5001/1/ASWDRgg3DT6g", "formats": { "default": { "html": "http://dev.kdoc.to:5001/1/ASWDRgg3DT6g", "png": "http://dev.kdoc.to:5001/1/ASWDRgg3DT6g.png", "pdf": "http://dev.kdoc.to:5001/1/ASWDRgg3DT6g.pdf" }, "qrcode": { "html": "http://dev.kdoc.to:5001/1/ASWDRgg3DT6g/qrcode", "png": "http://dev.kdoc.to:5001/1/ASWDRgg3DT6g/qrcode.png", "pdf": "http://dev.kdoc.to:5001/1/ASWDRgg3DT6g/qrcode.pdf" } }, "paid_amount": null, "paid_at": null, "end_to_end_id": null, "beneficiary": { "kind": "natural", "name": "Margret Santos Filgueiras", "tags": [ "laudantium", "sit", "eos" ], "emails": [ { "label": null, "address": "ned@rempel-fadel.example" } ], "phones": [ { "kind": "landline", "number": "30030386", "local_code": "21", "country_code": "55" } ], "addresses": [ { "state": "RJ", "number": "120", "street": "Av. Burkhard Hehn Simões", "zip_code": "24360440", "city_name": "Rio de Janeiro", "complement": "709", "neighborhood": "São Francisco" } ], "legal_name": "Margret Santos Filgueiras", "custom_data": { "numero_erp": 63126 }, "document_type": "CPF", "external_code": "000001", "classification": "person", "document_number": "009.521.466-65" }, "custom_data": null, "external_id": null, "ignore_whatsapp": false, "interest": { "type": null, "amount": null, "percentage": null }, "discounts": { "type": null, "discount_first": { "amount": null, "percentage": null, "days": null }, "discount_second": { "amount": null, "percentage": null, "days": null }, "discount_third": { "amount": null, "percentage": null, "days": null } }, "reduction": { "type": "none", "amount": null, "percentage": null }, "fine": { "type": null, "amount": null, "percentage": null }, "created_via_api": false, "password_protected_mode": null, "financial_provider_external_id": null, "tags": [ "tag 1", "tag 2", "tag 3" ], "tag_list": "tag 1,tag 2,tag 3", "revoke_days": null, "payments": [] }, { "id": 44, "uid": "01a06d8f-a049-76c5-a823-7b5df419d493", "txid": null, "status": "opened", "registration_status": "pending", "pix_account_id": 81, "pix_account_uid": "01a06d8f-a03e-7da7-aa8f-dc95154d88e2", "kind": "instant", "created_at": "2026-09-04T12:55:24-05:00", "updated_at": "2026-09-04T12:55:24-05:00", "expire_at": "2026-09-07T00:00:00-05:00", "canceled_at": null, "registered_at": null, "amount": 25.0, "additional_info": {}, "command_ids": [], "message": "MyText", "message_payer": null, "qrcode": { "emv": null, "png": null }, "payer": { "name": "José da Silva", "document_number": "39988107226" }, "url": "http://dev.kdoc.to:5001/1/KKrAhRY8MFFI", "formats": { "default": { "html": "http://dev.kdoc.to:5001/1/KKrAhRY8MFFI", "png": "http://dev.kdoc.to:5001/1/KKrAhRY8MFFI.png", "pdf": "http://dev.kdoc.to:5001/1/KKrAhRY8MFFI.pdf" }, "qrcode": { "html": "http://dev.kdoc.to:5001/1/KKrAhRY8MFFI/qrcode", "png": "http://dev.kdoc.to:5001/1/KKrAhRY8MFFI/qrcode.png", "pdf": "http://dev.kdoc.to:5001/1/KKrAhRY8MFFI/qrcode.pdf" } }, "paid_amount": null, "paid_at": null, "end_to_end_id": null, "beneficiary": { "kind": "natural", "name": "Margret Santos Filgueiras", "tags": [ "consequatur", "exercitationem", "voluptatum" ], "emails": [ { "label": null, "address": "ignacia_muller@ortiz-kessler.test" } ], "phones": [ { "kind": "landline", "number": "30030386", "local_code": "21", "country_code": "55" } ], "addresses": [ { "state": "RJ", "number": "120", "street": "Av. Burkhard Hehn Simões", "zip_code": "24360440", "city_name": "Rio de Janeiro", "complement": "709", "neighborhood": "São Francisco" } ], "legal_name": "Margret Santos Filgueiras", "custom_data": { "numero_erp": 63126 }, "document_type": "CPF", "external_code": "000001", "classification": "person", "document_number": "610.713.963-07" }, "custom_data": null, "external_id": null, "ignore_whatsapp": false, "interest": { "type": null, "amount": null, "percentage": null }, "discounts": { "type": null, "discount_first": { "amount": null, "percentage": null, "days": null }, "discount_second": { "amount": null, "percentage": null, "days": null }, "discount_third": { "amount": null, "percentage": null, "days": null } }, "reduction": { "type": "none", "amount": null, "percentage": null }, "fine": { "type": null, "amount": null, "percentage": null }, "created_via_api": false, "password_protected_mode": null, "financial_provider_external_id": null, "tags": [ "tag 1", "tag 3" ], "tag_list": "tag 1,tag 3", "revoke_days": null, "payments": [] } ], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_pix" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } }, "422": { "description": "cnpj_cpf inválido", "content": { "application/json": { "example": { "status": 422, "errors": [ { "title": "Parâmetro cnpj_cpf inválido", "code": "invalid_cnpj_cpf", "detail": "O valor informado não é um CNPJ ou CPF válido." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "post": { "summary": "Criar um Pix", "tags": [ "Pix" ], "security": [ { "bearerAuth": [] } ], "description": "\nEsse endpoint é utilizado para a geração de uma cobrança Pix.\n\nA criação do Pix é sincrona, porém o registro na instituição financeira é realizada em segundo plano. Sendo assim, o retorno da requisição não irá conter o campo `qrcode`.\n\nPara receber o qrcode é necessário assinar um webhook para receber o payload completo do Pix quando o registro for confirmado.\n\n## Pré-requisito\n\nPara emitir uma cobrança Pix é necessário ter cadastrado em sua conta uma Conta Pix. Todo Pix pertence a uma Conta Pix que representa a instituição de pagamento e a chave que será usada para a emissão do Pix.\nA criação da Conta Pix precisa ser feita pela interface web do sistema ou pelo endpoint `POST /api/v2/charge/pix_accounts`.\n\n## Eventos de Webhook\n\nAo cadastrar um Pix o sistema cria um comando para registrar o PIX na instituição financeira e o evento `pix.register.requested` é disparado. Após o registro do Pix ser confirmado na instituição o evento `pix.register.confirmed` é disparado.\n\nO evento `pix.db.created` também é disparado nesta operação.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Pix criado com dados de cliente", "content": { "application/json": { "example": { "status": 201, "data": { "id": 63, "uid": "01a06d8f-a750-7d0b-8b92-bea72b36bf01", "txid": null, "status": "opened", "registration_status": "pending", "pix_account_id": 93, "pix_account_uid": "01a06d8f-a72b-7cbe-a682-83319ab5afcf", "kind": "instant", "created_at": "2026-09-04T12:55:26-05:00", "updated_at": "2026-09-04T12:55:26-05:00", "expire_at": "2026-09-14T12:55:26-05:00", "canceled_at": null, "registered_at": null, "amount": 100.5, "additional_info": null, "command_ids": [], "message": null, "message_payer": null, "qrcode": { "emv": null, "png": null }, "payer": { "document_number": "523.447.835-12", "name": "John Doe", "emails": [ { "address": "margret@example.com" } ] }, "url": "http://dev.kdoc.to:5001/1/B3fnp8IveOaN", "formats": { "default": { "html": "http://dev.kdoc.to:5001/1/B3fnp8IveOaN", "png": "http://dev.kdoc.to:5001/1/B3fnp8IveOaN.png", "pdf": "http://dev.kdoc.to:5001/1/B3fnp8IveOaN.pdf" }, "qrcode": { "html": "http://dev.kdoc.to:5001/1/B3fnp8IveOaN/qrcode", "png": "http://dev.kdoc.to:5001/1/B3fnp8IveOaN/qrcode.png", "pdf": "http://dev.kdoc.to:5001/1/B3fnp8IveOaN/qrcode.pdf" } }, "paid_amount": null, "paid_at": null, "end_to_end_id": null, "beneficiary": { "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "classification": "person", "custom_data": { "numero_erp": 63126 }, "document_number": "244.652.700-03", "document_type": "CPF", "emails": [ { "label": null, "address": "markus_bailey@langosh-fay.test" } ], "external_code": "000001", "kind": "natural", "legal_name": "Margret Santos Filgueiras", "name": "Margret Santos Filgueiras", "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "tags": [ "porro", "nisi", "omnis" ] }, "custom_data": null, "external_id": null, "ignore_whatsapp": false, "interest": { "type": null, "amount": null, "percentage": null }, "discounts": { "type": null, "discount_first": { "amount": null, "percentage": null, "days": null }, "discount_second": { "amount": null, "percentage": null, "days": null }, "discount_third": { "amount": null, "percentage": null, "days": null } }, "reduction": { "type": "none", "amount": null, "percentage": null }, "fine": { "type": null, "amount": null, "percentage": null }, "created_via_api": true, "password_protected_mode": null, "financial_provider_external_id": null, "tags": [ "tag1", "tag2", "tag3" ], "tag_list": "tag1,tag2,tag3", "revoke_days": null, "payments": [] } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_pix" } } } } } }, "422": { "description": "Erro de validação", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "amount", "detail": "Quantia não pode ficar em branco" }, { "code": "validation_error", "param": "payer", "detail": "Pagador > CPF/CNPJ não é um CNPJ ou CPF válido" }, { "code": "validation_error", "param": "payer", "detail": "Pagador > Nome não pode ficar em branco" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_pix" } } }, "required": true, "description": "Parametros para criação de uma cobrança Pix" } } }, "/v2/charge/pix/{uid}": { "get": { "summary": "Visualizar um Pix", "tags": [ "Pix" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de um Pix.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UID do Pix", "required": true, "example": "dd58e076-95c4-4b42-bda2-af00f3aa51b4", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Pix encontrado", "content": { "application/json": { "example": { "status": 200, "data": { "id": 64, "uid": "01a06d8f-a8b8-7ed4-af13-e9b6682caca2", "txid": "TXID000001000001000001000001", "status": "opened", "registration_status": "pending", "pix_account_id": 96, "pix_account_uid": "01a06d8f-a8ad-7a3f-94af-947fd5299dff", "kind": "instant", "created_at": "2026-09-04T12:55:26-05:00", "updated_at": "2026-09-04T12:55:26-05:00", "expire_at": "2026-09-07T00:00:00-05:00", "canceled_at": null, "registered_at": null, "amount": 199.99, "additional_info": {}, "command_ids": [], "message": "MyText", "message_payer": null, "qrcode": { "emv": "00000000000000000000br.gov.bcb.pix2563qrcodepix.bb.com.br/pix/v2/99999999-8888-8888-4444-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.000000000000YYYYYYYYYYYYYYYYYYYYYYYYY6008XXXXXXXX62070503***63040921", "png": "iVBORw0KGgoAAAANSUhEUgAAAQkAAAEJAQAAAACvE+/JAAAEW0lEQVR4nO1a\nTW7rPAwkkwD2Tr6BfJFE6bEK5MeuA+RYjdKLSDewdjaQlG+odvteukr1AZ8X\nrRBrMWVGwxmqC3n0dAt6+Py/5W9bPDPX17TneUE915T2bY3PWromvFmUBpfx\nhdO6ITJ37mjeEsX5QLvIWzqKXEqDS4lbYK2EPqQjEjtI9WaGMBHdUezi4H49\nr+18SEA6jH07b/VP2Pwalsdb0ipOZGaeHRgBgnRUXX4Ly7+3GAnEI36/N0up\nZNzFSakMHixlejKWx1sE55+utLP0EffQAyJrhnizWPWM81YYXAdlmMRCFA50\n9mDsGafMVH7aGLz5LA2ub/q2duM5QLRe3czNK9drnlvwuSMtdllwN2nwaAhd\nJI8Si4wnmpegMnNzb/lQGlzogTNebpYPuZyms9UnnWhyMnh5Kw4uLUNyDfAB\nKQGzeKxEqndmV95R+xhPseZ4i+YT1Z2udHe1MCzEFq+nTWlwBRqrymChB2gO\nn+oZXmQItWpxeU2Yx7tDYaG+L+PZ11fYBVHu4uQNviqOu+tmF9PLuLPVJd3s\nvG96Ny9SZ8WPT8fygy0fkNz6SicIGc4bhPYYarEwvSCwUwKXBXeD5oAOcQyQ\ntBth1bfkYqcVP4aqwK629DUZrSSCBB/HZQDwzuLHKpbX1XjsXdomdDUHpJM0\nry18GAqrVC7RkQ3BvKP/KjSCPT+plUSQ2Kg8FKe7aMJt2mJZ9ZZbWmtge4lD\nAA+QMLalwd0gSGg3sDPULCL6wp4TgSBozAVy92puVi5JGxrUtlJHRspdtT0l\ndrXYERruEmrbwJ5rrjB908MzpK7Eo6aeAd8+9MDsNf8CM8NPVhdYiBKPWhfZ\nNTA2iyQBaYLybIQgGSB1cdxFB1N/sLO1OjLUeUdy58HPB6MlLg3uFfYcSFeU\n5zmVGpt5KXvtFecwFxd+MnehtrHyMoi2XtQ5DaF6g1qUNyNzsoIywI+nPbIk\nkN50nsPwOeO9wAnktzLcWzPEwdParpSxyzA7O4Tyqqvl5G0SQS7Trpvm7znD\nR5zds7H8YIvJFD3lOYOOmr7nDOaC1+XNGa5oXkpRm92D+vGvOUNSLS5wzmBU\ntHRWuoXkYiVeLXuoHYSivDkDRyiDIKapnSG0sXtG7ybflDhnWKOS4uMgApMA\nFwn0OQEZiciXz8Xyky1GlQE/YMvOIce0rGukBq28OQOllZ1wyiAKkDS5gwJY\nVSEtEIzLa8IwuGR6e4PKgsCstuxrzgAL4cqzOE66r65W6dQUaaLPcwYSTRNP\nxvKDLfnWEmQgnTNwNmjZA885zBfnd/OtJY/HIO/NWXSo04ICRzEXU2L4ybeW\nHmYMFmxHOU1oFtIbtlWJ4Sc/msu8Za4EVhL0QMV1qFPenCE/GxgHvbhGdXnP\neVYKbrzyb2B5sEVvLa8IPzk+aJrIaqupchnKi5b51pJUbTcqCi7e8pyhTUdh\nV549z7eWWXxZkIkv+r8B+lmVZ76FHrX/yJY/f72JkMFgLPYAAAAASUVORK5C\nYII=\n" }, "payer": { "name": "José da Silva", "document_number": "39988107226" }, "url": "http://dev.kdoc.to:5001/1/NsKtIgtSwo4u", "formats": { "default": { "html": "http://dev.kdoc.to:5001/1/NsKtIgtSwo4u", "png": "http://dev.kdoc.to:5001/1/NsKtIgtSwo4u.png", "pdf": "http://dev.kdoc.to:5001/1/NsKtIgtSwo4u.pdf" }, "qrcode": { "html": "http://dev.kdoc.to:5001/1/NsKtIgtSwo4u/qrcode", "png": "http://dev.kdoc.to:5001/1/NsKtIgtSwo4u/qrcode.png", "pdf": "http://dev.kdoc.to:5001/1/NsKtIgtSwo4u/qrcode.pdf" } }, "paid_amount": null, "paid_at": null, "end_to_end_id": null, "beneficiary": { "kind": "natural", "name": "Margret Santos Filgueiras", "tags": [ "id", "quis", "officiis" ], "emails": [ { "label": null, "address": "olive_bednar@cummerata.example" } ], "phones": [ { "kind": "landline", "number": "30030386", "local_code": "21", "country_code": "55" } ], "addresses": [ { "state": "RJ", "number": "120", "street": "Av. Burkhard Hehn Simões", "zip_code": "24360440", "city_name": "Rio de Janeiro", "complement": "709", "neighborhood": "São Francisco" } ], "legal_name": "Margret Santos Filgueiras", "custom_data": { "numero_erp": 63126 }, "document_type": "CPF", "external_code": "000001", "classification": "person", "document_number": "664.665.620-77" }, "custom_data": null, "external_id": null, "ignore_whatsapp": false, "interest": { "type": null, "amount": null, "percentage": null }, "discounts": { "type": null, "discount_first": { "amount": null, "percentage": null, "days": null }, "discount_second": { "amount": null, "percentage": null, "days": null }, "discount_third": { "amount": null, "percentage": null, "days": null } }, "reduction": { "type": "none", "amount": null, "percentage": null }, "fine": { "type": null, "amount": null, "percentage": null }, "created_via_api": false, "password_protected_mode": null, "financial_provider_external_id": null, "tags": [], "tag_list": null, "revoke_days": null, "payments": [] } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_pix" } } } } } }, "404": { "description": "Pix não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "delete": { "summary": "Excluir um Pix", "tags": [ "Pix" ], "security": [ { "bearerAuth": [] } ], "description": "Deleta um Pix cancelado.\n\nEsta operação excluí o PIX definitivamente do nosso banco de dados. Mesmo realizando a exclusão, o PIX é contabilizado na volumetria para o plano contratad\n\n## Eventos de Webhook\n\nO evento `pix.db.deleted` é disparado nesta operação.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "ID do Pix", "required": true, "example": "214479fd-aba0-408c-9b87-963ec8235f4e", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Pix deletado" }, "422": { "description": "Pix aberto", "content": { "application/json": { "example": { "status": 422, "errors": [ { "title": "Não foi possível excluir esta cobrança Pix.", "code": "destroy_pix_opened", "detail": "Não é possível excluir um Pix em aberto." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Pix não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/charge/pix/{pix_uid}/update": { "put": { "summary": "Atualizar um Pix", "tags": [ "Pix" ], "security": [ { "bearerAuth": [] } ], "description": "\n> **Processamento Assíncrono:** Este endpoint é processado assincronamente e cria um comando de atualização para o PIX.\nA atualização de um PIX é feita assincronamente, ou seja, ao receber a requisição, a nossa API guarda as mudanças que você está solicitando e cria um Comando. Esse comando é processado em segundo plano e depois de confirmado, o Pix é atualizado. Você recebe na resposta desta requisição o ID do comando criado e pode consultá-lo a qualquer momento. Veja mais em [Listar Comandos de um Pix](ref:get_v2-charge-pix-pix-id-commands) e [Visualizar um Comando](ref:get_v2-charge-pix-pix-id-commands-id).\n\n## Eventos de Webhook\n\nQuando a requisição é realizada, um evento `pix.update.requested` é disparado.\nO nosso servidor então começa as tentativas de envio da alteração para a instituição financeira.\nSomente depois de confirmado na instituição financeira, aí então o pix é atualizado.\nNeste momento o evento `pix.update.confirmed` é disparado.\n\nO evento `pix.db.updated` também é disparado na confirmação desta operação.\n> ⚠️ **Atenção ao payload de retorno:** A resposta da chamada de atualização de um PIX é o payload de um Comando. Dentro do payload do comando tem a chave `pix` com os dados do PIX em questão.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "pix_uid", "in": "path", "description": "UID do Pix", "required": true, "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Comando criado com sucesso - com pix_account_uid", "content": { "application/json": { "example": { "status": 200, "data": { "id": 74, "uid": "01a06d8f-b92e-7d37-8c53-c9326b85ab9c", "status": "pending", "operation": "update", "resource_type": "Pix", "resource_uid": "01a06d8f-b884-76fb-be79-7e9d5c9dadff", "financial_provider_slug": "itau", "params": { "additional_info": { "chave": "valor" }, "expire_at": "2026-09-14T12:55:30-05:00", "fine_type": "amount", "interest_type": "yearly_percentage_business", "message": "Atualização de Pix com nova conta via API", "payer": { "document_number": "05.813.794/0001-26", "name": "João da Silva", "address": { "street": "Rua Exemplo", "zip_code": "12345-678", "complement": "Apto 101", "number": "123", "neighborhood": "Bairro Exemplo", "city_name": "Cidade Exemplo", "state": "SP" }, "emails": [ { "address": "joao@example.com" } ] }, "reduction_type": "none", "revoke_days": 5, "amount": 100.2, "fine_amount": 10.0, "interest_amount": 3.0, "reduction_amount": 0.0, "discount_days": 10, "discount_second_days": 5, "discount_third_days": 0, "discount_type": "advance_percentage_calendar", "discount_amount": 10.0, "discount_second_amount": 7.0, "discount_third_amount": 3.0, "discount_percentage": "3.0", "discount_second_percentage": "2.5", "discount_third_percentage": "1.0", "interest_percentage": "2.5", "pix_account_id": 115 }, "payload": null, "created_at": "2026-09-04T12:55:30-05:00", "updated_at": "2026-09-04T12:55:30-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "pix": { "id": 82, "uid": "01a06d8f-b884-76fb-be79-7e9d5c9dadff", "txid": "TXID0000000000000000000001", "status": "opened", "registration_status": "pending", "pix_account_id": 114, "pix_account_uid": "01a06d8f-b878-7009-b8d8-49d458de3469", "kind": "instant", "created_at": "2026-09-04T12:55:30-05:00", "updated_at": "2026-09-04T12:55:30-05:00", "expire_at": "2026-09-07T00:00:00-05:00", "canceled_at": null, "registered_at": null, "amount": 199.99, "additional_info": {}, "command_ids": [ 74 ], "message": "MyText", "message_payer": null, "qrcode": { "emv": "00000000000000000000br.gov.bcb.pix2563qrcodepix.bb.com.br/pix/v2/99999999-8888-8888-4444-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.000000000000YYYYYYYYYYYYYYYYYYYYYYYYY6008XXXXXXXX62070503***63040921", "png": "iVBORw0KGgoAAAANSUhEUgAAAQkAAAEJAQAAAACvE+/JAAAEW0lEQVR4nO1a\nTW7rPAwkkwD2Tr6BfJFE6bEK5MeuA+RYjdKLSDewdjaQlG+odvteukr1AZ8X\nrRBrMWVGwxmqC3n0dAt6+Py/5W9bPDPX17TneUE915T2bY3PWromvFmUBpfx\nhdO6ITJ37mjeEsX5QLvIWzqKXEqDS4lbYK2EPqQjEjtI9WaGMBHdUezi4H49\nr+18SEA6jH07b/VP2Pwalsdb0ipOZGaeHRgBgnRUXX4Ly7+3GAnEI36/N0up\nZNzFSakMHixlejKWx1sE55+utLP0EffQAyJrhnizWPWM81YYXAdlmMRCFA50\n9mDsGafMVH7aGLz5LA2ub/q2duM5QLRe3czNK9drnlvwuSMtdllwN2nwaAhd\nJI8Si4wnmpegMnNzb/lQGlzogTNebpYPuZyms9UnnWhyMnh5Kw4uLUNyDfAB\nKQGzeKxEqndmV95R+xhPseZ4i+YT1Z2udHe1MCzEFq+nTWlwBRqrymChB2gO\nn+oZXmQItWpxeU2Yx7tDYaG+L+PZ11fYBVHu4uQNviqOu+tmF9PLuLPVJd3s\nvG96Ny9SZ8WPT8fygy0fkNz6SicIGc4bhPYYarEwvSCwUwKXBXeD5oAOcQyQ\ntBth1bfkYqcVP4aqwK629DUZrSSCBB/HZQDwzuLHKpbX1XjsXdomdDUHpJM0\nry18GAqrVC7RkQ3BvKP/KjSCPT+plUSQ2Kg8FKe7aMJt2mJZ9ZZbWmtge4lD\nAA+QMLalwd0gSGg3sDPULCL6wp4TgSBozAVy92puVi5JGxrUtlJHRspdtT0l\ndrXYERruEmrbwJ5rrjB908MzpK7Eo6aeAd8+9MDsNf8CM8NPVhdYiBKPWhfZ\nNTA2iyQBaYLybIQgGSB1cdxFB1N/sLO1OjLUeUdy58HPB6MlLg3uFfYcSFeU\n5zmVGpt5KXvtFecwFxd+MnehtrHyMoi2XtQ5DaF6g1qUNyNzsoIywI+nPbIk\nkN50nsPwOeO9wAnktzLcWzPEwdParpSxyzA7O4Tyqqvl5G0SQS7Trpvm7znD\nR5zds7H8YIvJFD3lOYOOmr7nDOaC1+XNGa5oXkpRm92D+vGvOUNSLS5wzmBU\ntHRWuoXkYiVeLXuoHYSivDkDRyiDIKapnSG0sXtG7ybflDhnWKOS4uMgApMA\nFwn0OQEZiciXz8Xyky1GlQE/YMvOIce0rGukBq28OQOllZ1wyiAKkDS5gwJY\nVSEtEIzLa8IwuGR6e4PKgsCstuxrzgAL4cqzOE66r65W6dQUaaLPcwYSTRNP\nxvKDLfnWEmQgnTNwNmjZA885zBfnd/OtJY/HIO/NWXSo04ICRzEXU2L4ybeW\nHmYMFmxHOU1oFtIbtlWJ4Sc/msu8Za4EVhL0QMV1qFPenCE/GxgHvbhGdXnP\neVYKbrzyb2B5sEVvLa8IPzk+aJrIaqupchnKi5b51pJUbTcqCi7e8pyhTUdh\nV549z7eWWXxZkIkv+r8B+lmVZ76FHrX/yJY/f72JkMFgLPYAAAAASUVORK5C\nYII=\n" }, "payer": { "name": "José da Silva", "document_number": "39988107226" }, "url": "http://dev.kdoc.to:5001/1/IWX91H6ZzJs2", "formats": { "default": { "html": "http://dev.kdoc.to:5001/1/IWX91H6ZzJs2", "png": "http://dev.kdoc.to:5001/1/IWX91H6ZzJs2.png", "pdf": "http://dev.kdoc.to:5001/1/IWX91H6ZzJs2.pdf" }, "qrcode": { "html": "http://dev.kdoc.to:5001/1/IWX91H6ZzJs2/qrcode", "png": "http://dev.kdoc.to:5001/1/IWX91H6ZzJs2/qrcode.png", "pdf": "http://dev.kdoc.to:5001/1/IWX91H6ZzJs2/qrcode.pdf" } }, "paid_amount": null, "paid_at": null, "end_to_end_id": null, "beneficiary": { "kind": "natural", "name": "Margret Santos Filgueiras", "tags": [ "quia", "et", "assumenda" ], "emails": [ { "label": null, "address": "jewell@white.test" } ], "phones": [ { "kind": "landline", "number": "30030386", "local_code": "21", "country_code": "55" } ], "addresses": [ { "state": "RJ", "number": "120", "street": "Av. Burkhard Hehn Simões", "zip_code": "24360440", "city_name": "Rio de Janeiro", "complement": "709", "neighborhood": "São Francisco" } ], "legal_name": "Margret Santos Filgueiras", "custom_data": { "numero_erp": 63126 }, "document_type": "CPF", "external_code": "000001", "classification": "person", "document_number": "810.552.078-80" }, "custom_data": null, "external_id": null, "ignore_whatsapp": false, "interest": { "type": null, "amount": null, "percentage": null }, "discounts": { "type": null, "discount_first": { "amount": null, "percentage": null, "days": null }, "discount_second": { "amount": null, "percentage": null, "days": null }, "discount_third": { "amount": null, "percentage": null, "days": null } }, "reduction": { "type": "none", "amount": null, "percentage": null }, "fine": { "type": null, "amount": null, "percentage": null }, "created_via_api": false, "password_protected_mode": null, "financial_provider_external_id": null, "tags": [], "tag_list": null, "revoke_days": null, "payments": [] } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_pix_command" } } } } } }, "422": { "description": "Pix pago", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Atualização de Pix.", "detail": "Não é possível alterar uma cobrança Pix que já foi paga." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_pix_update" } } }, "required": true, "description": "Parâmetros para atualização do Pix" } } }, "/v2/charge/pix/{pix_uid}/cancel": { "put": { "summary": "Cancelar um Pix", "tags": [ "Pix" ], "security": [ { "bearerAuth": [] } ], "description": "\n> **Processamento Assíncrono:** Este endpoint é processado assincronamente e cria um comando de cancelamento para o PIX.\nO cancelamento de um PIX é feito assincronamente, ou seja, ao receber a requisição, a nossa API guarda a solicitação e cria um Comando. Esse comando é processado em segundo plano e depois de confirmado, o Pix é cancelado. Você recebe na resposta desta requisição o ID do comando criado e pode consultá-lo a qualquer momento. Veja mais em [Listar Comandos de um Pix](ref:get_v2-charge-pix-pix-id-commands) e [Visualizar um Comando](ref:get_v2-charge-pix-pix-id-commands-id).\n\n## Eventos de Webhook\n\nQuando a requisição é realizada, um evento `pix.command.cancel.started` é disparado.\nO nosso servidor então começa as tentativas de envio da cancelamento para a instituição financeira.\nSomente depois de confirmado na instituição financeira, aí então o pix é cancelado em nosso banco de dados.\nNeste momento o evento `pix.command.cancel.confirmed` é disparado.\n\nO evento `pix.db.updated` também é disparado na confirmação desta operação.\n> ⚠️ **Atenção ao payload de retorno:** A resposta da chamada de cancelamento de um PIX é o payload de um Comando. Dentro do payload do comando tem a chave `pix` com os dados do PIX em questão.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "pix_uid", "in": "path", "description": "UID do Pix", "required": true, "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Comando criado com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "id": 75, "uid": "01a06d8f-c1b1-74fa-8bad-19ba0bcb0963", "status": "pending", "operation": "cancel", "resource_type": "Pix", "resource_uid": "01a06d8f-c176-71a0-8a92-fa9c0da0f9ad", "financial_provider_slug": "itau", "params": {}, "payload": null, "created_at": "2026-09-04T12:55:32-05:00", "updated_at": "2026-09-04T12:55:32-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "pix": { "id": 92, "uid": "01a06d8f-c176-71a0-8a92-fa9c0da0f9ad", "txid": "TXID0000000000000000000001", "status": "opened", "registration_status": "pending", "pix_account_id": 127, "pix_account_uid": "01a06d8f-c167-7e94-91cc-658e0052b6d8", "kind": "instant", "created_at": "2026-09-04T12:55:32-05:00", "updated_at": "2026-09-04T12:55:32-05:00", "expire_at": "2026-09-07T00:00:00-05:00", "canceled_at": null, "registered_at": null, "amount": 199.99, "additional_info": {}, "command_ids": [ 75 ], "message": "MyText", "message_payer": null, "qrcode": { "emv": "00000000000000000000br.gov.bcb.pix2563qrcodepix.bb.com.br/pix/v2/99999999-8888-8888-4444-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.000000000000YYYYYYYYYYYYYYYYYYYYYYYYY6008XXXXXXXX62070503***63040921", "png": "iVBORw0KGgoAAAANSUhEUgAAAQkAAAEJAQAAAACvE+/JAAAEW0lEQVR4nO1a\nTW7rPAwkkwD2Tr6BfJFE6bEK5MeuA+RYjdKLSDewdjaQlG+odvteukr1AZ8X\nrRBrMWVGwxmqC3n0dAt6+Py/5W9bPDPX17TneUE915T2bY3PWromvFmUBpfx\nhdO6ITJ37mjeEsX5QLvIWzqKXEqDS4lbYK2EPqQjEjtI9WaGMBHdUezi4H49\nr+18SEA6jH07b/VP2Pwalsdb0ipOZGaeHRgBgnRUXX4Ly7+3GAnEI36/N0up\nZNzFSakMHixlejKWx1sE55+utLP0EffQAyJrhnizWPWM81YYXAdlmMRCFA50\n9mDsGafMVH7aGLz5LA2ub/q2duM5QLRe3czNK9drnlvwuSMtdllwN2nwaAhd\nJI8Si4wnmpegMnNzb/lQGlzogTNebpYPuZyms9UnnWhyMnh5Kw4uLUNyDfAB\nKQGzeKxEqndmV95R+xhPseZ4i+YT1Z2udHe1MCzEFq+nTWlwBRqrymChB2gO\nn+oZXmQItWpxeU2Yx7tDYaG+L+PZ11fYBVHu4uQNviqOu+tmF9PLuLPVJd3s\nvG96Ny9SZ8WPT8fygy0fkNz6SicIGc4bhPYYarEwvSCwUwKXBXeD5oAOcQyQ\ntBth1bfkYqcVP4aqwK629DUZrSSCBB/HZQDwzuLHKpbX1XjsXdomdDUHpJM0\nry18GAqrVC7RkQ3BvKP/KjSCPT+plUSQ2Kg8FKe7aMJt2mJZ9ZZbWmtge4lD\nAA+QMLalwd0gSGg3sDPULCL6wp4TgSBozAVy92puVi5JGxrUtlJHRspdtT0l\ndrXYERruEmrbwJ5rrjB908MzpK7Eo6aeAd8+9MDsNf8CM8NPVhdYiBKPWhfZ\nNTA2iyQBaYLybIQgGSB1cdxFB1N/sLO1OjLUeUdy58HPB6MlLg3uFfYcSFeU\n5zmVGpt5KXvtFecwFxd+MnehtrHyMoi2XtQ5DaF6g1qUNyNzsoIywI+nPbIk\nkN50nsPwOeO9wAnktzLcWzPEwdParpSxyzA7O4Tyqqvl5G0SQS7Trpvm7znD\nR5zds7H8YIvJFD3lOYOOmr7nDOaC1+XNGa5oXkpRm92D+vGvOUNSLS5wzmBU\ntHRWuoXkYiVeLXuoHYSivDkDRyiDIKapnSG0sXtG7ybflDhnWKOS4uMgApMA\nFwn0OQEZiciXz8Xyky1GlQE/YMvOIce0rGukBq28OQOllZ1wyiAKkDS5gwJY\nVSEtEIzLa8IwuGR6e4PKgsCstuxrzgAL4cqzOE66r65W6dQUaaLPcwYSTRNP\nxvKDLfnWEmQgnTNwNmjZA885zBfnd/OtJY/HIO/NWXSo04ICRzEXU2L4ybeW\nHmYMFmxHOU1oFtIbtlWJ4Sc/msu8Za4EVhL0QMV1qFPenCE/GxgHvbhGdXnP\neVYKbrzyb2B5sEVvLa8IPzk+aJrIaqupchnKi5b51pJUbTcqCi7e8pyhTUdh\nV549z7eWWXxZkIkv+r8B+lmVZ76FHrX/yJY/f72JkMFgLPYAAAAASUVORK5C\nYII=\n" }, "payer": { "name": "José da Silva", "document_number": "39988107226" }, "url": "http://dev.kdoc.to:5001/1/wo-p-8jAxmJV", "formats": { "default": { "html": "http://dev.kdoc.to:5001/1/wo-p-8jAxmJV", "png": "http://dev.kdoc.to:5001/1/wo-p-8jAxmJV.png", "pdf": "http://dev.kdoc.to:5001/1/wo-p-8jAxmJV.pdf" }, "qrcode": { "html": "http://dev.kdoc.to:5001/1/wo-p-8jAxmJV/qrcode", "png": "http://dev.kdoc.to:5001/1/wo-p-8jAxmJV/qrcode.png", "pdf": "http://dev.kdoc.to:5001/1/wo-p-8jAxmJV/qrcode.pdf" } }, "paid_amount": null, "paid_at": null, "end_to_end_id": null, "beneficiary": { "kind": "natural", "name": "Margret Santos Filgueiras", "tags": [ "repellendus", "ducimus", "autem" ], "emails": [ { "label": null, "address": "elijah@gutkowski.test" } ], "phones": [ { "kind": "landline", "number": "30030386", "local_code": "21", "country_code": "55" } ], "addresses": [ { "state": "RJ", "number": "120", "street": "Av. Burkhard Hehn Simões", "zip_code": "24360440", "city_name": "Rio de Janeiro", "complement": "709", "neighborhood": "São Francisco" } ], "legal_name": "Margret Santos Filgueiras", "custom_data": { "numero_erp": 63126 }, "document_type": "CPF", "external_code": "000001", "classification": "person", "document_number": "926.626.661-29" }, "custom_data": null, "external_id": null, "ignore_whatsapp": false, "interest": { "type": null, "amount": null, "percentage": null }, "discounts": { "type": null, "discount_first": { "amount": null, "percentage": null, "days": null }, "discount_second": { "amount": null, "percentage": null, "days": null }, "discount_third": { "amount": null, "percentage": null, "days": null } }, "reduction": { "type": "none", "amount": null, "percentage": null }, "fine": { "type": null, "amount": null, "percentage": null }, "created_via_api": false, "password_protected_mode": null, "financial_provider_external_id": null, "tags": [], "tag_list": null, "revoke_days": null, "payments": [] } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_pix_command" } } } } } }, "422": { "description": "Pix já cancelado", "content": { "application/json": { "example": { "status": 422, "errors": [ { "title": "Não é possível alterar esta cobrança Pix.", "code": "change_pix_already_canceled", "detail": "Não é possível alterar uma cobrança Pix que já foi cancelada." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/charge/pix/{pix_uid}/commands": { "get": { "summary": "Listar Comandos de um Pix", "tags": [ "Pix" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todos os comandos (operações) executados em uma cobrança Pix específica, incluindo atualizações, cancelamentos e outras operações.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "pix_uid", "in": "path", "description": "UID do Pix", "required": true, "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Pix encontrado", "content": { "application/json": { "example": { "status": 200, "data": [ { "id": 76, "uid": "01a06d8f-c545-7a86-a88d-24dc2d87abf8", "status": "pending", "operation": "update", "resource_type": "Pix", "resource_uid": "01a06d8f-c532-7d11-9208-731abd91aa40", "financial_provider_slug": "itau", "params": { "amount": 100.0, "expire_at": "2026-09-14T12:55:33-05:00" }, "payload": null, "created_at": "2026-09-04T12:55:33-05:00", "updated_at": "2026-09-04T12:55:33-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "pix": { "id": 97, "uid": "01a06d8f-c532-7d11-9208-731abd91aa40", "txid": null, "status": "opened", "registration_status": "pending", "pix_account_id": 132, "pix_account_uid": "01a06d8f-c524-77b1-9423-5ba0499b249c", "kind": "instant", "created_at": "2026-09-04T12:55:33-05:00", "updated_at": "2026-09-04T12:55:33-05:00", "expire_at": "2026-09-07T00:00:00-05:00", "canceled_at": null, "registered_at": null, "amount": 25.0, "additional_info": {}, "command_ids": [ 76 ], "message": "MyText", "message_payer": null, "qrcode": { "emv": null, "png": null }, "payer": { "name": "José da Silva", "document_number": "39988107226" }, "url": "http://dev.kdoc.to:5001/1/iBJ_RtVNh8pS", "formats": { "default": { "html": "http://dev.kdoc.to:5001/1/iBJ_RtVNh8pS", "png": "http://dev.kdoc.to:5001/1/iBJ_RtVNh8pS.png", "pdf": "http://dev.kdoc.to:5001/1/iBJ_RtVNh8pS.pdf" }, "qrcode": { "html": "http://dev.kdoc.to:5001/1/iBJ_RtVNh8pS/qrcode", "png": "http://dev.kdoc.to:5001/1/iBJ_RtVNh8pS/qrcode.png", "pdf": "http://dev.kdoc.to:5001/1/iBJ_RtVNh8pS/qrcode.pdf" } }, "paid_amount": null, "paid_at": null, "end_to_end_id": null, "beneficiary": { "kind": "natural", "name": "Margret Santos Filgueiras", "tags": [ "molestias", "voluptas", "sed" ], "emails": [ { "label": null, "address": "abdul@schaden-bayer.test" } ], "phones": [ { "kind": "landline", "number": "30030386", "local_code": "21", "country_code": "55" } ], "addresses": [ { "state": "RJ", "number": "120", "street": "Av. Burkhard Hehn Simões", "zip_code": "24360440", "city_name": "Rio de Janeiro", "complement": "709", "neighborhood": "São Francisco" } ], "legal_name": "Margret Santos Filgueiras", "custom_data": { "numero_erp": 63126 }, "document_type": "CPF", "external_code": "000001", "classification": "person", "document_number": "737.054.732-98" }, "custom_data": null, "external_id": null, "ignore_whatsapp": false, "interest": { "type": null, "amount": null, "percentage": null }, "discounts": { "type": null, "discount_first": { "amount": null, "percentage": null, "days": null }, "discount_second": { "amount": null, "percentage": null, "days": null }, "discount_third": { "amount": null, "percentage": null, "days": null } }, "reduction": { "type": "none", "amount": null, "percentage": null }, "fine": { "type": null, "amount": null, "percentage": null }, "created_via_api": false, "password_protected_mode": null, "financial_provider_external_id": null, "tags": [], "tag_list": null, "revoke_days": null, "payments": [] } } ], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_pix_command" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } }, "404": { "description": "Pix não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/charge/pix/{pix_uid}/commands/{id}": { "get": { "summary": "Visualizar um Comando", "tags": [ "Pix" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações detalhadas de um comando específico executado em uma cobrança Pix.", "parameters": [ { "name": "pix_uid", "in": "path", "description": "UID do Pix", "required": true, "example": 999, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "ID da Atualização do Pix", "required": true, "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Atualização do Pix encontrada", "content": { "application/json": { "example": { "status": 200, "data": { "id": 77, "uid": "01a06d8f-c670-75cb-850f-27de476efe53", "status": "pending", "operation": "update", "resource_type": "Pix", "resource_uid": "01a06d8f-c65b-740c-8f26-0c9c973f1d0c", "financial_provider_slug": "itau", "params": { "amount": 100.0, "expire_at": "2026-09-14T12:55:34-05:00" }, "payload": null, "created_at": "2026-09-04T12:55:34-05:00", "updated_at": "2026-09-04T12:55:34-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "pix": { "id": 98, "uid": "01a06d8f-c65b-740c-8f26-0c9c973f1d0c", "txid": null, "status": "opened", "registration_status": "pending", "pix_account_id": 133, "pix_account_uid": "01a06d8f-c64b-7275-8705-c7f484852b61", "kind": "instant", "created_at": "2026-09-04T12:55:34-05:00", "updated_at": "2026-09-04T12:55:34-05:00", "expire_at": "2026-09-07T00:00:00-05:00", "canceled_at": null, "registered_at": null, "amount": 25.0, "additional_info": {}, "command_ids": [ 77 ], "message": "MyText", "message_payer": null, "qrcode": { "emv": null, "png": null }, "payer": { "name": "José da Silva", "document_number": "39988107226" }, "url": "http://dev.kdoc.to:5001/1/uTVXkUzcEenI", "formats": { "default": { "html": "http://dev.kdoc.to:5001/1/uTVXkUzcEenI", "png": "http://dev.kdoc.to:5001/1/uTVXkUzcEenI.png", "pdf": "http://dev.kdoc.to:5001/1/uTVXkUzcEenI.pdf" }, "qrcode": { "html": "http://dev.kdoc.to:5001/1/uTVXkUzcEenI/qrcode", "png": "http://dev.kdoc.to:5001/1/uTVXkUzcEenI/qrcode.png", "pdf": "http://dev.kdoc.to:5001/1/uTVXkUzcEenI/qrcode.pdf" } }, "paid_amount": null, "paid_at": null, "end_to_end_id": null, "beneficiary": { "kind": "natural", "name": "Margret Santos Filgueiras", "tags": [ "sed", "dolorem", "possimus" ], "emails": [ { "label": null, "address": "hugh_batz@corkery.test" } ], "phones": [ { "kind": "landline", "number": "30030386", "local_code": "21", "country_code": "55" } ], "addresses": [ { "state": "RJ", "number": "120", "street": "Av. Burkhard Hehn Simões", "zip_code": "24360440", "city_name": "Rio de Janeiro", "complement": "709", "neighborhood": "São Francisco" } ], "legal_name": "Margret Santos Filgueiras", "custom_data": { "numero_erp": 63126 }, "document_type": "CPF", "external_code": "000001", "classification": "person", "document_number": "959.302.190-60" }, "custom_data": null, "external_id": null, "ignore_whatsapp": false, "interest": { "type": null, "amount": null, "percentage": null }, "discounts": { "type": null, "discount_first": { "amount": null, "percentage": null, "days": null }, "discount_second": { "amount": null, "percentage": null, "days": null }, "discount_third": { "amount": null, "percentage": null, "days": null } }, "reduction": { "type": "none", "amount": null, "percentage": null }, "fine": { "type": null, "amount": null, "percentage": null }, "created_via_api": false, "password_protected_mode": null, "financial_provider_external_id": null, "tags": [], "tag_list": null, "revoke_days": null, "payments": [] } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_pix_command" } } } } } }, "404": { "description": "Atualização do Pix não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/financial/accounts/{financial_account_uid}/balances": { "get": { "summary": "Listar saldos", "tags": [ "Saldos" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todos os saldos de uma conta financeira específica. Retorna informações sobre valores disponíveis, bloqueados e investidos automaticamente.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "financial_account_uid", "in": "path", "description": "UUID da Conta Financeira", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Saldos encontrados", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d8f-f20e-70b8-832c-6da7aa626dee", "capture_date": "2026-09-04T12:55:45-05:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2026-09-04T12:55:45-05:00", "external_id": "4e11945d-20a9-4237-98e0-949de6d869e1", "custom_data": null, "tags": [], "financial_account": { "uid": "01a06d8f-e614-7bfa-b64f-eb5f978c8023", "status": "complete", "bank": null, "account_number": "78117792", "account_digit": "3", "agency_number": "1699", "agency_digit": "3", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:42-05:00", "updated_at": "2026-09-04T12:55:42-05:00", "kind": "checking", "custom_name": "Sicoob CC: 78117792-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-e610-7025-806d-83aa56ce6699", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "758.122.798-70", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "nakesha@ziemann.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "qui", "omnis", "molestiae" ], "tag_list": "qui,omnis,molestiae", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "9d640e24-416b-47b2-b57e-1ae478b41ae7" } }, { "uid": "01a06d8f-f1c7-701e-973a-cd29c524d455", "capture_date": "2026-09-04T12:55:45-05:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2026-09-04T12:55:45-05:00", "external_id": "7e8c19c7-6f87-4f50-990c-f2b7efb1e902", "custom_data": null, "tags": [], "financial_account": { "uid": "01a06d8f-e614-7bfa-b64f-eb5f978c8023", "status": "complete", "bank": null, "account_number": "78117792", "account_digit": "3", "agency_number": "1699", "agency_digit": "3", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:42-05:00", "updated_at": "2026-09-04T12:55:42-05:00", "kind": "checking", "custom_name": "Sicoob CC: 78117792-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-e610-7025-806d-83aa56ce6699", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "758.122.798-70", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "nakesha@ziemann.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "qui", "omnis", "molestiae" ], "tag_list": "qui,omnis,molestiae", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "9d640e24-416b-47b2-b57e-1ae478b41ae7" } }, { "uid": "01a06d8f-f181-781b-a26e-2c3d875bc142", "capture_date": "2026-09-04T12:55:45-05:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2026-09-04T12:55:45-05:00", "external_id": "b8dd0066-f734-42f6-af0f-947455353e62", "custom_data": null, "tags": [], "financial_account": { "uid": "01a06d8f-e614-7bfa-b64f-eb5f978c8023", "status": "complete", "bank": null, "account_number": "78117792", "account_digit": "3", "agency_number": "1699", "agency_digit": "3", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:42-05:00", "updated_at": "2026-09-04T12:55:42-05:00", "kind": "checking", "custom_name": "Sicoob CC: 78117792-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-e610-7025-806d-83aa56ce6699", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "758.122.798-70", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "nakesha@ziemann.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "qui", "omnis", "molestiae" ], "tag_list": "qui,omnis,molestiae", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "9d640e24-416b-47b2-b57e-1ae478b41ae7" } }, { "uid": "01a06d8f-f132-7d5b-8a1f-d0ac0d2884ab", "capture_date": "2026-09-04T12:55:45-05:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2026-09-04T12:55:45-05:00", "external_id": "f7cd6792-26e8-4c5c-999e-3dfaddfed81f", "custom_data": null, "tags": [], "financial_account": { "uid": "01a06d8f-e614-7bfa-b64f-eb5f978c8023", "status": "complete", "bank": null, "account_number": "78117792", "account_digit": "3", "agency_number": "1699", "agency_digit": "3", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:42-05:00", "updated_at": "2026-09-04T12:55:42-05:00", "kind": "checking", "custom_name": "Sicoob CC: 78117792-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-e610-7025-806d-83aa56ce6699", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "758.122.798-70", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "nakesha@ziemann.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "qui", "omnis", "molestiae" ], "tag_list": "qui,omnis,molestiae", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "9d640e24-416b-47b2-b57e-1ae478b41ae7" } }, { "uid": "01a06d8f-f0e6-7190-8b5f-8119d96ce952", "capture_date": "2026-09-04T12:55:44-05:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2026-09-04T12:55:44-05:00", "external_id": "93a054b0-40cb-4a93-ac93-bedcfa4a6303", "custom_data": null, "tags": [], "financial_account": { "uid": "01a06d8f-e614-7bfa-b64f-eb5f978c8023", "status": "complete", "bank": null, "account_number": "78117792", "account_digit": "3", "agency_number": "1699", "agency_digit": "3", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:42-05:00", "updated_at": "2026-09-04T12:55:42-05:00", "kind": "checking", "custom_name": "Sicoob CC: 78117792-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-e610-7025-806d-83aa56ce6699", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "758.122.798-70", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "nakesha@ziemann.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "qui", "omnis", "molestiae" ], "tag_list": "qui,omnis,molestiae", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "9d640e24-416b-47b2-b57e-1ae478b41ae7" } }, { "uid": "01a06d8f-f099-7cf1-a253-28629b1470f7", "capture_date": "2026-09-04T12:55:44-05:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2026-09-04T12:55:44-05:00", "external_id": "c2f8d394-8ef7-4289-b950-b32af5e4cc87", "custom_data": null, "tags": [], "financial_account": { "uid": "01a06d8f-e614-7bfa-b64f-eb5f978c8023", "status": "complete", "bank": null, "account_number": "78117792", "account_digit": "3", "agency_number": "1699", "agency_digit": "3", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:42-05:00", "updated_at": "2026-09-04T12:55:42-05:00", "kind": "checking", "custom_name": "Sicoob CC: 78117792-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-e610-7025-806d-83aa56ce6699", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "758.122.798-70", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "nakesha@ziemann.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "qui", "omnis", "molestiae" ], "tag_list": "qui,omnis,molestiae", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "9d640e24-416b-47b2-b57e-1ae478b41ae7" } }, { "uid": "01a06d8f-f04c-7e4f-bd62-1cc7e46af2fd", "capture_date": "2026-09-04T12:55:44-05:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2026-09-04T12:55:44-05:00", "external_id": "961c3b77-a533-488b-89c3-c75e703bb447", "custom_data": null, "tags": [], "financial_account": { "uid": "01a06d8f-e614-7bfa-b64f-eb5f978c8023", "status": "complete", "bank": null, "account_number": "78117792", "account_digit": "3", "agency_number": "1699", "agency_digit": "3", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:42-05:00", "updated_at": "2026-09-04T12:55:42-05:00", "kind": "checking", "custom_name": "Sicoob CC: 78117792-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-e610-7025-806d-83aa56ce6699", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "758.122.798-70", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "nakesha@ziemann.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "qui", "omnis", "molestiae" ], "tag_list": "qui,omnis,molestiae", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "9d640e24-416b-47b2-b57e-1ae478b41ae7" } }, { "uid": "01a06d8f-effe-7de3-812d-639d0fae644c", "capture_date": "2026-09-04T12:55:44-05:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2026-09-04T12:55:44-05:00", "external_id": "0d885ff2-a217-45d2-9eee-dac1794c07f4", "custom_data": null, "tags": [], "financial_account": { "uid": "01a06d8f-e614-7bfa-b64f-eb5f978c8023", "status": "complete", "bank": null, "account_number": "78117792", "account_digit": "3", "agency_number": "1699", "agency_digit": "3", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:42-05:00", "updated_at": "2026-09-04T12:55:42-05:00", "kind": "checking", "custom_name": "Sicoob CC: 78117792-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-e610-7025-806d-83aa56ce6699", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "758.122.798-70", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "nakesha@ziemann.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "qui", "omnis", "molestiae" ], "tag_list": "qui,omnis,molestiae", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "9d640e24-416b-47b2-b57e-1ae478b41ae7" } }, { "uid": "01a06d8f-efae-78b1-bd38-a6c1b64330e3", "capture_date": "2026-09-04T12:55:44-05:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2026-09-04T12:55:44-05:00", "external_id": "292345f3-166b-4b64-bab9-0d6e6be63a67", "custom_data": null, "tags": [], "financial_account": { "uid": "01a06d8f-e614-7bfa-b64f-eb5f978c8023", "status": "complete", "bank": null, "account_number": "78117792", "account_digit": "3", "agency_number": "1699", "agency_digit": "3", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:42-05:00", "updated_at": "2026-09-04T12:55:42-05:00", "kind": "checking", "custom_name": "Sicoob CC: 78117792-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-e610-7025-806d-83aa56ce6699", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "758.122.798-70", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "nakesha@ziemann.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "qui", "omnis", "molestiae" ], "tag_list": "qui,omnis,molestiae", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "9d640e24-416b-47b2-b57e-1ae478b41ae7" } }, { "uid": "01a06d8f-ef59-7861-8fc2-54981ca08635", "capture_date": "2026-09-04T12:55:44-05:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2026-09-04T12:55:44-05:00", "external_id": "7aaa535c-2662-4a41-8611-02280d3bc7a8", "custom_data": null, "tags": [], "financial_account": { "uid": "01a06d8f-e614-7bfa-b64f-eb5f978c8023", "status": "complete", "bank": null, "account_number": "78117792", "account_digit": "3", "agency_number": "1699", "agency_digit": "3", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:42-05:00", "updated_at": "2026-09-04T12:55:42-05:00", "kind": "checking", "custom_name": "Sicoob CC: 78117792-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-e610-7025-806d-83aa56ce6699", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "758.122.798-70", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "nakesha@ziemann.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "qui", "omnis", "molestiae" ], "tag_list": "qui,omnis,molestiae", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "9d640e24-416b-47b2-b57e-1ae478b41ae7" } }, { "uid": "01a06d8f-eec8-7bcf-a7c3-42c88ae56271", "capture_date": "2026-09-04T12:55:44-05:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2026-09-04T12:55:44-05:00", "external_id": "ffffcac4-704b-4c7b-a5de-b1926bc64ca5", "custom_data": null, "tags": [], "financial_account": { "uid": "01a06d8f-e614-7bfa-b64f-eb5f978c8023", "status": "complete", "bank": null, "account_number": "78117792", "account_digit": "3", "agency_number": "1699", "agency_digit": "3", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:42-05:00", "updated_at": "2026-09-04T12:55:42-05:00", "kind": "checking", "custom_name": "Sicoob CC: 78117792-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-e610-7025-806d-83aa56ce6699", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "758.122.798-70", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "nakesha@ziemann.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "qui", "omnis", "molestiae" ], "tag_list": "qui,omnis,molestiae", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "9d640e24-416b-47b2-b57e-1ae478b41ae7" } }, { "uid": "01a06d8f-ee7a-7bf0-a46a-acf7ba199f06", "capture_date": "2026-09-04T12:55:44-05:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2026-09-04T12:55:44-05:00", "external_id": "6669b55a-56aa-4c01-937d-85026a006fb7", "custom_data": null, "tags": [], "financial_account": { "uid": "01a06d8f-e614-7bfa-b64f-eb5f978c8023", "status": "complete", "bank": null, "account_number": "78117792", "account_digit": "3", "agency_number": "1699", "agency_digit": "3", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:42-05:00", "updated_at": "2026-09-04T12:55:42-05:00", "kind": "checking", "custom_name": "Sicoob CC: 78117792-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-e610-7025-806d-83aa56ce6699", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "758.122.798-70", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "nakesha@ziemann.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "qui", "omnis", "molestiae" ], "tag_list": "qui,omnis,molestiae", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "9d640e24-416b-47b2-b57e-1ae478b41ae7" } }, { "uid": "01a06d8f-ee2e-7b9e-a5ae-3bfec305e4d4", "capture_date": "2026-09-04T12:55:44-05:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2026-09-04T12:55:44-05:00", "external_id": "80547df3-dd4d-497e-92f0-66aaf591bf69", "custom_data": null, "tags": [], "financial_account": { "uid": "01a06d8f-e614-7bfa-b64f-eb5f978c8023", "status": "complete", "bank": null, "account_number": "78117792", "account_digit": "3", "agency_number": "1699", "agency_digit": "3", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:42-05:00", "updated_at": "2026-09-04T12:55:42-05:00", "kind": "checking", "custom_name": "Sicoob CC: 78117792-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-e610-7025-806d-83aa56ce6699", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "758.122.798-70", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "nakesha@ziemann.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "qui", "omnis", "molestiae" ], "tag_list": "qui,omnis,molestiae", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "9d640e24-416b-47b2-b57e-1ae478b41ae7" } }, { "uid": "01a06d8f-edea-7b3b-85a2-53fe82a4a75b", "capture_date": "2026-09-04T12:55:44-05:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2026-09-04T12:55:44-05:00", "external_id": "bd5c7c1e-c3fd-437d-927c-8942bb1c92bd", "custom_data": null, "tags": [], "financial_account": { "uid": "01a06d8f-e614-7bfa-b64f-eb5f978c8023", "status": "complete", "bank": null, "account_number": "78117792", "account_digit": "3", "agency_number": "1699", "agency_digit": "3", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:42-05:00", "updated_at": "2026-09-04T12:55:42-05:00", "kind": "checking", "custom_name": "Sicoob CC: 78117792-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-e610-7025-806d-83aa56ce6699", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "758.122.798-70", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "nakesha@ziemann.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "qui", "omnis", "molestiae" ], "tag_list": "qui,omnis,molestiae", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "9d640e24-416b-47b2-b57e-1ae478b41ae7" } }, { "uid": "01a06d8f-eda6-7f76-823b-c981a72e5043", "capture_date": "2026-09-04T12:55:44-05:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2026-09-04T12:55:44-05:00", "external_id": "672cc6a5-7b27-40d9-8250-9cf4b1579ccf", "custom_data": null, "tags": [], "financial_account": { "uid": "01a06d8f-e614-7bfa-b64f-eb5f978c8023", "status": "complete", "bank": null, "account_number": "78117792", "account_digit": "3", "agency_number": "1699", "agency_digit": "3", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:42-05:00", "updated_at": "2026-09-04T12:55:42-05:00", "kind": "checking", "custom_name": "Sicoob CC: 78117792-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-e610-7025-806d-83aa56ce6699", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "758.122.798-70", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "nakesha@ziemann.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "qui", "omnis", "molestiae" ], "tag_list": "qui,omnis,molestiae", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "9d640e24-416b-47b2-b57e-1ae478b41ae7" } }, { "uid": "01a06d8f-ed60-74c6-a0de-62e20e62f544", "capture_date": "2026-09-04T12:55:44-05:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2026-09-04T12:55:44-05:00", "external_id": "a7a34415-943e-4484-98a5-83530792b113", "custom_data": null, "tags": [], "financial_account": { "uid": "01a06d8f-e614-7bfa-b64f-eb5f978c8023", "status": "complete", "bank": null, "account_number": "78117792", "account_digit": "3", "agency_number": "1699", "agency_digit": "3", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:42-05:00", "updated_at": "2026-09-04T12:55:42-05:00", "kind": "checking", "custom_name": "Sicoob CC: 78117792-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-e610-7025-806d-83aa56ce6699", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "758.122.798-70", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "nakesha@ziemann.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "qui", "omnis", "molestiae" ], "tag_list": "qui,omnis,molestiae", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "9d640e24-416b-47b2-b57e-1ae478b41ae7" } }, { "uid": "01a06d8f-ed17-71f1-973a-c95128eea714", "capture_date": "2026-09-04T12:55:44-05:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2026-09-04T12:55:44-05:00", "external_id": "0727a20c-f67a-4ac7-b54a-0dcd3e5c9160", "custom_data": null, "tags": [], "financial_account": { "uid": "01a06d8f-e614-7bfa-b64f-eb5f978c8023", "status": "complete", "bank": null, "account_number": "78117792", "account_digit": "3", "agency_number": "1699", "agency_digit": "3", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:42-05:00", "updated_at": "2026-09-04T12:55:42-05:00", "kind": "checking", "custom_name": "Sicoob CC: 78117792-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-e610-7025-806d-83aa56ce6699", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "758.122.798-70", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "nakesha@ziemann.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "qui", "omnis", "molestiae" ], "tag_list": "qui,omnis,molestiae", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "9d640e24-416b-47b2-b57e-1ae478b41ae7" } }, { "uid": "01a06d8f-ecce-7c1f-890a-55140bafb373", "capture_date": "2026-09-04T12:55:43-05:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2026-09-04T12:55:43-05:00", "external_id": "41675edf-8d46-47a4-be10-9fd59bb6889d", "custom_data": null, "tags": [], "financial_account": { "uid": "01a06d8f-e614-7bfa-b64f-eb5f978c8023", "status": "complete", "bank": null, "account_number": "78117792", "account_digit": "3", "agency_number": "1699", "agency_digit": "3", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:42-05:00", "updated_at": "2026-09-04T12:55:42-05:00", "kind": "checking", "custom_name": "Sicoob CC: 78117792-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-e610-7025-806d-83aa56ce6699", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "758.122.798-70", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "nakesha@ziemann.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "qui", "omnis", "molestiae" ], "tag_list": "qui,omnis,molestiae", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "9d640e24-416b-47b2-b57e-1ae478b41ae7" } }, { "uid": "01a06d8f-ec74-79f9-902f-d21b833c12a4", "capture_date": "2026-09-04T12:55:43-05:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2026-09-04T12:55:43-05:00", "external_id": "0c80a77d-9a1d-49c8-bdd4-97b231f9a49f", "custom_data": null, "tags": [], "financial_account": { "uid": "01a06d8f-e614-7bfa-b64f-eb5f978c8023", "status": "complete", "bank": null, "account_number": "78117792", "account_digit": "3", "agency_number": "1699", "agency_digit": "3", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:42-05:00", "updated_at": "2026-09-04T12:55:42-05:00", "kind": "checking", "custom_name": "Sicoob CC: 78117792-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-e610-7025-806d-83aa56ce6699", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "758.122.798-70", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "nakesha@ziemann.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "qui", "omnis", "molestiae" ], "tag_list": "qui,omnis,molestiae", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "9d640e24-416b-47b2-b57e-1ae478b41ae7" } }, { "uid": "01a06d8f-ec2e-7b5a-9591-a2f3589d8018", "capture_date": "2026-09-04T12:55:43-05:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2026-09-04T12:55:43-05:00", "external_id": "bdd4c953-f785-43e1-9ec2-425c2c056bd7", "custom_data": null, "tags": [], "financial_account": { "uid": "01a06d8f-e614-7bfa-b64f-eb5f978c8023", "status": "complete", "bank": null, "account_number": "78117792", "account_digit": "3", "agency_number": "1699", "agency_digit": "3", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:42-05:00", "updated_at": "2026-09-04T12:55:42-05:00", "kind": "checking", "custom_name": "Sicoob CC: 78117792-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-e610-7025-806d-83aa56ce6699", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "758.122.798-70", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "nakesha@ziemann.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "qui", "omnis", "molestiae" ], "tag_list": "qui,omnis,molestiae", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "9d640e24-416b-47b2-b57e-1ae478b41ae7" } } ], "pagination": { "prev_url": null, "next_url": "/v2/financial/accounts/01a06d8f-e614-7bfa-b64f-eb5f978c8023/balances?per_page=20&page=2", "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_financial_account_balance" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } } } }, "post": { "summary": "Criar um saldo", "tags": [ "Contas" ], "security": [ { "bearerAuth": [] } ], "description": "Cria um novo saldo manual para uma conta financeira. Permite registrar saldos iniciais ou ajustes manuais de conciliação.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "financial_account_uid", "in": "path", "description": "UUID da Conta Financeira", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Saldo criado", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d8f-f290-7041-adbc-02755b34b5f7", "capture_date": null, "amount": 500.99, "blocked_amount": 100.1, "automatically_invested_amount": 0.0, "created_at": "2026-09-04T12:55:45-05:00", "external_id": "120712704", "custom_data": { "client_rating": 5 }, "tags": [ "tag 1", "tag 2" ], "financial_account": { "uid": "01a06d8f-f25d-7478-a572-7f4a3cbe7653", "status": "complete", "bank": null, "account_number": "53918980", "account_digit": "3", "agency_number": "1717", "agency_digit": "5", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:45-05:00", "updated_at": "2026-09-04T12:55:45-05:00", "kind": "checking", "custom_name": "Sicoob CC: 53918980-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-f25a-7c7a-a153-4803cfc95830", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "456.269.784-96", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "colton@dooley.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "ratione", "dolorem", "odio" ], "tag_list": "ratione,dolorem,odio", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "9b1f00a9-7f5d-4129-810a-495cb8d2dc1e" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_financial_account_balance" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_financial_account_balance" } } }, "required": true, "description": "Parametros para criação de um registro de saldo" } } }, "/v2/financial/accounts/{financial_account_uid}/balances/{balance_uid}": { "get": { "summary": "Visualizar um Saldo", "tags": [ "Saldos" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de uma Conta.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "field", "in": "query", "description": "Campo para buscar o ID. Exemplo: `uid` ou `external_id`", "required": false, "schema": { "type": "string" } }, { "name": "financial_account_uid", "in": "path", "description": "UUID da Conta Financeira", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } }, { "name": "balance_uid", "in": "path", "description": "UUID do Saldo", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Conta encontrada", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d8f-f338-7bb3-ac58-b76a9847fb5e", "capture_date": "2026-09-04T12:55:45-05:00", "amount": 500.99, "blocked_amount": 100.1, "automatically_invested_amount": 0.0, "created_at": "2026-09-04T12:55:45-05:00", "external_id": "120712704", "custom_data": { "client_rating": 5 }, "tags": [ "tag 1", "tag 2" ], "financial_account": { "uid": "01a06d8f-f2cf-7160-bc50-cd4d00595f0a", "status": "complete", "bank": null, "account_number": "64094910", "account_digit": "3", "agency_number": "9269", "agency_digit": "X", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:45-05:00", "updated_at": "2026-09-04T12:55:45-05:00", "kind": "checking", "custom_name": "Sicoob CC: 64094910-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-f2cb-7768-be82-099318981c62", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "315.890.052-10", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "temika.crist@stoltenberg-barton.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "rerum", "ut", "iusto" ], "tag_list": "rerum,ut,iusto", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "6b4b006e-7b29-4913-ab1f-59969ec33cf6" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_financial_account_balance" } } } } } }, "404": { "description": "Conta não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/financial/accounts/{financial_account_uid}/commands": { "get": { "summary": "Listar Comandos de uma Conta", "tags": [ "Contas" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todos os comandos executados em uma conta financeira. Comandos representam operações assíncronas como sincronização de extrato e outras ações automatizadas.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "financial_account_uid", "in": "path", "description": "UUID da Conta Financeira", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Comandos encontrado", "content": { "application/json": { "example": { "status": 200, "data": [ { "id": 119, "uid": "01a06d8f-f466-765b-a5f6-73c49fd485ee", "status": "pending", "operation": "statement_sync", "resource_type": "Financial::Account", "resource_uid": "01a06d8f-f400-739d-a3d7-d0eaff07200a", "financial_provider_slug": "sicoob", "params": {}, "payload": null, "created_at": "2026-09-04T12:55:45-05:00", "updated_at": "2026-09-04T12:55:45-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null } ], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_financial_account_command" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } }, "404": { "description": "Conta não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/financial/accounts/{financial_account_uid}/commands/{id}": { "get": { "summary": "Visualizar um Comando", "tags": [ "Contas" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações detalhadas de um comando específico executado em uma conta financeira.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "financial_account_uid", "in": "path", "description": "UUID da Conta Financeira", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "ID do Comando", "required": true, "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Comando encontrada", "content": { "application/json": { "example": { "status": 200, "data": { "id": 120, "uid": "01a06d8f-f5e9-7673-aed8-29b768d2e04a", "status": "pending", "operation": "statement_sync", "resource_type": "Financial::Account", "resource_uid": "01a06d8f-f588-722a-b7ec-e707fd3a6d35", "financial_provider_slug": "sicoob", "params": {}, "payload": null, "created_at": "2026-09-04T12:55:46-05:00", "updated_at": "2026-09-04T12:55:46-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_financial_account_command" } } } } } }, "404": { "description": "Comando não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/financial/accounts": { "get": { "summary": "Listar Contas", "tags": [ "Contas" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todas as contas financeiras cadastradas. Retorna informações sobre as contas bancárias incluindo provedor, tipo de conta, dados bancários e metadados personalizados.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } } ], "responses": { "200": { "description": "Contas encontradas", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d90-01f8-715e-b3e7-4ead6e35cfc1", "status": "complete", "bank": null, "account_number": "05412646", "account_digit": "3", "agency_number": "7318", "agency_digit": "0", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:49-05:00", "updated_at": "2026-09-04T12:55:49-05:00", "kind": "checking", "custom_name": "Sicoob CC: 5412646-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d90-01f6-7f92-b693-2761bdb638a8", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "383.027.573-06", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "wilfred_stokes@littel.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "fuga", "veritatis", "reprehenderit" ], "tag_list": "fuga,veritatis,reprehenderit", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "94327055-c896-441c-af18-b3ce3e536e7b", "balance": null, "service_accounts": [ { "slug": "statement.account", "uid": "01a06d90-020d-7b7f-8769-f43e5a3b0e87" }, { "slug": "payment.account", "uid": "01a06d90-01f6-72d3-b139-9eb3ff25e33d" }, { "slug": "transfer.account", "uid": "01a06d90-0208-741b-9e60-be5997e0671d" } ] }, { "uid": "01a06d90-01c0-7b84-83d4-96bfa011555f", "status": "complete", "bank": null, "account_number": "28182334", "account_digit": "3", "agency_number": "4986", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:49-05:00", "updated_at": "2026-09-04T12:55:49-05:00", "kind": "checking", "custom_name": "Sicoob CC: 28182334-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d90-01bd-74c9-8b38-4fc3ba87a735", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "029.376.867-61", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "edwardo@herzog-bernhard.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "cumque", "porro", "eum" ], "tag_list": "cumque,porro,eum", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "e88953e1-3b56-4ccd-8b87-0056e923d065", "balance": null, "service_accounts": [ { "slug": "statement.account", "uid": "01a06d90-01d5-70a5-8a01-ad68a2828633" }, { "slug": "payment.account", "uid": "01a06d90-01be-728e-80a9-a40ef06500f9" }, { "slug": "transfer.account", "uid": "01a06d90-01d0-71e4-aed5-893b6aee5634" } ] }, { "uid": "01a06d90-0180-7d46-bc64-a3106a7f8962", "status": "complete", "bank": null, "account_number": "72838343", "account_digit": "3", "agency_number": "3627", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:49-05:00", "updated_at": "2026-09-04T12:55:49-05:00", "kind": "checking", "custom_name": "Sicoob CC: 72838343-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d90-017c-7699-9447-7406df6f92e4", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "213.856.025-20", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "cortez@upton-kertzmann.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "veniam", "distinctio", "dolorum" ], "tag_list": "veniam,distinctio,dolorum", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "e747ffe0-70ef-44dd-b3fe-d8f5ac6e4074", "balance": null, "service_accounts": [ { "slug": "statement.account", "uid": "01a06d90-0194-7ffe-8c1c-48f28a8358ca" }, { "slug": "payment.account", "uid": "01a06d90-017d-78be-99c0-f877a27ed501" }, { "slug": "transfer.account", "uid": "01a06d90-018f-7e5f-81f9-fdbd8aa0ae9c" } ] }, { "uid": "01a06d90-0140-7104-804c-455fe6b64044", "status": "complete", "bank": null, "account_number": "45190106", "account_digit": "3", "agency_number": "8780", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:49-05:00", "updated_at": "2026-09-04T12:55:49-05:00", "kind": "checking", "custom_name": "Sicoob CC: 45190106-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d90-013d-70eb-9df9-388a74ff9338", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "658.183.023-26", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "gillian_wilderman@flatley-kshlerin.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "sint", "temporibus", "accusantium" ], "tag_list": "sint,temporibus,accusantium", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "af6bbb11-7670-4ca3-b1ac-7c19882ce0bd", "balance": null, "service_accounts": [ { "slug": "statement.account", "uid": "01a06d90-0159-760c-af62-09bb347cf94c" }, { "slug": "payment.account", "uid": "01a06d90-013e-79ae-b429-b0855edfccbd" }, { "slug": "transfer.account", "uid": "01a06d90-0153-74b0-b857-9a50a6ef3682" } ] }, { "uid": "01a06d90-0101-7a9d-be65-e37e9e11c76f", "status": "complete", "bank": null, "account_number": "07909802", "account_digit": "3", "agency_number": "7353", "agency_digit": "9", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:49-05:00", "updated_at": "2026-09-04T12:55:49-05:00", "kind": "checking", "custom_name": "Sicoob CC: 7909802-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d90-00fd-7547-8ba9-384741503406", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "506.751.847-20", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "dwight_sauer@mitchell-ferry.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "praesentium", "quo", "ut" ], "tag_list": "praesentium,quo,ut", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "19e773df-2e21-4ec2-9a4c-15f0cba2064a", "balance": null, "service_accounts": [ { "slug": "statement.account", "uid": "01a06d90-0117-7f44-be32-6bcf1384d1e6" }, { "slug": "payment.account", "uid": "01a06d90-00fe-77b1-8968-12d39f855527" }, { "slug": "transfer.account", "uid": "01a06d90-0111-7cf3-9f72-c15cfee925f6" } ] }, { "uid": "01a06d90-0099-7156-a1ba-9f528a9e45ec", "status": "complete", "bank": null, "account_number": "84866227", "account_digit": "3", "agency_number": "2564", "agency_digit": "X", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:49-05:00", "updated_at": "2026-09-04T12:55:49-05:00", "kind": "checking", "custom_name": "Sicoob CC: 84866227-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d90-0096-76b0-8d28-5fe86d8bf3ef", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "420.122.804-55", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "beverlee@stark-schultz.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "saepe", "dignissimos", "qui" ], "tag_list": "saepe,dignissimos,qui", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "89cfd2e5-c69e-499f-9f64-4733a250e4f7", "balance": null, "service_accounts": [ { "slug": "statement.account", "uid": "01a06d90-00ae-7aa3-916c-326a880b1c6a" }, { "slug": "payment.account", "uid": "01a06d90-0097-7c43-b97b-3af3fdc84f0e" }, { "slug": "transfer.account", "uid": "01a06d90-00a9-741c-bdfc-bb5359d96597" } ] }, { "uid": "01a06d90-005c-7f15-844d-d0fe1162e553", "status": "complete", "bank": null, "account_number": "24787253", "account_digit": "3", "agency_number": "1132", "agency_digit": "0", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:48-05:00", "updated_at": "2026-09-04T12:55:48-05:00", "kind": "checking", "custom_name": "Sicoob CC: 24787253-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d90-0059-7b81-8792-17ebd5db6ecc", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "973.204.858-18", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "sarai.sauer@kshlerin-dicki.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "dolores", "quos", "cum" ], "tag_list": "dolores,quos,cum", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "ea0deb9a-a5b2-4207-b168-2ca1762b3368", "balance": null, "service_accounts": [ { "slug": "statement.account", "uid": "01a06d90-0072-7d4d-bb36-4a9fddef9843" }, { "slug": "payment.account", "uid": "01a06d90-005a-753e-8bb7-b2765e75d120" }, { "slug": "transfer.account", "uid": "01a06d90-006d-7155-b479-374ea780794d" } ] }, { "uid": "01a06d90-001f-7648-91dc-c78f1c9e3216", "status": "complete", "bank": null, "account_number": "66521502", "account_digit": "3", "agency_number": "4371", "agency_digit": "0", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:48-05:00", "updated_at": "2026-09-04T12:55:48-05:00", "kind": "checking", "custom_name": "Sicoob CC: 66521502-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d90-001b-77a7-97de-4bb1fb329208", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "966.750.574-05", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "luann@hegmann-roberts.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "vel", "provident", "animi" ], "tag_list": "vel,provident,animi", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "941531e9-eb2c-4feb-a1b3-f5c9ece3eab3", "balance": null, "service_accounts": [ { "slug": "statement.account", "uid": "01a06d90-0036-7ae9-a62d-257e1312cd64" }, { "slug": "payment.account", "uid": "01a06d90-001c-7ef6-b132-d76a65455899" }, { "slug": "transfer.account", "uid": "01a06d90-0031-7016-8494-323039e29586" } ] }, { "uid": "01a06d8f-ffde-7d60-a466-6e8dfedf8ec3", "status": "complete", "bank": null, "account_number": "54667548", "account_digit": "3", "agency_number": "2979", "agency_digit": "3", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:48-05:00", "updated_at": "2026-09-04T12:55:48-05:00", "kind": "checking", "custom_name": "Sicoob CC: 54667548-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-ffdc-76b9-9867-675bff78aa23", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "010.315.124-97", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "corine@hettinger.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "cum", "accusantium", "est" ], "tag_list": "cum,accusantium,est", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "f8fdc5de-de14-4b16-8a53-84888ca5fc19", "balance": null, "service_accounts": [ { "slug": "statement.account", "uid": "01a06d8f-fff7-7cf3-acdb-e292729ca27b" }, { "slug": "payment.account", "uid": "01a06d8f-ffdc-708e-a3ed-3d380a6db658" }, { "slug": "transfer.account", "uid": "01a06d8f-fff1-7b09-ada0-d759b4f1b351" } ] }, { "uid": "01a06d8f-ffa2-7f15-816a-b5dfb6775c33", "status": "complete", "bank": null, "account_number": "90159359", "account_digit": "3", "agency_number": "7422", "agency_digit": "5", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:48-05:00", "updated_at": "2026-09-04T12:55:48-05:00", "kind": "checking", "custom_name": "Sicoob CC: 90159359-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-ffa0-7454-b056-b5c9e1cfeafa", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "514.289.930-02", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "felix@rau.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "molestiae", "id", "nam" ], "tag_list": "molestiae,id,nam", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "eb999ea2-efc8-4c8d-bb17-f454e32e39d9", "balance": null, "service_accounts": [ { "slug": "statement.account", "uid": "01a06d8f-ffba-76e2-9c7a-d67075e55c81" }, { "slug": "payment.account", "uid": "01a06d8f-ffa1-7e54-8806-16ec79412820" }, { "slug": "transfer.account", "uid": "01a06d8f-ffb2-749a-ad6c-abc16e7dabd8" } ] }, { "uid": "01a06d8f-ff68-73bb-af84-b6b03bb8850a", "status": "complete", "bank": null, "account_number": "88691442", "account_digit": "3", "agency_number": "2866", "agency_digit": "5", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:48-05:00", "updated_at": "2026-09-04T12:55:48-05:00", "kind": "checking", "custom_name": "Sicoob CC: 88691442-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-ff66-78d5-a986-ec904728b25e", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "513.334.119-95", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "wilson.frami@lueilwitz-homenick.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "iusto", "nobis", "consequatur" ], "tag_list": "iusto,nobis,consequatur", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "68cca2ba-a749-43d8-afbf-5b4ed1304911", "balance": null, "service_accounts": [ { "slug": "statement.account", "uid": "01a06d8f-ff7e-7dc3-9854-ee58ce65c16f" }, { "slug": "payment.account", "uid": "01a06d8f-ff66-78b0-a1bf-358bc4deb177" }, { "slug": "transfer.account", "uid": "01a06d8f-ff79-7286-97e5-91d3ce9d0f74" } ] }, { "uid": "01a06d8f-ff2b-7522-86dc-a98ec97a9d90", "status": "complete", "bank": null, "account_number": "46409971", "account_digit": "3", "agency_number": "8135", "agency_digit": "3", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:48-05:00", "updated_at": "2026-09-04T12:55:48-05:00", "kind": "checking", "custom_name": "Sicoob CC: 46409971-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-ff28-768c-af80-0a8e2f29bf1a", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "475.374.537-64", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "genevie.wolff@zboncak-johns.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "sit", "in", "nam" ], "tag_list": "sit,in,nam", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "c0e1c966-00ba-4077-af67-b109bc649bdb", "balance": null, "service_accounts": [ { "slug": "statement.account", "uid": "01a06d8f-ff41-710a-818f-3548d03dbc8f" }, { "slug": "payment.account", "uid": "01a06d8f-ff29-782f-8790-d80b2f73a949" }, { "slug": "transfer.account", "uid": "01a06d8f-ff3b-76f6-88f6-a70dab7fb92e" } ] }, { "uid": "01a06d8f-fee9-7c61-9e8b-203975a03100", "status": "complete", "bank": null, "account_number": "03335590", "account_digit": "3", "agency_number": "1420", "agency_digit": "6", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:48-05:00", "updated_at": "2026-09-04T12:55:48-05:00", "kind": "checking", "custom_name": "Sicoob CC: 3335590-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-fee6-7628-a2b7-aa193566222d", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "943.613.076-79", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "bert@feil.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "aut", "consequatur", "temporibus" ], "tag_list": "aut,consequatur,temporibus", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "091a926d-9900-4966-934e-a47c0fbfca9b", "balance": null, "service_accounts": [ { "slug": "statement.account", "uid": "01a06d8f-ff04-78f8-aa33-2187e6591635" }, { "slug": "payment.account", "uid": "01a06d8f-fee7-71a3-bf5e-3298672444db" }, { "slug": "transfer.account", "uid": "01a06d8f-fefe-781d-92f6-c8083ef2f6cc" } ] }, { "uid": "01a06d8f-fea4-7542-b8fc-478c58737df6", "status": "complete", "bank": null, "account_number": "17466333", "account_digit": "3", "agency_number": "4938", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:48-05:00", "updated_at": "2026-09-04T12:55:48-05:00", "kind": "checking", "custom_name": "Sicoob CC: 17466333-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-fea1-70d3-a66d-fbe76883c804", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "750.758.341-40", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "rolf.hansen@mckenzie-schoen.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "at", "commodi", "perferendis" ], "tag_list": "at,commodi,perferendis", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "40838304-cdbd-4f45-8b45-9c6075fa29a7", "balance": null, "service_accounts": [ { "slug": "statement.account", "uid": "01a06d8f-febb-7b1c-bea0-16e170cfb418" }, { "slug": "payment.account", "uid": "01a06d8f-fea2-7d0c-ae96-f06a4f28ec17" }, { "slug": "transfer.account", "uid": "01a06d8f-feb6-730a-87f3-b53cfa360c94" } ] }, { "uid": "01a06d8f-fe65-74ee-8c5a-e71d25a41bdb", "status": "complete", "bank": null, "account_number": "77745594", "account_digit": "3", "agency_number": "1735", "agency_digit": "3", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:48-05:00", "updated_at": "2026-09-04T12:55:48-05:00", "kind": "checking", "custom_name": "Sicoob CC: 77745594-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-fe62-752b-9fc1-0a54e2ceff9a", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "845.493.468-50", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "rey_kub@carroll.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "est", "consequatur", "nesciunt" ], "tag_list": "est,consequatur,nesciunt", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "ab3cbe71-f989-4aca-9837-92f36fe0f4e0", "balance": null, "service_accounts": [ { "slug": "statement.account", "uid": "01a06d8f-fe7c-79b2-a429-651dc275ab94" }, { "slug": "payment.account", "uid": "01a06d8f-fe62-7242-8f98-9096017ea286" }, { "slug": "transfer.account", "uid": "01a06d8f-fe76-7af3-ad54-9bbd30ce34bb" } ] }, { "uid": "01a06d8f-fe28-7ee3-8fac-406532112e93", "status": "complete", "bank": null, "account_number": "45299682", "account_digit": "3", "agency_number": "2293", "agency_digit": "4", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:48-05:00", "updated_at": "2026-09-04T12:55:48-05:00", "kind": "checking", "custom_name": "Sicoob CC: 45299682-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-fe25-7c91-a9fd-6d2d6a1804ae", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "535.364.819-65", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "hannah.terry@berge-dooley.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "omnis", "officia", "ut" ], "tag_list": "omnis,officia,ut", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "2960d3db-b57e-4916-b29a-d30c0a8322c8", "balance": null, "service_accounts": [ { "slug": "statement.account", "uid": "01a06d8f-fe3f-7cdc-bf62-cf89cee07106" }, { "slug": "payment.account", "uid": "01a06d8f-fe25-74e2-99ca-294ac6304f2a" }, { "slug": "transfer.account", "uid": "01a06d8f-fe3a-7311-b4d5-908f233d30c8" } ] }, { "uid": "01a06d8f-fdec-78e8-8250-535cecc64c32", "status": "complete", "bank": null, "account_number": "71209406", "account_digit": "3", "agency_number": "4367", "agency_digit": "2", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:48-05:00", "updated_at": "2026-09-04T12:55:48-05:00", "kind": "checking", "custom_name": "Sicoob CC: 71209406-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-fdea-77cb-9354-f5f12e444ee1", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "501.148.782-26", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "dorthy_corwin@sawayn.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "praesentium", "soluta", "qui" ], "tag_list": "praesentium,soluta,qui", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "22a8c408-ce7f-44c5-a9dc-5d6d55053619", "balance": null, "service_accounts": [ { "slug": "statement.account", "uid": "01a06d8f-fe02-7f4b-8178-91508967eb6c" }, { "slug": "payment.account", "uid": "01a06d8f-fdea-7a35-8ac4-56811ebbc5eb" }, { "slug": "transfer.account", "uid": "01a06d8f-fdfd-700b-bdbf-365c6306cd36" } ] }, { "uid": "01a06d8f-fdb0-76d0-a974-19c4dabd0ddc", "status": "complete", "bank": null, "account_number": "56129471", "account_digit": "3", "agency_number": "5529", "agency_digit": "8", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:48-05:00", "updated_at": "2026-09-04T12:55:48-05:00", "kind": "checking", "custom_name": "Sicoob CC: 56129471-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-fdae-7bdb-af7c-9e7f7e236f22", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "533.307.051-24", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "manie_hettinger@brekke-crooks.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "nam", "sed", "ut" ], "tag_list": "nam,sed,ut", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "323dead2-3da1-412b-a52e-751d417323c7", "balance": null, "service_accounts": [ { "slug": "statement.account", "uid": "01a06d8f-fdc8-776a-8a1e-04d3ab032984" }, { "slug": "payment.account", "uid": "01a06d8f-fdae-7acb-bfb6-11899848084e" }, { "slug": "transfer.account", "uid": "01a06d8f-fdc0-7c91-b700-a77ea0797441" } ] }, { "uid": "01a06d8f-fd75-7c7b-8205-8b77d6e1e938", "status": "complete", "bank": null, "account_number": "07426015", "account_digit": "3", "agency_number": "9056", "agency_digit": "5", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:48-05:00", "updated_at": "2026-09-04T12:55:48-05:00", "kind": "checking", "custom_name": "Sicoob CC: 7426015-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-fd73-76f1-8b22-028141778cfa", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "782.980.951-89", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "lizeth.schimmel@mante-beahan.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "cumque", "pariatur", "repellendus" ], "tag_list": "cumque,pariatur,repellendus", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "8eeaa5c9-b3e0-41b4-82bf-319a293df5ea", "balance": null, "service_accounts": [ { "slug": "statement.account", "uid": "01a06d8f-fd8b-74f0-940f-7bcac7f20945" }, { "slug": "payment.account", "uid": "01a06d8f-fd73-7a13-9bf9-770f9b857e36" }, { "slug": "transfer.account", "uid": "01a06d8f-fd85-748f-9937-4be3678f7b58" } ] }, { "uid": "01a06d8f-fd3a-71be-bf89-2456b09cb24f", "status": "complete", "bank": null, "account_number": "89542240", "account_digit": "3", "agency_number": "2284", "agency_digit": "5", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:48-05:00", "updated_at": "2026-09-04T12:55:48-05:00", "kind": "checking", "custom_name": "Sicoob CC: 89542240-3", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d8f-fd37-7737-b83c-5766ff6a9cdc", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "539.791.965-93", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "arielle@carroll.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "neque", "placeat", "dolor" ], "tag_list": "neque,placeat,dolor", "custom_data": { "numero_erp": 63126 } }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "d24a6d2b-ae0b-4e9b-9189-e01bdb2bafc4", "balance": null, "service_accounts": [ { "slug": "statement.account", "uid": "01a06d8f-fd50-74ef-8dbd-b7f4e3a55ca7" }, { "slug": "payment.account", "uid": "01a06d8f-fd37-701c-a9b5-069b7007214d" }, { "slug": "transfer.account", "uid": "01a06d8f-fd4a-7990-a95d-b2ca451bbb67" } ] } ], "pagination": { "prev_url": null, "next_url": "/v2/financial/accounts?per_page=20&page=2", "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_financial_account" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } } } }, "post": { "summary": "Criar uma Conta", "tags": [ "Contas" ], "security": [ { "bearerAuth": [] } ], "description": "Cria uma nova conta financeira para gerenciamento de transações bancárias. Suporta contas correntes e poupança.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Conta criada", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-0296-7203-92f2-6675adc3788b", "status": "complete", "bank": { "name": "BANCOOB/SICOOB", "bcb_name": "BANCO COOPERATIVO DO BRASIL S.A. - BANCOOB", "number": "756" }, "account_number": "123456", "account_digit": "0", "agency_number": "1234", "agency_digit": "1", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:49-05:00", "updated_at": "2026-09-04T12:55:49-05:00", "kind": "checking", "custom_name": "Sicoob CC: 123456-0", "payment_agreement_code": null, "person_info": null, "tags": [ "tag 1", "tag 2" ], "tag_list": "tag 1,tag 2", "custom_data": { "codigo": "123", "vip": true }, "external_id": "external id", "balance": null, "service_accounts": [ { "slug": "statement.account", "uid": "01a06d90-02a9-7195-a1bf-9c0672b6bacc" }, { "slug": "payment.account", "uid": "01a06d90-0297-7d25-a226-2e3d9b87b1f9" }, { "slug": "transfer.account", "uid": "01a06d90-02a4-7a9c-bf58-7f13f6d57f81" } ] } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_financial_account" } } } } } }, "422": { "description": "Erro de validação", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "account_number", "detail": "Número da Conta não pode ficar em branco" }, { "code": "validation_error", "param": "account_number", "detail": "Número da Conta não é um número" }, { "code": "validation_error", "param": "account_digit", "detail": "Dígito da Conta não pode ficar em branco" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_financial_account" } } }, "required": true, "description": "Parametros para criação de uma cobrança Pix" } } }, "/v2/financial/accounts/{id}": { "get": { "summary": "Visualizar uma Conta", "tags": [ "Contas" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de uma Conta.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "UUID ou External ID da Conta Financeira", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } }, { "name": "field", "in": "query", "description": "Campo para buscar o ID. Exemplo: `uid` ou `external_id`", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Conta encontrada", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-034d-7d3e-b266-6aa9e24e6683", "status": "complete", "bank": { "name": "BANCOOB/SICOOB", "bcb_name": "BANCO COOPERATIVO DO BRASIL S.A. - BANCOOB", "number": "756" }, "account_number": "123456", "account_digit": "0", "agency_number": "1234", "agency_digit": "1", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:49-05:00", "updated_at": "2026-09-04T12:55:49-05:00", "kind": "checking", "custom_name": "Sicoob CC: 123456-0", "payment_agreement_code": null, "person_info": { "id": null, "uid": "01a06d90-0349-785d-a38e-1b35610da4a2", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "550.133.900-52", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "cheryl@mitchell.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "culpa", "veritatis", "facere" ], "tag_list": "culpa,veritatis,facere", "custom_data": { "numero_erp": 63126 } }, "tags": [ "tag 1", "tag 2" ], "tag_list": "tag 1,tag 2", "custom_data": { "vip": true, "codigo": "123" }, "external_id": "external id", "balance": null, "service_accounts": [ { "slug": "statement.account", "uid": "01a06d90-0364-7e7d-b72c-372dde3ad8af" }, { "slug": "payment.account", "uid": "01a06d90-034b-784a-9ce5-3742442bdbb8" }, { "slug": "transfer.account", "uid": "01a06d90-035d-7cbb-87ed-4fb6c5da7058" } ] } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_financial_account" } } } } } }, "404": { "description": "Conta não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "put": { "summary": "Atualizar Conta", "tags": [ "Contas" ], "security": [ { "bearerAuth": [] } ], "description": "Atualiza uma Conta Financeira específica.", "parameters": [ { "name": "id", "required": true, "in": "path", "description": "UUID ou External ID da Conta Financeira", "example": "012ab34c-d567-8901-234e-5fghi6j789k0", "schema": { "type": "string" } }, { "name": "field", "in": "query", "description": "Campo para buscar o ID. Exemplo: `uid` ou `external_id`", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Conta Financeira atualizada", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-0407-7d2a-86ce-984a1d218ee1", "status": "complete", "bank": { "name": "BANCOOB/SICOOB", "bcb_name": "BANCO COOPERATIVO DO BRASIL S.A. - BANCOOB", "number": "756" }, "account_number": "123456", "account_digit": "0", "agency_number": "1234", "agency_digit": "1", "financial_provider_slug": "sicoob", "created_at": "2026-09-04T12:55:49-05:00", "updated_at": "2026-09-04T12:55:49-05:00", "kind": "checking", "custom_name": "Sicoob CC: 123456-0", "payment_agreement_code": "123123", "person_info": { "id": null, "uid": "01a06d90-0402-7465-aa91-a83a378abee4", "name": "Margret Santos Filgueiras", "nickname": null, "kind": "natural", "document_type": "CPF", "document_number": "640.822.376-15", "birthday": null, "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "earl_bins@walter-kuhic.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "notes": null, "created_via_api": false, "external_code": "000001", "tags": [ "et", "dolor", "blanditiis" ], "tag_list": "et,dolor,blanditiis", "custom_data": { "numero_erp": 63126 } }, "tags": [ "tag 1", "tag 2" ], "tag_list": "tag 1,tag 2", "custom_data": { "vip": true, "codigo": "123" }, "external_id": "external id", "balance": null, "service_accounts": [ { "slug": "statement.account", "uid": "01a06d90-041d-75cb-be9b-f49916ec94a9" }, { "slug": "payment.account", "uid": "01a06d90-0404-7bff-b67a-139625e9d497" }, { "slug": "transfer.account", "uid": "01a06d90-0417-7f5f-845e-221981d6c1bf" } ] } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_financial_account" } } } } } }, "401": { "description": "Usuário não autorizado", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o `scope` obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Conta Financeira não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] } } } }, "422": { "description": "Falha na validação", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "person_info", "detail": "Empresa > CPF/CNPJ não é um CNPJ ou CPF válido" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_financial_account_update" } } }, "required": true, "description": "Informações a serem atualizadas na Conta Financeira" } } }, "/v2/financial/accounts/{uid}": { "delete": { "summary": "Excluir uma Conta", "tags": [ "Contas" ], "security": [ { "bearerAuth": [] } ], "description": "Exclui uma Conta Financeira. A exclusão é processada de forma assíncrona.\n\n⚠️ Atenção: esta operação remove em cascata todos os registros\nassociados à Conta Financeira, incluindo carteiras de boleto,\ntransferências, pagamentos, extratos e demais recursos vinculados.\nEssa ação não pode ser desfeita.\n", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UID da Conta Financeira", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "202": { "description": "Conta enviada para exclusão", "content": { "application/json": { "example": { "status": 202, "message": "Conta Financeira enviada para ser excluída! Logo ela será removida definitivamente." }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 202 }, "message": { "type": "string" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o `scope` obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Conta Financeira não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/financial/providers": { "get": { "summary": "Listar Provedores", "tags": [ "Provedores" ], "description": "\nEsse endpoint é utilizado para receber os provedores de serviço que a Kobana está integrada.\n\nUm provedor de serviço é qualquer instituição regulada pelo BACEN, seja um banco comercial, instituição financeira, instituição de pagamento, provedor de serviço de pagamento, etc.\n\nO `slug` do provedor de serviço é utilizado para a criação de uma conta financeira.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Provedores encontradas", "content": { "application/json": { "example": { "status": 200, "data": [ { "kind": "bank", "name": "ABC Brasil", "bcb_name": "BANCO ABC BRASIL S.A.", "number": "246", "number_with_digit": "246-1", "slug": "abc" }, { "kind": "bank", "name": "Ailos", "bcb_name": "Cooperativa Central de Crédito Ailos", "number": "085", "number_with_digit": "085-0", "slug": "ailos" }, { "kind": "bank", "name": "ARBI", "bcb_name": "BANCO ARBI S.A.", "number": "213", "number_with_digit": "213-5", "slug": "arbi" }, { "kind": "bank", "name": "Banco ASA", "bcb_name": "BANCO ASA", "number": "594", "number_with_digit": "594-0", "slug": "asa" }, { "kind": "bank", "name": "Asaas", "bcb_name": "ASAAS GESTÃO FINANCEIRA INSTITUIÇÃO DE PAGAMENTO S.A.", "number": "461", "number_with_digit": "461-8", "slug": "asaas" }, { "kind": "bank", "name": "BANESE", "bcb_name": "BANESE", "number": "047", "number_with_digit": "047-7", "slug": "banese" }, { "kind": "bank", "name": "Banestes", "bcb_name": "BANESTES S.A. BANCO DO ESTADO DO ESPIRITO SANTO", "number": "021", "number_with_digit": "021-3", "slug": "banestes" }, { "kind": "bank", "name": "Banrisul", "bcb_name": "BANCO DO ESTADO DO RIO GRANDE DO SUL S.A.", "number": "041", "number_with_digit": "041-8", "slug": "banrisul" }, { "kind": "bank", "name": "Banco do Brasil", "bcb_name": "BANCO DO BRASIL S.A.", "number": "001", "number_with_digit": "001-9", "slug": "bb" }, { "kind": "bank", "name": "BOCOM BBM", "bcb_name": "O Banco BOCOM BBM S.A.", "number": "107", "number_with_digit": "107-4", "slug": "bbm" }, { "kind": "bank", "name": "BIB", "bcb_name": "Banco Industrial do Brasil S.A.", "number": "604", "number_with_digit": "604-1", "slug": "bib" }, { "kind": "ip", "name": "BLUPAY", "number": "001", "number_with_digit": "001-9", "slug": "blupay" }, { "kind": "bank", "name": "Banco do Nordeste", "bcb_name": "BANCO DO NORDESTE DO BRASIL S.A.", "number": "004", "number_with_digit": "004-3", "slug": "bnb" }, { "kind": "bank", "name": "BNP PARIBAS", "bcb_name": "BANCO BNP PARIBAS BRASIL S.A.", "number": "752", "number_with_digit": "752-8", "slug": "bnpparibas" }, { "kind": "bank", "name": "Bradesco", "bcb_name": "BANCO BRADESCO S.A.", "number": "237", "number_with_digit": "237-2", "slug": "bradesco" }, { "kind": "bank", "name": "BRB", "bcb_name": "BRB - Banco de Brasília S.A.", "number": "070", "number_with_digit": "070-1", "slug": "brb" }, { "kind": "bank", "name": "Banco BS2", "bcb_name": "BANCO BS2 S.A.", "number": "218", "number_with_digit": "218-6", "slug": "bs2" }, { "kind": "bank", "name": "Banco BTG", "bcb_name": "BANCO BTG PACTUAL S.A.", "number": "208", "number_with_digit": "208-1", "slug": "btg" }, { "kind": "bank", "name": "BTG Corporate (Enterprise)", "bcb_name": "BANCO BTG PACTUAL S.A.", "number": "208", "number_with_digit": "208-1", "slug": "btg_enterprise" }, { "kind": "bank", "name": "BV", "bcb_name": "BCO VOTORANTIM S.A.", "number": "655", "number_with_digit": "655-6", "slug": "bv" }, { "kind": "bank", "name": "C6 Bank", "bcb_name": "BANCO C6 CONSIGNADO S.A.", "number": "336", "number_with_digit": "336-0", "slug": "c6" }, { "kind": "bank", "name": "Caixa Econômica Federal", "bcb_name": "CAIXA ECONOMICA FEDERAL", "number": "104", "number_with_digit": "104-0", "slug": "caixa" }, { "kind": "bank", "name": "Caruana", "bcb_name": "CARUANA S.A. - SOCIEDADE DE CRÉDITO, FINANCIAMENTO E INVESTIMENTO", "number": "130", "number_with_digit": "130-9", "slug": "caruana" }, { "kind": "bank", "name": "Citibank", "bcb_name": "BANCO CITIBANK S.A.", "number": "745", "number_with_digit": "745-5", "slug": "citibank" }, { "kind": "bank", "name": "Cora", "bcb_name": "CORA SOCIEDADE DE CRÉDITO DIRETO S.A.", "number": "403", "number_with_digit": "403-0", "slug": "cora" }, { "kind": "bank", "name": "CrediSIS", "bcb_name": "Cooperativa Central de Crédito Noroeste Brasileiro Ltda.", "number": "097", "number_with_digit": "097-3", "slug": "credisis" }, { "kind": "bank", "name": "CRESOL", "bcb_name": "CRESOL", "number": "133", "number_with_digit": "133-3", "slug": "cresol" }, { "kind": "bank", "name": "CRESOL", "bcb_name": "CRESOL CONFEDERAÇÃO", "number": "237", "number_with_digit": "237-2", "slug": "cresol-bradesco" }, { "kind": "bank", "name": "Daycoval", "bcb_name": "BANCO DAYCOVAL S.A.", "number": "707", "number_with_digit": "707-2", "slug": "daycoval" }, { "kind": "bank", "name": "Banco Inter", "bcb_name": "BANCO INTER S.A.", "number": "077", "number_with_digit": "077-9", "slug": "inter" }, { "kind": "bank", "name": "BackOffice", "slug": "back_office" }, { "kind": "bank", "name": "Itaú", "bcb_name": "ITAÚ UNIBANCO S.A.", "number": "341", "number_with_digit": "341-7", "slug": "itau" }, { "kind": "bank", "name": "BANCO MERCANTIL", "bcb_name": "BANCO MERCANTIL DO BRASIL S.A.", "number": "389", "number_with_digit": "389-1", "slug": "mercantil" }, { "kind": "bank", "name": "MONEY PLUS SCMEPP LTDA", "bcb_name": "MONEY PLUS SOCIEDADE DE CRÉDITO AO MICROEMPREENDEDOR E A EMPRESA DE PEQUENO PORT", "number": "274", "number_with_digit": "274-7", "slug": "moneyplus" }, { "kind": "ip", "name": "PJBank", "number": "481", "number_with_digit": "481-2", "slug": "pjbank" }, { "kind": "bank", "name": "QI Tech", "number": "329", "number_with_digit": "329-8", "slug": "qitech" }, { "kind": "bank", "name": "Safra", "bcb_name": "BANCO SAFRA S.A.", "number": "422", "number_with_digit": "422-7", "slug": "safra" }, { "kind": "bank", "name": "Santander", "bcb_name": "BANCO SANTANDER (BRASIL) S.A.", "number": "033", "number_with_digit": "033-7", "slug": "santander" }, { "kind": "bank", "name": "Semear", "bcb_name": "BANCO SEMEAR S.A.", "number": "743", "number_with_digit": "743-9", "slug": "semear" }, { "kind": "bank", "name": "Rendimento", "bcb_name": "BCO RENDIMENTO S.A.", "number": "633", "number_with_digit": "633-5", "slug": "rendimento" }, { "kind": "bank", "name": "Sicoob", "bcb_name": "BANCO COOPERATIVO DO BRASIL S.A. - BANCOOB", "number": "756", "number_with_digit": "756-0", "slug": "sicoob" }, { "kind": "bank", "name": "Sicredi", "bcb_name": "BANCO COOPERATIVO SICREDI S.A.", "number": "748", "number_with_digit": "748-X", "slug": "sicredi" }, { "kind": "bank", "name": "Sofisa", "bcb_name": "Banco Sofisa S. A.", "number": "637", "number_with_digit": "637-8", "slug": "sofisa" }, { "kind": "bank", "name": "UNICRED DO BRASIL", "bcb_name": "UNICRED DO BRASIL", "number": "136", "number_with_digit": "136-8", "slug": "unicred" }, { "kind": "bank", "name": "SISPRIME", "bcb_name": "SISPRIME DO BRASIL", "number": "084", "number_with_digit": "084-1", "slug": "uniprime" }, { "kind": "bank", "name": "UNIPRIME Central", "bcb_name": "Uniprime Central - Central Interestadual De Cooperativas De Credito Ltda.", "number": "099", "number_with_digit": "099-X", "slug": "uniprime99" }, { "kind": "ip", "name": "ZemoBank", "number": "655", "number_with_digit": "655-6", "slug": "zemo" }, { "kind": "bank", "name": "Banco de exemplo", "number": "000", "number_with_digit": "000-0", "slug": "example_bank" }, { "kind": "credit-bureau", "name": "SPC", "slug": "spc" }, { "kind": "partner", "name": "Pluggy", "slug": "pluggy" }, { "kind": "partner", "name": "IuPay", "slug": "iupay" }, { "kind": "partner", "name": "DDA Exemplo (Sandbox)", "slug": "dda_example" } ] }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_financial_provider" } } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/financial/accounts/{financial_account_uid}/statement_transactions/imports": { "get": { "summary": "Listar Importações de extrato", "tags": [ "Extrato" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todas as importações de extrato realizadas para uma conta financeira. Permite filtrar por status, data de processamento, tags e nome do arquivo importado.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "financial_account_uid", "in": "path", "description": "UID da Conta Financeira", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "status", "in": "query", "description": "Filtro por status da importação", "example": "pending", "required": false, "schema": { "type": "string" } }, { "name": "source_file_name", "in": "query", "description": "Nome do arquivo importado", "example": "myfile.ofx", "required": false, "schema": { "type": "string" } }, { "name": "processed_from", "in": "query", "description": "Data inicial do filtro de data de processamento da importação", "example": "2020-01-01", "required": false, "schema": { "type": "string" } }, { "name": "processed_to", "in": "query", "description": "Data final do filtro de data de processamento da importação", "example": "2020-01-01", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "description": "Data inicial do filtro de data de criação da importação", "example": "2020-01-01", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "description": "Data final do filtro de data de criação da importação", "example": "2020-01-01", "required": false, "schema": { "type": "string" } }, { "name": "tags", "in": "query", "description": "Filtro por tags da importação", "example": "Tag 1, Tag 2", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Importações de Extrato encontradas", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d90-0b0c-7a92-9a1d-b98aab50b5f9", "created_rows": 0, "enqueued_at": null, "started_at": null, "finished_at": null, "processed_at": null, "failed_to_create_rows": 0, "failed_to_update_rows": 0, "import_errors": null, "processed_rows": 0, "total_rows": null, "updated_rows": 0, "source_file_name": "statement-itau-case-01.ret", "source_file_size": 15246, "status": "pending", "created_via_api": false, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:55:51-05:00", "updated_at": "2026-09-04T12:55:51-05:00" }, { "uid": "01a06d90-0ac4-7471-8398-d03f3c018da5", "created_rows": 0, "enqueued_at": null, "started_at": null, "finished_at": null, "processed_at": null, "failed_to_create_rows": 0, "failed_to_update_rows": 0, "import_errors": null, "processed_rows": 0, "total_rows": null, "updated_rows": 0, "source_file_name": "statement-itau-case-01.ret", "source_file_size": 15246, "status": "pending", "created_via_api": false, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:55:51-05:00", "updated_at": "2026-09-04T12:55:51-05:00" }, { "uid": "01a06d90-0a7e-755e-a069-a17d72fec94c", "created_rows": 0, "enqueued_at": null, "started_at": null, "finished_at": null, "processed_at": null, "failed_to_create_rows": 0, "failed_to_update_rows": 0, "import_errors": null, "processed_rows": 0, "total_rows": null, "updated_rows": 0, "source_file_name": "statement-itau-case-01.ret", "source_file_size": 15246, "status": "pending", "created_via_api": false, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:55:51-05:00", "updated_at": "2026-09-04T12:55:51-05:00" }, { "uid": "01a06d90-0a37-7df5-a507-9f4e1143a3d7", "created_rows": 0, "enqueued_at": null, "started_at": null, "finished_at": null, "processed_at": null, "failed_to_create_rows": 0, "failed_to_update_rows": 0, "import_errors": null, "processed_rows": 0, "total_rows": null, "updated_rows": 0, "source_file_name": "statement-itau-case-01.ret", "source_file_size": 15246, "status": "pending", "created_via_api": false, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:55:51-05:00", "updated_at": "2026-09-04T12:55:51-05:00" }, { "uid": "01a06d90-09f1-72c5-8935-7a67ef4e5c87", "created_rows": 0, "enqueued_at": null, "started_at": null, "finished_at": null, "processed_at": null, "failed_to_create_rows": 0, "failed_to_update_rows": 0, "import_errors": null, "processed_rows": 0, "total_rows": null, "updated_rows": 0, "source_file_name": "statement-itau-case-01.ret", "source_file_size": 15246, "status": "pending", "created_via_api": false, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:55:51-05:00", "updated_at": "2026-09-04T12:55:51-05:00" } ], "pagination": { "prev_url": null, "next_url": "/v2/financial/accounts/01a06d90-0681-7a95-af04-0b5060a56fbd/statement_transactions/imports?per_page=5&status=&page=2", "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_import" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } } } }, "post": { "summary": "Importar Extrato", "tags": [ "Extrato" ], "security": [ { "bearerAuth": [] } ], "description": "Importa um extrato bancário através de arquivo CNAB. O processamento é realizado de forma assíncrona e as transações são associadas à conta financeira.\n> **Processamento Assíncrono:** Este endpoint é processado assincronamente e cria um comando de atualização para a Conta Financeira.\n\nA Importação de Extrato de uma Conta Financeira é feita assincronamente, ou seja, ao receber a requisição,\na nossa API guarda os parâmetros da requisição e processa a importação em segundo plano.\nApós a importação ser processada, as transações serão associadas à Conta Financeira.\nVocê recebe na resposta desta requisição o UID da Importação criada e pode consultá-lo a qualquer momento.\n\n## Eventos de Webhook\n\nQuando a requisição é realizada, um evento `import.created` é disparado.\nO nosso servidor então começa o processamento da importação.\nApós o fim do processamento, o evento `import.processed` é disparado.\n", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "financial_account_uid", "in": "path", "description": "UID da Conta Financeira", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Importação criada", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-0b9f-7f82-84a1-cd268992cce6", "created_rows": 0, "enqueued_at": null, "started_at": null, "finished_at": null, "processed_at": null, "failed_to_create_rows": 0, "failed_to_update_rows": 0, "import_errors": null, "processed_rows": 0, "total_rows": null, "updated_rows": 0, "source_file_name": "statement-itau-case-02.ret", "source_file_size": 2662, "status": "pending", "created_via_api": true, "external_id": "123_external_id_abcdef", "custom_data": { "chave_1": "Valor um", "chave_2": "Valor dois" }, "tags": [ "etiq 1", "etiq 2" ], "tag_list": "etiq 1,etiq 2", "created_at": "2026-09-04T12:55:51-05:00", "updated_at": "2026-09-04T12:55:51-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_import" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/v2_import_send" } } }, "required": true, "description": "Parâmetros para criação de uma importação." } } }, "/v2/financial/accounts/{financial_account_uid}/statement_transactions/imports/{uid}": { "get": { "summary": "Visualizar Importação de Extrato", "tags": [ "Extrato" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de uma Importação de Extrato.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "financial_account_uid", "in": "path", "description": "UID da Conta Financeira", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UID da Importação de Extrato", "required": true, "example": "0196f8a9-ac8f-7125-ad2f-eb81aa4273c3", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Importação de Extrato encontrada", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-0cd1-77e5-917f-7133edb10f71", "created_rows": 0, "enqueued_at": null, "started_at": null, "finished_at": null, "processed_at": null, "failed_to_create_rows": 0, "failed_to_update_rows": 0, "import_errors": null, "processed_rows": 0, "total_rows": null, "updated_rows": 0, "source_file_name": "statement-itau-case-01.ret", "source_file_size": 15246, "status": "pending", "created_via_api": false, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2026-09-04T12:55:52-05:00", "updated_at": "2026-09-04T12:55:52-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_import" } } } } } }, "404": { "description": "Conta não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/financial/accounts/{financial_account_uid}/statement_transactions/syncs": { "get": { "summary": "Listar Sincronizações de Extrato", "tags": [ "Extrato" ], "security": [ { "bearerAuth": [] } ], "description": "Lista as sincronizações de extrato solicitadas para uma Conta Financeira, da mais recente para a mais antiga.\n\nCada item representa uma solicitação feita em\n[Sincronizar Extrato](ref:post_v2-financial-accounts-financial-account-uid-statement-transactions-sync-1)\ne agrega os comandos criados para a janela pedida — janelas que cruzam mais de um mês geram um comando por mês.\n\nO campo `commands_summary` traz a contagem de comandos por status, o que permite identificar quantos meses\nfalharam sem precisar abrir a solicitação. Para ver os comandos individualmente, use a consulta por `uid`.\n\n> Apenas sincronizações solicitadas via API aparecem aqui. As sincronizações automáticas periódicas não geram registro.\n", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "financial_account_uid", "in": "path", "description": "UUID da Conta Financeira", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "status", "in": "query", "required": false, "description": "Filtra por status agregado da sincronização.", "schema": { "type": "string", "enum": [ "pending", "processing", "done", "partial", "failed" ] } } ], "responses": { "200": { "description": "Sincronizações encontradas", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d90-0dd1-7358-9c11-deed270efdfb", "status": "processing", "start_at": "2026-07-01", "end_at": "2026-09-04", "commands_count": 3, "commands_summary": { "confirmed": 2, "pending": 1 }, "created_at": "2026-09-04T12:55:52-05:00", "updated_at": "2026-09-04T12:55:52-05:00" }, { "uid": "01a06d90-0db0-7bb2-958b-c17db4e802c6", "status": "done", "start_at": "2026-09-01", "end_at": "2026-09-04", "commands_count": 1, "commands_summary": { "confirmed": 1 }, "created_at": "2026-09-04T12:55:52-05:00", "updated_at": "2026-09-04T12:55:52-05:00" } ], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_statement_sync_request" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } } } } }, "/v2/financial/accounts/{financial_account_uid}/statement_transactions/syncs/{uid}": { "get": { "summary": "Consultar Sincronização de Extrato", "tags": [ "Extrato" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta o status de uma sincronização de extrato solicitada.\n\nO status é recalculado a cada consulta a partir dos comandos da solicitação:\n\n* `pending` - nenhum comando começou a ser processado\n* `processing` - em andamento (parte dos comandos já terminou)\n* `done` - todos os comandos foram confirmados e as transações já estão disponíveis em\n [Listar Transações](ref:get_v2-financial-accounts-financial-account-uid-statement-transactions)\n* `partial` - todos terminaram, mas parte falhou. O array `commands` mostra qual janela falhou e por quê\n* `failed` - todos terminaram e nenhum foi confirmado\n\nO array `commands` traz cada comando com sua própria janela em `params.start_at`/`params.end_at` e a\nmensagem de erro em `error_message`, quando houver. É por ele que se identifica **qual mês** falhou numa\nsincronização multi-mês.\n", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "financial_account_uid", "in": "path", "description": "UUID da Conta Financeira", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UUID da Sincronização", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sincronização encontrada", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-0e5f-71a9-9cf4-7ee3674c8e45", "status": "processing", "start_at": "2026-07-01", "end_at": "2026-09-04", "commands_count": 3, "commands_summary": { "confirmed": 2, "pending": 1 }, "created_at": "2026-09-04T12:55:52-05:00", "updated_at": "2026-09-04T12:55:52-05:00", "commands": [ { "id": 125, "uid": "01a06d90-0e45-7d66-933c-0464e38d9d41", "status": "confirmed", "operation": "statement_sync", "resource_type": "Financial::Account", "resource_uid": "01a06d90-0e19-78f3-a195-f00db69355c1", "financial_provider_slug": "sicoob", "params": { "start_at": "2026-07-01", "end_at": "2026-09-04" }, "payload": null, "created_at": "2026-09-04T12:55:52-05:00", "updated_at": "2026-09-04T12:55:52-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null }, { "id": 126, "uid": "01a06d90-0e4e-7e51-8ace-954e604c9be7", "status": "confirmed", "operation": "statement_sync", "resource_type": "Financial::Account", "resource_uid": "01a06d90-0e19-78f3-a195-f00db69355c1", "financial_provider_slug": "sicoob", "params": { "start_at": "2026-07-01", "end_at": "2026-09-04" }, "payload": null, "created_at": "2026-09-04T12:55:52-05:00", "updated_at": "2026-09-04T12:55:52-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null }, { "id": 127, "uid": "01a06d90-0e58-7fea-83f2-3f2d5fa62dac", "status": "pending", "operation": "statement_sync", "resource_type": "Financial::Account", "resource_uid": "01a06d90-0e19-78f3-a195-f00db69355c1", "financial_provider_slug": "sicoob", "params": { "start_at": "2026-07-01", "end_at": "2026-09-04" }, "payload": null, "created_at": "2026-09-04T12:55:52-05:00", "updated_at": "2026-09-04T12:55:52-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null } ] } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_statement_sync_request" } } } } } }, "404": { "description": "Sincronização não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/financial/accounts/{financial_account_uid}/statement_transactions": { "get": { "summary": "Listar Transações", "tags": [ "Extrato" ], "security": [ { "bearerAuth": [] } ], "description": "Lista as transações do extrato de uma conta financeira, filtrando por período, tipo, valor e descrição.\n\n## Janela de datas — mudança agendada\n\nHoje, uma requisição sem datas devolve o extrato inteiro da conta. Esse comportamento\n**vai mudar em 05/02/2027**: a consulta passará a rodar sempre dentro de uma janela de no\nmáximo 180 dias, o que é o que mantém o endpoint rápido em contas com histórico longo.\n\nVocê pode adotar o comportamento novo desde já enviando `date_window=strict`, e deve fazê-lo\nantes da data de corte. Com ele:\n\n| Parâmetros enviados | Janela consultada |\n|---|---|\n| nenhum | Os últimos 180 dias |\n| só `occurrence_date_from` | 180 dias a partir dela |\n| só `occurrence_date_to` | 180 dias antes dela |\n| ambos | O período informado, desde que não passe de 180 dias |\n\nUm intervalo maior que 180 dias é recusado com `422` em vez de ser reduzido silenciosamente —\num extrato parcial com aparência de completo é pior do que um erro. Para períodos mais longos,\nfaça chamadas sucessivas de até 180 dias cada.\n\nEnquanto `date_window=strict` não for enviado, nada muda. Requisições cujo resultado **seria\ndiferente** sob a janela estrita respondem com os cabeçalhos `Deprecation: true` e\n`Sunset: Fri, 05 Feb 2027 00:00:00 GMT` — use-os para descobrir quais das suas integrações\nprecisam de ajuste.\n", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página. Valores acima do máximo são reduzidos ao máximo.", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 500 } }, { "name": "date_window", "in": "query", "description": "Envie `strict` para adotar desde já a janela de 180 dias que passa a ser o padrão em 05/02/2027. Sem ele, o comportamento atual é preservado.", "example": "strict", "required": false, "schema": { "type": "string", "enum": [ "strict" ] } }, { "name": "occurrence_date_from", "in": "query", "description": "Data inicial do filtro de data de ocorrência. Com `date_window=strict`, se omitida é derivada de `occurrence_date_to` (180 dias antes) ou, na ausência das duas, de hoje.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "occurrence_date_to", "in": "query", "description": "Data final do filtro de data de ocorrência. Com `date_window=strict`, se omitida é derivada de `occurrence_date_from` (180 dias depois) ou, na ausência das duas, é hoje.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "kind", "in": "query", "description": "Filtra pelo tipo da transação.", "example": "credit", "required": false, "schema": { "type": "string", "enum": [ "credit", "debit" ] } }, { "name": "amount_from", "in": "query", "description": "Valor mínimo da transação, em reais e com sinal — débitos são negativos, assim como no campo `amount` da resposta. Use ponto como separador decimal.", "example": "-1500.00", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "amount_to", "in": "query", "description": "Valor máximo da transação, em reais e com sinal — débitos são negativos, assim como no campo `amount` da resposta. Use ponto como separador decimal.", "example": "1500.00", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "amount_abs_from", "in": "query", "description": "Valor mínimo em módulo, ignorando o sinal. Use para \"acima de X, entrada ou saída\".", "example": "1000.00", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "amount_abs_to", "in": "query", "description": "Valor máximo em módulo, ignorando o sinal.", "example": "5000.00", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "category", "in": "query", "description": "Código de categoria, ou lista separada por vírgula. Consulte o catálogo em `GET /v2/financial/statement_categories`. Códigos desconhecidos são ignorados.", "example": "105,112", "required": false, "schema": { "type": "string" } }, { "name": "updated_since", "in": "query", "description": "Retorna apenas transações alteradas a partir deste instante (ISO 8601). Serve para sincronização incremental.", "example": "2026-08-01T00:00:00Z", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "q", "in": "query", "description": "Busca textual na descrição da transação enviada pelo banco (`description`). Casa qualquer trecho do texto, sem diferenciar maiúsculas, minúsculas ou acentos — `manutencao` encontra `MANUTENÇÃO`.", "example": "PIX RECEBIDO", "required": false, "schema": { "type": "string" } }, { "name": "view", "in": "query", "description": "Use `compact` para receber apenas os campos essenciais de cada transação.", "example": "compact", "required": false, "schema": { "type": "string", "enum": [ "compact" ] } }, { "name": "fields", "in": "query", "description": "Lista de campos separados por vírgula a retornar em cada transação. Tem precedência sobre `view`. Um campo desconhecido resulta em `422`.", "example": "id,occurrence_date,amount,description", "required": false, "schema": { "type": "string" } }, { "name": "pagination", "in": "query", "description": "Use `keyset` para paginação por cursor, estável quando novas transações chegam durante a varredura. A resposta passa a trazer `next_cursor` no lugar das URLs.", "example": "keyset", "required": false, "schema": { "type": "string", "enum": [ "keyset" ] } }, { "name": "cursor", "in": "query", "description": "Cursor devolvido em `pagination.next_cursor`. Só tem efeito com `pagination=keyset`.", "required": false, "schema": { "type": "string" } }, { "name": "financial_account_uid", "in": "path", "description": "UUID da Conta Financeira", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Transações encontradas", "content": { "application/json": { "example": { "status": 200, "data": [ { "id": 40, "financial_account_uid": "01a06d90-0f34-7c87-b63a-2466b73bc0a9", "amount": -100.0, "occurrence_date": "2026-09-04", "created_at": "2026-09-04T12:55:53-05:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "404.534.544-29" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "160cd347451ef44c1864ab3d040fc950", "hashed_content": "160cd347451ef44c1864ab3d040fc950", "updated_at": "2026-09-04T12:55:53-05:00", "financial_provider_external_id": "12dca300-38ce-44ad-b2bb-a48a034389a2" }, { "id": 39, "financial_account_uid": "01a06d90-0f34-7c87-b63a-2466b73bc0a9", "amount": -100.0, "occurrence_date": "2026-09-04", "created_at": "2026-09-04T12:55:53-05:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "482.117.272-00" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "bc67ff094372ace03b95f52ed7b00ac0", "hashed_content": "bc67ff094372ace03b95f52ed7b00ac0", "updated_at": "2026-09-04T12:55:53-05:00", "financial_provider_external_id": "25c2f051-9f5d-423f-9d8f-7fea921da358" }, { "id": 38, "financial_account_uid": "01a06d90-0f34-7c87-b63a-2466b73bc0a9", "amount": -100.0, "occurrence_date": "2026-09-04", "created_at": "2026-09-04T12:55:53-05:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "677.544.619-51" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "d72be47da8744a7521b0fc497520587c", "hashed_content": "d72be47da8744a7521b0fc497520587c", "updated_at": "2026-09-04T12:55:53-05:00", "financial_provider_external_id": "09d75d95-2ba4-4241-9fe4-ba7c236d0c45" }, { "id": 37, "financial_account_uid": "01a06d90-0f34-7c87-b63a-2466b73bc0a9", "amount": -100.0, "occurrence_date": "2026-09-04", "created_at": "2026-09-04T12:55:53-05:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "530.421.153-72" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "d11dc885d6bc121677c6cfa7512adc51", "hashed_content": "d11dc885d6bc121677c6cfa7512adc51", "updated_at": "2026-09-04T12:55:53-05:00", "financial_provider_external_id": "beeee17c-c598-4922-b893-6023f33dac8f" }, { "id": 36, "financial_account_uid": "01a06d90-0f34-7c87-b63a-2466b73bc0a9", "amount": -100.0, "occurrence_date": "2026-09-04", "created_at": "2026-09-04T12:55:53-05:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "175.068.487-08" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "0a5cd77bed581512ebc9539c3f312e4c", "hashed_content": "0a5cd77bed581512ebc9539c3f312e4c", "updated_at": "2026-09-04T12:55:53-05:00", "financial_provider_external_id": "ddf3773c-8414-4583-9cc6-2ce553795d25" }, { "id": 35, "financial_account_uid": "01a06d90-0f34-7c87-b63a-2466b73bc0a9", "amount": -100.0, "occurrence_date": "2026-09-04", "created_at": "2026-09-04T12:55:53-05:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "050.094.730-97" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "4f83c7f5496d9de469d1fa6b335d5b91", "hashed_content": "4f83c7f5496d9de469d1fa6b335d5b91", "updated_at": "2026-09-04T12:55:53-05:00", "financial_provider_external_id": "29df8f7c-759d-41a3-b862-1cb8304de118" }, { "id": 34, "financial_account_uid": "01a06d90-0f34-7c87-b63a-2466b73bc0a9", "amount": -100.0, "occurrence_date": "2026-09-04", "created_at": "2026-09-04T12:55:53-05:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "174.957.209-56" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "fab09e37755bec73fbed84395ffb71a5", "hashed_content": "fab09e37755bec73fbed84395ffb71a5", "updated_at": "2026-09-04T12:55:53-05:00", "financial_provider_external_id": "ce0e0bbf-1cf6-48e9-97f0-9e60493c9743" }, { "id": 33, "financial_account_uid": "01a06d90-0f34-7c87-b63a-2466b73bc0a9", "amount": -100.0, "occurrence_date": "2026-09-04", "created_at": "2026-09-04T12:55:53-05:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "579.697.367-34" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "a9599bb6eb551a16f9ca1798c32d866d", "hashed_content": "a9599bb6eb551a16f9ca1798c32d866d", "updated_at": "2026-09-04T12:55:53-05:00", "financial_provider_external_id": "329c0919-aabb-48be-a21d-7093349ae32f" }, { "id": 32, "financial_account_uid": "01a06d90-0f34-7c87-b63a-2466b73bc0a9", "amount": -100.0, "occurrence_date": "2026-09-04", "created_at": "2026-09-04T12:55:53-05:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "368.184.254-02" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "ba039e8a957936784a5bd3ae37fa236e", "hashed_content": "ba039e8a957936784a5bd3ae37fa236e", "updated_at": "2026-09-04T12:55:53-05:00", "financial_provider_external_id": "e769e5fb-dce4-4262-a2d7-11fbea3192fc" }, { "id": 31, "financial_account_uid": "01a06d90-0f34-7c87-b63a-2466b73bc0a9", "amount": -100.0, "occurrence_date": "2026-09-04", "created_at": "2026-09-04T12:55:53-05:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "189.161.050-30" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "c47a17c5ef341992f3cbfada5a61b91a", "hashed_content": "c47a17c5ef341992f3cbfada5a61b91a", "updated_at": "2026-09-04T12:55:53-05:00", "financial_provider_external_id": "b85284c3-5415-41d0-8df3-736d25a6bdc4" }, { "id": 30, "financial_account_uid": "01a06d90-0f34-7c87-b63a-2466b73bc0a9", "amount": -100.0, "occurrence_date": "2026-09-04", "created_at": "2026-09-04T12:55:53-05:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "118.687.124-51" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "a3d3933a0a231317915da9dbf17341e8", "hashed_content": "a3d3933a0a231317915da9dbf17341e8", "updated_at": "2026-09-04T12:55:53-05:00", "financial_provider_external_id": "b295742d-ace1-4d44-a45b-42c83cc1be6a" }, { "id": 29, "financial_account_uid": "01a06d90-0f34-7c87-b63a-2466b73bc0a9", "amount": -100.0, "occurrence_date": "2026-09-04", "created_at": "2026-09-04T12:55:53-05:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "447.852.521-89" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "34793d38f4ab3988925ff456a6a74224", "hashed_content": "34793d38f4ab3988925ff456a6a74224", "updated_at": "2026-09-04T12:55:53-05:00", "financial_provider_external_id": "2bb065a6-6792-4ce6-9cb9-5a107323b450" }, { "id": 28, "financial_account_uid": "01a06d90-0f34-7c87-b63a-2466b73bc0a9", "amount": -100.0, "occurrence_date": "2026-09-04", "created_at": "2026-09-04T12:55:53-05:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "004.901.643-15" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "731cf247b6352b691eea29f8de81f118", "hashed_content": "731cf247b6352b691eea29f8de81f118", "updated_at": "2026-09-04T12:55:53-05:00", "financial_provider_external_id": "c710701d-26ed-4716-9883-e8d43bac569c" }, { "id": 27, "financial_account_uid": "01a06d90-0f34-7c87-b63a-2466b73bc0a9", "amount": -100.0, "occurrence_date": "2026-09-04", "created_at": "2026-09-04T12:55:53-05:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "322.687.150-19" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "f129de3aac918fbd2fa96b7243387fff", "hashed_content": "f129de3aac918fbd2fa96b7243387fff", "updated_at": "2026-09-04T12:55:53-05:00", "financial_provider_external_id": "32feaece-94ad-449c-a045-65fd83b08784" }, { "id": 26, "financial_account_uid": "01a06d90-0f34-7c87-b63a-2466b73bc0a9", "amount": -100.0, "occurrence_date": "2026-09-04", "created_at": "2026-09-04T12:55:53-05:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "720.626.888-90" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "d7163cb10289b04af84c627fe2b00baa", "hashed_content": "d7163cb10289b04af84c627fe2b00baa", "updated_at": "2026-09-04T12:55:53-05:00", "financial_provider_external_id": "a746db4e-bd96-4757-b201-0cb3befe15ed" }, { "id": 25, "financial_account_uid": "01a06d90-0f34-7c87-b63a-2466b73bc0a9", "amount": -100.0, "occurrence_date": "2026-09-04", "created_at": "2026-09-04T12:55:53-05:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "789.574.464-00" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "1e05ab0f8e9f812299a73ed0cb404c81", "hashed_content": "1e05ab0f8e9f812299a73ed0cb404c81", "updated_at": "2026-09-04T12:55:53-05:00", "financial_provider_external_id": "90bb5d36-d69f-42b6-aaf2-7af56894e6a1" }, { "id": 24, "financial_account_uid": "01a06d90-0f34-7c87-b63a-2466b73bc0a9", "amount": -100.0, "occurrence_date": "2026-09-04", "created_at": "2026-09-04T12:55:53-05:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "651.212.134-17" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "3f5c2bd8dc4918e23036065f4828dc40", "hashed_content": "3f5c2bd8dc4918e23036065f4828dc40", "updated_at": "2026-09-04T12:55:53-05:00", "financial_provider_external_id": "2cdb0cd8-f76e-428a-aaca-aad0a0f88777" }, { "id": 23, "financial_account_uid": "01a06d90-0f34-7c87-b63a-2466b73bc0a9", "amount": -100.0, "occurrence_date": "2026-09-04", "created_at": "2026-09-04T12:55:53-05:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "465.377.170-78" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "150e732a90056683242999a9b4d7a7c4", "hashed_content": "150e732a90056683242999a9b4d7a7c4", "updated_at": "2026-09-04T12:55:53-05:00", "financial_provider_external_id": "5836256a-b76a-4510-8fe1-50378e919318" }, { "id": 22, "financial_account_uid": "01a06d90-0f34-7c87-b63a-2466b73bc0a9", "amount": -100.0, "occurrence_date": "2026-09-04", "created_at": "2026-09-04T12:55:53-05:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "128.070.602-34" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "3bbc5c7f29af8ba38f05d62ce27c7ffa", "hashed_content": "3bbc5c7f29af8ba38f05d62ce27c7ffa", "updated_at": "2026-09-04T12:55:53-05:00", "financial_provider_external_id": "540bc544-8353-4aa2-a3cf-20f759c3b67b" }, { "id": 21, "financial_account_uid": "01a06d90-0f34-7c87-b63a-2466b73bc0a9", "amount": -100.0, "occurrence_date": "2026-09-04", "created_at": "2026-09-04T12:55:53-05:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "435.800.531-40" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "2922ae834b580009f643f3a0d569b8a3", "hashed_content": "2922ae834b580009f643f3a0d569b8a3", "updated_at": "2026-09-04T12:55:53-05:00", "financial_provider_external_id": "ae8f0285-6faa-4ffe-b781-4490e5abf855" } ], "filters": { "occurrence_date_from": "2026-09-02", "occurrence_date_to": "2026-09-05", "kind": null, "amount_from": null, "amount_to": null, "amount_abs_from": null, "amount_abs_to": null, "category": null, "updated_since": null, "q": null }, "meta": { "statement_updated_at": null, "statement_sync_last_updated_at": null, "current_balance": 0.0, "balance_updated_at": null }, "pagination": { "prev_url": null, "next_url": "/v2/financial/accounts/01a06d90-0f34-7c87-b63a-2466b73bc0a9/statement_transactions?per_page=20&occurrence_date_from=2026-09-02&occurrence_date_to=2026-09-05&page=2", "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_statement_transaction" } }, "filters": { "type": "object", "description": "Filtros efetivamente aplicados na consulta, já com a janela resolvida e os valores normalizados. Um filtro que não foi aplicado — porque não foi enviado ou porque o valor era inválido — volta como `null`.", "properties": { "occurrence_date_from": { "type": "string", "format": "date", "nullable": true, "description": "Início da janela consultada. Com `date_window=strict` nunca é nulo, porque é derivado quando não informado." }, "occurrence_date_to": { "type": "string", "format": "date", "nullable": true, "description": "Fim da janela consultada. Com `date_window=strict` nunca é nulo, porque é derivado quando não informado." }, "kind": { "type": "string", "enum": [ "credit", "debit" ], "nullable": true, "description": "Tipo filtrado, ou `null` quando não houve filtro por tipo." }, "amount_from": { "type": "number", "format": "float", "nullable": true, "description": "Valor mínimo aplicado, em reais e com sinal." }, "amount_to": { "type": "number", "format": "float", "nullable": true, "description": "Valor máximo aplicado, em reais e com sinal." }, "amount_abs_from": { "type": "number", "format": "float", "nullable": true, "description": "Valor mínimo em módulo aplicado." }, "amount_abs_to": { "type": "number", "format": "float", "nullable": true, "description": "Valor máximo em módulo aplicado." }, "category": { "type": "array", "nullable": true, "items": { "type": "integer" }, "description": "Códigos de categoria que sobreviveram à validação, ou `null`." }, "updated_since": { "type": "string", "format": "date-time", "nullable": true, "description": "Instante mínimo de alteração aplicado." }, "q": { "type": "string", "nullable": true, "description": "Termo de busca aplicado na descrição." } } }, "meta": { "type": "object", "description": "Estado da conta no momento da consulta. Permite saber se o extrato lido está atualizado — uma resposta construída sobre extrato defasado erra de forma especialmente convincente.", "properties": { "statement_updated_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o extrato desta conta foi atualizado pela última vez." }, "statement_sync_last_updated_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando a última sincronização de extrato rodou." }, "current_balance": { "type": "number", "format": "float", "nullable": true, "description": "Saldo atual conhecido da conta, em reais." }, "balance_updated_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Quando o saldo foi atualizado pela última vez." } } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } }, "422": { "description": "Intervalo de datas maior que 180 dias (com date_window=strict)", "content": { "application/json": { "example": { "status": 422, "errors": [ { "title": "O intervalo entre occurrence_date_from e occurrence_date_to não pode ser maior que 180 dias.", "code": "unprocessable_content" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/financial/accounts/{financial_account_uid}/statement_transactions/sync": { "post": { "summary": "Sincronizar Extrato", "tags": [ "Extrato" ], "security": [ { "bearerAuth": [] } ], "description": "Sincroniza o extrato bancário de uma conta financeira. Busca transações diretamente da instituição financeira através de API. Requer conexão ativa.\n> **Processamento Assíncrono:** Este endpoint é processado assincronamente e cria um comando de sincronização de extrato para a Conta Financeira.\n\nA Sincronização de Extrato de uma Conta Financeira é feita assincronamente, ou seja, ao receber a requisição, a nossa\nAPI guarda os parametros da requisição e cria um Comando. Esse comando é processado em sgundo plano e depois é confirmado\ne as transações serão importadas na Conta Financeira. Você recebe na resposta desta requisição o ID do comando criado\ne pode consultá-lo a qualquer momento.\n\nVeja mais em [Listar Comandos de uma Conta Finaneira](ref:get_v2-financial-accounts-account-id-commands) e\n[Visualizar um Comando](ref:get_v2-financial-accounts-account-id-commands-id).\n\nPara que seja possível executar a Sincronização de Extrato, deve haver uma Conexão ativa (ou seja, validada e habilitada)\nassociada à Conta Financeira.\n\n## Período da Sincronização\n\nOs campos `start_at` e `end_at` são opcionais e delimitam a janela a sincronizar.\nQuando omitidos, a janela padrão vai do **primeiro dia do mês corrente até hoje**.\n\n* informando apenas `start_at`, a data final assumida é hoje;\n* informando apenas `end_at`, a data inicial assumida é o primeiro dia do mês de `end_at`;\n* a data final não pode ser futura;\n* o período máximo é de **2 anos** para trás a partir de hoje.\n\nJanelas que cruzam mais de um mês-calendário são **fatiadas em um comando por mês**. Isso mantém cada\nrequisição à instituição financeira dentro de um volume que o banco consegue responder, e permite\nreprocessar apenas o mês que eventualmente falhar. Uma janela dentro de um mesmo mês continua criando\num único comando.\n\n## Acompanhando a Importação\n\nAlém do comando em `data`, a resposta traz em `sync` o registro da importação solicitada, com um `uid`\npróprio. Use esse `uid` para acompanhar o conjunto inteiro — especialmente em janelas multi-mês, onde\nvários comandos são criados — em\n[Consultar Sincronização de Extrato](ref:get_v2-financial-accounts-financial-account-uid-statement-transactions-syncs-uid).\n\n## Eventos de Webhook\n\nQuando a requisição é realizada, um evento `financial.account.statement_sync.requested` é disparado.\nO nosso servidor então começa a comunicação com a API da instituição financeira para buscar transações.\nSomente depois de confirmado na instituição financeira, aí então o extrato é atualizado.\nNeste momento o evento `financial.account.statement_sync.confirmed` é disparado.\n", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "financial_account_uid", "in": "path", "description": "UUID da Conta Financeira", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Comando criado por mês para janela multi-mês", "content": { "application/json": { "example": { "status": 201, "data": { "id": 169, "uid": "01a06d90-13cd-7c6c-937e-de0acdaacb99", "status": "pending", "operation": "statement_sync", "resource_type": "Financial::Account", "resource_uid": "01a06d90-139c-706a-a063-053b2cf50088", "financial_provider_slug": "sicoob", "params": { "start_at": "2026-07-01", "end_at": "2026-07-31" }, "payload": null, "created_at": "2026-09-04T12:55:53-05:00", "updated_at": "2026-09-04T12:55:53-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null }, "sync": { "uid": "01a06d90-13d3-7c67-b181-b811d7fa3964", "status": "pending", "start_at": "2026-07-01", "end_at": "2026-09-04", "commands_count": 3, "commands_summary": { "pending": 3 }, "created_at": "2026-09-04T12:55:53-05:00", "updated_at": "2026-09-04T12:55:53-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_financial_account_command" }, "sync": { "$ref": "#/components/schemas/v2_statement_sync_request" } } } } } }, "422": { "description": "Conexão para Extrato não ativa", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "financial_account", "detail": "Financial account não possui conexão ativa associada" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "start_at": { "type": "string", "format": "date", "description": "Data inicial da sincronização. Padrão: primeiro dia do mês corrente. Máximo de 2 anos atrás.", "example": "2026-01-15" }, "end_at": { "type": "string", "format": "date", "description": "Data final da sincronização. Padrão: hoje. Não pode ser futura.", "example": "2026-03-10" } } } } }, "description": "Janela de período a sincronizar. Omitido, usa do primeiro dia do mês corrente até hoje." } } }, "/v2/financial/accounts/{financial_account_uid}/statement_transactions/summary": { "get": { "summary": "Resumir Extrato", "tags": [ "Extrato" ], "security": [ { "bearerAuth": [] } ], "description": "Agrega as transações do extrato em totais por grupo, em vez de devolver uma linha por transação.\n\nResponde perguntas como \"quanto gastei com tarifas em julho?\" numa única requisição, com a\naritmética feita no banco — sem paginar o extrato inteiro.\n\n> **A janela aqui pode chegar a 730 dias**, contra os 180 da listagem. O tamanho da resposta é\n> limitado pela quantidade de grupos, não pelo histórico, então uma janela longa é segura.\n\nAceita os mesmos filtros da listagem. Se a combinação de `group_by` e janela gerar mais de\n1000 grupos, a requisição é recusada com `422` em vez de devolver um resumo truncado — um total\ncortado pela metade parece completo e engana silenciosamente.\n\nA resposta também traz os blocos `filters` e `meta`, idênticos aos da listagem, com o acréscimo\nde `filters.group_by` informando o agrupamento aplicado.\n", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "financial_account_uid", "in": "path", "required": true, "description": "UUID da Conta Financeira", "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } }, { "name": "group_by", "in": "query", "description": "Dimensões de agrupamento separadas por vírgula: `day`, `week`, `month`, `kind`, `category`. Padrão: `month`.", "example": "month,category", "required": false, "schema": { "type": "string" } }, { "name": "occurrence_date_from", "in": "query", "description": "Data inicial da janela. Mesma regra de derivação da listagem, com limite de 730 dias.", "example": "2025-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "occurrence_date_to", "in": "query", "description": "Data final da janela.", "example": "2026-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "kind", "in": "query", "required": false, "description": "Mesmo filtro da listagem.", "example": "debit", "schema": { "type": "string", "enum": [ "credit", "debit" ] } }, { "name": "category", "in": "query", "required": false, "description": "Mesmo filtro da listagem.", "example": "105", "schema": { "type": "string" } }, { "name": "q", "in": "query", "required": false, "description": "Mesmo filtro da listagem.", "example": "TARIFA", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resumo calculado", "content": { "application/json": { "example": { "status": 200, "data": [ { "month": "2026-09", "count": 3, "credit_total": 0.0, "debit_total": -300.0, "net_total": -300.0 } ], "filters": { "occurrence_date_from": "2024-09-04", "occurrence_date_to": "2026-09-04", "kind": null, "amount_from": null, "amount_to": null, "amount_abs_from": null, "amount_abs_to": null, "category": null, "updated_since": null, "q": null, "group_by": [ "month" ] }, "meta": { "statement_updated_at": null, "statement_sync_last_updated_at": null, "current_balance": 0.0, "balance_updated_at": null } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "description": "Um objeto por grupo. As chaves de agrupamento presentes dependem do `group_by`.", "items": { "type": "object", "properties": { "month": { "type": "string", "nullable": true, "description": "Bucket `YYYY-MM`, quando agrupado por mês." }, "week": { "type": "string", "format": "date", "nullable": true, "description": "Início da semana, quando agrupado por semana." }, "day": { "type": "string", "format": "date", "nullable": true, "description": "Dia, quando agrupado por dia." }, "kind": { "type": "string", "nullable": true, "enum": [ "credit", "debit" ], "description": "Tipo, quando agrupado por tipo." }, "category": { "type": "integer", "nullable": true, "description": "Código da categoria, quando agrupado por categoria." }, "category_description": { "type": "string", "nullable": true, "description": "Descrição da categoria." }, "count": { "type": "integer", "description": "Quantidade de transações no grupo." }, "credit_total": { "type": "number", "format": "float", "description": "Soma dos créditos, em reais." }, "debit_total": { "type": "number", "format": "float", "description": "Soma dos débitos, em reais (negativa)." }, "net_total": { "type": "number", "format": "float", "description": "Resultado líquido do grupo, em reais." } } } }, "filters": { "type": "object", "description": "Filtros efetivamente aplicados, iguais aos da listagem, acrescidos de `group_by` com o agrupamento em vigor.", "properties": { "occurrence_date_from": { "type": "string", "format": "date", "description": "Início da janela consultada." }, "occurrence_date_to": { "type": "string", "format": "date", "description": "Fim da janela consultada." }, "kind": { "type": "string", "enum": [ "credit", "debit" ], "nullable": true, "description": "Tipo filtrado." }, "amount_from": { "type": "number", "format": "float", "nullable": true, "description": "Valor mínimo aplicado, com sinal." }, "amount_to": { "type": "number", "format": "float", "nullable": true, "description": "Valor máximo aplicado, com sinal." }, "amount_abs_from": { "type": "number", "format": "float", "nullable": true, "description": "Valor mínimo em módulo." }, "amount_abs_to": { "type": "number", "format": "float", "nullable": true, "description": "Valor máximo em módulo." }, "category": { "type": "array", "nullable": true, "items": { "type": "integer" }, "description": "Códigos de categoria aplicados." }, "updated_since": { "type": "string", "format": "date-time", "nullable": true, "description": "Instante mínimo de alteração." }, "q": { "type": "string", "nullable": true, "description": "Termo de busca aplicado." }, "group_by": { "type": "array", "items": { "type": "string" }, "description": "Dimensões de agrupamento aplicadas." } } }, "meta": { "type": "object", "description": "Estado da conta no momento da consulta, idêntico ao da listagem.", "properties": { "statement_updated_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Última atualização do extrato." }, "statement_sync_last_updated_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Última sincronização." }, "current_balance": { "type": "number", "format": "float", "nullable": true, "description": "Saldo atual, em reais." }, "balance_updated_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Última atualização do saldo." } } } } } } } } } } }, "/v2/financial/statement_categories": { "get": { "summary": "Listar Categorias de Extrato", "tags": [ "Extrato" ], "security": [ { "bearerAuth": [] } ], "description": "Catálogo das categorias que uma transação de extrato pode carregar.\n\nNecessário para usar o filtro `category` da listagem e do resumo: os códigos são um domínio\nfechado, e sem o catálogo não há como descobrir que tarifas bancárias são o código `105`.\n\nO catálogo tem duas naturezas: cerca de 50 códigos genéricos (`1xx` débitos, `2xx` créditos,\ne `9999` para `outros`) e centenas de códigos específicos de banco, no formato\n`1 + numero_do_banco + codigo_do_banco` (ex.: `107701`).\n\n`kind` é derivado do slug e vem nulo quando a categoria não declara um lado — o que é o caso\nda maioria dos códigos específicos de banco. Ele é uma conveniência, não uma classificação\nexaustiva: para somar entradas e saídas, use o filtro `kind` da listagem ou o `group_by=kind`\ndo resumo, que operam sobre o tipo real da transação.\n", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Catálogo de categorias", "content": { "application/json": { "example": { "status": 200, "data": [ { "code": 101, "slug": "debito_cheques", "kind": "debit", "description": "Débito Cheque Compensado" }, { "code": 102, "slug": "debito_encargos", "kind": "debit", "description": "Débito Encargos" }, { "code": 103, "slug": "debito_estornos", "kind": "debit", "description": "Débito Estornos" }, { "code": 104, "slug": "debito_lancamento_avisado", "kind": "debit", "description": "Débito Lançamento Avisado" }, { "code": 105, "slug": "debito_tarifas", "kind": "debit", "description": "Débito Tarifas" }, { "code": 106, "slug": "debito_aplicacao", "kind": "debit", "description": "Débito Aplicação" }, { "code": 107, "slug": "debito_emprestimo_financiamento", "kind": "debit", "description": "Débito Empréstimo / Financiamento" }, { "code": 108, "slug": "debito_cambio", "kind": "debit", "description": "Débito Câmbio" }, { "code": 109, "slug": "debito_cpmf", "kind": "debit", "description": "Débito CPMF" }, { "code": 110, "slug": "debito_iof", "kind": "debit", "description": "Débito IOF" }, { "code": 111, "slug": "debito_imposto_de_renda", "kind": "debit", "description": "Débito Imposto de Renda" }, { "code": 112, "slug": "debito_pagamento_fornecedores", "kind": "debit", "description": "Débito Pagamento Fornecedores" }, { "code": 113, "slug": "debito_pagamento_funcionarios", "kind": "debit", "description": "Débito Pagamento Salário" }, { "code": 114, "slug": "debito_saque_eletronico", "kind": "debit", "description": "Débito Saque Eletrônico" }, { "code": 115, "slug": "debito_acoes", "kind": "debit", "description": "Débito Ações" }, { "code": 116, "slug": "debito_seguro", "kind": "debit", "description": "Débito Seguro" }, { "code": 117, "slug": "debito_transferencia_entre_contas", "kind": "debit", "description": "Débito Transferência entre Contas" }, { "code": 118, "slug": "debito_devolucao_da_compensacao", "kind": "debit", "description": "Débito Devolução da Compensação" }, { "code": 119, "slug": "debito_devolucao_de_cheque_depositado", "kind": "debit", "description": "Débito Devolução de Cheque Depositado" }, { "code": 120, "slug": "debito_transferencia_interbancaria_doc_ted", "kind": "debit", "description": "Débito Transferência Interbancária (DOC, TED, Pix)" }, { "code": 121, "slug": "debito_antecipacao_a_fornecedores", "kind": "debit", "description": "Débito Antecipação a Fornecedores" }, { "code": 122, "slug": "debito_oc_aerops", "kind": "debit", "description": "Débito OC / AEROPS" }, { "code": 123, "slug": "debito_saque_em_especie", "kind": "debit", "description": "Débito Saque em Espécie" }, { "code": 124, "slug": "debito_cheque_pago", "kind": "debit", "description": "Débito Cheque Pago" }, { "code": 125, "slug": "debito_pagamentos_diversos", "kind": "debit", "description": "Débito Pagamentos Diversos" }, { "code": 126, "slug": "debito_pagamento_de_tributos", "kind": "debit", "description": "Débito Pagamento de Tributos" }, { "code": 127, "slug": "debito_cartao_de_credito_pagamento_fatura", "kind": "debit", "description": "Débito Cartão de crédito - Pagamento de fatura" }, { "code": 201, "slug": "credito_depositos", "kind": "credit", "description": "Crédito Depósito em Cheque" }, { "code": 202, "slug": "credito_liquido_de_cobranca", "kind": "credit", "description": "Crédito Crédito de Cobrança" }, { "code": 203, "slug": "credito_devolucao_de_cheques", "kind": "credit", "description": "Crédito Devolução de Cheques" }, { "code": 204, "slug": "credito_estornos", "kind": "credit", "description": "Crédito Estornos" }, { "code": 205, "slug": "credito_lancamento_avisado", "kind": "credit", "description": "Crédito Lançamento Avisado" }, { "code": 206, "slug": "credito_resgate_de_aplicacao", "kind": "credit", "description": "Crédito Resgate de Aplicação" }, { "code": 207, "slug": "credito_emprestimo_financiamento", "kind": "credit", "description": "Crédito Empréstimo / Financiamento" }, { "code": 208, "slug": "credito_cambio", "kind": "credit", "description": "Crédito Câmbio" }, { "code": 209, "slug": "credito_transferencia_interbancaria_doc_ted", "kind": "credit", "description": "Crédito Transferência Interbancária (DOC, TED, Pix)" }, { "code": 210, "slug": "credito_acoes", "kind": "credit", "description": "Crédito Ações" }, { "code": 211, "slug": "credito_dividendos", "kind": "credit", "description": "Crédito Dividendos" }, { "code": 212, "slug": "credito_seguro", "kind": "credit", "description": "Crédito Seguro" }, { "code": 213, "slug": "credito_transferencia_entre_contas", "kind": "credit", "description": "Crédito Transferência entre Contas" }, { "code": 214, "slug": "credito_depositos_especiais", "kind": "credit", "description": "Crédito Depósitos Especiais" }, { "code": 215, "slug": "credito_devolucao_da_compensacao", "kind": "credit", "description": "Crédito Devolução da Compensação" }, { "code": 216, "slug": "credito_oct", "kind": "credit", "description": "Crédito OCT" }, { "code": 217, "slug": "credito_pagamento_fornecedores", "kind": "credit", "description": "Crédito Pagamentos Fornecedores" }, { "code": 218, "slug": "credito_pagamentos_diversos", "kind": "credit", "description": "Crédito Pagamentos Diversos" }, { "code": 219, "slug": "credito_pagamentos_salarios", "kind": "credit", "description": "Crédito Recebimento de Salário" }, { "code": 220, "slug": "credito_deposito_em_especie", "kind": "credit", "description": "Crédito Depósito em Espécie" }, { "code": 221, "slug": "credito_pagamento_de_tributos", "kind": "credit", "description": "Crédito Pagamento de Tributos" }, { "code": 222, "slug": "credito_cartao_de_credito_recebiveis", "kind": "credit", "description": "Crédito Cartão de Crédito - Recebíveis" }, { "code": 223, "slug": "credito_credito_pix_via_qrcode", "kind": "credit", "description": "Crédito Crédito Pix via QrCode" }, { "code": 9999, "slug": "outros", "kind": null, "description": "Outros" }, { "code": 107701, "slug": "debito_em_conta", "kind": "debit", "description": "Débito em conta" }, { "code": 107702, "slug": "deposito_boleto", "kind": null, "description": "Depósito boleto" }, { "code": 107703, "slug": "antecipacao_recebiveis", "kind": null, "description": "Antecipação recebíveis" }, { "code": 107704, "slug": "antecipacao_recebiveis_cartao", "kind": null, "description": "Antecipação recebíveis cartão" }, { "code": 107705, "slug": "boleto_cobranca", "kind": null, "description": "Boleto cobrança" }, { "code": 107706, "slug": "cambio", "kind": null, "description": "Câmbio" }, { "code": 107707, "slug": "cashback", "kind": null, "description": "Cashback" }, { "code": 107708, "slug": "cheque", "kind": null, "description": "Cheque" }, { "code": 107709, "slug": "estorno", "kind": null, "description": "Estorno" }, { "code": 107710, "slug": "domicilio_cartao", "kind": null, "description": "Domicílio cartão" }, { "code": 107711, "slug": "financiamento", "kind": null, "description": "Financiamento" }, { "code": 107712, "slug": "imposto", "kind": null, "description": "Imposto" }, { "code": 107713, "slug": "interpag", "kind": null, "description": "Interpag" }, { "code": 107714, "slug": "investimento", "kind": null, "description": "Investimento" }, { "code": 107715, "slug": "juros", "kind": null, "description": "Juros" }, { "code": 107716, "slug": "maquininha_granito", "kind": null, "description": "Maquininha granito" }, { "code": 107717, "slug": "multa", "kind": null, "description": "Multa" }, { "code": 107719, "slug": "pagamento", "kind": null, "description": "Pagamento" }, { "code": 107720, "slug": "pix", "kind": null, "description": "Pix" }, { "code": 107721, "slug": "proventos", "kind": null, "description": "Proventos" }, { "code": 107722, "slug": "saque", "kind": null, "description": "Saque" }, { "code": 107723, "slug": "compra_debito", "kind": null, "description": "Compra débito" }, { "code": 107724, "slug": "debito_automatico", "kind": "debit", "description": "Débito automático" }, { "code": 107725, "slug": "tarifa", "kind": null, "description": "Tarifa" }, { "code": 107726, "slug": "transferencia", "kind": null, "description": "Transferência" }, { "code": 101001, "slug": "caixa_pagamento", "kind": null, "description": "Caixa Pagamento" }, { "code": 101003, "slug": "saque_contra_recibo", "kind": null, "description": "Saque contra recibo" }, { "code": 101004, "slug": "saque_sem_cartao", "kind": null, "description": "Saque sem cartão" }, { "code": 101005, "slug": "emissao_de_cheque_de_viagem", "kind": null, "description": "Emissão de Cheque de Viagem" }, { "code": 101006, "slug": "cheque_visado", "kind": null, "description": "Cheque Visado" }, { "code": 101007, "slug": "estorno_de_recebimento", "kind": null, "description": "Estorno de Recebimento" }, { "code": 101008, "slug": "emissao_de_ordem_de_pagamento", "kind": null, "description": "Emissão de Ordem de Pagamento" }, { "code": 101009, "slug": "tarifa_de_emissao_de_doc_ted", "kind": null, "description": "Tarifa de emissão de DOC/TED" }, { "code": 101010, "slug": "tarifa_adicional_doc_r_5mil", "kind": null, "description": "Tarifa Adicional DOC R 5mil" }, { "code": 101019, "slug": "recebimento_de_numerario", "kind": null, "description": "Recebimento de Numerário" }, { "code": 101023, "slug": "custodia", "kind": null, "description": "Custódia" }, { "code": 101024, "slug": "pagamento_de_empenho", "kind": null, "description": "Pagamento de Empenho" }, { "code": 101028, "slug": "pagamento_fatura_cartao_cred", "kind": null, "description": "Pagamento Fatura Cartão Cred" }, { "code": 101030, "slug": "saque_com_cartao", "kind": null, "description": "Saque com Cartão" }, { "code": 101032, "slug": "emissao_ordem_bancaria", "kind": null, "description": "Emissão Ordem Bancária" }, { "code": 101033, "slug": "cheque_tb", "kind": null, "description": "Cheque TB" }, { "code": 101041, "slug": "aplicacao_poupanca", "kind": null, "description": "Aplicação Poupança" }, { "code": 101042, "slug": "prestacao_leasing", "kind": null, "description": "Prestação Leasing" }, { "code": 101043, "slug": "tarifa_telecomunicacao", "kind": null, "description": "Tarifa Telecomunicação" }, { "code": 101044, "slug": "tarifa_servico_cambio", "kind": null, "description": "Tarifa Serviço Câmbio" }, { "code": 101045, "slug": "tarifa_servico_cobranca", "kind": null, "description": "Tarifa Serviço Cobrança" }, { "code": 101046, "slug": "tarifa_de_cadastro", "kind": null, "description": "Tarifa de cadastro" }, { "code": 101047, "slug": "tarifa_comercio_exterior", "kind": null, "description": "Tarifa Comércio Exterior" }, { "code": 101048, "slug": "emissao_de_doc_d", "kind": null, "description": "Emissão de DOC D" }, { "code": 101049, "slug": "sqfacil_cartao_pagto", "kind": null, "description": "SQFACIL - Cartão Pagto" }, { "code": 101050, "slug": "saque_caixa_cartao_pagamento", "kind": null, "description": "Saque Caixa - Cartão Pagamento" }, { "code": 101051, "slug": "aplicacao_em_cdb_rdb", "kind": null, "description": "Aplicação em CDB/RDB" }, { "code": 101052, "slug": "ted", "kind": null, "description": "TED" }, { "code": 101053, "slug": "cheque_do_bacen", "kind": null, "description": "Cheque do Bacen" }, { "code": 101054, "slug": "tarifa_de_sustacao_de_cheque", "kind": null, "description": "Tarifa de Sustação de Cheque" }, { "code": 101055, "slug": "pagtos_diversos_autorizados", "kind": null, "description": "Pagtos Diversos Autorizados" }, { "code": 101056, "slug": "tarifa_servicos_diversos", "kind": null, "description": "Tarifa Serviços Diversos" }, { "code": 101057, "slug": "contribuicao", "kind": null, "description": "Contribuição" }, { "code": 101058, "slug": "emissao_de_doc", "kind": null, "description": "Emissão de DOC" }, { "code": 101059, "slug": "pagamento_de_boleto", "kind": null, "description": "Pagamento de Boleto" }, { "code": 101060, "slug": "despesas_cartoriais", "kind": null, "description": "Despesas Cartoriais" }, { "code": 101061, "slug": "pagamento_tributos", "kind": null, "description": "Pagamento Tributos" }, { "code": 101062, "slug": "ted_transf_eletr_disponivel", "kind": null, "description": "TED Transf Eletr Disponivel" }, { "code": 101063, "slug": "compra_de_acoes_via_doc", "kind": null, "description": "Compra de Ações via DOC" }, { "code": 101064, "slug": "despesas_diversas", "kind": null, "description": "Despesas Diversas" }, { "code": 101067, "slug": "saque_no_rural_rapido", "kind": null, "description": "Saque no Rural Rápido" }, { "code": 101068, "slug": "debito_tributos_res_d1", "kind": "debit", "description": "Débito Tributos Res D1" }, { "code": 101072, "slug": "diferenca_de_caixa", "kind": null, "description": "Diferença de Caixa" }, { "code": 101077, "slug": "transf_arrecadacao", "kind": null, "description": "Transf Arrecadação" }, { "code": 101081, "slug": "pagamento_seguro_bb", "kind": null, "description": "Pagamento Seguro BB" }, { "code": 101088, "slug": "estorna_lanc_hst_505", "kind": null, "description": "Estorna Lanc. HST.505" }, { "code": 101100, "slug": "movimento_de_caixa", "kind": null, "description": "Movimento de Caixa" }, { "code": 101101, "slug": "diario", "kind": null, "description": "Diário" }, { "code": 101102, "slug": "cheque_compensado", "kind": null, "description": "Cheque Compensado" }, { "code": 101103, "slug": "cheque_pago_em_outra_agencia", "kind": null, "description": "Cheque Pago em Outra Agência" }, { "code": 101104, "slug": "cota_previdenciaria", "kind": null, "description": "Cota Previdenciária" }, { "code": 101105, "slug": "comunicacao_remessa", "kind": null, "description": "Comunicação Remessa" }, { "code": 101106, "slug": "pagamento_cheque_visado", "kind": null, "description": "Pagamento Cheque Visado" }, { "code": 101107, "slug": "despesas_de_comissao", "kind": null, "description": "Despesas de Comissão" }, { "code": 101108, "slug": "emissao_de_orpag", "kind": null, "description": "Emissão de ORPAG" }, { "code": 101110, "slug": "estorno_acerto_credito", "kind": null, "description": "Estorno Acerto-Crédito" }, { "code": 101111, "slug": "transferencia_autorizada", "kind": null, "description": "Transferência Autorizada" }, { "code": 101112, "slug": "debito_autorizado", "kind": "debit", "description": "Débito Autorizado" }, { "code": 101114, "slug": "devolucao_cheque_depositado", "kind": null, "description": "Devolução Cheque Depositado" }, { "code": 101115, "slug": "aviso_de_debito", "kind": null, "description": "Aviso de Débito" }, { "code": 101116, "slug": "dividendos_de_acoes", "kind": null, "description": "Dividendos de Ações" }, { "code": 101117, "slug": "retencao", "kind": null, "description": "Retenção" }, { "code": 101118, "slug": "cobranca_de_i_o_f_", "kind": null, "description": "Cobrança de I.O.F." }, { "code": 101119, "slug": "a_c_fecob", "kind": null, "description": "A.C. FECOB" }, { "code": 101120, "slug": "transferido_para_poupanca", "kind": null, "description": "Transferido para Poupança" }, { "code": 101121, "slug": "transporte_de_saldo", "kind": null, "description": "Transporte de Saldo" }, { "code": 101122, "slug": "debito_bacen", "kind": "debit", "description": "Débito BACEN" }, { "code": 101123, "slug": "cobranca_de_juros", "kind": null, "description": "Cobrança de Juros" }, { "code": 101124, "slug": "debito_servico_cobranca", "kind": "debit", "description": "Débito Serviço Cobrança" }, { "code": 101125, "slug": "aplicacao_open", "kind": null, "description": "Aplicação Open" }, { "code": 101126, "slug": "mensalidade_unamibb", "kind": null, "description": "Mensalidade UNAMIBB" }, { "code": 101127, "slug": "tarifa_de_fornecimento_cheque", "kind": null, "description": "Tarifa de Fornecimento Cheque" }, { "code": 101128, "slug": "transf_entre_cooperativa", "kind": null, "description": "Transf entre Cooperativa" }, { "code": 101129, "slug": "tarifa_deposito_identificado", "kind": null, "description": "Tarifa Depósito Identificado" }, { "code": 101130, "slug": "anotacao_provisoria_debito", "kind": null, "description": "Anotação Provisória Débito" }, { "code": 101132, "slug": "emissao_de_ordem_bancaria", "kind": null, "description": "Emissão de Ordem Bancária" }, { "code": 101133, "slug": "seguro", "kind": null, "description": "Seguro" }, { "code": 101134, "slug": "regularizacao_poupanca_ouro", "kind": null, "description": "Regularização Poupança Ouro" }, { "code": 101135, "slug": "cpmf_liminar_cassada", "kind": null, "description": "CPMF liminar Cassada" }, { "code": 101136, "slug": "juros_s_liminar_cassada_cpmf", "kind": null, "description": "Juros s/Liminar Cassada CPMF" }, { "code": 101137, "slug": "multa_s_liminar_cassada_cpmf", "kind": null, "description": "Multa s/Liminar Cassada CPMF" }, { "code": 101138, "slug": "ac_rec_ags", "kind": null, "description": "Ac.Rec.Ags" }, { "code": 101139, "slug": "cpmf_poupanca_liminar_cassad", "kind": null, "description": "CPMF Poupança Liminar Cassada" }, { "code": 101140, "slug": "adiantamento", "kind": null, "description": "Adiantamento" }, { "code": 101141, "slug": "tarifa_saque_banco_24_horas", "kind": null, "description": "Tarifa Saque Banco 24 Horas" }, { "code": 101142, "slug": "tarifa_de_sms", "kind": null, "description": "Tarifa de SMS" }, { "code": 101143, "slug": "aluguel", "kind": null, "description": "Aluguel" }, { "code": 101144, "slug": "transferencia_enviada", "kind": null, "description": "Transferência enviada" }, { "code": 101145, "slug": "aplic_fundo_empresarial_di_60", "kind": null, "description": "Aplic Fundo Empresarial DI 60" }, { "code": 101146, "slug": "apropriacao", "kind": null, "description": "Apropriação" }, { "code": 101147, "slug": "desp_secex", "kind": null, "description": "Desp.SECEX" }, { "code": 101148, "slug": "baixa", "kind": null, "description": "Baixa" }, { "code": 101149, "slug": "bonificacao", "kind": null, "description": "Bonificação" }, { "code": 101150, "slug": "furnas_a_credito_rmho", "kind": null, "description": "Furnas a Crédito RMHO" }, { "code": 101151, "slug": "furnas_pagamento_de_pessoal", "kind": null, "description": "Furnas-Pagamento de Pessoal" }, { "code": 101152, "slug": "asbac", "kind": null, "description": "ASBAC" }, { "code": 101153, "slug": "cheque_bacen", "kind": null, "description": "Cheque BACEN" }, { "code": 101154, "slug": "cobranca_externa", "kind": null, "description": "Cobrança Externa" }, { "code": 101155, "slug": "consignacao", "kind": null, "description": "Consignação" }, { "code": 101158, "slug": "cassi", "kind": null, "description": "CASSI" }, { "code": 101159, "slug": "cooperativa", "kind": null, "description": "Cooperativa" }, { "code": 101160, "slug": "bordero", "kind": null, "description": "Borderô" }, { "code": 101161, "slug": "furnas_mn_eletr_", "kind": null, "description": "Furnas - MN Eletr." }, { "code": 101162, "slug": "tarifa_de_custodi", "kind": null, "description": "Tarifa de Custódia" }, { "code": 101163, "slug": "acerto_sistema_cr", "kind": null, "description": "Acerto Sistema CR" }, { "code": 101165, "slug": "despesas_de_manutencao", "kind": null, "description": "Despesas de Manutenção" }, { "code": 101167, "slug": "indenizacao_sinistro", "kind": null, "description": "Indenização Sinistro" }, { "code": 101168, "slug": "pagamento_de_ourocap", "kind": null, "description": "Pagamento de Ourocap" }, { "code": 101169, "slug": "devolucao", "kind": null, "description": "Devolução" }, { "code": 101170, "slug": "tarifas_servicos_diversos", "kind": null, "description": "Tarifas Serviços Diversos" }, { "code": 101171, "slug": "taxa_compra_e_venda_de_acoes", "kind": null, "description": "Taxa Compra e Venda de Ações" }, { "code": 101173, "slug": "aplicacao_bb_acoes_energia", "kind": null, "description": "Aplicação BB Ações Energia" }, { "code": 101174, "slug": "atualizacao", "kind": null, "description": "Atualização" }, { "code": 101175, "slug": "debito_de_acoes", "kind": "debit", "description": "Débito de Ações" }, { "code": 101176, "slug": "donativos", "kind": null, "description": "Donativos" }, { "code": 101177, "slug": "emprestimo", "kind": null, "description": "Empréstimo" }, { "code": 101178, "slug": "leilao_balcao_eletronico", "kind": null, "description": "Leilão/Balcão Eletrônico" }, { "code": 101179, "slug": "encargos", "kind": null, "description": "Encargos" }, { "code": 101180, "slug": "estorno_de_credito", "kind": null, "description": "Estorno de Crédito" }, { "code": 101181, "slug": "tarifa_de_saque_contra_recibo", "kind": null, "description": "Tarifa de saque contra recibo" }, { "code": 101182, "slug": "aplicacao_em_bb_cin", "kind": null, "description": "Aplicação em BB CIN" }, { "code": 101183, "slug": "saque_com_cartao_no_exterior", "kind": null, "description": "Saque com cartão no exterior" }, { "code": 101184, "slug": "est_anotacao_credito", "kind": null, "description": "Est. Anotação Crédito" }, { "code": 101185, "slug": "devolucao_cheque_leilao", "kind": null, "description": "Devolução Cheque Leilão" }, { "code": 101186, "slug": "imoveis", "kind": null, "description": "Imóveis" }, { "code": 101187, "slug": "tarifa_saque_caixa_ate_r_1mil", "kind": null, "description": "Tarifa Saque Caixa até R 1mil" }, { "code": 101188, "slug": "imposto_de_renda", "kind": null, "description": "Imposto de Renda" }, { "code": 101189, "slug": "emprestimo_cdc", "kind": null, "description": "Empréstimo CDC" }, { "code": 101190, "slug": "dco_pedagio_ag_01_9", "kind": null, "description": "DCO - Pedágio AG.01-9" }, { "code": 101191, "slug": "convenio_afpesp", "kind": null, "description": "Convênio AFPESP" }, { "code": 101192, "slug": "estorno_recebimento", "kind": null, "description": "Estorno Recebimento" }, { "code": 101193, "slug": "debito_secex", "kind": "debit", "description": "Débito SECEX" }, { "code": 101194, "slug": "mensalidade_seguro_saude", "kind": null, "description": "Mensalidade Seguro saúde" }, { "code": 101195, "slug": "debito_favor_inss", "kind": "debit", "description": "Débito Favor INSS" }, { "code": 101196, "slug": "inss_arrecadacao", "kind": null, "description": "INSS Arrecadação" }, { "code": 101197, "slug": "liberacoes", "kind": null, "description": "Liberações" }, { "code": 101198, "slug": "assefaz_pronto_socorro", "kind": null, "description": "ASSEFAZ Pronto-Socorro" }, { "code": 101199, "slug": "montreal_turismo_dco", "kind": null, "description": "Montreal Turismo - DCO" }, { "code": 101200, "slug": "dmr_debito", "kind": null, "description": "DMR-Débito" }, { "code": 101201, "slug": "tarifa_sustacao_de_cheque", "kind": null, "description": "Tarifa sustação de cheque" }, { "code": 101202, "slug": "taxa_do_banco_central", "kind": null, "description": "Taxa do Banco Central" }, { "code": 101203, "slug": "saque_agencia_exterior", "kind": null, "description": "Saque Agência Exterior" }, { "code": 101204, "slug": "cielo_cartoes", "kind": null, "description": "Cielo - Cartoes" }, { "code": 101205, "slug": "tarifa_gerenciador_financeiro", "kind": null, "description": "Tarifa Gerenciador Financeiro" }, { "code": 101206, "slug": "passagens", "kind": null, "description": "Passagens" }, { "code": 101207, "slug": "pensao", "kind": null, "description": "Pensão" }, { "code": 101208, "slug": "trs_antecip_e_estornad", "kind": null, "description": "TRS ANTECIPADA E ESTORNADA" }, { "code": 101209, "slug": "prestacao_de_contas", "kind": null, "description": "Prestação de Contas" }, { "code": 101211, "slug": "provisao", "kind": null, "description": "Provisão" }, { "code": 101212, "slug": "un_nac_assist_servidor", "kind": null, "description": "UN.NAC.ASSIST.SERVIDOR" }, { "code": 101213, "slug": "encargos_trans_antecip", "kind": null, "description": "ENCARGOS TRANS ANTECIPADA" }, { "code": 101214, "slug": "tarifa_sobre_saque", "kind": null, "description": "Tarifa sobre Saque" }, { "code": 101215, "slug": "comissao_sobre_saque", "kind": null, "description": "Comissão sobre Saque" }, { "code": 101216, "slug": "dco_38583_grenasp_ag_4", "kind": null, "description": "DCO 38583-GRENASP-AG.4" }, { "code": 101217, "slug": "reserva", "kind": null, "description": "Reserva" }, { "code": 101218, "slug": "registro", "kind": null, "description": "Registro" }, { "code": 101219, "slug": "saque_c_liquidacao_antecipada", "kind": null, "description": "Saque c/ Liquidação Antecipada" }, { "code": 101220, "slug": "desativado", "kind": null, "description": "Desativado" }, { "code": 101221, "slug": "repasse", "kind": null, "description": "Repasse" }, { "code": 101224, "slug": "antecipacao_credito_ao_lojista", "kind": null, "description": "Antecipação Crédito ao Lojista" }, { "code": 101225, "slug": "tarifa_de_auto_atendimento_bb", "kind": null, "description": "Tarifa de Auto-Atendimento BB" }, { "code": 101226, "slug": "saldo_transferido", "kind": null, "description": "Saldo Transferido" }, { "code": 101227, "slug": "subscricao_de_acoes", "kind": null, "description": "Subscrição de Ações" }, { "code": 101228, "slug": "ourocard_business_card", "kind": null, "description": "OUROCARD-Business Card" }, { "code": 101229, "slug": "transferencia_de_saldo", "kind": null, "description": "Transferência de Saldo" }, { "code": 101230, "slug": "juros_sem_liminar_cassada", "kind": null, "description": "Juros sem Liminar Cassada" }, { "code": 101231, "slug": "tarifa_de_manutencao_de_conta", "kind": null, "description": "Tarifa de manutenção de conta" }, { "code": 101232, "slug": "multa_sem_liminar_cassada", "kind": null, "description": "Multa sem Liminar Cassada" }, { "code": 101234, "slug": "compra_com_cartao", "kind": null, "description": "Compra com Cartão" }, { "code": 101235, "slug": "custodia_petrobras", "kind": null, "description": "Custódia Petrobrás" }, { "code": 101236, "slug": "ferias_licenca_premio", "kind": null, "description": "Férias Licença Prêmio" }, { "code": 101237, "slug": "financiamento_poupex", "kind": null, "description": "Financiamento POUPEX" }, { "code": 101238, "slug": "transfer_conta_centralizadora", "kind": null, "description": "Transfer.conta centralizadora" }, { "code": 101239, "slug": "tarifa_adiant_a_depositante", "kind": null, "description": "Tarifa Adiantada a Depositante" }, { "code": 101241, "slug": "debito_centralizado", "kind": "debit", "description": "Débito Centralizado" }, { "code": 101242, "slug": "debito_prestacao_leasing", "kind": "debit", "description": "Débito Prestação Leasing" }, { "code": 101243, "slug": "cheque_avulso_entre_agencias", "kind": null, "description": "Cheque Avulso entre Agências" }, { "code": 101244, "slug": "tarifa_remessa_talao_cheque", "kind": null, "description": "Tarifa remessa talão cheque" }, { "code": 101245, "slug": "taxa_confecc_cadastro", "kind": null, "description": "Taxa Confecc Cadastro" }, { "code": 101246, "slug": "anabb", "kind": null, "description": "ANABB" }, { "code": 101247, "slug": "apabb", "kind": null, "description": "APABB" }, { "code": 101248, "slug": "estorno_resgate_automatico", "kind": null, "description": "Estorno Resgate Automático" }, { "code": 101249, "slug": "fam_fhe", "kind": null, "description": "FAM FHE" }, { "code": 101250, "slug": "folha_de_pagamento", "kind": null, "description": "Folha de Pagamento" }, { "code": 101251, "slug": "conversao_p_o_real", "kind": null, "description": "Conversão P/ o Real" }, { "code": 101252, "slug": "dco_aafb", "kind": null, "description": "DCO - AAFB" }, { "code": 101253, "slug": "debito_carim", "kind": "debit", "description": "Débito CARIM" }, { "code": 101254, "slug": "proex", "kind": null, "description": "Proex" }, { "code": 101255, "slug": "debito_beneficio", "kind": "debit", "description": "Débito Benefício" }, { "code": 101256, "slug": "tarifa_conv_sicredi", "kind": null, "description": "Tarifa Conv.SICREDI" }, { "code": 101257, "slug": "debito_serv_cambio", "kind": "debit", "description": "Débito Serv.Cambio" }, { "code": 101258, "slug": "prestacao_de_servicos", "kind": null, "description": "Prestação de Serviços" }, { "code": 101259, "slug": "estorno_devolucao_cpmf", "kind": null, "description": "Estorno Devolução CPMF" }, { "code": 101261, "slug": "tarifa_de_cartao_magnetico", "kind": null, "description": "Tarifa de cartão magnético" }, { "code": 101262, "slug": "tarifa_de_abertura_de_credito", "kind": null, "description": "Tarifa de abertura de crédito" }, { "code": 101263, "slug": "tarifa_de_extrato", "kind": null, "description": "Tarifa de Extrato" }, { "code": 101264, "slug": "juros_saldo_devedor", "kind": null, "description": "Juros Saldo Devedor" }, { "code": 101265, "slug": "iof_s_saldo_devedor", "kind": null, "description": "IOF S/Saldo Devedor" }, { "code": 101266, "slug": "aplicacao_em_bb_cdb_tr", "kind": null, "description": "Aplicação em BB CDB TR" }, { "code": 101267, "slug": "gerof_tit_compra", "kind": null, "description": "GEROF - TIT. COMPRA" }, { "code": 101268, "slug": "devolucao_conab", "kind": null, "description": "DEVOLUÇÃO CONAB" }, { "code": 101269, "slug": "bb_fif_c_prazo_apl_aut", "kind": null, "description": "BB-FIF C.PRAZO-APL.AUT" }, { "code": 101271, "slug": "bb_aplic_c_prz_apl_aut", "kind": null, "description": "BB-APLIC C.PRZ-APL.AUT" }, { "code": 101272, "slug": "compra_de_acoes", "kind": null, "description": "Compra de Ações" }, { "code": 101273, "slug": "aplicacao_em_bb_cdb_di", "kind": null, "description": "Aplicação em BB CDB DI" }, { "code": 101274, "slug": "aplicacao_em_cdb_rdb_cheque", "kind": null, "description": "Aplicação em CDB/RDB - cheque" }, { "code": 101275, "slug": "tarifa_de_devolucao_de_cheque", "kind": null, "description": "Tarifa de devolução de cheque" }, { "code": 101276, "slug": "comp_divida_cartao_cre", "kind": null, "description": "COMP.DIVIDA CARTAO CRE" }, { "code": 101278, "slug": "aquis_gov_fed_conab", "kind": null, "description": "AQUIS GOV FED - CONAB" }, { "code": 101279, "slug": "bb_vendor", "kind": null, "description": "BB Vendor" }, { "code": 101281, "slug": "amort_liq_securitiz_bb", "kind": null, "description": "AMORT/LIQ SECURITIZ BB" }, { "code": 101282, "slug": "previ_carim_dco_43726", "kind": null, "description": "PREVI/CARIM-DCO 43726" }, { "code": 101283, "slug": "amort_liq_securit_outr", "kind": null, "description": "AMORT/LIQ SECURIT OUTR" }, { "code": 101284, "slug": "debito_bloq_judicial", "kind": "debit", "description": "DÉBITO BLOQ. JUDICIAL" }, { "code": 101285, "slug": "acerto_entre_ctas_arre", "kind": null, "description": "ACERTO ENTRE CTAS ARRE" }, { "code": 101286, "slug": "rateio_ipva_entre_muni", "kind": null, "description": "RATEIO IPVA ENTRE MUNICÍPIOS" }, { "code": 101287, "slug": "pasep_fopag", "kind": null, "description": "PASEP FOPAG" }, { "code": 101288, "slug": "aplicacao_cbi", "kind": null, "description": "APLICAÇÃO CBI" }, { "code": 101289, "slug": "aplic_fif_curto_prazo", "kind": null, "description": "APLICAÇÃO FIF CURTO PRAZO" }, { "code": 101290, "slug": "aplicacao_em_fundo_de_acoes", "kind": null, "description": "Aplicação em Fundo de Ações" }, { "code": 101291, "slug": "aplicacao_em_fundo", "kind": null, "description": "Aplicação em Fundo" }, { "code": 101292, "slug": "lancamento_bbdtvm", "kind": null, "description": "LANÇAMENTO BBDTVM" }, { "code": 101293, "slug": "fornecim_combustivel", "kind": null, "description": "FORNECIMENTO COMBUSTÍVEL" }, { "code": 101294, "slug": "contribuicao_amatra", "kind": null, "description": "CONTRIBUIÇÃO AMATRA" }, { "code": 101295, "slug": "est_seguro_inflacao", "kind": null, "description": "EST. SEGURO INFLAÇÃO" }, { "code": 101296, "slug": "est_de_juros", "kind": null, "description": "EST. DE JUROS" }, { "code": 101299, "slug": "dl_compra", "kind": null, "description": "DL COMPRA" }, { "code": 101300, "slug": "ch_compe_nacional", "kind": null, "description": "CH. COMPE NACIONAL" }, { "code": 101301, "slug": "pagto_divida_governo", "kind": null, "description": "PAGTO DIVIDA GOVERNO" }, { "code": 101302, "slug": "compra_web", "kind": null, "description": "Compra-WEB" }, { "code": 101303, "slug": "pagto_via_auto_atendimento_bb", "kind": null, "description": "Pagto via Auto-Atendimento BB" }, { "code": 101304, "slug": "operacoes_bmf", "kind": null, "description": "Operações BMF" }, { "code": 101305, "slug": "apl_bb_princ_garantido", "kind": null, "description": "APL BB-PRINC.GARANTIDO" }, { "code": 101306, "slug": "pagamento_bbcpr", "kind": null, "description": "Pagamento BBCPR" }, { "code": 101308, "slug": "ass_j_tarde_estadao", "kind": null, "description": "ASS J.TARDE ESTADÃO" }, { "code": 101309, "slug": "trf_compe_com_d1_cmf", "kind": null, "description": "TRF COMPE COM D+1 CMF" }, { "code": 101310, "slug": "tarifa_de_doc_ou_ted", "kind": null, "description": "Tarifa de DOC ou TED" }, { "code": 101311, "slug": "tarifa_renovacao_limite_credit", "kind": null, "description": "Tarifa renovação limite crédito" }, { "code": 101312, "slug": "cheque_pre_datado", "kind": null, "description": "Cheque Pré-datado" }, { "code": 101313, "slug": "saldo_dev_transf_bema", "kind": null, "description": "SALDO DEV. TRANSF BEMA" }, { "code": 101314, "slug": "diferencial_de_swap", "kind": null, "description": "DIFERENCIAL DE SWAP" }, { "code": 101315, "slug": "governo_pe_transf_icms", "kind": null, "description": "GOVERNO PE TRANSF ICMS" }, { "code": 101316, "slug": "governo_pe_transf_ipva", "kind": null, "description": "GOVERNO PE TRANSF IPVA" }, { "code": 101317, "slug": "governo_pe_transf_gnr", "kind": null, "description": "GOVERNO PE TRANSF GNR" }, { "code": 101318, "slug": "governo_pe_transf_btp", "kind": null, "description": "GOVERNO PE TRANSF BTP" }, { "code": 101319, "slug": "aplicacao_fundo_private", "kind": null, "description": "Aplicação Fundo Private" }, { "code": 101320, "slug": "cpmf", "kind": null, "description": "Cpmf" }, { "code": 101321, "slug": "the_cash", "kind": null, "description": "THE CASH" }, { "code": 101322, "slug": "bompreco", "kind": null, "description": "Bompreço" }, { "code": 101323, "slug": "mercadorama", "kind": null, "description": "Mercadorama" }, { "code": 101324, "slug": "banco_24_horas", "kind": null, "description": "Banco 24 Horas" }, { "code": 101325, "slug": "pagamento_com_cartao", "kind": null, "description": "Pagamento com cartão" }, { "code": 101326, "slug": "cheque_eletr_tecban", "kind": null, "description": "CHEQUE ELETR. TECBAN" }, { "code": 101327, "slug": "tarifa_tef_tecban", "kind": null, "description": "Tarifa TEF TECBAN" }, { "code": 101328, "slug": "pagto_cartao_credito", "kind": null, "description": "Pagto cartão crédito" }, { "code": 101329, "slug": "autocaixa", "kind": null, "description": "Autocaixa" }, { "code": 101332, "slug": "hipermidia_tecban", "kind": null, "description": "HIPERMIDIA-TECBAN" }, { "code": 101333, "slug": "aluguel_de_p_o_s_tecban", "kind": null, "description": "Aluguel de P.O.S. Tecban" }, { "code": 101334, "slug": "sendas", "kind": null, "description": "Sendas" }, { "code": 101335, "slug": "aplicacao_em_bb_fiex", "kind": null, "description": "Aplicação em BB Fiex" }, { "code": 101336, "slug": "valetik", "kind": null, "description": "Valetik" }, { "code": 101337, "slug": "taxa_de_aval_bbcpr", "kind": null, "description": "TAXA DE AVAL BBCPR" }, { "code": 101338, "slug": "desp_finame_sist_cf", "kind": null, "description": "DESP. FINAME - SIST.CF" }, { "code": 101339, "slug": "export_notes_deref", "kind": null, "description": "EXPORT NOTES - DEREF" }, { "code": 101340, "slug": "bolsa_auxilio", "kind": null, "description": "Bolsa auxílio" }, { "code": 101341, "slug": "auxilio_creche", "kind": null, "description": "Auxílio creche" }, { "code": 101342, "slug": "importacao_siscomex", "kind": null, "description": "Importação siscomex" }, { "code": 101343, "slug": "dc0_internet", "kind": null, "description": "DC0 - INTERNET" }, { "code": 101344, "slug": "tarifa_s_saque_rede_branca", "kind": null, "description": "Tarifa S/Saque Rede Branca" }, { "code": 101345, "slug": "aplicacao_em_bb_fix", "kind": null, "description": "Aplicação em BB Fix" }, { "code": 101346, "slug": "aplicacao_em_renda_fixa_di", "kind": null, "description": "Aplicação em Renda Fixa DI" }, { "code": 101347, "slug": "aplicacao_bb_fdos_extramercado", "kind": null, "description": "Aplicação BB Fdos.Extramercado" }, { "code": 101348, "slug": "aplicacao_bb_aplic_curto_prazo", "kind": null, "description": "Aplicação BB Aplic Curto Prazo" }, { "code": 101349, "slug": "bb_acoes_indice", "kind": null, "description": "BB Ações Índice" }, { "code": 101350, "slug": "cota_daf_debito", "kind": null, "description": "COTA DAF-DÉBITO" }, { "code": 101352, "slug": "deb_sistema_cda_bsb", "kind": null, "description": "DEB.SISTEMA CDA -BSB" }, { "code": 101353, "slug": "tarifa_sobre_acoes", "kind": null, "description": "Tarifa sobre ações" }, { "code": 101357, "slug": "carrefour", "kind": null, "description": "Carrefour" }, { "code": 101360, "slug": "oc_op_e_dr", "kind": null, "description": "OC/OP E DR" }, { "code": 101361, "slug": "pagamento_conta_agua", "kind": null, "description": "Pagamento conta água" }, { "code": 101362, "slug": "pagamento_conta_luz", "kind": null, "description": "Pagamento conta luz" }, { "code": 101363, "slug": "pagamento_conta_telefone", "kind": null, "description": "Pagamento conta telefone" }, { "code": 101364, "slug": "pagamento_consorcio", "kind": null, "description": "Pagamento consórcio" }, { "code": 101365, "slug": "jornal_ou_revistas", "kind": null, "description": "Jornal ou revistas" }, { "code": 101366, "slug": "condominio", "kind": null, "description": "Condomínio" }, { "code": 101367, "slug": "sindicato", "kind": null, "description": "Sindicato" }, { "code": 101368, "slug": "bancorbras", "kind": null, "description": "Bancorbrás" }, { "code": 101369, "slug": "bb_turismo", "kind": null, "description": "BB Turismo" }, { "code": 101370, "slug": "cooperforte", "kind": null, "description": "COOPERFORTE" }, { "code": 101371, "slug": "satelite_seguros", "kind": null, "description": "Satélite seguros" }, { "code": 101372, "slug": "escola", "kind": null, "description": "Escola" }, { "code": 101373, "slug": "aabb", "kind": null, "description": "AABB" }, { "code": 101374, "slug": "mensalidade_clube", "kind": null, "description": "Mensalidade clube" }, { "code": 101375, "slug": "impostos", "kind": null, "description": "Impostos" }, { "code": 101376, "slug": "unimed", "kind": null, "description": "UNIMED" }, { "code": 101377, "slug": "pagto_premio_seguro", "kind": null, "description": "PAGTO PRÊMIO SEGURO" }, { "code": 101378, "slug": "pagamento_conta_gas", "kind": null, "description": "Pagamento conta gás" }, { "code": 101379, "slug": "unafisco", "kind": null, "description": "UNAFISCO" }, { "code": 101380, "slug": "tv_por_assinatura", "kind": null, "description": "TV por assinatura" }, { "code": 101381, "slug": "remuneracao_sobre_acoe", "kind": null, "description": "REMUNERAÇÃO SOBRE AÇÕES" }, { "code": 101382, "slug": "debito_de_carnet", "kind": "debit", "description": "DÉBITO DE CARNET" }, { "code": 101383, "slug": "agendamento_debito_dar", "kind": null, "description": "AGENDAMENTO DÉBITO DAR" }, { "code": 101384, "slug": "agendamento_debito_grp", "kind": null, "description": "AGENDAMENTO DÉBITO GRP" }, { "code": 101385, "slug": "agendamento_debito_grc", "kind": null, "description": "AGENDAMENTO DÉBITO GRC" }, { "code": 101386, "slug": "agendam_debito_icms_s", "kind": null, "description": "AGENDAM. DÉBITO ICMS-S" }, { "code": 101387, "slug": "concurso", "kind": null, "description": "Concurso" }, { "code": 101388, "slug": "aplicacao_aplic_plus", "kind": null, "description": "APLICAÇÃO APLIC PLUS" }, { "code": 101389, "slug": "fdo_estorno", "kind": null, "description": "FDO-ESTORNO" }, { "code": 101390, "slug": "aplicacao_em_bb_multicarteira", "kind": null, "description": "Aplicação em BB Multicarteira" }, { "code": 101391, "slug": "aplic_fundo_moderado", "kind": null, "description": "APLIC FUNDO MODERADO" }, { "code": 101392, "slug": "tarif_adicion_cheque_r_5mil", "kind": null, "description": "Tarif.Adicion.Cheque R 5mil" }, { "code": 101394, "slug": "aplicacao_em_bb_fapi", "kind": null, "description": "Aplicação em BB FAPI" }, { "code": 101395, "slug": "plus_aut_aplic_autom", "kind": null, "description": "PLUS AUT APLICAÇÃO AUTOMÁTICA" }, { "code": 101396, "slug": "plus_cp_aplicacao", "kind": null, "description": "PLUS CP APLICAÇÃO" }, { "code": 101398, "slug": "aplicacao_em_bb_cdb_pre", "kind": null, "description": "Aplicação em BB CDB Pré" }, { "code": 101399, "slug": "aplicacao_em_bb_aplic_pos", "kind": null, "description": "Aplicação em BB Aplic Pós" }, { "code": 101400, "slug": "transferencia_beron", "kind": null, "description": "TRANSFERÊNCIA BERON" }, { "code": 101401, "slug": "aplicacao_bb_aplic_pub", "kind": null, "description": "APLICAÇÃO BB APLIC PUB" }, { "code": 101402, "slug": "aplicacao_bb_aplic_cor", "kind": null, "description": "Aplicação BB APLIC COR" }, { "code": 101403, "slug": "aplicacao_bb_fundos_exclusivos", "kind": null, "description": "Aplicação BB Fundos Exclusivos" }, { "code": 101404, "slug": "debito_programado_abril_s_a_", "kind": "debit", "description": "Débito programado Abril S.A." }, { "code": 101405, "slug": "tarifa_centralizacao_de_saldo", "kind": null, "description": "Tarifa Centralização de Saldo" }, { "code": 101406, "slug": "convenio_leasing", "kind": null, "description": "Convênio leasing" }, { "code": 101407, "slug": "debito_bb_previdencia", "kind": "debit", "description": "DÉBITO BB PREVIDÊNCIA" }, { "code": 101408, "slug": "cheque_descontado", "kind": null, "description": "Cheque descontado" }, { "code": 101409, "slug": "contribuicao_afesp", "kind": null, "description": "CONTRIBUIÇÃO AFESP" }, { "code": 101410, "slug": "desbloqueio_de_deposito", "kind": null, "description": "Desbloqueio de depósito" }, { "code": 101411, "slug": "estorno_deposito_1_dia", "kind": null, "description": "Estorno depósito 1 dia" }, { "code": 101412, "slug": "estorno_dep_bl_2_d", "kind": null, "description": "ESTORNO DEP. BL. 2 D" }, { "code": 101413, "slug": "estorno_dep_bl_3_d", "kind": null, "description": "ESTORNO DEP. BL. 3 D" }, { "code": 101414, "slug": "estorno_dep_bl_4_d", "kind": null, "description": "ESTORNO DEP. BL. 4 D" }, { "code": 101415, "slug": "estorno_dep_bl_5_d", "kind": null, "description": "ESTORNO DEP. BL. 5 D" }, { "code": 101416, "slug": "estorno_dep_bl_6_d", "kind": null, "description": "ESTORNO DEP. BL. 6 D" }, { "code": 101417, "slug": "estorno_dep_bl_7_d", "kind": null, "description": "ESTORNO DEP. BL. 7 D" }, { "code": 101418, "slug": "estorno_dep_bl_8_d", "kind": null, "description": "ESTORNO DEP. BL. 8 D" }, { "code": 101419, "slug": "estorno_dep_bl_9_d", "kind": null, "description": "ESTORNO DEP. BL. 9 D" }, { "code": 101420, "slug": "estorno_dep_bl_ind", "kind": null, "description": "ESTORNO DEP. BL. IND" }, { "code": 101421, "slug": "est_bloqueio_liberado", "kind": null, "description": "EST. BLOQUEIO LIBERADO" }, { "code": 101422, "slug": "debito_geap", "kind": "debit", "description": "DÉBITO GEAP" }, { "code": 101423, "slug": "aplicacao_em_bb_fix_di_60_cpmf", "kind": null, "description": "Aplicação em BB Fix DI 60 CPMF" }, { "code": 101424, "slug": "clube_de_compras_0800", "kind": null, "description": "CLUBE DE COMPRAS 0800" }, { "code": 101425, "slug": "aplicacao_bb_fix_cpmf_diario", "kind": null, "description": "Aplicação BB Fix CPMF Diário" }, { "code": 101426, "slug": "tarifa_bb_giro_rapido", "kind": null, "description": "TARIFA BB GIRO RÁPIDO" }, { "code": 101427, "slug": "bb_fix_di_30", "kind": null, "description": "BB FIX DI 30" }, { "code": 101428, "slug": "financiamento_veiculo", "kind": null, "description": "Financiamento Veículo" }, { "code": 101429, "slug": "tarifa_processamento_de_cheque", "kind": null, "description": "Tarifa Processamento de Cheque" }, { "code": 101430, "slug": "tar_chq_proc_abx_r_10", "kind": null, "description": "TAR.CHQ.PROC. ABX.R 10" }, { "code": 101431, "slug": "tarifa_processamento_deposito", "kind": null, "description": "Tarifa processamento depósito" }, { "code": 101432, "slug": "tarifa_saque_em_taa_terceiros", "kind": null, "description": "Tarifa saque em TAA terceiros" }, { "code": 101434, "slug": "ajuda_alimentacao", "kind": null, "description": "AJUDA ALIMENTAÇÃO" }, { "code": 101435, "slug": "tarifa_de_pacote_de_servicos", "kind": null, "description": "Tarifa de Pacote de Serviços" }, { "code": 101436, "slug": "telefone_pre_pago", "kind": null, "description": "TELEFONE PRE-PAGO" }, { "code": 101437, "slug": "cancel_conv_cta_unic", "kind": null, "description": "CANCEL. CONV. CTA UNIC" }, { "code": 101439, "slug": "sindfisco_df", "kind": null, "description": "SINDFISCO-DF" }, { "code": 101440, "slug": "rsg_acoes_telebrasil", "kind": null, "description": "RSG AÇÕES TELEBRASIL" }, { "code": 101441, "slug": "estorno_da_plr", "kind": null, "description": "Estorno da PLR" }, { "code": 101442, "slug": "tarifa_extrato_unificado", "kind": null, "description": "Tarifa Extrato Unificado" }, { "code": 101443, "slug": "contr_ass_tecn_tes_nac", "kind": null, "description": "CONTR.ASS.TECN.TES.NAC" }, { "code": 101444, "slug": "parcelamento_div_inss", "kind": null, "description": "PARCELAMENTO DIV. INSS" }, { "code": 101445, "slug": "pix_enviado", "kind": null, "description": "Pix Enviado" }, { "code": 101447, "slug": "aplicacao_fdo_bb_dolar", "kind": null, "description": "APLICAÇÃO FDO BB-DOLAR" }, { "code": 101448, "slug": "aplicacao_fdo_milenio", "kind": null, "description": "APLICAÇÃO FDO MILENIO" }, { "code": 101449, "slug": "sq_cart_eletr_tsf", "kind": null, "description": "SQ CART.ELETR TSF" }, { "code": 101450, "slug": "sq_cart_eletr_tcx", "kind": null, "description": "SQ CART.ELETR TCX" }, { "code": 101451, "slug": "orban_flux", "kind": null, "description": "ORBAN FLUX" }, { "code": 101452, "slug": "cheque_pago", "kind": null, "description": "Cheque Pago" }, { "code": 101453, "slug": "cheque_devolvido", "kind": null, "description": "CHEQUE DEVOLVIDO" }, { "code": 101455, "slug": "ch_tb_compe_nacional", "kind": null, "description": "CH. TB COMPE NACIONAL" }, { "code": 101456, "slug": "cheque_tb_compensado", "kind": null, "description": "Cheque TB Compensado" }, { "code": 101457, "slug": "pagamento_cheque_tb", "kind": null, "description": "Pagamento Cheque TB" }, { "code": 101458, "slug": "pagamento_cheque_tb_na", "kind": null, "description": "PAGAMENTO CHEQUE TB NA" }, { "code": 101459, "slug": "ch_com_rem_cpmf0", "kind": null, "description": "CH.COM.REM.CPMF0" }, { "code": 101461, "slug": "pagamento_eletronico_boleto", "kind": null, "description": "Pagamento Eletrônico Boleto" }, { "code": 101462, "slug": "apl_fundo_acoes_coelba", "kind": null, "description": "APL FUNDO AÇÕES COELBA" }, { "code": 101463, "slug": "estorno_transf_p_cobr", "kind": null, "description": "ESTORNO TRANSF.P/COBR" }, { "code": 101465, "slug": "brasilprev", "kind": null, "description": "Brasilprev" }, { "code": 101466, "slug": "aplicacao_em_fundo_fix_di_60", "kind": null, "description": "Aplicação em Fundo Fix DI 60" }, { "code": 101467, "slug": "amort_liq_rural_rapid", "kind": null, "description": "AMORT/LIQ. RURAL RÁPIDO" }, { "code": 101468, "slug": "drivers_card", "kind": null, "description": "DRIVERS CARD" }, { "code": 101469, "slug": "aplicacao_bb_fundos_privativos", "kind": null, "description": "Aplicação BB Fundos Privativos" }, { "code": 101471, "slug": "aplicacao_bb_fix_30", "kind": null, "description": "APLICAÇÃO BB-FIX 30" }, { "code": 101472, "slug": "estorno_commodities", "kind": null, "description": "ESTORNO COMMODITIES" }, { "code": 101473, "slug": "renda_fixa_estorno", "kind": null, "description": "RENDA FIXA - ESTORNO" }, { "code": 101475, "slug": "aplicacao_em_poupanca", "kind": null, "description": "Aplicação em Poupança" }, { "code": 101476, "slug": "tributos_estaduais", "kind": null, "description": "TRIBUTOS ESTADUAIS" }, { "code": 101477, "slug": "aplicacao_bb_empresarial", "kind": null, "description": "APLICAÇÃO BB EMPRESARIAL" }, { "code": 101479, "slug": "aplicacao_em_bb_premium", "kind": null, "description": "Aplicação em BB Premium" }, { "code": 101481, "slug": "proagro_cooperativas", "kind": null, "description": "PROAGRO COOPERATIVAS" }, { "code": 101482, "slug": "deposito_em_bb_reaplic", "kind": null, "description": "Depósito em BB Reaplicação" }, { "code": 101483, "slug": "aplicacao_em_bb_cambial", "kind": null, "description": "Aplicação em BB Cambial" }, { "code": 101484, "slug": "bb_acoes_master", "kind": null, "description": "BB-AÇÕES MASTER" }, { "code": 101485, "slug": "regul_recolhim_indevid", "kind": null, "description": "REGUL.RECOLHIM INDEVID" }, { "code": 101486, "slug": "debito_por_ordem_nucle", "kind": "debit", "description": "DÉBITO POR ORDEM NÚCLEO" }, { "code": 101487, "slug": "aplicacao_fundo_acoes_en", "kind": null, "description": "APLICAÇÃO FUNDO AÇÕES EN" }, { "code": 101488, "slug": "estorna_hst_605_657", "kind": null, "description": "ESTORNA HST 605/657" }, { "code": 101489, "slug": "deb_automat_vitalmed", "kind": null, "description": "DEB. AUTOMAT. VITALMED" }, { "code": 101490, "slug": "pagamento_fornecedor", "kind": null, "description": "PAGAMENTO FORNECEDOR" }, { "code": 101491, "slug": "aplic_bb_commodities", "kind": null, "description": "APLICAÇÃO. BB-COMMODITIES" }, { "code": 101492, "slug": "aquisicao_ctn_pesa", "kind": null, "description": "AQUISIÇÃO CTN PESA" }, { "code": 101493, "slug": "cop_dbto_automatico", "kind": null, "description": "COP DBTO AUTOMÁTICO" }, { "code": 101494, "slug": "debito_grupo_afinidade", "kind": "debit", "description": "DÉBITO GRUPO AFINIDADE" }, { "code": 101496, "slug": "desp_manut_estoq_conab", "kind": null, "description": "DESP MANUT ESTOQ CONAB" }, { "code": 101497, "slug": "assefaz", "kind": null, "description": "ASSEFAZ" }, { "code": 101498, "slug": "debito_grupo_co_brande", "kind": "debit", "description": "DÉBITO GRUPO CO-BRANDE" }, { "code": 101499, "slug": "tarifa_adicional_orpag", "kind": null, "description": "Tarifa Adicional ORPAG" }, { "code": 101500, "slug": "movimento_do_dia", "kind": null, "description": "Movimento do Dia" }, { "code": 101501, "slug": "caixa", "kind": null, "description": "Caixa" }, { "code": 101502, "slug": "deposito_em_dinheiro", "kind": null, "description": "Depósito em Dinheiro" }, { "code": 101503, "slug": "deposito_inicial", "kind": null, "description": "Depósito Inicial" }, { "code": 101504, "slug": "cobranca", "kind": null, "description": "Cobrança" }, { "code": 101505, "slug": "deposito_em_cheque_liber", "kind": null, "description": "Depósito em cheque liberado" }, { "code": 101506, "slug": "deposito_em_cheque_bb_lib", "kind": null, "description": "Depósito em cheque BB liberado" }, { "code": 101507, "slug": "estorno_de_pagamento", "kind": null, "description": "Estorno de Pagamento" }, { "code": 101508, "slug": "recebimento_de_guias", "kind": null, "description": "Recebimento de Guias" }, { "code": 101509, "slug": "recomposicao_de_provento", "kind": null, "description": "Recomposição de Provento" }, { "code": 101510, "slug": "deposito_cheque_bb_liqui", "kind": null, "description": "Depósito Cheque BB Liquidado" }, { "code": 101511, "slug": "deposito_bloqueado_1_dia", "kind": null, "description": "Depósito bloqueado 1 dia" }, { "code": 101512, "slug": "deposito_bloqueado_2dias", "kind": null, "description": "Depósito bloqueado 2dias" }, { "code": 101513, "slug": "deposito_bloqueado_3dias", "kind": null, "description": "Depósito bloqueado 3dias" }, { "code": 101514, "slug": "deposito_bloqueado_4dias", "kind": null, "description": "Depósito bloqueado 4dias" }, { "code": 101515, "slug": "deposito_bloqueado_5dias", "kind": null, "description": "Depósito bloqueado 5dias" }, { "code": 101516, "slug": "deposito_bloqueado_6dias", "kind": null, "description": "Depósito bloqueado 6dias" }, { "code": 101517, "slug": "deposito_bloqueado_7dias", "kind": null, "description": "Depósito bloqueado 7dias" }, { "code": 101518, "slug": "deposito_bloqueado_8dias", "kind": null, "description": "Depósito bloqueado 8dias" }, { "code": 101519, "slug": "deposito_bloqueado_9dias", "kind": null, "description": "Depósito bloqueado 9dias" }, { "code": 101520, "slug": "deposito_bloquead_20dias", "kind": null, "description": "Depósito bloqueado 20dias" }, { "code": 101530, "slug": "deposito_com_cartao", "kind": null, "description": "Depósito com Cartão" }, { "code": 101532, "slug": "ordem_bancaria", "kind": null, "description": "Ordem Bancária" }, { "code": 101533, "slug": "seguros", "kind": null, "description": "Seguros" }, { "code": 101534, "slug": "corretagem", "kind": null, "description": "Corretagem" }, { "code": 101541, "slug": "resgate_poupanca", "kind": null, "description": "Resgate Poupança" }, { "code": 101545, "slug": "rem_n_exp_", "kind": null, "description": "Rem N.Exp." }, { "code": 101551, "slug": "resgate_cdb_rdb", "kind": null, "description": "Resgate CDB/RDB" }, { "code": 101555, "slug": "recebimentos", "kind": null, "description": "Recebimentos" }, { "code": 101558, "slug": "recolhimentos", "kind": null, "description": "Recolhimentos" }, { "code": 101560, "slug": "finame", "kind": null, "description": "FINAME" }, { "code": 101568, "slug": "ordem_de_pagamento", "kind": null, "description": "Ordem de Pagamento" }, { "code": 101575, "slug": "estorno_lancamento", "kind": null, "description": "Estorno Lançamento" }, { "code": 101577, "slug": "saque_do_pasep", "kind": null, "description": "Saque do PASEP" }, { "code": 101580, "slug": "estorno_autenticacao_pagament", "kind": null, "description": "Estorno Autenticação Pagamento" }, { "code": 101590, "slug": "est_aut_pgt_ipmf", "kind": null, "description": "Est Aut Pgt IPMF" }, { "code": 101598, "slug": "cheque_de_viagem", "kind": null, "description": "Cheque de Viagem" }, { "code": 101602, "slug": "adiantamento_de_proventos", "kind": null, "description": "Adiantamento de Proventos" }, { "code": 101603, "slug": "cheque_devolvido_sem_fundo", "kind": null, "description": "Cheque Devolvido Sem Fundo" }, { "code": 101605, "slug": "deposito_em_cheque_liberado", "kind": null, "description": "Depósito em cheque liberado" }, { "code": 101606, "slug": "deposito_em_cheque_bb_liberad", "kind": null, "description": "Depósito em cheque BB liberado" }, { "code": 101608, "slug": "credito_ordem_pagamento", "kind": "credit", "description": "Crédito Ordem Pagamento" }, { "code": 101609, "slug": "desconto", "kind": null, "description": "Desconto" }, { "code": 101610, "slug": "estorno_de_debito", "kind": null, "description": "Estorno de Débito" }, { "code": 101611, "slug": "credito_autorizado", "kind": "credit", "description": "Crédito autorizado" }, { "code": 101612, "slug": "credito_cfe_instrucoes", "kind": "credit", "description": "Crédito cfe. instruções" }, { "code": 101615, "slug": "aviso_de_credito", "kind": null, "description": "Aviso de Crédito" }, { "code": 101618, "slug": "cheque_tb_devolvido", "kind": null, "description": "Cheque TB devolvido" }, { "code": 101619, "slug": "devolucao_de_juros", "kind": null, "description": "Devolução de juros" }, { "code": 101620, "slug": "devolucao_de_iof", "kind": null, "description": "Devolução de IOF" }, { "code": 101622, "slug": "credito_bacen", "kind": "credit", "description": "Crédito BACEN" }, { "code": 101623, "slug": "deposito_compe", "kind": null, "description": "Depósito COMPE" }, { "code": 101625, "slug": "cred_por_ordem_rffsa", "kind": null, "description": "CRED. POR ORDEM RFFSA" }, { "code": 101626, "slug": "saque_em_poupanca", "kind": null, "description": "SAQUE EM POUPANÇA" }, { "code": 101627, "slug": "racoes_guabi", "kind": null, "description": "RAÇÕES GUABI" }, { "code": 101628, "slug": "cartao_de_credito", "kind": null, "description": "Cartão de Crédito" }, { "code": 101629, "slug": "trf_entre_cooperativa", "kind": null, "description": "TRF. ENTRE COOPERATIVA" }, { "code": 101630, "slug": "anot_provisoria_credito", "kind": null, "description": "Anot. provisória crédito" }, { "code": 101634, "slug": "credito_fapex", "kind": "credit", "description": "Crédito FAPEX" }, { "code": 101635, "slug": "remuneracao_a_cooperado", "kind": null, "description": "Remuneração a Cooperado" }, { "code": 101636, "slug": "recebimento_telefone_pre_pago", "kind": null, "description": "Recebimento Telefone Pré-Pago" }, { "code": 101637, "slug": "abono", "kind": null, "description": "Abono" }, { "code": 101638, "slug": "itcmd_transm_causa_mortis_doa", "kind": null, "description": "ITCMD-TRANSM CAUSA MORTIS DOA" }, { "code": 101639, "slug": "ipva_propried_veiculos_automo", "kind": null, "description": "IPVA-PROPRIEDADE VEÍCULOS AUTOMOTORES" }, { "code": 101641, "slug": "adiantamento_de_bordero", "kind": null, "description": "Adiantamento de Borderô" }, { "code": 101643, "slug": "cred_ipmc_", "kind": null, "description": "Cred.IPMC." }, { "code": 101644, "slug": "amortizacao", "kind": null, "description": "Amortização" }, { "code": 101645, "slug": "rsg_fndo_empres_di_60", "kind": null, "description": "RSG FNDO EMPRES. DI 60" }, { "code": 101647, "slug": "auxilio", "kind": null, "description": "Auxílio" }, { "code": 101648, "slug": "grupo_perdigao", "kind": null, "description": "Grupo Perdigão" }, { "code": 101649, "slug": "cred_por_ordem_fipecq", "kind": null, "description": "CRED. POR ORDEM FIPECQ" }, { "code": 101650, "slug": "dividendos_telebras", "kind": null, "description": "DIVIDENDOS TELEBRAS" }, { "code": 101651, "slug": "cred_por_ordem_furnas", "kind": null, "description": "CRED. POR ORDEM FURNAS" }, { "code": 101655, "slug": "devolucao_iae", "kind": null, "description": "DEVOLUÇÃO IAE" }, { "code": 101656, "slug": "credito_servico_cambio", "kind": "credit", "description": "CRÉDITO SERVIÇO CÂMBIO" }, { "code": 101657, "slug": "cambio_a_liberar_d1", "kind": null, "description": "CÂMBIO A LIBERAR D+1" }, { "code": 101658, "slug": "conversao", "kind": null, "description": "Conversão" }, { "code": 101659, "slug": "cred_por_ordem_ford", "kind": null, "description": "CRED. POR ORDEM FORD" }, { "code": 101660, "slug": "correcao_monetaria", "kind": null, "description": "Correção Monetária" }, { "code": 101661, "slug": "credito_furnas", "kind": "credit", "description": "Crédito Furnas" }, { "code": 101663, "slug": "acertos_sistema_crm", "kind": null, "description": "ACERTOS SISTEMA CRM" }, { "code": 101664, "slug": "recebimentos_diversos", "kind": null, "description": "Recebimentos diversos" }, { "code": 101665, "slug": "hosp_clinicas_p_alegre", "kind": null, "description": "HOSP.CLINICAS P.ALEGRE" }, { "code": 101666, "slug": "grupo_hosp_conceic_", "kind": null, "description": "GRUPO HOSP. CONCEIC." }, { "code": 101667, "slug": "indenizacao_seguro", "kind": null, "description": "INDENIZAÇÃO SEGURO" }, { "code": 101668, "slug": "resgate_autom_aplic_curto_pra", "kind": null, "description": "Resgate Autom.Aplic Curto Pra" }, { "code": 101670, "slug": "estorno_de_tarifa", "kind": null, "description": "Estorno de tarifa" }, { "code": 101671, "slug": "diarias", "kind": null, "description": "Diárias" }, { "code": 101673, "slug": "resgate_acoes_energia", "kind": null, "description": "Resgate ações energia" }, { "code": 101674, "slug": "devolucao_chq_motivo_2", "kind": null, "description": "DEVOLUÇÃO CHQ MOTIVO 2" }, { "code": 101675, "slug": "estorno_debito", "kind": null, "description": "Estorno Débito" }, { "code": 101678, "slug": "leilao_balcao_eletron_", "kind": null, "description": "LEILAO/BALÇÃO ELETRON." }, { "code": 101679, "slug": "resgate_bb_premium", "kind": null, "description": "Resgate BB Premium" }, { "code": 101681, "slug": "fornecimento", "kind": null, "description": "FORNECIMENTO" }, { "code": 101682, "slug": "estorno_de_aquisicao", "kind": null, "description": "ESTORNO DE AQUISIÇÃO" }, { "code": 101683, "slug": "itr_imposto_territorial_rural", "kind": null, "description": "ITR-IMPOSTO TERRITORIAL RURAL" }, { "code": 101684, "slug": "est_anotacao_debito", "kind": null, "description": "EST. ANOTAÇÃO DÉBITO" }, { "code": 101685, "slug": "credito_previ_carim", "kind": "credit", "description": "Crédito previ carim" }, { "code": 101686, "slug": "chq_devolvido_apresent_indevi", "kind": null, "description": "CHQ DEVOLVIDO APRESENT INDEVI" }, { "code": 101687, "slug": "brasilcap", "kind": null, "description": "Brasilcap" }, { "code": 101688, "slug": "restituicao_da_receita_federa", "kind": null, "description": "RESTITUIÇÃO DA RECEITA FEDERAL" }, { "code": 101689, "slug": "mensalidade_seg_saude", "kind": null, "description": "MENSALIDADE SEG SAÚDE" }, { "code": 101690, "slug": "imposto_sindical", "kind": null, "description": "IMPOSTO SINDICAL" }, { "code": 101691, "slug": "venda_de_acoes", "kind": null, "description": "VENDA DE AÇÕES" }, { "code": 101692, "slug": "resgate_bb_cin", "kind": null, "description": "Resgate BB CIN" }, { "code": 101693, "slug": "credito_secex", "kind": "credit", "description": "CRÉDITO SECEX" }, { "code": 101694, "slug": "crd_bloqueado_cobranc", "kind": null, "description": "CRD. BLOQUEADO COBRANÇA" }, { "code": 101695, "slug": "credito_origem_inss", "kind": "credit", "description": "Crédito origem INSS" }, { "code": 101697, "slug": "liberacao", "kind": null, "description": "Liberação" }, { "code": 101698, "slug": "liquidacao", "kind": null, "description": "Liquidação" }, { "code": 101699, "slug": "crd_origem_prefeitura", "kind": null, "description": "CRD ORIGEM PREFEITURA" }, { "code": 101700, "slug": "dmr_credito", "kind": null, "description": "DMR CRÉDITO" }, { "code": 101701, "slug": "chq_dev_motivo_25_ou_2", "kind": null, "description": "CHQ DEV.MOTIVO 25 OU 2" }, { "code": 101702, "slug": "multa_taxa", "kind": null, "description": "Multa-Taxa" }, { "code": 101703, "slug": "cred_a_liberar_no_dia", "kind": null, "description": "CRED. A LIBERAR NO DIA" }, { "code": 101704, "slug": "ordem_de_credito", "kind": null, "description": "Ordem de Crédito" }, { "code": 101705, "slug": "ch_devolvido_com_irregularida", "kind": null, "description": "CH DEVOLVIDO COM IRREGULARIDA" }, { "code": 101707, "slug": "beneficio_inss", "kind": null, "description": "Benefício INSS" }, { "code": 101708, "slug": "conta_unica", "kind": null, "description": "Conta Única" }, { "code": 101712, "slug": "estorno_de_devolucao", "kind": null, "description": "Estorno de Devolução" }, { "code": 101714, "slug": "resgate_bb_multicarteira", "kind": null, "description": "Resgate BB Multicarteira" }, { "code": 101715, "slug": "resgate_bb_moderado_60", "kind": null, "description": "Resgate BB Moderado 60" }, { "code": 101716, "slug": "refinanciamento", "kind": null, "description": "Refinanciamento" }, { "code": 101718, "slug": "ch_devolvido_impedim_pagament", "kind": null, "description": "CH DEVOLVIDO IMPEDIM PAGAMENTO" }, { "code": 101719, "slug": "fed_coop_cons_fun_bb", "kind": null, "description": "FED.COOP.CONS.FUN.BB" }, { "code": 101720, "slug": "remuneracao_agencia", "kind": null, "description": "Remuneração Agência" }, { "code": 101722, "slug": "credito_fassincra", "kind": "credit", "description": "Crédito FASSINCRA" }, { "code": 101723, "slug": "credito_semus", "kind": "credit", "description": "Crédito SEMUS" }, { "code": 101724, "slug": "ressarcimento", "kind": null, "description": "Ressarcimento" }, { "code": 101725, "slug": "credito_codomar", "kind": "credit", "description": "Crédito CODOMAR" }, { "code": 101727, "slug": "cancelamento_de_subscricao", "kind": null, "description": "Cancelamento de Subscrição" }, { "code": 101728, "slug": "seguro_automatico_penhor_rura", "kind": null, "description": "Seguro Automático Penhor Rural" }, { "code": 101729, "slug": "transferencia_recebida", "kind": null, "description": "Transferência recebida" }, { "code": 101730, "slug": "vendas", "kind": null, "description": "Vendas" }, { "code": 101731, "slug": "credito_com_aviso", "kind": "credit", "description": "CRÉDITO COM AVISO" }, { "code": 101733, "slug": "custodia_bonificacao", "kind": null, "description": "CUSTODIA/BONIFICAÇÃO" }, { "code": 101735, "slug": "resgate_bb_fiex", "kind": null, "description": "Resgate BB Fiex" }, { "code": 101739, "slug": "telemar", "kind": null, "description": "Telemar" }, { "code": 101740, "slug": "credito_convenio", "kind": "credit", "description": "CRÉDITO CONVÊNIO" }, { "code": 101741, "slug": "golden_cross", "kind": null, "description": "GOLDEN CROSS" }, { "code": 101742, "slug": "credito_leasing", "kind": "credit", "description": "CRÉDITO LEASING" }, { "code": 101743, "slug": "resgate_open", "kind": null, "description": "RESGATE OPEN" }, { "code": 101744, "slug": "canc_trs_contest_ou_na", "kind": null, "description": "CANC TRS-CONTEST OU NA" }, { "code": 101745, "slug": "credito_geap", "kind": "credit", "description": "CRÉDITO GEAP" }, { "code": 101746, "slug": "credito_sindifisco", "kind": "credit", "description": "CRÉDITO SINDIFISCO" }, { "code": 101747, "slug": "credito_pasep", "kind": "credit", "description": "CRÉDITO PASEP" }, { "code": 101748, "slug": "rsg_bb_aplic_c_prazo", "kind": null, "description": "RSG BB-APLIC C.PRAZO" }, { "code": 101749, "slug": "resgate_ourocap", "kind": null, "description": "Resgate Ourocap" }, { "code": 101750, "slug": "fopag_bb", "kind": null, "description": "FOPAG BB" }, { "code": 101751, "slug": "conv_real", "kind": null, "description": "conv.Real" }, { "code": 101752, "slug": "credito_do_sistema_cda", "kind": "credit", "description": "Crédito do Sistema CDA" }, { "code": 101755, "slug": "cassi_credito", "kind": null, "description": "CASSI CRÉDITO" }, { "code": 101756, "slug": "ferias_licenca_premi", "kind": null, "description": "FÉRIAS - LICENCA PREMI" }, { "code": 101757, "slug": "devolucao_mens_ouroca", "kind": null, "description": "DEVOLUÇÃO MENS. OUROCA" }, { "code": 101758, "slug": "ordem_banc_petrobras", "kind": null, "description": "ORDEM BANC PETROBRAS" }, { "code": 101759, "slug": "ourocap_premiacao", "kind": null, "description": "OUROCAP PREMIAÇÃO" }, { "code": 101760, "slug": "bdar_banco_do_brasil", "kind": null, "description": "BDAR-BANCO DO BRASIL" }, { "code": 101761, "slug": "cbr_ciope_bb_vendor", "kind": null, "description": "CBR-CIOPE BB-VENDOR" }, { "code": 101762, "slug": "distribuicao_simples_nacional", "kind": null, "description": "Distribuição Simples Nacional" }, { "code": 101763, "slug": "obc_credito_diversos", "kind": null, "description": "OBC-CREDITO DIVERSOS" }, { "code": 101764, "slug": "rendimentos_pis", "kind": null, "description": "RENDIMENTOS PIS" }, { "code": 101765, "slug": "embratel", "kind": null, "description": "EMBRATEL" }, { "code": 101766, "slug": "credito_carnet_recebid", "kind": "credit", "description": "CRÉDITO CARNET RECEBIDO" }, { "code": 101769, "slug": "bbtur", "kind": null, "description": "BBTUR" }, { "code": 101770, "slug": "fopag", "kind": null, "description": "Fopag" }, { "code": 101771, "slug": "salario_educacao", "kind": null, "description": "SALÁRIO EDUCAÇÃO" }, { "code": 101773, "slug": "credito_carim", "kind": "credit", "description": "CRÉDITO CARIM" }, { "code": 101775, "slug": "credito_aluguel", "kind": "credit", "description": "CRÉDITO ALUGUEL" }, { "code": 101776, "slug": "doc_devolvido", "kind": null, "description": "DOC devolvido" }, { "code": 101777, "slug": "drc_credito", "kind": null, "description": "DRC-CREDITO" }, { "code": 101778, "slug": "pagamento_fornecedor_philips", "kind": null, "description": "Pagamento Fornecedor PHILIPS" }, { "code": 101779, "slug": "pagamento_fornecedor_ambev", "kind": null, "description": "Pagamento Fornecedor AmBev" }, { "code": 101781, "slug": "credito_sesi", "kind": "credit", "description": "CRÉDITO SESI" }, { "code": 101782, "slug": "credito_unimed", "kind": "credit", "description": "CRÉDITO UNIMED" }, { "code": 101783, "slug": "credito_senai", "kind": "credit", "description": "CRÉDITO SENAI" }, { "code": 101784, "slug": "br_telecom_pagto_fornecedores", "kind": null, "description": "BR TELECOM Pagto Fornecedores" }, { "code": 101786, "slug": "dl_venda", "kind": null, "description": "DL VENDA" }, { "code": 101787, "slug": "credito_conta_salario", "kind": "credit", "description": "CRÉDITO CONTA SALÁRIO" }, { "code": 101789, "slug": "credito_por_ordem_ect", "kind": "credit", "description": "CRÉDITO POR ORDEM ECT" }, { "code": 101790, "slug": "resgate_bb_fundo_de_acoes", "kind": null, "description": "Resgate BB Fundo de Ações" }, { "code": 101791, "slug": "resgate_fundo", "kind": null, "description": "Resgate Fundo" }, { "code": 101793, "slug": "pagamento_fornecedor_tam", "kind": null, "description": "Pagamento Fornecedor TAM" }, { "code": 101794, "slug": "dividendos_crt", "kind": null, "description": "Dividendos CRT" }, { "code": 101795, "slug": "credito_automatico_cdc", "kind": "credit", "description": "Crédito Automático CDC" }, { "code": 101796, "slug": "estorno_compra", "kind": null, "description": "ESTORNO COMPRA" }, { "code": 101797, "slug": "resgate_bb_extrapoupe", "kind": null, "description": "Resgate BB Extrapoupe" }, { "code": 101798, "slug": "cdb_rdb", "kind": null, "description": "CDB/RDB" }, { "code": 101799, "slug": "resgate_fdo_aplic_120", "kind": null, "description": "RESGATE FDO APLIC-120" }, { "code": 101800, "slug": "credito_por_ordem_cnpq", "kind": "credit", "description": "CRÉDITO POR ORDEM CNPQ" }, { "code": 101804, "slug": "resgate_aplic_prog", "kind": null, "description": "RESGATE APLIC-PROG" }, { "code": 101805, "slug": "p_ordem_empresa_weg_s", "kind": null, "description": "P/ ORDEM EMPRESA WEG S" }, { "code": 101806, "slug": "recebimento_bbcpr", "kind": null, "description": "RECEBIMENTO BBCPR" }, { "code": 101808, "slug": "orpag_origem_exterior", "kind": null, "description": "ORPAG ORIGEM EXTERIOR" }, { "code": 101809, "slug": "petrobras_bloq_1_dia", "kind": null, "description": "PETROBRAS BLOQ.1 DIA" }, { "code": 101811, "slug": "taxa_de_administracao", "kind": null, "description": "Taxa de administração" }, { "code": 101812, "slug": "devolucao_cpmf_bb_aplic", "kind": null, "description": "Devolução CPMF BB Aplicação" }, { "code": 101815, "slug": "estorno_agf_securitiza", "kind": null, "description": "ESTORNO AGF-SECURITIZA" }, { "code": 101816, "slug": "proventos_p_m_m_g_", "kind": null, "description": "Proventos P.M.M.G." }, { "code": 101817, "slug": "faelba_pagto_forneced_", "kind": null, "description": "FAELBA-PAGTO FORNECED." }, { "code": 101819, "slug": "cred_por_ordem_nuclem", "kind": null, "description": "CRED POR ORDEM NUCLEM" }, { "code": 101820, "slug": "devolucao_de_cpmf", "kind": null, "description": "Devolução de CPMF" }, { "code": 101821, "slug": "pix_recebido", "kind": null, "description": "Pix Recebido" }, { "code": 101822, "slug": "creditos_bloquetos", "kind": null, "description": "Créditos bloquetos" }, { "code": 101823, "slug": "divida_transferida_p_prejuiz", "kind": null, "description": "Dívida Transferida p/ Prejuízo" }, { "code": 101824, "slug": "acl_cielo", "kind": null, "description": "ACL CIELO" }, { "code": 101826, "slug": "credito_sistema_tef", "kind": "credit", "description": "CRÉDITO SISTEMA TEF" }, { "code": 101827, "slug": "rsg_bb_princ_garantido", "kind": null, "description": "RSG BB-PRINC.GARANTIDO" }, { "code": 101828, "slug": "estorno_deb_cart_cred", "kind": null, "description": "ESTORNO DEB CART CRED" }, { "code": 101829, "slug": "pensao_alim_judicial", "kind": null, "description": "PENSAO ALIM. JUDICIAL" }, { "code": 101830, "slug": "deposito_online", "kind": null, "description": "Depósito Online" }, { "code": 101831, "slug": "recebimento_de_icms", "kind": null, "description": "RECEBIMENTO DE ICMS" }, { "code": 101832, "slug": "credito_lojista_tecban", "kind": "credit", "description": "Credito Lojista-TECBAN" }, { "code": 101833, "slug": "recebimento_de_ipva", "kind": null, "description": "RECEBIMENTO DE IPVA" }, { "code": 101835, "slug": "rsg_aut_bb_commoditie", "kind": null, "description": "RSG AUT. BB-COMMODITIE" }, { "code": 101836, "slug": "assef_plus", "kind": null, "description": "ASSEF PLUS" }, { "code": 101837, "slug": "assef_medi", "kind": null, "description": "ASSEF MEDI" }, { "code": 101838, "slug": "assef_pat", "kind": null, "description": "ASSEF PAT" }, { "code": 101840, "slug": "aih_inamps", "kind": null, "description": "AIH-INAMPS" }, { "code": 101841, "slug": "sinpas_div", "kind": null, "description": "SINPAS-DIV" }, { "code": 101842, "slug": "pericia_medica", "kind": null, "description": "PERÍCIA MÉDICA" }, { "code": 101843, "slug": "pagmento_cta_amb", "kind": null, "description": "PAGAMENTO CTA.AMB" }, { "code": 101844, "slug": "financto_rural_rapido", "kind": null, "description": "FINANCTO RURAL RÁPIDO" }, { "code": 101845, "slug": "resgate_poupex", "kind": null, "description": "Resgate Poupex" }, { "code": 101846, "slug": "resgate_bb_renda_fixa_di", "kind": null, "description": "Resgate BB Renda Fixa DI" }, { "code": 101847, "slug": "resgate_bb_fundos_extramercad", "kind": null, "description": "Resgate BB Fundos Extramercado" }, { "code": 101848, "slug": "resgate_automatico", "kind": null, "description": "Resgate Automático" }, { "code": 101850, "slug": "cota_daf_credito", "kind": null, "description": "COTA DAF - CRÉDITO" }, { "code": 101852, "slug": "resgate_fundo_energia", "kind": null, "description": "Resgate Fundo Energia" }, { "code": 101854, "slug": "rsg_bb_acoes_telebrasi", "kind": null, "description": "RSG BB-AÇÕES TELEBRASIL" }, { "code": 101855, "slug": "resgate_bb_fix", "kind": null, "description": "Resgate BB Fix" }, { "code": 101856, "slug": "estorno_de_despesas", "kind": null, "description": "ESTORNO DE DESPESAS" }, { "code": 101857, "slug": "rsg_fundo_acoes_coelba", "kind": null, "description": "RSG FUNDO AÇÕES COELBA" }, { "code": 101858, "slug": "prestacao_servicos", "kind": null, "description": "PRESTAÇÃO SERVIÇOS" }, { "code": 101859, "slug": "cred_ordem_cargill", "kind": null, "description": "CRED ORDEM CARGILL" }, { "code": 101861, "slug": "rsg_aut_bb_fif_c_prazo", "kind": null, "description": "RSG AUT.BB-FIF C.PRAZO" }, { "code": 101862, "slug": "recebimento_atraves_bt", "kind": null, "description": "RECEBIMENTO ATRAVÉS BT" }, { "code": 101863, "slug": "cia_seguros_alianca", "kind": null, "description": "CIA SEGUROS ALIANÇA" }, { "code": 101868, "slug": "excedente_chq_garantia", "kind": null, "description": "EXCEDENTE CHQ GARANTIA" }, { "code": 101869, "slug": "estorno_aplicacao_fundos", "kind": null, "description": "Estorno Aplicação Fundos" }, { "code": 101871, "slug": "resgate_bb_fix_30", "kind": null, "description": "RESGATE BB-FIX-30" }, { "code": 101872, "slug": "estorno_aplic_bb_commo", "kind": null, "description": "ESTORNO APLICAÇÃO BB-COMMO" }, { "code": 101873, "slug": "estorno_apl_bb_rnd_fix", "kind": null, "description": "ESTORNO APL BB-RND-FIX" }, { "code": 101875, "slug": "transferido_da_poupanca", "kind": null, "description": "Transferido da poupança" }, { "code": 101877, "slug": "rsg_bb_empresarial_30", "kind": null, "description": "RSG BB-EMPRESARIAL-30" }, { "code": 101878, "slug": "rsg_bb_empresarial_60", "kind": null, "description": "RSG BB-EMPRESARIAL-60" }, { "code": 101880, "slug": "gap_inamps", "kind": null, "description": "GAP-INAMPS" }, { "code": 101881, "slug": "sia_inamps", "kind": null, "description": "SIA-INAMPS" }, { "code": 101882, "slug": "resgate_bb_reaplic", "kind": null, "description": "Resgate BB REAPLICAÇÃO" }, { "code": 101883, "slug": "resgate_bb_cambial", "kind": null, "description": "Resgate BB Cambial" }, { "code": 101884, "slug": "rsg_bb_acoes_master", "kind": null, "description": "RSG BB-AÇÕES-MASTER" }, { "code": 101886, "slug": "remuneracao_sobre_acoes", "kind": null, "description": "Remuneração sobre ações" }, { "code": 101887, "slug": "devolucao_cpmf_pasep", "kind": null, "description": "DEVOLUÇÃO CPMF PASEP" }, { "code": 101889, "slug": "rsg_bb_fif_curto_prazo", "kind": null, "description": "RSG BB-FIF-CURTO-PRAZO" }, { "code": 101890, "slug": "volkswagen", "kind": null, "description": "VOLKSWAGEN" }, { "code": 101891, "slug": "rsg_bb_commodities", "kind": null, "description": "RSG BB-COMMODITIES" }, { "code": 101892, "slug": "credito_sesef", "kind": "credit", "description": "CRÉDITO SESEF" }, { "code": 101893, "slug": "capesesp", "kind": null, "description": "CAPESESP" }, { "code": 101894, "slug": "credito_cvrd", "kind": "credit", "description": "CRÉDITO CVRD" }, { "code": 101895, "slug": "resg_fundo_di_60", "kind": null, "description": "RESG. FUNDO DI-60" }, { "code": 101896, "slug": "credito_conab", "kind": "credit", "description": "CRÉDITO CONAB" }, { "code": 101898, "slug": "centrais_eletricas_es", "kind": null, "description": "CENTRAIS ELETRICAS-ES" }, { "code": 101899, "slug": "resgate_bb_fundos_privat", "kind": null, "description": "Resgate BB Fundos Private" }, { "code": 101901, "slug": "salario_ord_empregador", "kind": null, "description": "Salário ord empregador" }, { "code": 101902, "slug": "venda_web", "kind": null, "description": "Venda-WEB" }, { "code": 101903, "slug": "governo_pe_devol_fopag", "kind": null, "description": "GOVERNO PE DEVOL FOPAG" }, { "code": 101904, "slug": "resgate_bb_fapi", "kind": null, "description": "Resgate BB FAPI" }, { "code": 101905, "slug": "plus_aut_resg_autom", "kind": null, "description": "PLUS AUT (RESG AUTOM)" }, { "code": 101906, "slug": "plus_cp_resgate", "kind": null, "description": "PLUS CP (RESGATE)" }, { "code": 101909, "slug": "cop_cred_automatico", "kind": null, "description": "COP CRED AUTOMÁTICO" }, { "code": 101924, "slug": "piso_de_atencao_basica", "kind": null, "description": "PISO DE ATENÇÃO BÁSICA" }, { "code": 101925, "slug": "programa_saude_familia", "kind": null, "description": "PROGRAMA SAÚDE FAMÍLIA" }, { "code": 101926, "slug": "pgm_agente_comun_saude", "kind": null, "description": "PGM AGENTE COMUNITÁRIO SAÚDE" }, { "code": 101927, "slug": "pgm_farmacias_basicas", "kind": null, "description": "PGM FARMÁCIAS BÁSICAS" }, { "code": 101928, "slug": "pgm_carencia_nutricion", "kind": null, "description": "PGM CARENCIA NUTRICIONAL" }, { "code": 101929, "slug": "pgm_vigilancia_sanitar", "kind": null, "description": "PGM VIGILÂNCIA SANITÁRIA" }, { "code": 101930, "slug": "pgm_vigilancia_epidemi", "kind": null, "description": "PGM VIGILÂNCIA EPIDEMIOLÓGICA" }, { "code": 101931, "slug": "programa_saude_bucal", "kind": null, "description": "PROGRAMA SAÚDE BUCAL" }, { "code": 101932, "slug": "gestao_plena_sistema", "kind": null, "description": "GESTÃO PLENA SISTEMA" }, { "code": 101933, "slug": "liquidacao_bb_cdb_pre", "kind": null, "description": "Liquidação BB CDB Pré" }, { "code": 101934, "slug": "liquidacao_bb_aplic_pos", "kind": null, "description": "Liquidação BB Aplic Pós" }, { "code": 101936, "slug": "resgate_bb_aplic_pub", "kind": null, "description": "RESGATE BB APLICAÇÃO PÚBLICA" }, { "code": 101937, "slug": "resgate_bb_aplic_corp", "kind": null, "description": "RESGATE BB APLICAÇÃO CORPORATIVA" }, { "code": 101938, "slug": "resgate_bb_fundos_exclus", "kind": null, "description": "Resgate BB Fundos Exclusivos" }, { "code": 101939, "slug": "apos_pensao_bbprev", "kind": null, "description": "APOS/PENSAO BBPREV" }, { "code": 101940, "slug": "credito_bb_previdencia", "kind": "credit", "description": "CRÉDITO BB PREVIDÊNCIA" }, { "code": 101943, "slug": "estorno_de_saque_cedula", "kind": null, "description": "Estorno de Saque-cédula" }, { "code": 101949, "slug": "taxa_renov_chq_esecial", "kind": null, "description": "TAXA RENOV CHQ ESPECIAL" }, { "code": 101950, "slug": "cobranca_devolvida", "kind": null, "description": "Cobrança Devolvida" }, { "code": 101951, "slug": "devol_renov_chq_esp", "kind": null, "description": "DEVOL. RENOV. CHQ. ESP" }, { "code": 101952, "slug": "fpe_fpm", "kind": null, "description": "FPE/FPM" }, { "code": 101953, "slug": "ipi_exportacao", "kind": null, "description": "IPI/EXPORTAÇÃO" }, { "code": 101954, "slug": "icms_desoner_exportaco", "kind": null, "description": "ICMS-DESONER.EXPORTACOES" }, { "code": 101955, "slug": "complemento_uniao", "kind": null, "description": "COMPLEMENTO UNIÃO" }, { "code": 101956, "slug": "incentivo_descet_funas", "kind": null, "description": "INCENTIVO DESCET.FUNAS" }, { "code": 101957, "slug": "consorcio_honda", "kind": null, "description": "CONSÓRCIO HONDA" }, { "code": 101958, "slug": "resgate_fundo_bb_dolar", "kind": null, "description": "RESGATE FUNDO BB DOLAR" }, { "code": 101959, "slug": "resgate_fundo_milenio", "kind": null, "description": "RESGATE FUNDO MILENIO" }, { "code": 101960, "slug": "cred_cobranca_ef_comp", "kind": null, "description": "CRED.COBRANCA EF. COMP" }, { "code": 101961, "slug": "bb_fix_di_60_cpmf_resg", "kind": null, "description": "BB FIX DI 60 CPMF RESG" }, { "code": 101962, "slug": "resgate_bb_fix_diario", "kind": null, "description": "Resgate BB Fix Diário" }, { "code": 101964, "slug": "empr_cta_garantida", "kind": null, "description": "EMPR CTA GARANTIDA" }, { "code": 101965, "slug": "saldo_transf_prejuizo", "kind": null, "description": "SALDO TRANSF PREJUÍZO" }, { "code": 101966, "slug": "creditos_do_gov_ms", "kind": null, "description": "CREDITOS DO GOV. MS" }, { "code": 101967, "slug": "cred_fundo_nac_saude", "kind": null, "description": "CRED FUNDO NAC SAÚDE" }, { "code": 101968, "slug": "plano_oab_de_saude", "kind": null, "description": "PLANO OAB DE SAÚDE" }, { "code": 101969, "slug": "bonus_performance_gfi", "kind": null, "description": "BONUS PERFORMANCE-GFI" }, { "code": 101970, "slug": "taxa_de_resgate_gfi", "kind": null, "description": "TAXA DE RESGATE-GFI" }, { "code": 101971, "slug": "ressarcimento_fundos", "kind": null, "description": "RESSARCIMENTO FUNDOS" }, { "code": 101972, "slug": "ordem_banc_cancelada", "kind": null, "description": "ORDEM BANC CANCELADA" }, { "code": 101973, "slug": "cred_de_ks_pistoes_ltd", "kind": null, "description": "CRED DE KS PISTOES LTD" }, { "code": 101974, "slug": "bbcpr_nao_cumprida", "kind": null, "description": "BBCPR Não Cumprida" }, { "code": 101975, "slug": "sadia", "kind": null, "description": "SADIA" }, { "code": 101976, "slug": "ted_transferencia_eletr_", "kind": null, "description": "TED Transferência Eletr." }, { "code": 101977, "slug": "seara", "kind": null, "description": "SEARA" }, { "code": 101978, "slug": "bunge", "kind": null, "description": "BUNGE" }, { "code": 101979, "slug": "fgts_lei_complementar_11", "kind": null, "description": "FGTS Lei Complementar 11" }, { "code": 101980, "slug": "credito_coamo", "kind": "credit", "description": "Crédito COAMO" }, { "code": 101983, "slug": "ted_devolvida", "kind": null, "description": "TED Devolvida" }, { "code": 101984, "slug": "credito_por_ordem_da_pnu", "kind": "credit", "description": "Crédito por ordem da PNU" }, { "code": 101985, "slug": "credito_cooperat_castrol", "kind": "credit", "description": "Crédito Cooperat Castrol" }, { "code": 101986, "slug": "resgate_fundo_private", "kind": null, "description": "Resgate Fundo Private" }, { "code": 101988, "slug": "resgate_aplic_plus", "kind": null, "description": "RESGATE APLICAÇÃO PLUS" }, { "code": 101989, "slug": "resgate_bb_cdb_di", "kind": null, "description": "Resgate BB CDB DI" }, { "code": 101990, "slug": "rsg_blq_uso_excl_rd", "kind": null, "description": "RSG BLQ - USO EXCL. RD" }, { "code": 101991, "slug": "pagamento_de_prebenda", "kind": null, "description": "Pagamento de Prebenda" }, { "code": 101992, "slug": "recompra_ctn_pesa", "kind": null, "description": "RECOMPRA CTN PESA" }, { "code": 101993, "slug": "cia_particip_alianca_da", "kind": null, "description": "Cia Participativo Aliança da" }, { "code": 101994, "slug": "credito_grupo_afinidad", "kind": "credit", "description": "CRÉDITO GRUPO AFINIDADE" }, { "code": 101996, "slug": "pagamento_da_plr", "kind": null, "description": "Pagamento da PLR" }, { "code": 101998, "slug": "controle_aplicativo_de", "kind": null, "description": "CONTROLE APLICATIVO DE" } ] }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "integer", "description": "Código usado no filtro `category`." }, "slug": { "type": "string", "description": "Identificador estável da categoria." }, "kind": { "type": "string", "nullable": true, "enum": [ "credit", "debit" ], "description": "Lado da categoria, ou nulo para `outros`." }, "description": { "type": "string", "nullable": true, "description": "Descrição legível em pt-BR." } } } } } } } } } } } }, "/v2/admin/certificates/{uid}": { "delete": { "summary": "Excluir um Certificado", "tags": [ "Certificado" ], "security": [ { "bearerAuth": [] } ], "description": "Remove permanentemente um certificado. Só é possível excluir certificados que não estejam vinculados a nenhuma conexão ativa e que não tenham sido criados pelo sistema.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "required": true, "description": "UID do Certificado (UUID).", "example": "018df180-7208-727b-a10a-ea545e4a75a8", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Certificado excluído" }, "422": { "description": "Certificado criado pelo sistema não pode ser excluído", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "certificate_system_managed", "detail": "Este certificado foi criado pelo sistema e não pode ser excluído." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Certificado não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/admin/certificates": { "post": { "summary": "Incluir um Certificado", "tags": [ "Certificado" ], "security": [ { "bearerAuth": [] } ], "description": "Incluir um certificado.\n\n> **Tipo do Certificado:** Conforme o tipo do certificado informado é necessario enviar o objeto files com conteúdos diferentes. Se o tipo do certificado for `CRT` é obrigatório enviar o `crt_file` e o `crt_private_key_file`, se o tipo for `PFX` é obrigatório `pfx_file` e `pfx_password`.\n", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Certificado incluído", "content": { "application/json": { "example": { "status": 201, "data": { "id": 13, "uid": "01a06d8e-cc8c-7e46-833c-ed298c264a18", "account_id": 278, "label": "certificado teste", "common_name": "KOBANA", "issuer": null, "cnpj_cpf": "05.813.794/0001-26", "subaccounts": true, "created_by": "user", "status": "validated", "created_via_api": true, "created_at": "2026-09-04T12:54:30-05:00", "updated_at": "2026-09-04T12:54:30-05:00", "expiration_date": "2030-04-28" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_certificate" } } } } } }, "422": { "description": "Dados do certificado inválido", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "label", "detail": "Identificação não pode ficar em branco" }, { "code": "validation_error", "param": "cnpj_cpf", "detail": "CNPJ/CPF não pode ficar em branco" }, { "code": "validation_error", "param": "crt_file", "detail": "Arquivo .cer/.crt não pode ficar em branco" }, { "code": "validation_error", "param": "crt_private_key_file", "detail": "Arquivo .key não pode ficar em branco" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/v2_certificate_create" } } }, "required": true, "description": "Informações do certificado a ser incluído." } }, "get": { "summary": "Listar Certificados", "tags": [ "Certificado" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todos os certificados cadastrados na conta com filtros opcionais de paginação.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } } ], "responses": { "200": { "description": "Certificados encontrados", "content": { "application/json": { "example": { "status": 200, "data": [ { "id": 15, "uid": "01a06d8e-cd5b-770a-aa50-04d58560498e", "account_id": 282, "label": "MyString", "common_name": "www.test.com", "issuer": "issuer", "cnpj_cpf": "05.813.794/0001-26", "subaccounts": null, "created_by": "user", "status": "validated", "created_via_api": false, "created_at": "2026-09-04T12:54:30-05:00", "updated_at": "2026-09-04T12:54:30-05:00", "expiration_date": "2122-09-16" }, { "id": 14, "uid": "01a06d8e-cd54-704b-a832-9329e98af723", "account_id": 282, "label": "MyString", "common_name": "www.test.com", "issuer": "issuer", "cnpj_cpf": "05.813.794/0001-26", "subaccounts": null, "created_by": "user", "status": "validated", "created_via_api": false, "created_at": "2026-09-04T12:54:30-05:00", "updated_at": "2026-09-04T12:54:30-05:00", "expiration_date": "2122-09-16" } ], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_certificate" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/admin/commands": { "get": { "summary": "Listar Comandos", "tags": [ "Comando" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todos os Comandos da conta, com suporte a filtros por status, operação e origem de confirmação.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "description": "Filtrar por status do Comando.", "example": "confirmed", "schema": { "type": "string" } }, { "name": "operation", "in": "query", "required": false, "description": "Filtrar por tipo de operação.", "example": "register", "schema": { "type": "string" } }, { "name": "confirmation_via", "in": "query", "required": false, "description": "Filtrar por origem da confirmação. Valores: `api`, `edi`.", "example": "api", "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "required": false, "description": "Filtrar por data de criação (início). Formato: YYYY-MM-DD.", "example": "2026-01-01", "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "required": false, "description": "Filtrar por data de criação (fim). Formato: YYYY-MM-DD.", "example": "2026-12-31", "schema": { "type": "string" } }, { "name": "resource_type", "in": "query", "required": false, "description": "Filtrar por tipo de recurso (ex.: `BankBillet`, `Pix`, `Financial::Transfer`).", "example": "BankBillet", "schema": { "type": "string" } }, { "name": "resource_uid", "in": "query", "required": false, "description": "Filtrar Comandos de um recurso específico (boleto, Pix ou conta financeira) pelo seu uid.", "example": "018f1a2b-3c4d-7e5f-8a9b-0c1d2e3f4a5b", "schema": { "type": "string" } }, { "name": "financial_provider_slug", "in": "query", "required": false, "description": "Filtrar pelo slug do provedor financeiro.", "example": "itau", "schema": { "type": "string" } }, { "name": "bank_billet_account_uid", "in": "query", "required": false, "description": "Filtrar Comandos de Boletos de uma carteira (BankBilletAccount) específica, pelo seu uid.", "example": "018f1a2b-3c4d-7e5f-8a9b-0c1d2e3f4a5b", "schema": { "type": "string" } }, { "name": "pix_account_uid", "in": "query", "required": false, "description": "Filtrar Comandos de Pix de uma Conta Pix (PixAccount) específica, pelo seu uid.", "example": "018f1a2b-3c4d-7e5f-8a9b-0c1d2e3f4a5b", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Lista paginada de Comandos", "content": { "application/json": { "example": { "status": 200, "data": [ { "id": 4, "uid": "01a06d8e-cdfd-7218-b876-a4e68b227897", "status": "confirmed", "operation": "register", "resource_type": "BankBillet", "resource_uid": "01a06d8e-cdf0-7d06-a5d2-0837b28087ea", "financial_provider_slug": "sicoob", "params": {}, "payload": null, "created_at": "2026-09-04T12:54:30-05:00", "updated_at": "2026-09-04T12:54:30-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": "api" } ], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_command" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } }, "401": { "description": "Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Escopo integration.commands ausente", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"all integration.commands\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/admin/commands/{uid}": { "get": { "summary": "Visualizar Comando", "tags": [ "Comando" ], "security": [ { "bearerAuth": [] } ], "description": "Retorna os detalhes de um Comando específico pelo seu UID.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "required": true, "description": "UID (UUID) do Comando.", "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Comando encontrado", "content": { "application/json": { "example": { "status": 200, "data": { "id": 50, "uid": "01a06d8e-dd5f-7d33-9cfb-4f9cf1b19d90", "status": "confirmed", "operation": "register", "resource_type": "BankBillet", "resource_uid": "01a06d8e-dd54-743f-893a-d00ca94f90cc", "financial_provider_slug": "sicoob", "params": {}, "payload": null, "created_at": "2026-09-04T12:54:34-05:00", "updated_at": "2026-09-04T12:54:34-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": "api" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP." }, "data": { "$ref": "#/components/schemas/v2_command" } } } } } }, "404": { "description": "Comando não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/admin/connections/{uid}/associations": { "post": { "summary": "Conectar Conta de Serviço", "tags": [ "Conexões" ], "security": [ { "bearerAuth": [] } ], "description": "\n Este endpoint é utilizado para associar uma Conta de Serviço a uma Conexão.\n ", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "required": true, "description": "UUID da Conexão", "example": "e596865f-07a4-4458-88c1-fbb4ffd196e1", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Associação criada", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d8e-dfa3-7b3f-b179-a1dded51831b", "certificate_uid": "01a06d8e-df9d-706f-911c-a8eeedb624dc", "keypair_uid": null, "label": "Connection Name", "apis": [ "charge/pix" ], "provider_slug": "bradesco", "environment": "production", "created_at": "2026-09-04T12:54:35-05:00", "updated_at": "2026-09-04T12:54:35-05:00", "enabled_at": null, "validated_at": null, "validate_failed_at": null, "association_failures": [], "associations": [ { "resource": { "slug": "charge.pix_account", "uid": "01a06d8e-dff6-7b3c-86e3-db047f4a5bd8" } } ] } } } } }, "422": { "description": "Dados da associação inválidos", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "base", "detail": "Chave PIX inválida ou não encontrada" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_association" } } }, "required": true, "description": "Informações da conta de serviço a ser associada." } }, "delete": { "summary": "Desconectar Conta de Serviço", "tags": [ "Conexões" ], "security": [ { "bearerAuth": [] } ], "description": "\n Este endpoint é utilizado para remover associação de uma Conexão com Conta de Serviço.\n\n A remoção não é bloqueada por operações em andamento, e a resposta não tem corpo — as\n consequências abaixo valem a partir do `204`.\n\n **Conta Pix.** Sem conexão a conta fica desativada: não registra novas cobranças, e as já\n registradas deixam de poder ser canceladas ou consultadas. Carteiras de boleto que emitem\n BolePix por essa conta passam a gerar boletos sem QR Code. Para voltar a operar, associe a\n conta a uma conexão com escopo Pix — a associação substitui o vínculo anterior, sem\n precisar removê-lo antes.\n ", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "description": "UUID da Conexão", "required": true, "example": "383f7902-2af5-4a4e-9954-752950102773", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Conexão" }, "404": { "description": "Conexão não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_association" } } }, "required": true, "description": "Informações da conta de serviço a ser removida." } } }, "/v2/admin/connections": { "post": { "summary": "Incluir uma Conexão", "tags": [ "Conexões" ], "security": [ { "bearerAuth": [] } ], "description": "\n Este endpoint é utilizado para cadastrar uma nova conexão.\n ", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Conexão criada com API de scope inexistente", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d8e-e913-7daf-a60d-4b82527b7a95", "certificate_uid": "01a06d8e-e8f1-7e1e-ab8d-7a2d823d7a65", "keypair_uid": null, "label": "Conexão Bradesco", "apis": [ "charge/bank_billet", "payment" ], "provider_slug": "bradesco", "environment": "production", "created_at": "2026-09-04T12:54:37-05:00", "updated_at": "2026-09-04T12:54:37-05:00", "enabled_at": "2026-09-04T12:54:37-05:00", "validated_at": "2026-09-04T12:54:37-05:00", "validate_failed_at": null, "association_failures": [], "associations": [ { "resource": { "slug": "charge.bank_billet_account", "uid": "01a06d8e-e902-7de6-a14c-1985b0470500" } } ] } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_connection" } } } } } }, "422": { "description": "Dados da conexão inválidos", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "provider_slug", "detail": "Provedor não está incluído na lista" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/v2_new_connection_spc_1" }, { "$ref": "#/components/schemas/v2_new_connection_unicred_1" }, { "$ref": "#/components/schemas/v2_new_connection_uniprime_1" }, { "$ref": "#/components/schemas/v2_new_connection_uniprime99_1" }, { "$ref": "#/components/schemas/v2_new_connection_abc_1" }, { "$ref": "#/components/schemas/v2_new_connection_abc_2" }, { "$ref": "#/components/schemas/v2_new_connection_ailos_1" }, { "$ref": "#/components/schemas/v2_new_connection_asaas_1" }, { "$ref": "#/components/schemas/v2_new_connection_banrisul_1" }, { "$ref": "#/components/schemas/v2_new_connection_bb_2" }, { "$ref": "#/components/schemas/v2_new_connection_bradesco_1" }, { "$ref": "#/components/schemas/v2_new_connection_bradesco_2" }, { "$ref": "#/components/schemas/v2_new_connection_bradesco_4" }, { "$ref": "#/components/schemas/v2_new_connection_btg_1" }, { "$ref": "#/components/schemas/v2_new_connection_btg_enterprise_1" }, { "$ref": "#/components/schemas/v2_new_connection_bv_1" }, { "$ref": "#/components/schemas/v2_new_connection_c6_1" }, { "$ref": "#/components/schemas/v2_new_connection_caixa_1" }, { "$ref": "#/components/schemas/v2_new_connection_cora_1" }, { "$ref": "#/components/schemas/v2_new_connection_cresol_1" }, { "$ref": "#/components/schemas/v2_new_connection_daycoval_1" }, { "$ref": "#/components/schemas/v2_new_connection_digisac_1" }, { "$ref": "#/components/schemas/v2_new_connection_example_bank_1" }, { "$ref": "#/components/schemas/v2_new_connection_inter_2" }, { "$ref": "#/components/schemas/v2_new_connection_itau_2" }, { "$ref": "#/components/schemas/v2_new_connection_itau_3" }, { "$ref": "#/components/schemas/v2_new_connection_pjbank_1" }, { "$ref": "#/components/schemas/v2_new_connection_qitech_1" }, { "$ref": "#/components/schemas/v2_new_connection_safra_1" }, { "$ref": "#/components/schemas/v2_new_connection_safra_2" }, { "$ref": "#/components/schemas/v2_new_connection_santander_1" }, { "$ref": "#/components/schemas/v2_new_connection_santander_2" }, { "$ref": "#/components/schemas/v2_new_connection_santander_3" }, { "$ref": "#/components/schemas/v2_new_connection_semear_1" }, { "$ref": "#/components/schemas/v2_new_connection_sicoob_2" }, { "$ref": "#/components/schemas/v2_new_connection_sicredi_2" }, { "$ref": "#/components/schemas/v2_new_connection_sicredi_3" } ] } } }, "required": true, "description": "Informações da conexão a ser cadastrada." } }, "get": { "summary": "Listar Conexões", "tags": [ "Conexões" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todas as conexões cadastradas com filtros opcionais por provedor, certificado, status de habilitação e validação.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "provider_slug", "in": "query", "description": "Provedor financeiro", "example": "bradesco", "required": false, "schema": { "type": "string" } }, { "name": "certificate_uid", "in": "query", "description": "UUID do Certificado", "example": "aafd1e-96684662a-6c19c5f-9c991", "required": false, "schema": { "type": "string" } }, { "name": "enabled", "in": "query", "description": "Conexões habilitadas", "example": true, "required": false, "schema": { "type": "boolean" } }, { "name": "validated", "in": "query", "description": "Conexões validadas", "example": true, "required": false, "schema": { "type": "boolean" } }, { "name": "created_from", "in": "query", "description": "Data inicial do filtro de data de criação da conexão.", "example": "2025-01-01", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "description": "Data final do filtro de data de criação da conexão.", "example": "2025-01-01", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Conexões encontradas", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d8e-ec81-7e7e-ad59-327868489c3a", "certificate_uid": null, "keypair_uid": null, "label": "Connection Name", "apis": [], "provider_slug": "digisac", "environment": "production", "created_at": "2026-09-04T12:54:38-05:00", "updated_at": "2026-09-04T12:54:38-05:00", "enabled_at": null, "validated_at": null, "validate_failed_at": null, "association_failures": [], "associations": [] }, { "uid": "01a06d8e-ec79-7c61-b943-81bc435481e5", "certificate_uid": null, "keypair_uid": null, "label": "Connection Name", "apis": [], "provider_slug": "digisac", "environment": "production", "created_at": "2026-09-04T12:54:38-05:00", "updated_at": "2026-09-04T12:54:38-05:00", "enabled_at": null, "validated_at": null, "validate_failed_at": null, "association_failures": [], "associations": [] } ], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_connection" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/admin/connections/{uid}": { "get": { "summary": "Informações da conexão", "tags": [ "Conexões" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de uma conexão", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "required": true, "description": "UID da Conexão", "example": "e596865f-07a4-4458-88c1-fbb4ffd196e1", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Conexão encontrada", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d8e-ecfb-75ef-a2af-b3263783b7ab", "certificate_uid": null, "keypair_uid": null, "label": "Connection Name", "apis": [], "provider_slug": "digisac", "environment": "production", "created_at": "2026-09-04T12:54:38-05:00", "updated_at": "2026-09-04T12:54:38-05:00", "enabled_at": null, "validated_at": null, "validate_failed_at": null, "association_failures": [], "associations": [] } }, "schema": { "$ref": "#/components/schemas/v2_connection" } } } }, "404": { "description": "Conexão não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "put": { "summary": "Atualizar Conexão", "tags": [ "Conexões" ], "security": [ { "bearerAuth": [] } ], "description": "Atualiza uma conexão", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "required": true, "description": "UUID da Conexão", "example": "e596865f-07a4-4458-88c1-fbb4ffd196e1", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Conexão atualizada", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d8e-edb6-7db9-9ac1-471a08e295a1", "certificate_uid": null, "keypair_uid": null, "label": "Connection Name", "apis": [], "provider_slug": "digisac", "environment": "production", "created_at": "2026-09-04T12:54:38-05:00", "updated_at": "2026-09-04T12:54:38-05:00", "enabled_at": "2026-09-04T12:54:38-05:00", "validated_at": null, "validate_failed_at": null, "association_failures": [], "associations": [] } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "items": { "$ref": "#/components/schemas/v2_connection" } } } } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Conexão não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_connection_update" } } }, "required": true, "description": "Informações da conexão" } }, "delete": { "summary": "Excluir uma Conexão", "tags": [ "Conexões" ], "security": [ { "bearerAuth": [] } ], "description": "Exclui uma conexão.\n A exclusão de uma conexão resultará na remoção de todas as suas associações, impossibilitando o uso da API anteriormente conectada.\n ", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "description": "UUID da Conexão", "required": true, "example": "2e125002-f36d-485d-a9ab-543ffcdf7d36", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Conexão" }, "404": { "description": "Conexão não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/admin/subaccounts": { "post": { "summary": "Criar uma Subconta", "tags": [ "Subcontas" ], "security": [ { "bearerAuth": [] } ], "description": "Criar uma subconta", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Subconta criada", "content": { "application/json": { "example": { "status": 201, "data": { "id": 351, "uid": "01a06d8e-ef33-7f39-a3a3-9a2c1c40c379", "email": "1786fa6cb07f711744da761ccbe94cc9@emard-breitenberg.example", "business_name": null, "business_legal_name": "Empresa LTDA", "nickname": "Empresa", "business_cnpj": "GI.F7M.BBD/289X-56", "configuration": null, "parent_id": 350, "parent_uid": "01a06d8e-ef1c-7283-9a47-dfc574830212", "created_via_api": true, "api_access_token": "eyJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJLMjNybEIwN2tiTjI1bWciLCJpYXQiOjE3ODg1NDQ0NzksImF1ZCI6ImFwcC9kZXYiLCJqdGkiOiIwMWEwNmQ4ZS1lZjhhLTdhNDktYmYyZS1hMGEwYTI3Y2FiODAiLCJzdWIiOiIwMWEwNmQ4ZS1lZjMzLTdmMzktYTNhMy05YTJjMWM0MGMzNzkiLCJzcmMiOm51bGx9.FKWRueN71XpF_jAZcVbv21fShvsBiKjAaKnr3vJqjK2cfal090A73_bPzwAbHFvLxP7MmAJEXtYb03Etj-KeqA", "created_at": "2026-09-04T12:54:39-05:00", "updated_at": "2026-09-04T12:54:39-05:00", "external_id": "26843f45f68d3bc098a89c550a349bd2", "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_subaccount" } } } } } }, "422": { "description": "Dados da subconta inválidos", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "nickname", "detail": "Apelido não pode ficar em branco" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_subaccount" } } }, "required": true, "description": "Informações da subconta a ser criada." } }, "get": { "summary": "Listar Subcontas", "tags": [ "Subcontas" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todas as subcontas da conta principal com filtros opcionais por email, CNPJ e data de criação.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "email", "in": "query", "description": "Filtro por email. Busca subconta por email", "example": "exemplo@.com", "required": false, "schema": { "type": "string" } }, { "name": "business_cnpj", "in": "query", "description": "Filtro por CNPJ. Busca subconta por CNPJ", "example": "91.159.979/0001-09", "required": false, "schema": { "type": "string" } }, { "name": "created_from", "in": "query", "description": "Data inicial do filtro de data de criação da subconta", "example": "2020-01-01", "required": false, "schema": { "type": "string" } }, { "name": "created_to", "in": "query", "description": "Data final do filtro de data de criação da subconta", "example": "2020-01-01", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Subcontas encontradas", "content": { "application/json": { "example": { "status": 200, "data": [ { "id": 376, "uid": "01a06d8e-f1c8-7f8f-a62d-5464d964978e", "email": "5370c0b0c136222aef9f7aeb2bbf86e6@beer-dietrich.example", "business_name": null, "business_legal_name": "Sebastian Elias Publicidade LTDA.", "nickname": "Sebastian", "business_cnpj": "4Q.95J.GBB/ZP7S-65", "configuration": null, "parent_id": 366, "parent_uid": "01a06d8e-f117-73a5-8a4c-478be169922e", "created_via_api": false, "api_access_token": "eyJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJLMjNybEIwN2tiTjI1bWciLCJpYXQiOjE3ODg1NDQ0NzksImF1ZCI6ImFwcC9kZXYiLCJqdGkiOiIwMWEwNmQ4ZS1mMWU5LTc1MjAtOTcwMC1iNmY4MmIxNDg1NWQiLCJzdWIiOiIwMWEwNmQ4ZS1mMWM4LTdmOGYtYTYyZC01NDY0ZDk2NDk3OGUiLCJzcmMiOm51bGx9.x-pT8Tq08O2EjVEw4kR8oxmC6p62Boihs0Orc_io6WM3ZbNpTly_cohbQXpFn4QgPpT3DwlJnho81vyhYGAEBA", "created_at": "2026-09-04T12:54:39-05:00", "updated_at": "2026-09-04T12:54:39-05:00", "external_id": null, "custom_data": null, "tags": [], "tag_list": null }, { "id": 375, "uid": "01a06d8e-f1b7-77ff-ba62-1f44259e6ba9", "email": "dcfc1cd06abd11f6fe12d24c548264fe@barton.example", "business_name": null, "business_legal_name": "Sebastian Elias Publicidade LTDA.", "nickname": "Sebastian", "business_cnpj": "7B.C9H.4X0/WVQZ-34", "configuration": null, "parent_id": 366, "parent_uid": "01a06d8e-f117-73a5-8a4c-478be169922e", "created_via_api": false, "api_access_token": "eyJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJLMjNybEIwN2tiTjI1bWciLCJpYXQiOjE3ODg1NDQ0NzksImF1ZCI6ImFwcC9kZXYiLCJqdGkiOiIwMWEwNmQ4ZS1mMWVmLTczNzAtYmM5Zi1iNWIxMDhlMDNkOGIiLCJzdWIiOiIwMWEwNmQ4ZS1mMWI3LTc3ZmYtYmE2Mi0xZjQ0MjU5ZTZiYTkiLCJzcmMiOm51bGx9.pfJHkILolIMl3hjMvB-na4Vd_0Dhsf8oiCWZBO3sTiImFJhhlaOhlpT8cD79ZX791DMjyYGgrvE_ak1TFVKq3w", "created_at": "2026-09-04T12:54:39-05:00", "updated_at": "2026-09-04T12:54:39-05:00", "external_id": null, "custom_data": null, "tags": [], "tag_list": null }, { "id": 374, "uid": "01a06d8e-f1a5-769a-ae9b-f03e983d2cec", "email": "50db3ce751766155965f3fac8b04e417@rosenbaum.test", "business_name": null, "business_legal_name": "Sebastian Elias Publicidade LTDA.", "nickname": "Sebastian", "business_cnpj": "36.REB.YQX/HD3H-72", "configuration": null, "parent_id": 366, "parent_uid": "01a06d8e-f117-73a5-8a4c-478be169922e", "created_via_api": false, "api_access_token": "eyJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJLMjNybEIwN2tiTjI1bWciLCJpYXQiOjE3ODg1NDQ0NzksImF1ZCI6ImFwcC9kZXYiLCJqdGkiOiIwMWEwNmQ4ZS1mMWY0LTdmZDUtYmY2MS0yOWE3OTdlNmQ5OGIiLCJzdWIiOiIwMWEwNmQ4ZS1mMWE1LTc2OWEtYWU5Yi1mMDNlOTgzZDJjZWMiLCJzcmMiOm51bGx9.PQulcgG4yf7A6MsosGAgdXSZQGEP0iqqol4dTODa6SD0ynU-jP5lXDDmEHnhwzBFbO575EgHr_xKzcI1opaj3w", "created_at": "2026-09-04T12:54:39-05:00", "updated_at": "2026-09-04T12:54:39-05:00", "external_id": null, "custom_data": null, "tags": [], "tag_list": null }, { "id": 373, "uid": "01a06d8e-f193-732e-a131-95cffb4b193a", "email": "27fb8dd96e2a0e764014b4092557105f@bergstrom.example", "business_name": null, "business_legal_name": "Sebastian Elias Publicidade LTDA.", "nickname": "Sebastian", "business_cnpj": "CC.EQ6.4Z5/J5WX-08", "configuration": null, "parent_id": 366, "parent_uid": "01a06d8e-f117-73a5-8a4c-478be169922e", "created_via_api": false, "api_access_token": "eyJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJLMjNybEIwN2tiTjI1bWciLCJpYXQiOjE3ODg1NDQ0NzksImF1ZCI6ImFwcC9kZXYiLCJqdGkiOiIwMWEwNmQ4ZS1mMWY4LTczYmYtYTQwNS0xNDVmNGFiN2Q1MGMiLCJzdWIiOiIwMWEwNmQ4ZS1mMTkzLTczMmUtYTEzMS05NWNmZmI0YjE5M2EiLCJzcmMiOm51bGx9.xamzOXyhStST-B5ML-lrpd2rY6GyMSlx4TR_LrLLfDdc1ri6A-_lPQF-Q4PzU7XgS-dokc6xtG-V78yoghZGbA", "created_at": "2026-09-04T12:54:39-05:00", "updated_at": "2026-09-04T12:54:39-05:00", "external_id": null, "custom_data": null, "tags": [], "tag_list": null } ], "pagination": { "prev_url": null, "next_url": "/v2/admin/subaccounts?per_page=4&page=2", "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_subaccount" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/admin/subaccounts/{uid}": { "get": { "summary": "Visualizar uma Subconta", "tags": [ "Subcontas" ], "security": [ { "bearerAuth": [] } ], "description": "Visualizar uma subconta", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "required": true, "description": "UID da Subconta", "example": "acc_5f7e4f2b3c1a", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Subconta encontrada", "content": { "application/json": { "example": { "status": 200, "data": { "id": 379, "uid": "01a06d8e-f262-7ab5-aef6-e390862e4686", "email": "56328daff30c176fb7aba979519f6e6a@oconnell.example", "business_name": null, "business_legal_name": "Sebastian Elias Publicidade LTDA.", "nickname": "Sebastian", "business_cnpj": "EQ.HOL.TUA/KPYI-87", "configuration": null, "parent_id": 378, "parent_uid": "01a06d8e-f250-75a6-9d9a-7c8479e825e6", "created_via_api": false, "api_access_token": "eyJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJLMjNybEIwN2tiTjI1bWciLCJpYXQiOjE3ODg1NDQ0NzksImF1ZCI6ImFwcC9kZXYiLCJqdGkiOiIwMWEwNmQ4ZS1mMjdhLTc1NTItOTkwYS0xODIxZThjOGI5OWMiLCJzdWIiOiIwMWEwNmQ4ZS1mMjYyLTdhYjUtYWVmNi1lMzkwODYyZTQ2ODYiLCJzcmMiOm51bGx9.YrQcXi5p9DeYX5uC5N4x82jNbKBuIvEdTpQ9TW3mOJK9LF9GYKDyNc5GabZSnsVwY8x0AzIiJAS693MsfQdRUg", "created_at": "2026-09-04T12:54:39-05:00", "updated_at": "2026-09-04T12:54:39-05:00", "external_id": null, "custom_data": null, "tags": [], "tag_list": null } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_subaccount" } } } } } }, "404": { "description": "Subconta não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "put": { "summary": "Alterar Subconta", "tags": [ "Subcontas" ], "security": [ { "bearerAuth": [] } ], "description": "Alterar Subconta. Não é possível alterar o CNPJ da subconta.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "required": true, "description": "UID da Subconta", "example": "acc_5f7e4f2b3c1a", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Subconta alterada", "content": { "application/json": { "example": { "status": 200, "data": { "id": 383, "uid": "01a06d8e-f312-7bd4-8ffe-73dc37097036", "email": "1234567890example@example.com", "business_name": "HE:labs", "business_legal_name": "Disney", "nickname": "Sebastian", "business_cnpj": "B9.WJG.UHZ/6INM-08", "configuration": null, "parent_id": 382, "parent_uid": "01a06d8e-f300-79bf-8419-e0f6929c7970", "created_via_api": false, "api_access_token": "eyJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJLMjNybEIwN2tiTjI1bWciLCJpYXQiOjE3ODg1NDQ0ODAsImF1ZCI6ImFwcC9kZXYiLCJqdGkiOiIwMWEwNmQ4ZS1mMzU2LTc5MmYtYWI1YS03MjJmOGI2YWYyZTEiLCJzdWIiOiIwMWEwNmQ4ZS1mMzEyLTdiZDQtOGZmZS03M2RjMzcwOTcwMzYiLCJzcmMiOm51bGx9.WHsY7pFm6lA0DqCLywHB7Pei4PGdt5OoDQKSUuzViuXxyi5tdwm3aVAcZ55Tg9OcA_vT2iRTHCZ5oUPPCG-Tkw", "created_at": "2026-09-04T12:54:40-05:00", "updated_at": "2026-09-04T12:54:40-05:00", "external_id": "123456123456098a89c550a349bd2", "custom_data": { "any": "thing" }, "tags": [ "tag3", "tag4" ], "tag_list": "tag3,tag4" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_subaccount" } } } } } }, "404": { "description": "Subconta não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "422": { "description": "Parâmetros inválidos", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "email", "detail": "E-mail não é válido" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_subaccount_update" } } }, "required": true, "description": "Informações da subconta para serem alteradas." } } }, "/v2/admin/users": { "post": { "summary": "Incluir um Usuário", "tags": [ "Usuário" ], "security": [ { "bearerAuth": [] } ], "description": "Incluir um usuário", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Usuário incluído", "content": { "application/json": { "example": { "status": 201, "data": { "id": 2, "uid": "01a06d8e-f65e-73eb-9e9b-521e9c78a861", "email": "4a37902087067acb31ebd9de6e5af27e@bosco-feeney.test", "first_name": "Jonh", "middle_name": "Silva", "last_name": "Doe", "full_name": "Jonh Silva Doe", "created_via_api": true, "permissions": [ "*" ], "created_at": "2026-09-04T12:54:40-05:00", "updated_at": "2026-09-04T12:54:40-05:00", "enabled_at": "2026-09-04T12:54:40-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_user" } } } } } }, "422": { "description": "Dados do usuário inválido", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "email", "detail": "E-mail não pode ficar em branco" }, { "code": "validation_error", "param": "email", "detail": "E-mail não é válido" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_user" } } }, "required": true, "description": "Informações do usuário a ser incluído." } }, "get": { "summary": "Listar Usuários", "tags": [ "Usuário" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todos os usuários cadastrados na conta, com opção de filtrar por email. Suporta paginação.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "email", "in": "query", "description": "Filtro por email. Busca usuário por email", "example": "exemplo@.com", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Usuários encontrados", "content": { "application/json": { "example": { "status": 200, "data": [ { "id": 23, "uid": "01a06d8e-f81e-78b6-a0cb-30c0f53c025a", "email": "6a4dc31f5e8c665a7ad9ca141a8e4fd1@wilkinson-dach.example", "first_name": "Margret", "middle_name": "Simões", "last_name": "Gonçalo", "full_name": "Margret Simões Gonçalo", "created_via_api": false, "permissions": [ "*" ], "created_at": "2026-09-04T12:54:41-05:00", "updated_at": "2026-09-04T12:54:41-05:00", "enabled_at": "2026-09-04T12:54:41-05:00" }, { "id": 22, "uid": "01a06d8e-f813-73fc-b4f0-fb15cfe770c0", "email": "33d9a4732fd372914e6510f35ac93974@jacobi.test", "first_name": "Margret", "middle_name": "Simões", "last_name": "Gonçalo", "full_name": "Margret Simões Gonçalo", "created_via_api": false, "permissions": [ "*" ], "created_at": "2026-09-04T12:54:41-05:00", "updated_at": "2026-09-04T12:54:41-05:00", "enabled_at": "2026-09-04T12:54:41-05:00" }, { "id": 21, "uid": "01a06d8e-f808-7337-8742-fd99292e1d5b", "email": "80f0287f81717ead8bdab05289771fee@pfeffer.test", "first_name": "Margret", "middle_name": "Simões", "last_name": "Gonçalo", "full_name": "Margret Simões Gonçalo", "created_via_api": false, "permissions": [ "*" ], "created_at": "2026-09-04T12:54:41-05:00", "updated_at": "2026-09-04T12:54:41-05:00", "enabled_at": "2026-09-04T12:54:41-05:00" }, { "id": 20, "uid": "01a06d8e-f7fd-7af3-a3da-6d1690a51a68", "email": "d32dfe48de8772539d9521aabf721d6d@corkery.example", "first_name": "Margret", "middle_name": "Simões", "last_name": "Gonçalo", "full_name": "Margret Simões Gonçalo", "created_via_api": false, "permissions": [ "*" ], "created_at": "2026-09-04T12:54:41-05:00", "updated_at": "2026-09-04T12:54:41-05:00", "enabled_at": "2026-09-04T12:54:41-05:00" } ], "pagination": { "prev_url": null, "next_url": "/v2/admin/users?per_page=4&page=2", "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_user" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/admin/users/{uid}": { "put": { "summary": "Alterar Dados De Um Usuário", "tags": [ "Usuário" ], "security": [ { "bearerAuth": [] } ], "description": "Atualiza as informações de um usuário existente, incluindo nome, email e permissões.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "required": true, "description": "UID do Usuário (UUID). Também aceita o ID inteiro para compatibilidade.", "example": "019ae1b7-a1b2-7c3d-8e4f-9a0b1c2d3e4f", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Usuário Alterado", "content": { "application/json": { "example": { "status": 200, "data": { "id": 24, "uid": "01a06d8e-f894-7c2f-b0d3-a719627a35aa", "email": "baff474c9be08a1db1b5c97360c07d44@jacobi.example", "first_name": "Jonh", "middle_name": "Simões", "last_name": "Gonçalo", "full_name": "Jonh Simões Gonçalo", "created_via_api": false, "permissions": [ "charge.pix.*" ], "created_at": "2026-09-04T12:54:41-05:00", "updated_at": "2026-09-04T12:54:41-05:00", "enabled_at": "2026-09-04T12:54:41-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_user" } } } } } }, "404": { "description": "Usuário não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "422": { "description": "Parâmetros inválidos", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "email", "detail": "E-mail não é válido" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_user" } } }, "required": true, "description": "Informações do usuário a serem alteradas." } }, "delete": { "summary": "Excluir um Usuário", "tags": [ "Usuário" ], "security": [ { "bearerAuth": [] } ], "description": "Remove permanentemente um usuário do sistema.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "required": true, "description": "UID do Usuário (UUID). Também aceita o ID inteiro para compatibilidade.", "example": "019ae1b7-a1b2-7c3d-8e4f-9a0b1c2d3e4f", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Usuário excluído" }, "404": { "description": "Usuário não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/transfer/batches": { "get": { "summary": "Listar Lotes de Transferência", "tags": [ "Todos - Transferência" ], "security": [ { "bearerAuth": [] } ], "description": "Listar Lotes de Transferência.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } } ], "responses": { "200": { "description": "Sucesso na listagem dos lotes", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d90-9024-7344-a36c-cac3fe1cf925", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-8fe8-74ca-98a2-6ef3edd34342", "transfer_account_uid": "01a06d90-8ff9-7466-b6a1-bb70880054ec", "transport_kind": "pix", "transfers": [ { "uid": "01a06d90-9012-71b3-b879-a39c1b439298", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-8fe8-74ca-98a2-6ef3edd34342", "transfer_account_uid": "01a06d90-8ff9-7466-b6a1-bb70880054ec", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:25-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:25-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": "100007", "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:25-05:00", "updated_at": "2026-09-04T12:56:25-05:00" }, { "uid": "01a06d90-9018-7531-acc5-510e836f68f5", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-8fe8-74ca-98a2-6ef3edd34342", "transfer_account_uid": "01a06d90-8ff9-7466-b6a1-bb70880054ec", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:25-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:25-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": "100008", "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:25-05:00", "updated_at": "2026-09-04T12:56:25-05:00" }, { "uid": "01a06d90-901d-7636-b456-00257a46b086", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-8fe8-74ca-98a2-6ef3edd34342", "transfer_account_uid": "01a06d90-8ff9-7466-b6a1-bb70880054ec", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:25-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:25-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": "100009", "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:25-05:00", "updated_at": "2026-09-04T12:56:25-05:00" } ], "created_at": "2026-09-04T12:56:25-05:00", "updated_at": "2026-09-04T12:56:25-05:00" }, { "uid": "01a06d90-8fbd-7113-bbbd-3b3351da5cfa", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-8f82-700f-afd3-59abf7597c1d", "transfer_account_uid": "01a06d90-8f92-75c5-b8d5-68273a82898e", "transport_kind": "pix", "transfers": [ { "uid": "01a06d90-8fab-753e-bc36-3127cec07685", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-8f82-700f-afd3-59abf7597c1d", "transfer_account_uid": "01a06d90-8f92-75c5-b8d5-68273a82898e", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:25-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:25-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": "100004", "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:25-05:00", "updated_at": "2026-09-04T12:56:25-05:00" }, { "uid": "01a06d90-8fb1-76cc-b7aa-2d045f52fb4b", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-8f82-700f-afd3-59abf7597c1d", "transfer_account_uid": "01a06d90-8f92-75c5-b8d5-68273a82898e", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:25-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:25-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": "100005", "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:25-05:00", "updated_at": "2026-09-04T12:56:25-05:00" }, { "uid": "01a06d90-8fb6-7467-b0ab-2626fd01593a", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-8f82-700f-afd3-59abf7597c1d", "transfer_account_uid": "01a06d90-8f92-75c5-b8d5-68273a82898e", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:25-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:25-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": "100006", "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:25-05:00", "updated_at": "2026-09-04T12:56:25-05:00" } ], "created_at": "2026-09-04T12:56:25-05:00", "updated_at": "2026-09-04T12:56:25-05:00" }, { "uid": "01a06d90-8f56-72b2-ad8f-2d257cee7798", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-8f0d-7d62-bed0-7d4aaeecd98c", "transfer_account_uid": "01a06d90-8f1d-7b6c-931d-13ac7443735e", "transport_kind": "pix", "transfers": [ { "uid": "01a06d90-8f42-773b-a37e-ced0893eb6e8", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-8f0d-7d62-bed0-7d4aaeecd98c", "transfer_account_uid": "01a06d90-8f1d-7b6c-931d-13ac7443735e", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:25-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:25-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": "100001", "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:25-05:00", "updated_at": "2026-09-04T12:56:25-05:00" }, { "uid": "01a06d90-8f49-7c1f-a69c-0e949ad4d8de", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-8f0d-7d62-bed0-7d4aaeecd98c", "transfer_account_uid": "01a06d90-8f1d-7b6c-931d-13ac7443735e", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:25-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:25-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": "100002", "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:25-05:00", "updated_at": "2026-09-04T12:56:25-05:00" }, { "uid": "01a06d90-8f4e-77af-aee2-3dea4aac2d74", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-8f0d-7d62-bed0-7d4aaeecd98c", "transfer_account_uid": "01a06d90-8f1d-7b6c-931d-13ac7443735e", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:25-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:25-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": "100003", "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:25-05:00", "updated_at": "2026-09-04T12:56:25-05:00" } ], "created_at": "2026-09-04T12:56:25-05:00", "updated_at": "2026-09-04T12:56:25-05:00" } ], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_transfer_batch" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/transfer/batches/{uid}": { "get": { "summary": "Visualizar um Lote de Transferência", "tags": [ "Todos - Transferência" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de um Lote de Transferência.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UUID do Lote de Transferência", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Lote de Transferência encontrado", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-90ef-75b7-b830-28e8584f9a73", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-90b7-791e-8f34-46a16fe8c529", "transfer_account_uid": "01a06d90-90c6-7d82-a84a-c33fed71f81a", "transport_kind": "pix", "transfers": [ { "uid": "01a06d90-90df-70cc-8745-785947541aaa", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-90b7-791e-8f34-46a16fe8c529", "transfer_account_uid": "01a06d90-90c6-7d82-a84a-c33fed71f81a", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:25-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:25-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": "100010", "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:25-05:00", "updated_at": "2026-09-04T12:56:25-05:00" }, { "uid": "01a06d90-90e3-783a-8f80-2efbde33ed07", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-90b7-791e-8f34-46a16fe8c529", "transfer_account_uid": "01a06d90-90c6-7d82-a84a-c33fed71f81a", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:25-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:25-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": "100011", "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:25-05:00", "updated_at": "2026-09-04T12:56:25-05:00" }, { "uid": "01a06d90-90e8-7b19-ab60-3b208ba1184d", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-90b7-791e-8f34-46a16fe8c529", "transfer_account_uid": "01a06d90-90c6-7d82-a84a-c33fed71f81a", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:25-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:25-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": "100012", "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:25-05:00", "updated_at": "2026-09-04T12:56:25-05:00" } ], "created_at": "2026-09-04T12:56:25-05:00", "updated_at": "2026-09-04T12:56:25-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_transfer_batch" } } } } } }, "404": { "description": "Lote de Transferência não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/transfer/batches/{uid}/approve": { "put": { "summary": "Aprovar um Lote de Transferência", "tags": [ "Todos - Transferência" ], "security": [ { "bearerAuth": [] } ], "description": "\n > **Processamento Assíncrono:** Este endpoint é processado assincronamente e cria um comando de aprovação para o Lote de Transferência.\n A aprovação de um Lote de Transferência é feito assincronamente, ou seja, ao receber a requisição, a nossa API guarda a solicitação e cria um Comando. Esse comando é processado em segundo plano e depois de confirmado, o Lote tem seu status alterado para Aprovado. Você recebe na resposta desta requisição o ID do comando criado e pode consultá-lo a qualquer momento.\n\n ## Eventos de Webhook\n\n Quando a requisição é realizada, um evento `transfer.transfer_batch.approve.requested` é disparado.\n O nosso servidor então começa as tentativas de envio da liberação para a instituição financeira.\n Somente depois de confirmado na instituição financeira, aí então o lote é marcado como aprovado em nosso banco de dados.\n Neste momento o evento `transfer.transfer_batch.approve.confirmed` é disparado.\n\n > ⚠️ **Atenção ao status Aprovado:** O status de Aprovado não é terminal. Quando a instituição financeira confirmar as transferências, os mesmos terão seus status alterados para Confirmado", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "description": "UUID do Lote de Transferência", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Comando criado com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "id": 192, "uid": "01a06d90-91c6-7bdb-a282-800aff818b8b", "status": "pending", "operation": "approve", "resource_type": "Financial::TransferBatch", "resource_uid": "01a06d90-91a6-7439-81b9-efb8a274a535", "financial_provider_slug": "bb", "params": null, "payload": null, "created_at": "2026-09-04T12:56:26-05:00", "updated_at": "2026-09-04T12:56:26-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "financial_transfer_batch": { "uid": "01a06d90-91a6-7439-81b9-efb8a274a535", "status": "awaiting_approval", "registration_status": "confirmed", "financial_account_uid": "01a06d90-916f-75e0-a396-764c1bd609b4", "transfer_account_uid": "01a06d90-917e-7494-b49a-0994bc0979fd", "transport_kind": "pix", "transfers": [ { "uid": "01a06d90-9196-74ca-bfe3-5bcaf68eeb52", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-916f-75e0-a396-764c1bd609b4", "transfer_account_uid": "01a06d90-917e-7494-b49a-0994bc0979fd", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:26-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:26-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": "100013", "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:26-05:00", "updated_at": "2026-09-04T12:56:26-05:00" }, { "uid": "01a06d90-919b-7283-8240-0330dec1aa19", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-916f-75e0-a396-764c1bd609b4", "transfer_account_uid": "01a06d90-917e-7494-b49a-0994bc0979fd", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:26-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:26-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": "100014", "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:26-05:00", "updated_at": "2026-09-04T12:56:26-05:00" }, { "uid": "01a06d90-919f-75b1-80b1-c1734d21d7ce", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-916f-75e0-a396-764c1bd609b4", "transfer_account_uid": "01a06d90-917e-7494-b49a-0994bc0979fd", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:26-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:26-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": "100015", "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:26-05:00", "updated_at": "2026-09-04T12:56:26-05:00" } ], "created_at": "2026-09-04T12:56:26-05:00", "updated_at": "2026-09-04T12:56:26-05:00" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_transfer_batch_command" } } } } } }, "422": { "description": "Lote de Transferência não está aguardando liberação", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Aprovação de Lote de Transferência.", "detail": "Lote de Transferência não está aguardando aprovação." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/transfer/batches/{uid}/reprove": { "put": { "summary": "Reprovar um Lote de Transferência", "tags": [ "Todos - Transferência" ], "security": [ { "bearerAuth": [] } ], "description": "\n > **Processamento Assíncrono:** Este endpoint é processado assincronamente e cria um comando de reprovação para o Lote de Transferência.\n A reprovação de um Lote de Transferência é feita assincronamente, ou seja, ao receber a requisição, a nossa API guarda a solicitação e cria um Comando. Esse comando é processado em segundo plano e depois de confirmado, o Lote tem seu status alterado para Reprovado. Você recebe na resposta desta requisição o ID do comando criado e pode consultá-lo a qualquer momento.\n\n ## Eventos de Webhook\n\n Quando a requisição é realizada, um evento `transfer.transfer_batch.reprove.requested` é disparado.\n O nosso servidor então começa as tentativas de envio da liberação para a instituição financeira.\n Somente depois de confirmado na instituição financeira, aí então o lote é marcado como aprovado em nosso banco de dados.\n Neste momento o evento `transfer.transfer_batch.reprove.confirmed` é disparado.\n\n > ⚠️ **Atenção ao status Reprovado:** O status de Reprovado é terminal. Quando a instituição financeira cancelar as transferências, os mesmos terão seus status alterados para Reprovado", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "description": "UUID do Lote de Transferência", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Comando criado com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "id": 197, "uid": "01a06d90-94db-779e-a057-aa6a2b2a1532", "status": "pending", "operation": "reprove", "resource_type": "Financial::TransferBatch", "resource_uid": "01a06d90-94ba-7555-a99f-ebde4a5055e0", "financial_provider_slug": "bb", "params": null, "payload": null, "created_at": "2026-09-04T12:56:26-05:00", "updated_at": "2026-09-04T12:56:26-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "financial_transfer_batch": { "uid": "01a06d90-94ba-7555-a99f-ebde4a5055e0", "status": "awaiting_approval", "registration_status": "confirmed", "financial_account_uid": "01a06d90-947e-75ab-a6ba-9c87c433991c", "transfer_account_uid": "01a06d90-948e-78bd-9104-36bc67e2cbff", "transport_kind": "pix", "transfers": [ { "uid": "01a06d90-94a7-7a5f-8c7a-901d3ea81a7c", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-947e-75ab-a6ba-9c87c433991c", "transfer_account_uid": "01a06d90-948e-78bd-9104-36bc67e2cbff", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:26-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:26-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": "100022", "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:26-05:00", "updated_at": "2026-09-04T12:56:26-05:00" }, { "uid": "01a06d90-94ad-7e2c-add2-8a633ad83b19", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-947e-75ab-a6ba-9c87c433991c", "transfer_account_uid": "01a06d90-948e-78bd-9104-36bc67e2cbff", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:26-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:26-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": "100023", "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:26-05:00", "updated_at": "2026-09-04T12:56:26-05:00" }, { "uid": "01a06d90-94b3-7969-acc3-0172617d40b4", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-947e-75ab-a6ba-9c87c433991c", "transfer_account_uid": "01a06d90-948e-78bd-9104-36bc67e2cbff", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:26-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:26-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": "100024", "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:26-05:00", "updated_at": "2026-09-04T12:56:26-05:00" } ], "created_at": "2026-09-04T12:56:26-05:00", "updated_at": "2026-09-04T12:56:26-05:00" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_transfer_batch_command" } } } } } }, "422": { "description": "Lote de Transferência não está aguardando liberação", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Reprovação de Lote de Transferência.", "detail": "Lote de Transferência não está aguardando aprovação." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/transfer/batches/{uid}/cancel": { "put": { "summary": "Cancelar um Lote de Transferência", "tags": [ "Todos - Transferência" ], "security": [ { "bearerAuth": [] } ], "description": "\n > **Cancelamento:** Este endpoint cancela o Lote de Transferência. O comportamento depende do estado de registro do lote.\n\n - **Não registrado no provedor:** O lote é cancelado imediatamente de forma local, sem interação com a instituição financeira. A resposta contém o lote atualizado.\n - **Registrado no provedor (API de cancelamento suportada):** Um Comando de cancelamento é criado e processado assincronamente. A resposta contém o Comando criado.\n - **Registrado no provedor (API de cancelamento não suportada):** Um Comando de cancelamento é criado por Transferência individualmente. A resposta contém o lote atualizado.\n\n O cancelamento é possível nos estados: `pending`, `awaiting_approval`, `confirmed` e `approved`.\n\n > ⚠️ **Atenção ao status Cancelado:** O status de Cancelado é terminal.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "description": "UUID do Lote de Transferência", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Cancelado com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "id": 202, "uid": "01a06d90-9796-7c6d-9d46-6666769c2207", "status": "pending", "operation": "cancel", "resource_type": "Financial::TransferBatch", "resource_uid": "01a06d90-9776-721b-9f75-fc815e265aff", "financial_provider_slug": "bb", "params": null, "payload": null, "created_at": "2026-09-04T12:56:27-05:00", "updated_at": "2026-09-04T12:56:27-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "financial_transfer_batch": { "uid": "01a06d90-9776-721b-9f75-fc815e265aff", "status": "awaiting_approval", "registration_status": "confirmed", "financial_account_uid": "01a06d90-973b-7145-8639-7686afb99a9b", "transfer_account_uid": "01a06d90-974b-71a5-b2a8-e88d2cb9a63b", "transport_kind": "pix", "transfers": [ { "uid": "01a06d90-9764-75fe-9101-4167fd96f8c0", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-973b-7145-8639-7686afb99a9b", "transfer_account_uid": "01a06d90-974b-71a5-b2a8-e88d2cb9a63b", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:27-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:27-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": "100031", "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:27-05:00", "updated_at": "2026-09-04T12:56:27-05:00" }, { "uid": "01a06d90-9769-7dea-80f2-f8689abe4058", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-973b-7145-8639-7686afb99a9b", "transfer_account_uid": "01a06d90-974b-71a5-b2a8-e88d2cb9a63b", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:27-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:27-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": "100032", "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:27-05:00", "updated_at": "2026-09-04T12:56:27-05:00" }, { "uid": "01a06d90-976e-7fef-b6e2-41c91eb11576", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-973b-7145-8639-7686afb99a9b", "transfer_account_uid": "01a06d90-974b-71a5-b2a8-e88d2cb9a63b", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:27-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:27-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": "100033", "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:27-05:00", "updated_at": "2026-09-04T12:56:27-05:00" } ], "created_at": "2026-09-04T12:56:27-05:00", "updated_at": "2026-09-04T12:56:27-05:00" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "oneOf": [ { "$ref": "#/components/schemas/v2_transfer_batch_command" }, { "$ref": "#/components/schemas/v2_transfer_batch" } ], "description": "Comando de cancelamento (`transfer_batch_command`) quando o lote registrado é cancelado via API em lote do provedor, ou o próprio Lote de Transferência atualizado (`transfer_batch`) no cancelamento local pré-registro e no fallback por Transferência." } } } } } }, "422": { "description": "Lote de Transferência não pode ser cancelado no estado atual", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Cancelamento de Lote de Transferência.", "detail": "Lote de Transferência não pode ser cancelado no estado atual." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/transfer/internal_batches": { "post": { "summary": "Criar um Lote de Transferência Entre Contas", "tags": [ "Entre Contas" ], "security": [ { "bearerAuth": [] } ], "description": "\nEsse endpoint é utilizado para a geração de um lote de transferência Entre Contas.\n\n## Pré-requisito\n\nPara emitir um lote de transferência é necessário ter uma Conta Financeira, informada em `financial_account_uid`. A conta de transferência aplicada ao lote é definida em `transfer_account_uid`; se omitida, usa-se a mais antiga vinculada à conta financeira; se informada, deve pertencer à `financial_account_uid`.\n\n## Eventos de Webhook\n\nO evento `transfer.batch.db.created` é disparado nesta operação.\n\nAo cadastrar um Lote de Transferência, 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 `transfer.internal_batch.confirmed` é disparado.\n\nO evento `transfer.db.created` também é disparado nesta operação caso o lote contenha uma nova transferência.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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 Transferência Entre Contas criado", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-988a-7e3c-9786-f12ccb0f0239", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-9865-7675-a957-b1c43582d9d5", "transfer_account_uid": "01a06d90-9872-7ac5-bb59-2e7978e1ce38", "transport_kind": "internal", "transfers": [ { "uid": "01a06d90-9889-7706-b068-bc6b4973f105", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-9865-7675-a957-b1c43582d9d5", "transfer_account_uid": "01a06d90-9872-7ac5-bb59-2e7978e1ce38", "amount": 100.0, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": { "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x" }, "pix": null, "transfer_kind": "internal" }, "kind": "internal", "pix": null, "ted": null, "internal": { "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x" }, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": null, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:27-05:00", "updated_at": "2026-09-04T12:56:27-05:00" }, { "uid": "01a06d90-9889-7f27-859a-9e6a12fdabdb", "status": "pending", "scheduled_to": "2026-10-04T12:56:27-05:00", "registration_status": "pending", "financial_account_uid": "01a06d90-9865-7675-a957-b1c43582d9d5", "transfer_account_uid": "01a06d90-9872-7ac5-bb59-2e7978e1ce38", "amount": 100.0, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": { "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x" }, "pix": null, "transfer_kind": "internal" }, "kind": "internal", "pix": null, "ted": null, "internal": { "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x" }, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": null, "identifier": null, "external_id": "26843f45f68d3bc098a89c550a34845847", "financial_provider_external_id": null, "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:27-05:00", "updated_at": "2026-09-04T12:56:27-05:00" } ], "created_at": "2026-09-04T12:56:27-05:00", "updated_at": "2026-09-04T12:56:27-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_transfer_batch" } } } } } }, "422": { "description": "Erro de validação — external_id duplicado", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "transfers.external_id", "detail": "ID Externo já está em uso" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_transfer_batch_internal" } } }, "required": true, "description": "Parametros para criação de um Lote de Transferência Entre Contas" } } }, "/v2/transfer/internal": { "get": { "summary": "Listar Transferências Entre Contas", "tags": [ "Entre Contas" ], "security": [ { "bearerAuth": [] } ], "description": "Listar Transferências Entre Contas.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } } ], "responses": { "200": { "description": "Sucesso na listagem das transferências", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d90-9ac6-77e1-85c9-404d105a704c", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-9a9f-7d70-a86b-86843b662c87", "transfer_account_uid": "01a06d90-9aae-7d08-8218-e4bc9aa24f29", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": { "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x" }, "pix": null, "transfer_kind": "internal" }, "kind": "internal", "pix": null, "ted": null, "internal": { "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x" }, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:28-05:00", "updated_at": "2026-09-04T12:56:28-05:00" }, { "uid": "01a06d90-9a7c-7813-a774-4bfd55c0ffd4", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-9a54-79c1-b97a-9b3f47b76653", "transfer_account_uid": "01a06d90-9a64-75fc-aefd-cf63584549f9", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": { "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x" }, "pix": null, "transfer_kind": "internal" }, "kind": "internal", "pix": null, "ted": null, "internal": { "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x" }, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:28-05:00", "updated_at": "2026-09-04T12:56:28-05:00" }, { "uid": "01a06d90-9a35-7b66-a149-083dc5add7fc", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-9a10-7acf-9467-cb0e61bfb33a", "transfer_account_uid": "01a06d90-9a1e-7c84-9cad-5bf7a72d79a6", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": { "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x" }, "pix": null, "transfer_kind": "internal" }, "kind": "internal", "pix": null, "ted": null, "internal": { "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x" }, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:28-05:00", "updated_at": "2026-09-04T12:56:28-05:00" } ], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_transfer" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "post": { "summary": "Criar uma Transferência Entre Contas", "tags": [ "Entre Contas" ], "security": [ { "bearerAuth": [] } ], "description": "\nEsse endpoint é utilizado para a geração de uma transferência Entre Contas.\n\n## Pré-requisito\n\nPara emitir uma transferência é necessário ter uma Conta Financeira, informada em `financial_account_uid`. A conta de transferência que registra a operação é definida em `transfer_account_uid`; se omitida, usa-se a mais antiga vinculada à conta financeira; se informada, deve pertencer à `financial_account_uid`.\n\n## Eventos de Webhook\n\nO evento `transfer.db.created` é disparado nesta operação.\n\n> **Próximos passos:** Após criar uma transferência, você desejará em algum momento enviar um Lote para a instituição financeira. Para isso, utilize o endpoint `POST /api/v2/transfer/internal_batches`.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Transferência Entre Contas criada", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-9bb0-7a4b-9c77-bbf2c00d4856", "status": "pending", "scheduled_to": "2026-09-04T12:56:28-05:00", "registration_status": "pending", "financial_account_uid": "01a06d90-9b89-7925-8fcd-e031bfecfd68", "transfer_account_uid": "01a06d90-9b98-7a57-add8-e636c5dde7bd", "amount": 100.4, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": { "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x" }, "pix": null, "transfer_kind": "internal" }, "kind": "internal", "pix": null, "ted": null, "internal": { "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x" }, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": "26843f45f68d3bc098a89c550a34845847", "financial_provider_external_id": null, "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:28-05:00", "updated_at": "2026-09-04T12:56:28-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_transfer" } } } } } }, "422": { "description": "Erro de validação", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "amount", "detail": "Quantia deve ser maior que 0" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_transfer_internal" } } }, "required": true, "description": "Parametros para criação de uma Transferência Entre Contas" } } }, "/v2/transfer/internal/{uid}": { "get": { "summary": "Visualizar uma Transferência Entre Contas", "tags": [ "Entre Contas" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de uma Transferência Entre Contas.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UUID da Transferência", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Transferência Entre Contas encontrada", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-9ce3-702b-bbd3-3a29398794a7", "status": "pending", "scheduled_to": "2026-09-05T12:56:28-05:00", "registration_status": "pending", "financial_account_uid": "01a06d90-9cbb-746e-8f5a-7e7ac8ef185c", "transfer_account_uid": "01a06d90-9ccb-7c4a-a3c1-d8d4a01e9fb7", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": { "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x" }, "pix": null, "transfer_kind": "internal" }, "kind": "internal", "pix": null, "ted": null, "internal": { "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x" }, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:29-05:00", "updated_at": "2026-09-04T12:56:29-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_transfer" } } } } } }, "404": { "description": "Transferência Entre Contas não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/transfer/internal/{uid}/cancel": { "put": { "summary": "Cancelar uma Transferência Entre Contas", "tags": [ "Entre Contas" ], "security": [ { "bearerAuth": [] } ], "description": "\n> **Processamento Assíncrono:** Este endpoint é processado assincronamente e cria um comando de cancelamento para a Transferência.\nO cancelamento de uma Transferência é feito assincronamente, ou seja, ao receber a requisição, a nossa API guarda a solicitação e cria um Comando. Esse comando é processado em segundo plano e depois de confirmado, a Transferência tem seu status alterado para Cancelado. Você recebe na resposta desta requisição o ID do comando criado e pode consultá-lo a qualquer momento.\n\n## Eventos de Webhook\n\nQuando a requisição é realizada, um evento `transfer.internal.cancel.requested` é disparado.\nO nosso servidor então começa as tentativas de envio do cancelamento para a instituição financeira.\nSomente depois de confirmado na instituição financeira, aí então a transferência é marcada como cancelada em nosso banco de dados.\nNeste momento o evento `transfer.internal.cancel.confirmed` é disparado.\n\n> ⚠️ **Atenção ao status Cancelado:** O status de Cancelado é terminal. A transferência não poderá mais ser processada após o cancelamento.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "description": "UUID da Transferência", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Comando criado com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "id": 203, "uid": "01a06d90-9d9e-79a6-915e-ded25daa85a3", "status": "pending", "operation": "cancel", "resource_type": "Transfer", "resource_uid": "01a06d90-9d82-7240-97ab-684a714ef013", "financial_provider_slug": "bb", "params": null, "payload": null, "created_at": "2026-09-04T12:56:29-05:00", "updated_at": "2026-09-04T12:56:29-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "financial_transfer": { "uid": "01a06d90-9d82-7240-97ab-684a714ef013", "status": "pending", "scheduled_to": null, "registration_status": "confirmed", "financial_account_uid": "01a06d90-9d5a-721d-bca2-aa10a1cda593", "transfer_account_uid": "01a06d90-9d6a-771e-bdc1-2927343ec8cc", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": { "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x" }, "pix": null, "transfer_kind": "internal" }, "kind": "internal", "pix": null, "ted": null, "internal": { "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x" }, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:29-05:00", "updated_at": "2026-09-04T12:56:29-05:00" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_transfer_command" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "422": { "description": "Transferência já foi confirmada ou rejeitada", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Cancelamento de Transferência.", "detail": "Transferência já foi confirmada ou rejeitada." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/transfer/internal/{uid}/approve": { "put": { "summary": "Liberar (aprovar) uma Transferência interna", "tags": [ "INTERNAL" ], "security": [ { "bearerAuth": [] } ], "description": "\n> **Processamento Assíncrono:** cria um comando de liberação (approve) para a Transferência aguardando aprovação.\n\n> ⚠️ **Suporte por banco:** nenhum provedor financeiro suporta liberação de transferência interna via API no momento — a chamada responde `422` (\"não possui suporte a esta operação via API para este provedor financeiro\"). O endpoint existe para simetria e habilita o suporte automaticamente quando algum provedor o implementar.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UUID da Transferência", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "422": { "description": "Provedor sem suporte à liberação via API", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Liberação de Transferência.", "detail": "Transferência não possui suporte a esta operação via API para este provedor financeiro" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/transfer/internal/{uid}/reschedule": { "put": { "summary": "Reagendar (mudar a data) uma Transferência interna", "tags": [ "INTERNAL" ], "security": [ { "bearerAuth": [] } ], "description": "\n> **Processamento Assíncrono:** cria um comando de reagendamento (mudança da data de pagamento) para a Transferência.\n\n> ⚠️ **Suporte por banco:** nenhum provedor financeiro suporta reagendamento de transferência interna via API no momento — a chamada responde `422` (\"não possui suporte a esta operação via API para este provedor financeiro\"). O endpoint existe para simetria e habilita o suporte automaticamente quando algum provedor o implementar.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UUID da Transferência", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "422": { "description": "Provedor sem suporte ao reagendamento via API", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Reagendamento de Transferência.", "detail": "Transferência nova data não pode ser no passado" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "Nova data de pagamento (YYYY-MM-DD).", "example": "2026-07-10" } }, "required": [ "date" ] } } }, "required": true } } }, "/v2/transfer/pix_batches": { "post": { "summary": "Criar um Lote de Transferência Pix", "tags": [ "Pix - Transferência" ], "security": [ { "bearerAuth": [] } ], "description": "\nEsse endpoint é utilizado para a geração de um lote de transferência pix.\n\n## Pré-requisito\n\nPara emitir um lote de transferência é necessário ter uma Conta Financeira, informada em `financial_account_uid`. A conta de transferência aplicada ao lote é definida em `transfer_account_uid`; se omitida, usa-se a mais antiga vinculada à conta financeira; se informada, deve pertencer à `financial_account_uid`.\n\n## Eventos de Webhook\n\nO evento `transfer.batch.db.created` é disparado nesta operação.\n\nAo cadastrar um Lote de Transferência, 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 `transfer.pix_batch.confirmed` é disparado.\n\nO evento `transfer.db.created` também é disparado nesta operação caso o lote contenha uma nova transferência.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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 Transferência Pix criado", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-a104-7a8a-b631-b454f762d86e", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-a0de-7ae6-90c3-f28f6c70ef39", "transfer_account_uid": "01a06d90-a0eb-7be8-817a-a92067039038", "transport_kind": "pix", "transfers": [ { "uid": "01a06d90-a103-7d44-b03e-d4cac7035a67", "status": "pending", "scheduled_to": "2026-09-05T12:56:30-05:00", "registration_status": "pending", "financial_account_uid": "01a06d90-a0de-7ae6-90c3-f28f6c70ef39", "transfer_account_uid": "01a06d90-a0eb-7be8-817a-a92067039038", "amount": 100.0, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "pix": { "pix_type": "bank_account", "txid": null, "key": null, "key_type": null, "end_to_end_id": null }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "bank_account", "txid": null, "key": null, "key_type": null, "end_to_end_id": null, "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": null, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:30-05:00", "updated_at": "2026-09-04T12:56:30-05:00" }, { "uid": "01a06d90-a104-77a6-81ca-73d87070c1b2", "status": "pending", "scheduled_to": "2026-09-05T12:56:30-05:00", "registration_status": "pending", "financial_account_uid": "01a06d90-a0de-7ae6-90c3-f28f6c70ef39", "transfer_account_uid": "01a06d90-a0eb-7be8-817a-a92067039038", "amount": 100.0, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "pix": { "pix_type": "bank_account", "txid": null, "key": null, "key_type": null, "end_to_end_id": null }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "bank_account", "txid": null, "key": null, "key_type": null, "end_to_end_id": null, "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": null, "identifier": null, "external_id": "26843f45f68d3bc098a89c550a34845847", "financial_provider_external_id": null, "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:30-05:00", "updated_at": "2026-09-04T12:56:30-05:00" } ], "created_at": "2026-09-04T12:56:30-05:00", "updated_at": "2026-09-04T12:56:30-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_transfer_batch" } } } } } }, "422": { "description": "Erro de validação — external_id duplicado", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "transfers.external_id", "detail": "ID Externo já está em uso" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_transfer_batch_pix" } } }, "required": true, "description": "Parametros para criação de um Lote de Transferência Pix" } } }, "/v2/transfer/pix": { "get": { "summary": "Listar Transferências Pix", "tags": [ "Pix - Transferência" ], "security": [ { "bearerAuth": [] } ], "description": "Listar Transferências Pix.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } } ], "responses": { "200": { "description": "Sucesso na listagem das transferências", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d90-a350-7346-b6db-58a39cfaf36c", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-a32a-7829-ba08-36b5720cf980", "transfer_account_uid": "01a06d90-a339-7651-bc82-d1f46548216a", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:30-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:30-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": null, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:30-05:00", "updated_at": "2026-09-04T12:56:30-05:00" }, { "uid": "01a06d90-a30a-721d-bea3-08bce110cdb8", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-a2e3-77a4-a03a-3702ddb82b6e", "transfer_account_uid": "01a06d90-a2f2-7839-9dcb-ad088bc640e5", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:30-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:30-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": null, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:30-05:00", "updated_at": "2026-09-04T12:56:30-05:00" }, { "uid": "01a06d90-a2c3-7dc4-b474-757e1809f8b1", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-a29c-7e82-ba42-56bde4097b02", "transfer_account_uid": "01a06d90-a2ac-7c2f-94f4-8e5cee77a5fd", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:30-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:30-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": null, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:30-05:00", "updated_at": "2026-09-04T12:56:30-05:00" } ], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_transfer" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "post": { "summary": "Criar uma Transferência Pix", "tags": [ "Pix - Transferência" ], "security": [ { "bearerAuth": [] } ], "description": "\nEsse endpoint é utilizado para a geração de uma transferência Pix.\n\n## Pré-requisito\n\nPara emitir uma transferência é necessário ter uma Conta Financeira, informada em `financial_account_uid`. A conta de transferência que registra a operação é definida em `transfer_account_uid`; se omitida, usa-se a mais antiga vinculada à conta financeira; se informada, deve pertencer à `financial_account_uid`.\n\n## Eventos de Webhook\n\nO evento `transfer.db.created` é disparado nesta operação.\n\n> **Próximos passos:** Após criar uma transferência, você desejará em algum momento enviar um Lote para a instituição financeira. Para isso, utilize o endpoint `POST /api/v2/transfer/pix_batches`.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Transferência Pix criada", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-a40a-761b-949c-9c5beb853127", "status": "pending", "scheduled_to": "2026-09-04T12:56:30-05:00", "registration_status": "pending", "financial_account_uid": "01a06d90-a3e4-710e-8934-a493fa9e0d07", "transfer_account_uid": "01a06d90-a3f1-75c3-b2fc-6e16599ede57", "amount": 100.4, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "pix": { "pix_type": "bank_account", "txid": null, "key": null, "key_type": null, "end_to_end_id": null }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "bank_account", "txid": null, "key": null, "key_type": null, "end_to_end_id": null, "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": null, "identifier": "SID0987654321", "external_id": "26843f45f68d3bc098a89c550a34845847", "financial_provider_external_id": null, "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:30-05:00", "updated_at": "2026-09-04T12:56:30-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_transfer" } } } } } }, "422": { "description": "Erro de validação", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "amount", "detail": "Quantia deve ser maior que 0" }, { "code": "validation_error", "param": "target", "detail": "Dados de destino Dados bancários Número ISPB não corresponde ao banco informado (COMPE)" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_transfer_pix" } } }, "required": true, "description": "Parametros para criação de uma Transferência Pix" } } }, "/v2/transfer/pix/{uid}": { "get": { "summary": "Visualizar uma Transferência Pix", "tags": [ "Pix - Transferência" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de uma Transferência Pix.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UUID da Transferência", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Transferência Pix encontrada", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-a5a0-7c5e-b9c9-19332f43ea35", "status": "pending", "scheduled_to": "2026-09-05T12:56:31-05:00", "registration_status": "pending", "financial_account_uid": "01a06d90-a578-72a9-90fa-a7f5cd8be2d2", "transfer_account_uid": "01a06d90-a587-76d8-8572-3b3520ca288e", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:31-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:31-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": "SID0987654321", "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:31-05:00", "updated_at": "2026-09-04T12:56:31-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_transfer" } } } } } }, "404": { "description": "Transferência Pix não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/transfer/pix/{uid}/cancel": { "put": { "summary": "Cancelar uma Transferência Pix", "tags": [ "Pix - Transferência" ], "security": [ { "bearerAuth": [] } ], "description": "\n> **Processamento Assíncrono:** Este endpoint é processado assincronamente e cria um comando de cancelamento para a Transferência.\nO cancelamento de uma Transferência é feito assincronamente, ou seja, ao receber a requisição, a nossa API guarda a solicitação e cria um Comando. Esse comando é processado em segundo plano e depois de confirmado, a Transferência tem seu status alterado para Cancelado. Você recebe na resposta desta requisição o ID do comando criado e pode consultá-lo a qualquer momento.\n\n## Eventos de Webhook\n\nQuando a requisição é realizada, um evento `transfer.pix.cancel.requested` é disparado.\nO nosso servidor então começa as tentativas de envio do cancelamento para a instituição financeira.\nSomente depois de confirmado na instituição financeira, aí então a transferência é marcada como cancelada em nosso banco de dados.\nNeste momento o evento `transfer.pix.cancel.confirmed` é disparado.\n\n> ⚠️ **Atenção ao status Cancelado:** O status de Cancelado é terminal. A transferência não poderá mais ser processada após o cancelamento.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "description": "UUID da Transferência", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Comando criado com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "id": 204, "uid": "01a06d90-a66b-7973-8d81-fb2eeb2b00d0", "status": "pending", "operation": "cancel", "resource_type": "Transfer", "resource_uid": "01a06d90-a655-76c4-a417-04c7a365f95c", "financial_provider_slug": "bb", "params": null, "payload": null, "created_at": "2026-09-04T12:56:31-05:00", "updated_at": "2026-09-04T12:56:31-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "financial_transfer": { "uid": "01a06d90-a655-76c4-a417-04c7a365f95c", "status": "pending", "scheduled_to": null, "registration_status": "confirmed", "financial_account_uid": "01a06d90-a62e-718d-b0e5-f2ea041700b2", "transfer_account_uid": "01a06d90-a63d-7f7d-8bec-1fe2070308d5", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:31-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:31-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:31-05:00", "updated_at": "2026-09-04T12:56:31-05:00" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_transfer_command" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "422": { "description": "Transferência já foi confirmada ou rejeitada", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Cancelamento de Transferência.", "detail": "Transferência já foi confirmada ou rejeitada." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/transfer/pix/{uid}/approve": { "put": { "summary": "Liberar (aprovar) uma Transferência Pix", "tags": [ "PIX" ], "security": [ { "bearerAuth": [] } ], "description": "\n> **Processamento Assíncrono:** cria um comando de liberação (approve) para a Transferência Pix aguardando aprovação.\n\n> ⚠️ **Suporte por banco:** nem todo provedor financeiro suporta liberação via API. Quando não suportado, a API responde `422` (\"não possui suporte a esta operação via API para este provedor financeiro\").", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "description": "UUID da Transferência", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Comando criado com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "id": 205, "uid": "01a06d90-a7ff-731b-a848-9549af67ef3c", "status": "pending", "operation": "approve", "resource_type": "Transfer", "resource_uid": "01a06d90-a7e7-795b-84b1-a850ceaab14d", "financial_provider_slug": "santander", "params": null, "payload": null, "created_at": "2026-09-04T12:56:31-05:00", "updated_at": "2026-09-04T12:56:31-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "financial_transfer": { "uid": "01a06d90-a7e7-795b-84b1-a850ceaab14d", "status": "awaiting_approval", "scheduled_to": null, "registration_status": "confirmed", "financial_account_uid": "01a06d90-a7c2-7cb5-882b-f6ac360205b1", "transfer_account_uid": "01a06d90-a7e4-70db-959b-8b955743454d", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:31-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:31-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:31-05:00", "updated_at": "2026-09-04T12:56:31-05:00" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_transfer_command" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "422": { "description": "Transferência não pode ser liberada", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Liberação de Transferência.", "detail": "Transferência não está aguardando liberação" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/transfer/pix/{uid}/reschedule": { "put": { "summary": "Reagendar (mudar a data) uma Transferência Pix", "tags": [ "PIX" ], "security": [ { "bearerAuth": [] } ], "description": "\n> **Processamento Assíncrono:** cria um comando de reagendamento (mudança da data de pagamento) para a Transferência Pix.\n\n> ⚠️ **Suporte por banco:** nem todo provedor financeiro suporta reagendamento via API. Quando não suportado, a API responde `422` (\"não possui suporte a esta operação via API para este provedor financeiro\").", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UUID da Transferência", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Comando criado com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "id": 206, "uid": "01a06d90-a994-78e4-b3f5-949332319791", "status": "pending", "operation": "reschedule", "resource_type": "Transfer", "resource_uid": "01a06d90-a97f-75ca-a591-5c78e78d8791", "financial_provider_slug": "bb", "params": { "date": "2026-09-11" }, "payload": null, "created_at": "2026-09-04T12:56:32-05:00", "updated_at": "2026-09-04T12:56:32-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "financial_transfer": { "uid": "01a06d90-a97f-75ca-a591-5c78e78d8791", "status": "scheduled", "scheduled_to": null, "registration_status": "confirmed", "financial_account_uid": "01a06d90-a957-7f71-bb42-be07a6b5da2c", "transfer_account_uid": "01a06d90-a967-72bd-a27b-ccec5b1bc790", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:32-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:32-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:32-05:00", "updated_at": "2026-09-04T12:56:32-05:00" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_transfer_command" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "422": { "description": "Transferência não pode ser reagendada", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Reagendamento de Transferência.", "detail": "Transferência não está em um estado que permita reagendamento (precisa estar registrada e ainda não confirmada)." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "Nova data de pagamento (YYYY-MM-DD).", "example": "2026-07-10" } }, "required": [ "date" ] } } }, "required": true } } }, "/v2/transfer/ted_batches": { "post": { "summary": "Criar um Lote de Transferência TED", "tags": [ "TED" ], "security": [ { "bearerAuth": [] } ], "description": "\nEsse endpoint é utilizado para a geração de um lote de transferência TED.\n\n## Pré-requisito\n\nPara emitir um lote de transferência é necessário ter uma Conta Financeira, informada em `financial_account_uid`. A conta de transferência aplicada ao lote é definida em `transfer_account_uid`; se omitida, usa-se a mais antiga vinculada à conta financeira; se informada, deve pertencer à `financial_account_uid`.\n\n## Eventos de Webhook\n\nO evento `transfer.batch.db.created` é disparado nesta operação.\n\nAo cadastrar um Lote de Transferência, 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 `transfer.ted_batch.confirmed` é disparado.\n\nO evento `transfer.db.created` também é disparado nesta operação caso o lote contenha uma nova transferência.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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 Transferência TED criado", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-ab02-764a-9f2a-8b51718860de", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-aadd-7c2d-9c3f-93594685007f", "transfer_account_uid": "01a06d90-aaea-7164-9240-bbba1e3f8ed0", "transport_kind": "ted", "transfers": [ { "uid": "01a06d90-ab00-770b-8887-dc03ea27c0b6", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-aadd-7c2d-9c3f-93594685007f", "transfer_account_uid": "01a06d90-aaea-7164-9240-bbba1e3f8ed0", "amount": 100.0, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "pix": null, "transfer_kind": "ted" }, "kind": "ted", "pix": null, "ted": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": null, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:32-05:00", "updated_at": "2026-09-04T12:56:32-05:00" }, { "uid": "01a06d90-ab01-79c7-95db-bfdc87ac8d4a", "status": "pending", "scheduled_to": "2026-10-04T12:56:32-05:00", "registration_status": "pending", "financial_account_uid": "01a06d90-aadd-7c2d-9c3f-93594685007f", "transfer_account_uid": "01a06d90-aaea-7164-9240-bbba1e3f8ed0", "amount": 100.0, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "pix": null, "transfer_kind": "ted" }, "kind": "ted", "pix": null, "ted": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": null, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:32-05:00", "updated_at": "2026-09-04T12:56:32-05:00" }, { "uid": "01a06d90-ab01-7149-90b8-515a4ead4ec3", "status": "pending", "scheduled_to": "2026-10-04T12:56:32-05:00", "registration_status": "pending", "financial_account_uid": "01a06d90-aadd-7c2d-9c3f-93594685007f", "transfer_account_uid": "01a06d90-aaea-7164-9240-bbba1e3f8ed0", "amount": 100.0, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "pix": null, "transfer_kind": "ted" }, "kind": "ted", "pix": null, "ted": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": null, "identifier": null, "external_id": "26843f45f68d3bc098a89c550a34845847", "financial_provider_external_id": null, "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:32-05:00", "updated_at": "2026-09-04T12:56:32-05:00" } ], "created_at": "2026-09-04T12:56:32-05:00", "updated_at": "2026-09-04T12:56:32-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_transfer_batch" } } } } } }, "422": { "description": "Erro de validação — external_id duplicado", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "transfers.external_id", "detail": "ID Externo já está em uso" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_transfer_batch_ted" } } }, "required": true, "description": "Parametros para criação de um Lote de Transferência TED" } } }, "/v2/transfer/ted": { "get": { "summary": "Listar Transferências TED", "tags": [ "TED" ], "security": [ { "bearerAuth": [] } ], "description": "Listar Transferências TED.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } } ], "responses": { "200": { "description": "Sucesso na listagem das transferências", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d90-ad9b-7e56-bd26-fbee493e48ff", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-ad6f-7d84-a279-ac05ed8d12d2", "transfer_account_uid": "01a06d90-ad80-7b3f-b998-28f3533150b1", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "pix": null, "transfer_kind": "ted" }, "kind": "ted", "pix": null, "ted": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:33-05:00", "updated_at": "2026-09-04T12:56:33-05:00" }, { "uid": "01a06d90-ad22-7906-8bca-c21f729ef8ee", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-acfb-710c-b9ab-c4d866538be1", "transfer_account_uid": "01a06d90-ad0b-704e-95f1-e9a5da566aa8", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "pix": null, "transfer_kind": "ted" }, "kind": "ted", "pix": null, "ted": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:33-05:00", "updated_at": "2026-09-04T12:56:33-05:00" }, { "uid": "01a06d90-acdb-7ce8-b84b-ef54375d2525", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-aca3-774b-aae9-109f1f71f362", "transfer_account_uid": "01a06d90-acb8-7454-9a75-1134f3411442", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "pix": null, "transfer_kind": "ted" }, "kind": "ted", "pix": null, "ted": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:33-05:00", "updated_at": "2026-09-04T12:56:33-05:00" } ], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_transfer" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "post": { "summary": "Criar uma Transferência TED", "tags": [ "TED" ], "security": [ { "bearerAuth": [] } ], "description": "\nEsse endpoint é utilizado para a geração de uma transferência TED.\n\n## Pré-requisito\n\nPara emitir uma transferência é necessário ter uma Conta Financeira, informada em `financial_account_uid`. A conta de transferência que registra a operação é definida em `transfer_account_uid`; se omitida, usa-se a mais antiga vinculada à conta financeira; se informada, deve pertencer à `financial_account_uid`.\n\n## Eventos de Webhook\n\nO evento `transfer.db.created` é disparado nesta operação.\n\n> **Próximos passos:** Após criar uma transferência, você desejará em algum momento enviar um Lote para a instituição financeira. Para isso, utilize o endpoint `POST /api/v2/transfer/ted_batches`.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Transferência TED criada", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-ae83-72cb-a930-bc89b089591a", "status": "pending", "scheduled_to": "2026-09-04T12:56:33-05:00", "registration_status": "pending", "financial_account_uid": "01a06d90-ae5a-7795-b58a-74b231361bfb", "transfer_account_uid": "01a06d90-ae68-7af6-b63a-285709946295", "amount": 100.4, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "pix": null, "transfer_kind": "ted" }, "kind": "ted", "pix": null, "ted": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": "26843f45f68d3bc098a89c550a34845847", "financial_provider_external_id": null, "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:33-05:00", "updated_at": "2026-09-04T12:56:33-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_transfer" } } } } } }, "422": { "description": "Erro de validação", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "amount", "detail": "Quantia deve ser maior que 0" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_transfer_ted" } } }, "required": true, "description": "Parametros para criação de uma Transferência TED" } } }, "/v2/transfer/ted/{uid}": { "get": { "summary": "Visualizar uma Transferência TED", "tags": [ "TED" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de uma Transferência TED.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UUID da Transferência", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Transferência TED encontrada", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-afcd-7765-bff6-efc3c3356c33", "status": "pending", "scheduled_to": "2026-09-05T12:56:33-05:00", "registration_status": "pending", "financial_account_uid": "01a06d90-afa3-7da4-8e22-3e0b8f681bc7", "transfer_account_uid": "01a06d90-afb3-7d28-813e-f02487421f10", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "pix": null, "transfer_kind": "ted" }, "kind": "ted", "pix": null, "ted": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:33-05:00", "updated_at": "2026-09-04T12:56:33-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_transfer" } } } } } }, "404": { "description": "Transferência TED não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/transfer/ted/{uid}/cancel": { "put": { "summary": "Cancelar uma Transferência TED", "tags": [ "TED" ], "security": [ { "bearerAuth": [] } ], "description": "\n> **Processamento Assíncrono:** Este endpoint é processado assincronamente e cria um comando de cancelamento para a Transferência.\nO cancelamento de uma Transferência é feito assincronamente, ou seja, ao receber a requisição, a nossa API guarda a solicitação e cria um Comando. Esse comando é processado em segundo plano e depois de confirmado, a Transferência tem seu status alterado para Cancelado. Você recebe na resposta desta requisição o ID do comando criado e pode consultá-lo a qualquer momento.\n\n## Eventos de Webhook\n\nQuando a requisição é realizada, um evento `transfer.ted.cancel.requested` é disparado.\nO nosso servidor então começa as tentativas de envio do cancelamento para a instituição financeira.\nSomente depois de confirmado na instituição financeira, aí então a transferência é marcada como cancelada em nosso banco de dados.\nNeste momento o evento `transfer.ted.cancel.confirmed` é disparado.\n\n> ⚠️ **Atenção ao status Cancelado:** O status de Cancelado é terminal. A transferência não poderá mais ser processada após o cancelamento.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "description": "UUID da Transferência", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Comando criado com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "id": 207, "uid": "01a06d90-b095-7cc3-af7d-3c10f2875104", "status": "pending", "operation": "cancel", "resource_type": "Transfer", "resource_uid": "01a06d90-b07f-7ea4-9f28-0795d5e6eac0", "financial_provider_slug": "bb", "params": null, "payload": null, "created_at": "2026-09-04T12:56:34-05:00", "updated_at": "2026-09-04T12:56:34-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "financial_transfer": { "uid": "01a06d90-b07f-7ea4-9f28-0795d5e6eac0", "status": "pending", "scheduled_to": null, "registration_status": "confirmed", "financial_account_uid": "01a06d90-b057-7556-9802-ec6cfcb8f8b8", "transfer_account_uid": "01a06d90-b066-7ff1-a518-580a5fbf756c", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "pix": null, "transfer_kind": "ted" }, "kind": "ted", "pix": null, "ted": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:34-05:00", "updated_at": "2026-09-04T12:56:34-05:00" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_transfer_command" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "422": { "description": "Transferência já foi confirmada ou rejeitada", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Cancelamento de Transferência.", "detail": "Transferência já foi confirmada ou rejeitada." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/transfer/ted/{uid}/approve": { "put": { "summary": "Liberar (aprovar) uma Transferência TED", "tags": [ "TED" ], "security": [ { "bearerAuth": [] } ], "description": "\n> **Processamento Assíncrono:** cria um comando de liberação (approve) para a Transferência aguardando aprovação.\n\nA liberação é processada assincronamente: a API guarda a solicitação, cria um Comando e responde com o ID dele. Após confirmado na instituição financeira, a Transferência é liberada.\n\n> ⚠️ **Suporte por banco:** nem todo provedor financeiro suporta liberação via API. Quando não suportado, a API responde `422` com a mensagem de \"não possui suporte a esta operação via API para este provedor financeiro\".", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "description": "UUID da Transferência", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Comando criado com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "id": 208, "uid": "01a06d90-b237-79dc-bd19-c54cd457dc14", "status": "pending", "operation": "approve", "resource_type": "Transfer", "resource_uid": "01a06d90-b221-7bf7-b97d-0da8b80666a6", "financial_provider_slug": "bb", "params": null, "payload": null, "created_at": "2026-09-04T12:56:34-05:00", "updated_at": "2026-09-04T12:56:34-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "financial_transfer": { "uid": "01a06d90-b221-7bf7-b97d-0da8b80666a6", "status": "awaiting_approval", "scheduled_to": null, "registration_status": "confirmed", "financial_account_uid": "01a06d90-b1f8-7736-bedf-cb7e0157270a", "transfer_account_uid": "01a06d90-b208-7481-93aa-c492861ced4e", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "pix": null, "transfer_kind": "ted" }, "kind": "ted", "pix": null, "ted": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:34-05:00", "updated_at": "2026-09-04T12:56:34-05:00" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_transfer_command" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "422": { "description": "Transferência não pode ser liberada", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Liberação de Transferência.", "detail": "Transferência não está aguardando liberação" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/transfer/ted/{uid}/reschedule": { "put": { "summary": "Reagendar (mudar a data) uma Transferência TED", "tags": [ "TED" ], "security": [ { "bearerAuth": [] } ], "description": "\n> **Processamento Assíncrono:** cria um comando de reagendamento (mudança da data de pagamento) para a Transferência.\n\n> ⚠️ **Suporte por banco:** nem todo provedor financeiro suporta reagendamento via API. Quando não suportado, a API responde `422` (\"não possui suporte a esta operação via API para este provedor financeiro\").", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UUID da Transferência", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Comando criado com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "id": 209, "uid": "01a06d90-b3d1-7689-94d4-42e9e124caca", "status": "pending", "operation": "reschedule", "resource_type": "Transfer", "resource_uid": "01a06d90-b3bc-7f15-ad30-342d94e38b8a", "financial_provider_slug": "bb", "params": { "date": "2026-09-11" }, "payload": null, "created_at": "2026-09-04T12:56:34-05:00", "updated_at": "2026-09-04T12:56:34-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "financial_transfer": { "uid": "01a06d90-b3bc-7f15-ad30-342d94e38b8a", "status": "scheduled", "scheduled_to": null, "registration_status": "confirmed", "financial_account_uid": "01a06d90-b394-741e-965e-009667662305", "transfer_account_uid": "01a06d90-b3a3-7d9c-a8c2-237c57425877", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "pix": null, "transfer_kind": "ted" }, "kind": "ted", "pix": null, "ted": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:34-05:00", "updated_at": "2026-09-04T12:56:34-05:00" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_transfer_command" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "422": { "description": "Transferência não pode ser reagendada", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Reagendamento de Transferência.", "detail": "Transferência não está em um estado que permita reagendamento (precisa estar registrada e ainda não confirmada)." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "Nova data de pagamento (YYYY-MM-DD).", "example": "2026-07-10" } }, "required": [ "date" ] } } }, "required": true } } }, "/v2/transfer/accounts": { "get": { "summary": "Listar Contas de Transferência", "tags": [ "Contas de Transferência" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todas as contas de transferência cadastradas na conta. Suporta paginação.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "financial_account_uid", "in": "query", "description": "Filtrar por UID da conta financeira", "required": false, "schema": { "type": "string" }, "example": "e596865f-07a4-4458-88c1-fbb4ffd196e1" } ], "responses": { "200": { "description": "Contas de Transferência acessadas com escopo read", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d90-b6b0-7399-bb13-e094c323240d", "financial_account_uid": "01a06d90-b68b-7395-8ebb-a46b7e55483a", "connection_uid": null, "agreement_code": "12345", "service_point_number": null, "provider_data": null, "balance_validation_enabled_at": null, "remittance_enabled_at": null, "external_id": "M4XDQ9WHIK", "created_at": "2026-09-04T12:56:35-05:00", "updated_at": "2026-09-04T12:56:35-05:00" }, { "uid": "01a06d90-b6ac-7ccc-bc78-d33a521a134f", "financial_account_uid": "01a06d90-b68b-7395-8ebb-a46b7e55483a", "connection_uid": null, "agreement_code": "12345", "service_point_number": null, "provider_data": null, "balance_validation_enabled_at": null, "remittance_enabled_at": null, "external_id": "UCQLYVGXQ2", "created_at": "2026-09-04T12:56:35-05:00", "updated_at": "2026-09-04T12:56:35-05:00" }, { "uid": "01a06d90-b699-7012-8517-e0b9fe0970ae", "financial_account_uid": "01a06d90-b68b-7395-8ebb-a46b7e55483a", "connection_uid": null, "agreement_code": null, "service_point_number": null, "provider_data": null, "balance_validation_enabled_at": null, "remittance_enabled_at": "2026-09-04T12:56:35-05:00", "external_id": null, "created_at": "2026-09-04T12:56:35-05:00", "updated_at": "2026-09-04T12:56:35-05:00" } ], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_transfer_account" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "post": { "summary": "Criar Conta de Transferência", "tags": [ "Contas de Transferência" ], "security": [ { "bearerAuth": [] } ], "description": "Cria uma nova conta de transferência associada a uma conta financeira. Use quando a conta financeira precisa de mais de uma conta de transferência. A conta é criada sem conexão bancária (`connection_uid` retorna `null`); associe uma conexão antes de habilitar remessas/registro. Requer escopo `write` + `transfer.accounts`.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Conta de Transferência criada", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-b75d-7ca8-b472-9fbe7ef86f07", "financial_account_uid": "01a06d90-b72a-7dc4-94b6-5067aecf9f80", "connection_uid": null, "agreement_code": "778899", "service_point_number": null, "provider_data": null, "balance_validation_enabled_at": null, "remittance_enabled_at": null, "external_id": null, "created_at": "2026-09-04T12:56:35-05:00", "updated_at": "2026-09-04T12:56:35-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `201`." }, "data": { "$ref": "#/components/schemas/v2_transfer_account" } } } } } }, "404": { "description": "Conta Financeira não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "422": { "description": "Erro de validação. `agreement_code` acima do limite.", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "agreement_code", "detail": "Número do Convênio de Transferência é muito longo (máximo: 30 caracteres)" } ] }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `422`." }, "errors": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Falha de permissão. Token sem o escopo `write`.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_transfer_account" } } }, "required": true, "description": "Dados da nova conta de transferência." } } }, "/v2/transfer/accounts/{uid}": { "get": { "summary": "Buscar Conta de Transferência", "tags": [ "Contas de Transferência" ], "security": [ { "bearerAuth": [] } ], "description": "Retorna os detalhes de uma conta de transferência específica pelo UID", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "required": true, "description": "UUID da conta de transferência", "example": "e596865f-07a4-4458-88c1-fbb4ffd196e1", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Conta de Transferência acessada com escopo read", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-b935-760c-a87b-a28ee1c647f9", "financial_account_uid": "01a06d90-b914-7222-b160-b5fea116d68c", "connection_uid": null, "agreement_code": "12345", "service_point_number": null, "provider_data": null, "balance_validation_enabled_at": null, "remittance_enabled_at": null, "external_id": "TOTF0RQE85", "created_at": "2026-09-04T12:56:36-05:00", "updated_at": "2026-09-04T12:56:36-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_transfer_account" } } } } } }, "404": { "description": "Conta de Transferência não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "patch": { "summary": "Atualizar Conta de Transferência", "tags": [ "Contas de Transferência" ], "security": [ { "bearerAuth": [] } ], "description": "Atualiza atributos editáveis de uma conta de transferência. Aceita `remittance_enabled` (booleano, controla a geração de remessas EDI), `provider_data.service_point_number` (string, ponto de atendimento — por exemplo `numeroPa` em TED Sicoob) e `provider_data.cooperative_cnpj` (string, CNPJ da cooperativa Sicoob). O corpo aceita PATCH parcial: envie apenas os campos que deseja atualizar.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "required": true, "description": "UUID da conta de transferência", "example": "e596865f-07a4-4458-88c1-fbb4ffd196e1", "schema": { "type": "string" } } ], "responses": { "200": { "description": "PATCH parcial — apenas service_point_number (sem remittance_enabled)", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-ba59-7ba6-b117-7a622ba9ae05", "financial_account_uid": "01a06d90-ba3a-782f-9b5b-b3f1783272b6", "connection_uid": null, "agreement_code": "12345", "service_point_number": "PA42", "provider_data": { "service_point_number": "PA42", "cooperative_cnpj": null }, "balance_validation_enabled_at": null, "remittance_enabled_at": null, "external_id": "TAP0APRVHJ", "created_at": "2026-09-04T12:56:36-05:00", "updated_at": "2026-09-04T12:56:36-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_transfer_account" } } } } } }, "422": { "description": "Erro de validação. `remittance_enabled` deve ser verdadeiro ou falso.", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "remittance_enabled", "detail": "Remessa habilitada deve ser verdadeiro ou falso" } ] }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `422`." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Tipo do erro. Ex: `validation_error`." }, "param": { "type": "string", "description": "Parâmetro com erro. Ex: `remittance_enabled`." }, "detail": { "type": "string", "description": "Mensagem descritiva do erro." } } } } } } } } }, "403": { "description": "Falha de permissão. Token sem o escopo `write`.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Conta de Transferência não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_transfer_account" } } }, "required": true, "description": "Atributos a atualizar. Apenas campos graváveis são considerados; envie só os que deseja alterar (PATCH parcial)." } } }, "/v2/transfers": { "get": { "summary": "Listar Transferências", "tags": [ "Todos" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todas as transferências de qualquer tipo (PIX, TED, Interna). Suporta filtros e paginação. Este é um endpoint unificado que retorna transfers de todos os tipos através de uma única consulta.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "transfer_kind", "in": "query", "description": "Filtrar por tipo de transferência", "required": false, "schema": { "type": "string", "enum": [ "pix", "ted", "internal" ] } } ], "responses": { "200": { "description": "Transferências encontradas", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d90-bbcc-776c-947e-70a04c4a8dfe", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-bb9f-726b-8fd7-2dfce457929a", "transfer_account_uid": "01a06d90-bbad-75cc-ab37-ef7dffef89da", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": { "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x" }, "pix": null, "transfer_kind": "internal" }, "kind": "internal", "pix": null, "ted": null, "internal": { "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x" }, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:36-05:00", "updated_at": "2026-09-04T12:56:36-05:00" }, { "uid": "01a06d90-bbc7-71f0-abf8-6634ce2120a8", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-bb9f-726b-8fd7-2dfce457929a", "transfer_account_uid": "01a06d90-bbad-75cc-ab37-ef7dffef89da", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "pix": null, "transfer_kind": "ted" }, "kind": "ted", "pix": null, "ted": { "compe_number": 1, "ispb_number": 0, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "account_type": "checkings", "document_number": "80.815.210/0000-96" }, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:36-05:00", "updated_at": "2026-09-04T12:56:36-05:00" }, { "uid": "01a06d90-bbc0-7eed-9546-73c559caf6c9", "status": "pending", "scheduled_to": "2026-09-04T12:56:36-05:00", "registration_status": "pending", "financial_account_uid": "01a06d90-bb9f-726b-8fd7-2dfce457929a", "transfer_account_uid": "01a06d90-bbad-75cc-ab37-ef7dffef89da", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:36-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:36-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:36-05:00", "updated_at": "2026-09-04T12:56:36-05:00" } ], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_generic_transfer" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } } } }, "post": { "summary": "Criar uma Transferência", "tags": [ "Todos" ], "security": [ { "bearerAuth": [] } ], "description": "Endpoint genérico para criação de transferências de qualquer tipo. O tipo é especificado pelo campo obrigatório 'kind' no nível raiz do payload:\n\n## Pré-requisitos\n\nPara emitir uma transferência é necessário ter uma Conta Financeira, informada em `financial_account_uid`. A conta de transferência que registra a operação é definida em `transfer_account_uid`; se omitida, usa-se a mais antiga vinculada à conta financeira; se informada, deve pertencer à `financial_account_uid`.\n\n## Tipos Suportados\n\n### PIX por Chave\nEspecificar `kind: \"pix\"` e fornecer os dados PIX dentro de `pix.data` (padrão Payment):\n```json\n{\n \"financial_account_uid\": \"...\",\n \"amount\": 100.0,\n \"kind\": \"pix\",\n \"pix\": {\n \"kind\": \"pix\",\n \"data\": {\n \"type\": \"key\",\n \"key_type\": \"email\",\n \"key\": \"destinatario@example.com\"\n }\n },\n \"beneficiary\": {\n \"name\": \"João Silva\",\n \"document\": \"123.456.789-10\"\n }\n}\n```\n\n### PIX por Conta Bancária\nEspecificar `kind: \"pix\"` e fornecer os dados PIX dentro de `pix.data` com `type: \"bank_account\"`:\n```json\n{\n \"financial_account_uid\": \"...\",\n \"amount\": 200.0,\n \"kind\": \"pix\",\n \"pix\": {\n \"kind\": \"pix\",\n \"data\": {\n \"type\": \"bank_account\",\n \"bank_account\": {\n \"bank_code\": \"237\",\n \"agency_number\": \"1234\",\n \"account_number\": \"56789-0\"\n }\n }\n },\n \"beneficiary\": {\n \"name\": \"Maria Santos\",\n \"document\": \"987.654.321-00\"\n }\n}\n```\n\n### TED\nEspecificar `kind: \"ted\"` e fornecer os dados bancários dentro de `ted.data`:\n```json\n{\n \"financial_account_uid\": \"...\",\n \"amount\": 300.0,\n \"kind\": \"ted\",\n \"ted\": {\n \"kind\": \"ted\",\n \"data\": {\n \"bank_account\": {\n \"bank_code\": \"341\",\n \"agency_number\": \"4321\",\n \"agency_digit\": \"5\",\n \"account_number\": \"98765-4\",\n \"account_type\": \"checking\"\n }\n }\n },\n \"beneficiary\": {\n \"name\": \"Pedro Oliveira\",\n \"document\": \"11.222.333/0001-44\"\n }\n}\n```\n\n### Transferência Interna\nEspecificar `kind: \"internal\"` e fornecer os dados da conta destino dentro de `internal.data`:\n```json\n{\n \"financial_account_uid\": \"...\",\n \"amount\": 400.0,\n \"kind\": \"internal\",\n \"internal\": {\n \"kind\": \"internal\",\n \"data\": {\n \"agency_number\": \"0001\",\n \"account_number\": \"12345-6\"\n }\n },\n \"beneficiary\": {\n \"name\": \"Ana Costa\",\n \"document\": \"555.666.777-88\"\n }\n}\n```\n\n## Eventos de Webhook\n\nO evento `transfer.db.created` é disparado nesta operação.\n\n> **Endpoint Unificado:** Este endpoint unifica a criação de todos os tipos de transferência. Para criar transferências de um tipo específico, você também pode usar os endpoints dedicados em `/api/v2/transfer/{type}`.\n", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Transferência Interna criada", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-bdf8-79f0-87d2-15a0b3abfc35", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-bdd3-7092-94d9-6ec7a2732150", "transfer_account_uid": "01a06d90-bde0-7f11-8be1-a97722186bc9", "amount": 400.25, "target": { "beneficiary": { "document_number": "111.444.777-35", "name": "Ana Costa" }, "bank_account": null, "internal": { "agency_number": "0001", "agency_digit": "0", "account_number": "12345", "account_digit": "6" }, "pix": null, "transfer_kind": "internal" }, "kind": "internal", "pix": null, "ted": null, "internal": { "agency_number": "0001", "agency_digit": "0", "account_number": "12345", "account_digit": "6" }, "beneficiary": { "document_number": "111.444.777-35", "name": "Ana Costa" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": null, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:37-05:00", "updated_at": "2026-09-04T12:56:37-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `201`." }, "data": { "$ref": "#/components/schemas/v2_transfer_internal" } } } } } }, "422": { "description": "Tipo de transferência não identificado", "content": { "application/json": { "example": { "status": 422, "errors": [ { "title": "Campo 'kind' é obrigatório e deve ser um dos valores: pix, ted, internal não pode ficar em branco", "code": "unprocessable_content" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_generic_transfer" } } }, "required": true, "description": "Parâmetros para criação de uma Transferência" } } }, "/v2/transfers/{uid}": { "get": { "summary": "Visualizar uma Transferência", "tags": [ "Todos" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de uma Transferência de qualquer tipo. O tipo é identificado automaticamente e a resposta é serializada adequadamente.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UUID da Transferência", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Transferência encontrada", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-bff9-71d9-838e-335d5258323f", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01a06d90-bfd2-7e7f-ac7b-91eaefd28f70", "transfer_account_uid": "01a06d90-bfe2-7bef-83c7-2adeebf2b9c2", "amount": 100.0, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:38-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:38-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": "154785966666666", "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:38-05:00", "updated_at": "2026-09-04T12:56:38-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_generic_transfer" } } } } } }, "404": { "description": "Transferência não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/transfers/{uid}/cancel": { "put": { "summary": "Cancelar uma Transferência", "tags": [ "Todos" ], "security": [ { "bearerAuth": [] } ], "description": "Cancela uma transferência que ainda não foi confirmada ou rejeitada. Transferências já processadas não podem ser canceladas.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UUID da Transferência", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Transferência cancelada com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "id": 210, "uid": "01a06d90-c105-77a3-95f6-b7b6f2a87e6b", "status": "pending", "operation": "cancel", "resource_type": "Transfer", "resource_uid": "01a06d90-c0f0-7ab7-9fb4-c95c4ab2614b", "financial_provider_slug": "example_bank", "params": null, "payload": null, "created_at": "2026-09-04T12:56:38-05:00", "updated_at": "2026-09-04T12:56:38-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "financial_transfer": { "uid": "01a06d90-c0f0-7ab7-9fb4-c95c4ab2614b", "status": "pending", "scheduled_to": null, "registration_status": "requested", "financial_account_uid": "01a06d90-c0cc-70fd-9d1b-6132a38bf16c", "transfer_account_uid": "01a06d90-c0da-7ff5-9e6a-6dd02c9f771b", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": null, "internal": null, "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:38-05:00" }, "transfer_kind": "pix" }, "kind": "pix", "pix": { "pix_type": "key", "txid": null, "key": "kobana@example.com", "key_type": "email", "end_to_end_id": null, "expire_at": "2026-09-07T12:56:38-05:00" }, "ted": null, "internal": null, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "source": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "transfer_purpose": { "code": "98", "description": "Pagamentos Diversos" }, "identifier": null, "external_id": null, "financial_provider_external_id": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:38-05:00", "updated_at": "2026-09-04T12:56:38-05:00" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_transfer_command" } } } } } }, "422": { "description": "Transferência já foi confirmada ou rejeitada", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Cancelamento de Transferência.", "detail": "Transferência já foi confirmada ou rejeitada." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Transferência não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/payment/bank_billet_batches": { "post": { "summary": "Criar um Lote de Pagamento de Boletos", "tags": [ "Boletos" ], "security": [ { "bearerAuth": [] } ], "description": "\nEsse endpoint é utilizado para a geração de um lote de pagamento.\n\n## Pré-requisito\n\nPara emitir um lote de pagamento é necessário ter uma Conta Financeira, informada em `financial_account_uid`. A conta de pagamento aplicada ao lote é definida em `payment_account_uid`; se omitida, usa-se a mais antiga vinculada à conta financeira; se informada, deve pertencer à `financial_account_uid`.\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.bank_billet_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 ", "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": "01a06d90-2f3d-7c31-9424-09f2e6b0c7ad", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-2eec-761d-b713-91450fec5ca9", "payment_account_uid": "01a06d90-2eea-701c-af16-81a28dc7d307", "created_at": "2026-09-04T12:56:00-05:00", "updated_at": "2026-09-04T12:56:00-05:00", "payments": [ { "uid": "01a06d90-2f29-7a98-8be4-b4281ed2260e", "kind": "bank_billet", "amount": 100.4, "scheduled_to": "2026-09-04T12:56:00-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-2eec-761d-b713-91450fec5ca9", "payment_account_uid": "01a06d90-2eea-701c-af16-81a28dc7d307", "batch_uid": "01a06d90-2f3d-7c31-9424-09f2e6b0c7ad", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": null, "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:00-05:00", "updated_at": "2026-09-04T12:56:00-05:00", "bank_billet": { "code": "81770000001800005659970741131079703900143338", "beneficiary": { "name": null, "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-2f33-7eb9-98c8-da34f93cc15b", "kind": "bank_billet", "amount": 100.4, "scheduled_to": "2026-09-04T12:56:00-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-2eec-761d-b713-91450fec5ca9", "payment_account_uid": "01a06d90-2eea-701c-af16-81a28dc7d307", "batch_uid": "01a06d90-2f3d-7c31-9424-09f2e6b0c7ad", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": null, "external_id": "26843f45f68d3bc098a89c550a34845847", "financial_provider_external_id": null, "beneficiary": { "name": null, "document_number": "34.414.342/0000-99" }, "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:00-05:00", "updated_at": "2026-09-04T12:56:00-05:00", "bank_billet": { "code": "81770000001800005659970741131079703900143338", "beneficiary": { "name": null, "document_number": "34.414.342/0000-99" } } } ] } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_payment_batch_bank_billet" } } } } } }, "422": { "description": "Erro de validação — external_id duplicado", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "payments.external_id", "detail": "ID externo já está em uso" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_payment_batch_bank_billet" } } }, "required": true, "description": "Parametros para criação de um Lote de Pagamento" } } }, "/v2/payment/bank_billets": { "get": { "summary": "Listar Pagamentos de Boleto", "tags": [ "Boletos" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todos os pagamentos de boletos bancários realizados. Suporta paginação e retorna informações detalhadas sobre cada pagamento.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } } ], "responses": { "200": { "description": "Pagamentos encontrados", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d90-34a0-79d0-97dc-ea95cdd0dcfd", "kind": "bank_billet", "amount": 100.0, "scheduled_to": "2026-09-05T12:56:01-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3467-7d3b-a3bd-7951812866b1", "payment_account_uid": "01a06d90-3464-73ff-842e-a8bfdfdac2b0", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": "018df180-7208-727b-a10a-ea545e4a75a8", "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:02-05:00", "updated_at": "2026-09-04T12:56:02-05:00", "bank_billet": { "code": "00290156906819125490408930887971550694387071", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-33fb-7d25-9d7d-dc3a043efdeb", "kind": "bank_billet", "amount": 100.0, "scheduled_to": "2026-09-05T12:56:01-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-33c7-7668-adbb-a3b1d97789c1", "payment_account_uid": "01a06d90-33c5-77f3-aff5-84303e84c2dd", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": "018df180-7208-727b-a10a-ea545e4a75a8", "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:02-05:00", "updated_at": "2026-09-04T12:56:02-05:00", "bank_billet": { "code": "08390156903382710630889831205354916419632121", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-33a1-7289-80af-66c287e923ba", "kind": "bank_billet", "amount": 100.0, "scheduled_to": "2026-09-05T12:56:01-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-336e-75c7-ade5-f3844efd8581", "payment_account_uid": "01a06d90-336c-7d4b-ab20-53df67f9a087", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": "018df180-7208-727b-a10a-ea545e4a75a8", "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:02-05:00", "updated_at": "2026-09-04T12:56:02-05:00", "bank_billet": { "code": "03090156907877900720949585652897126533047744", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-3348-7433-8216-62b8f654213c", "kind": "bank_billet", "amount": 100.0, "scheduled_to": "2026-09-05T12:56:01-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3314-78fd-ae97-e69c40c18039", "payment_account_uid": "01a06d90-3312-73a1-8634-f1eb01cd5543", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": "018df180-7208-727b-a10a-ea545e4a75a8", "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:01-05:00", "updated_at": "2026-09-04T12:56:01-05:00", "bank_billet": { "code": "07590156907043733360914390746981360083601497", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-32ef-7746-b416-744b0f11c730", "kind": "bank_billet", "amount": 100.0, "scheduled_to": "2026-09-05T12:56:01-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-32bd-787d-aff6-1fc6411157f4", "payment_account_uid": "01a06d90-32ba-76ff-9573-2c8787791e1f", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": "018df180-7208-727b-a10a-ea545e4a75a8", "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:01-05:00", "updated_at": "2026-09-04T12:56:01-05:00", "bank_billet": { "code": "03690156901491633860776658601234043157559594", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } ], "pagination": { "prev_url": null, "next_url": "/v2/payment/bank_billets?per_page=5&page=2", "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_payment_bank_billet" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } } } }, "post": { "summary": "Criar um Pagamento de Boleto", "tags": [ "Boletos" ], "security": [ { "bearerAuth": [] } ], "description": "\nEsse endpoint é utilizado para a geração de um pagamento.\n\n## Pré-requisito\n\nPara emitir um pagamento é necessário ter uma Conta Financeira, informada em `financial_account_uid`. A conta de pagamento que registra a operação é definida em `payment_account_uid`; se omitida, usa-se a mais antiga vinculada à conta financeira; se informada, deve pertencer à `financial_account_uid`.\n\n## Eventos de Webhook\n\nO evento `payment.db.created` é disparado nesta operação.\n\n> **Próximos passos:** Após criar um pagamento, você desejará em algum momento enviar um Lote para a instituição financeira. Para isso, utilize o endpoint `POST /api/v2/payment/bank_billet_batches`.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Pagamento criado", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-3568-7f21-9cc0-8d05a722bf85", "kind": "bank_billet", "amount": 100.4, "scheduled_to": "2026-09-04T12:56:02-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3530-795e-8c1c-94f49b935317", "payment_account_uid": "01a06d90-352e-71ad-b22e-1794155269b9", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": null, "external_id": "26843f45f68d3bc098a89c550a34845847", "financial_provider_external_id": null, "beneficiary": { "name": "Empresa Teste LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:02-05:00", "updated_at": "2026-09-04T12:56:02-05:00", "bank_billet": { "code": "81770000018000056599707411310797039001433708", "beneficiary": { "name": "Empresa Teste LTDA", "document_number": "34.414.342/0000-99" } } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_payment_bank_billet" } } } } } }, "422": { "description": "Erro de validação", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "amount", "detail": "Quantia não pode ficar em branco" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_payment_bank_billet" } } }, "required": true, "description": "Parametros para criação de um Pagamento" } } }, "/v2/payment/bank_billets/{uid}": { "get": { "summary": "Visualizar um Pagamento de Boleto", "tags": [ "Boletos" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de um Pagamento de Boleto.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UUID do Pagamento de Boleto", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Pagamento encontrado", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-3704-76d3-9344-bec5da3db40a", "kind": "bank_billet", "amount": 100.0, "scheduled_to": "2026-09-05T12:56:02-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-36d1-7199-af8a-b4004c8751d4", "payment_account_uid": "01a06d90-36cf-79d2-88f1-8467ac42dea7", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:02-05:00", "updated_at": "2026-09-04T12:56:02-05:00", "bank_billet": { "code": "06690156900989628750902150428295103015225342", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_payment_bank_billet" } } } } } }, "404": { "description": "Pagamento não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/payment/bank_billets/{uid}/cancel": { "put": { "summary": "Cancelar um Pagamento de Boleto", "tags": [ "Boletos" ], "security": [ { "bearerAuth": [] } ], "description": "\n> **Processamento Assíncrono:** Este endpoint é processado assincronamente e cria um comando de cancelamento para o Pagamento.\nO cancelamento de um Pagamento é feito assincronamente, ou seja, ao receber a requisição, a nossa API guarda a solicitação e cria um Comando. Esse comando é processado em segundo plano e depois de confirmado, o Pagamento tem seu status alterado para Cancelado. Você recebe na resposta desta requisição o ID do comando criado e pode consultá-lo a qualquer momento.\n\n## Eventos de Webhook\n\nQuando a requisição é realizada, um evento `payment.bank_billet.cancel.requested` é disparado.\nO nosso servidor então começa as tentativas de envio do cancelamento para a instituição financeira.\nSomente depois de confirmado na instituição financeira, aí então o pagamento é marcado como cancelado em nosso banco de dados.\nNeste momento o evento `payment.bank_billet.cancel.confirmed` é disparado.\n\n> ⚠️ **Atenção ao status Cancelado:** O status de Cancelado é terminal. O pagamento não poderá mais ser processado após o cancelamento.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "description": "UUID do Pagamento", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Pagamento cancelado sem interação com provedor", "content": { "application/json": { "example": { "status": 200, "data": { "id": 175, "uid": "01a06d90-37c9-7dc1-8e11-da2c509a3497", "status": "pending", "operation": "cancel", "resource_type": "Payment", "resource_uid": "01a06d90-37b3-782d-9f7e-129c4ad90089", "financial_provider_slug": "btg", "params": null, "payload": null, "created_at": "2026-09-04T12:56:03-05:00", "updated_at": "2026-09-04T12:56:03-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "payment": { "uid": "01a06d90-37b3-782d-9f7e-129c4ad90089", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "confirmed", "financial_account_uid": "01a06d90-3786-7a73-9691-0b9a1d92f8b7", "payment_account_uid": "01a06d90-3783-7bbc-8510-906157b2e883", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:03-05:00", "updated_at": "2026-09-04T12:56:03-05:00", "bank_billet": { "code": "00790156900682801100346835065687064828114652", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } }, "message": "Pagamento cancelado com sucesso sem interação com provedor." }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_payment_command" }, "message": { "type": "string", "description": "Mensagem de sucesso" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "422": { "description": "Pagamento já foi confirmado ou rejeitado", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Cancelamento de Pagamento.", "detail": "Pagamento já foi confirmado ou rejeitado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/payment/batches": { "get": { "summary": "Listar Lotes de Pagamentos", "tags": [ "Todos" ], "security": [ { "bearerAuth": [] } ], "description": "Retorna uma lista paginada de todos os lotes de pagamentos da conta. Os lotes são retornados em ordem decrescente de data de criação, com os mais recentes primeiro. Este endpoint permite filtrar e paginar os resultados para facilitar a navegação através de grandes volumes de lotes.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } } ], "responses": { "200": { "description": "Lotes encontrados", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d90-3d93-7ac6-bb27-c38ca2fa04a9", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3d47-7116-9e44-cff743135714", "payment_account_uid": "01a06d90-3d45-7c70-a45c-9a46b69d742a", "created_at": "2026-09-04T12:56:04-05:00", "updated_at": "2026-09-04T12:56:04-05:00", "payments": [ { "uid": "01a06d90-3d76-7914-a3fd-7b3074cdc530", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3d47-7116-9e44-cff743135714", "payment_account_uid": "01a06d90-3d45-7c70-a45c-9a46b69d742a", "batch_uid": "01a06d90-3d93-7ac6-bb27-c38ca2fa04a9", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "711398", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:04-05:00", "updated_at": "2026-09-04T12:56:04-05:00", "bank_billet": { "code": "05590156908478992080774378160081606845394439", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-3d7f-7d0c-b459-6e431839f888", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3d47-7116-9e44-cff743135714", "payment_account_uid": "01a06d90-3d45-7c70-a45c-9a46b69d742a", "batch_uid": "01a06d90-3d93-7ac6-bb27-c38ca2fa04a9", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "898364", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:04-05:00", "updated_at": "2026-09-04T12:56:04-05:00", "bank_billet": { "code": "05790156907717539500629536224331411878750587", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-3d8c-7985-a872-59cd83546193", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3d47-7116-9e44-cff743135714", "payment_account_uid": "01a06d90-3d45-7c70-a45c-9a46b69d742a", "batch_uid": "01a06d90-3d93-7ac6-bb27-c38ca2fa04a9", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "542106", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:04-05:00", "updated_at": "2026-09-04T12:56:04-05:00", "bank_billet": { "code": "06690156909741219090465855899594498552603341", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } ] }, { "uid": "01a06d90-3d20-7a35-8022-f0511d76c792", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3ce3-7ddd-988f-814b706ca06d", "payment_account_uid": "01a06d90-3ce1-7b7c-b470-73ce36748770", "created_at": "2026-09-04T12:56:04-05:00", "updated_at": "2026-09-04T12:56:04-05:00", "payments": [ { "uid": "01a06d90-3d0f-78c3-b9b0-0161f1f0dd62", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3ce3-7ddd-988f-814b706ca06d", "payment_account_uid": "01a06d90-3ce1-7b7c-b470-73ce36748770", "batch_uid": "01a06d90-3d20-7a35-8022-f0511d76c792", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "407024", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:04-05:00", "updated_at": "2026-09-04T12:56:04-05:00", "bank_billet": { "code": "05490156902379413640394273930391769589894681", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-3d16-773f-bd8c-cb800468111b", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3ce3-7ddd-988f-814b706ca06d", "payment_account_uid": "01a06d90-3ce1-7b7c-b470-73ce36748770", "batch_uid": "01a06d90-3d20-7a35-8022-f0511d76c792", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "634344", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:04-05:00", "updated_at": "2026-09-04T12:56:04-05:00", "bank_billet": { "code": "03890156904298656440846993104491674065491433", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-3d1d-7e9d-ada9-3de7a9514e2b", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3ce3-7ddd-988f-814b706ca06d", "payment_account_uid": "01a06d90-3ce1-7b7c-b470-73ce36748770", "batch_uid": "01a06d90-3d20-7a35-8022-f0511d76c792", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "534652", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:04-05:00", "updated_at": "2026-09-04T12:56:04-05:00", "bank_billet": { "code": "06890156901958029760609974166329237853732155", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } ] }, { "uid": "01a06d90-3cbd-781d-b3d3-748d49b916c3", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3c7c-71a5-8cfe-f9af1db9aa99", "payment_account_uid": "01a06d90-3c7a-70d7-8d26-eb79b23adf68", "created_at": "2026-09-04T12:56:04-05:00", "updated_at": "2026-09-04T12:56:04-05:00", "payments": [ { "uid": "01a06d90-3ca9-718b-84bc-184da6b5c361", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3c7c-71a5-8cfe-f9af1db9aa99", "payment_account_uid": "01a06d90-3c7a-70d7-8d26-eb79b23adf68", "batch_uid": "01a06d90-3cbd-781d-b3d3-748d49b916c3", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "875733", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:04-05:00", "updated_at": "2026-09-04T12:56:04-05:00", "bank_billet": { "code": "00190156904626304070640528087295367213611798", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-3cb1-7866-813f-bf40c9e3be5d", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3c7c-71a5-8cfe-f9af1db9aa99", "payment_account_uid": "01a06d90-3c7a-70d7-8d26-eb79b23adf68", "batch_uid": "01a06d90-3cbd-781d-b3d3-748d49b916c3", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "577309", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:04-05:00", "updated_at": "2026-09-04T12:56:04-05:00", "bank_billet": { "code": "03390156903310937620499215443693849568727330", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-3cb9-746b-8b1d-9fa1395f15ef", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3c7c-71a5-8cfe-f9af1db9aa99", "payment_account_uid": "01a06d90-3c7a-70d7-8d26-eb79b23adf68", "batch_uid": "01a06d90-3cbd-781d-b3d3-748d49b916c3", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "262283", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:04-05:00", "updated_at": "2026-09-04T12:56:04-05:00", "bank_billet": { "code": "05990156904778358390338238469707670243721723", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } ] }, { "uid": "01a06d90-3c53-7c5c-8ed8-9001990c2066", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3c13-7977-811d-1cc1f52fc44f", "payment_account_uid": "01a06d90-3c11-72d7-b1d0-39e7863ec807", "created_at": "2026-09-04T12:56:04-05:00", "updated_at": "2026-09-04T12:56:04-05:00", "payments": [ { "uid": "01a06d90-3c40-71e1-aa0a-c0a93db9cfda", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3c13-7977-811d-1cc1f52fc44f", "payment_account_uid": "01a06d90-3c11-72d7-b1d0-39e7863ec807", "batch_uid": "01a06d90-3c53-7c5c-8ed8-9001990c2066", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "293927", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:04-05:00", "updated_at": "2026-09-04T12:56:04-05:00", "bank_billet": { "code": "06490156909097700440997092138509462160418974", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-3c48-78a7-b9ed-953eb1485422", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3c13-7977-811d-1cc1f52fc44f", "payment_account_uid": "01a06d90-3c11-72d7-b1d0-39e7863ec807", "batch_uid": "01a06d90-3c53-7c5c-8ed8-9001990c2066", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "79075", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:04-05:00", "updated_at": "2026-09-04T12:56:04-05:00", "bank_billet": { "code": "03590156907630624930281142182798144329590097", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-3c4f-71de-aa5f-83d1da6b6257", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3c13-7977-811d-1cc1f52fc44f", "payment_account_uid": "01a06d90-3c11-72d7-b1d0-39e7863ec807", "batch_uid": "01a06d90-3c53-7c5c-8ed8-9001990c2066", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "726933", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:04-05:00", "updated_at": "2026-09-04T12:56:04-05:00", "bank_billet": { "code": "05790156900681754400662261967541401977061010", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } ] }, { "uid": "01a06d90-3bec-7188-9b7c-8f0dcc4a958d", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3bac-7d33-af45-c0688c76e588", "payment_account_uid": "01a06d90-3baa-7558-8dfc-1ef8deae984d", "created_at": "2026-09-04T12:56:04-05:00", "updated_at": "2026-09-04T12:56:04-05:00", "payments": [ { "uid": "01a06d90-3bd8-7f12-83a4-ab102cdb48e4", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3bac-7d33-af45-c0688c76e588", "payment_account_uid": "01a06d90-3baa-7558-8dfc-1ef8deae984d", "batch_uid": "01a06d90-3bec-7188-9b7c-8f0dcc4a958d", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "410991", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:04-05:00", "updated_at": "2026-09-04T12:56:04-05:00", "bank_billet": { "code": "03190156902133465210129454862634818393775282", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-3bdf-72e5-bb2f-cb1162982d78", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3bac-7d33-af45-c0688c76e588", "payment_account_uid": "01a06d90-3baa-7558-8dfc-1ef8deae984d", "batch_uid": "01a06d90-3bec-7188-9b7c-8f0dcc4a958d", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "561217", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:04-05:00", "updated_at": "2026-09-04T12:56:04-05:00", "bank_billet": { "code": "02490156908596729700420404658421572516831949", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-3be7-7e24-bad8-a5a228d6f971", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3bac-7d33-af45-c0688c76e588", "payment_account_uid": "01a06d90-3baa-7558-8dfc-1ef8deae984d", "batch_uid": "01a06d90-3bec-7188-9b7c-8f0dcc4a958d", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "87645", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:04-05:00", "updated_at": "2026-09-04T12:56:04-05:00", "bank_billet": { "code": "08390156908724335380614118924106981095281170", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } ] } ], "pagination": { "prev_url": null, "next_url": "/v2/payment/batches?per_page=5&page=2", "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_payment_batch" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } } } } }, "/v2/payment/batches/{uid}": { "get": { "summary": "Visualizar um Lote de Pagamento", "tags": [ "Todos" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de um Pagamento de Boleto.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UUID do Lote de Pagamento", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Lote de Pagamento encontrado", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-3e98-7e6e-accd-ba91e4a40892", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3e50-7036-8bae-f6675b9dd3a6", "payment_account_uid": "01a06d90-3e4d-7529-b2b2-24e32f410ce9", "created_at": "2026-09-04T12:56:04-05:00", "updated_at": "2026-09-04T12:56:04-05:00", "payments": [ { "uid": "01a06d90-3e82-79a9-be40-c8d0a80d6f02", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3e50-7036-8bae-f6675b9dd3a6", "payment_account_uid": "01a06d90-3e4d-7529-b2b2-24e32f410ce9", "batch_uid": "01a06d90-3e98-7e6e-accd-ba91e4a40892", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "105921", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:04-05:00", "updated_at": "2026-09-04T12:56:04-05:00", "bank_billet": { "code": "06190156900296514320569300488180329744364108", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-3e8b-7064-a72d-afc5ca86df4a", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3e50-7036-8bae-f6675b9dd3a6", "payment_account_uid": "01a06d90-3e4d-7529-b2b2-24e32f410ce9", "batch_uid": "01a06d90-3e98-7e6e-accd-ba91e4a40892", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "949555", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:04-05:00", "updated_at": "2026-09-04T12:56:04-05:00", "bank_billet": { "code": "02790156906437183160892083924119078289406081", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-3e93-7214-920f-fd6fe26d7d8d", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3e50-7036-8bae-f6675b9dd3a6", "payment_account_uid": "01a06d90-3e4d-7529-b2b2-24e32f410ce9", "batch_uid": "01a06d90-3e98-7e6e-accd-ba91e4a40892", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "75616", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:04-05:00", "updated_at": "2026-09-04T12:56:04-05:00", "bank_billet": { "code": "03090156901503968820767716686802223128499873", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } ] } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_payment_batch" } } } } } }, "404": { "description": "Lote de Pagamento não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/payment/batches/{uid}/approve": { "put": { "summary": "Aprovar um Lote de Pagamento", "tags": [ "Todos" ], "security": [ { "bearerAuth": [] } ], "description": "\n > **Processamento Assíncrono:** Este endpoint é processado assincronamente e cria um comando de aprovação para o Lote de Pagamento.\n A aprovação de um Lote de Pagamento é feito assincronamente, ou seja, ao receber a requisição, a nossa API guarda a solicitação e cria um Comando. Esse comando é processado em segundo plano e depois de confirmado, o Lote tem seu status alterado para Aprovado. Você recebe na resposta desta requisição o ID do comando criado e pode consultá-lo a qualquer momento.\n\n ## Eventos de Webhook\n\n Quando a requisição é realizada, um evento `payment.payment_batch.approve.requested` é disparado.\n O nosso servidor então começa as tentativas de envio da liberação para a instituição financeira.\n Somente depois de confirmado na instituição financeira, aí então o lote é marcado como aprovado em nosso banco de dados.\n Neste momento o evento `payment.payment_batch.approve.confirmed` é disparado.\n\n > ⚠️ **Atenção ao status Aprovado:** O status de Aprovado não é terminal. Quando a instituição financeira confirmar os pagamentos, os mesmos terão seus status alterados para Confirmado", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "description": "UUID do Lote de Pagamento", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Comando criado com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "id": 176, "uid": "01a06d90-3f97-74b0-9233-9bc0ad3bc573", "status": "pending", "operation": "approve", "resource_type": "PaymentBatch", "resource_uid": "01a06d90-3f7a-7e9b-91ff-c61a6f2e1e82", "financial_provider_slug": "bb", "params": null, "payload": null, "created_at": "2026-09-04T12:56:05-05:00", "updated_at": "2026-09-04T12:56:05-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "payment_batch": { "uid": "01a06d90-3f7a-7e9b-91ff-c61a6f2e1e82", "status": "awaiting_approval", "registration_status": "confirmed", "financial_account_uid": "01a06d90-3f3b-7453-9f08-f0a3bf15df31", "payment_account_uid": "01a06d90-3f39-75ac-9279-d8c7b3719d49", "created_at": "2026-09-04T12:56:05-05:00", "updated_at": "2026-09-04T12:56:05-05:00", "payments": [ { "uid": "01a06d90-3f68-78a7-9f74-ce38feab7ffd", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3f3b-7453-9f08-f0a3bf15df31", "payment_account_uid": "01a06d90-3f39-75ac-9279-d8c7b3719d49", "batch_uid": "01a06d90-3f7a-7e9b-91ff-c61a6f2e1e82", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "240637", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:05-05:00", "updated_at": "2026-09-04T12:56:05-05:00", "bank_billet": { "code": "01190156900558664540790599456866298643780466", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-3f6f-7858-939d-cb23e71b49dd", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3f3b-7453-9f08-f0a3bf15df31", "payment_account_uid": "01a06d90-3f39-75ac-9279-d8c7b3719d49", "batch_uid": "01a06d90-3f7a-7e9b-91ff-c61a6f2e1e82", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "799973", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:05-05:00", "updated_at": "2026-09-04T12:56:05-05:00", "bank_billet": { "code": "08590156903984948300143983305432643673952306", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-3f77-7da4-9213-1310daeb5d34", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-3f3b-7453-9f08-f0a3bf15df31", "payment_account_uid": "01a06d90-3f39-75ac-9279-d8c7b3719d49", "batch_uid": "01a06d90-3f7a-7e9b-91ff-c61a6f2e1e82", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "499425", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:05-05:00", "updated_at": "2026-09-04T12:56:05-05:00", "bank_billet": { "code": "09290156907113390880895695326442380278323516", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } ] } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_payment_batch_command" } } } } } }, "422": { "description": "Lote de Pagamento não está aguardando liberação", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Aprovação de Lote de Pagamento.", "detail": "Lote de Pagamento não está aguardando aprovação." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/payment/batches/{uid}/reprove": { "put": { "summary": "Reprovar um Lote de Pagamento", "tags": [ "Todos" ], "security": [ { "bearerAuth": [] } ], "description": "\n > **Processamento Assíncrono:** Este endpoint é processado assincronamente e cria um comando de reprovação para o Lote de Pagamento.\n A reprovação de um Lote de Pagamento é feita assincronamente, ou seja, ao receber a requisição, a nossa API guarda a solicitação e cria um Comando. Esse comando é processado em segundo plano e depois de confirmado, o Lote tem seu status alterado para Reprovado. Você recebe na resposta desta requisição o ID do comando criado e pode consultá-lo a qualquer momento.\n\n ## Eventos de Webhook\n\n Quando a requisição é realizada, um evento `payment.payment_batch.reprove.requested` é disparado.\n O nosso servidor então começa as tentativas de envio da liberação para a instituição financeira.\n Somente depois de confirmado na instituição financeira, aí então o lote é marcado como aprovado em nosso banco de dados.\n Neste momento o evento `payment.payment_batch.reprove.confirmed` é disparado.\n\n > ⚠️ **Atenção ao status Reprovado:** O status de Reprovado é terminal. Quando a instituição financeira cancelar os pagamentos, os mesmos terão seus status alterados para Reprovado", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "description": "UUID do Lote de Pagamento", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Comando criado com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "id": 181, "uid": "01a06d90-428d-7b19-9ee1-09aec23479c2", "status": "pending", "operation": "reprove", "resource_type": "PaymentBatch", "resource_uid": "01a06d90-426f-7089-b79f-bf6fd879f9fb", "financial_provider_slug": "bb", "params": null, "payload": null, "created_at": "2026-09-04T12:56:05-05:00", "updated_at": "2026-09-04T12:56:05-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "payment_batch": { "uid": "01a06d90-426f-7089-b79f-bf6fd879f9fb", "status": "awaiting_approval", "registration_status": "confirmed", "financial_account_uid": "01a06d90-422c-7bc0-b52c-340b9e6c76e0", "payment_account_uid": "01a06d90-422a-7025-afdc-cdfb56330ff2", "created_at": "2026-09-04T12:56:05-05:00", "updated_at": "2026-09-04T12:56:05-05:00", "payments": [ { "uid": "01a06d90-425b-7437-adae-7f762ecc379c", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-422c-7bc0-b52c-340b9e6c76e0", "payment_account_uid": "01a06d90-422a-7025-afdc-cdfb56330ff2", "batch_uid": "01a06d90-426f-7089-b79f-bf6fd879f9fb", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "583974", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:05-05:00", "updated_at": "2026-09-04T12:56:05-05:00", "bank_billet": { "code": "04190156900493168630997778712627779830880402", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-4263-7927-89fb-3c7e9bb6a03f", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-422c-7bc0-b52c-340b9e6c76e0", "payment_account_uid": "01a06d90-422a-7025-afdc-cdfb56330ff2", "batch_uid": "01a06d90-426f-7089-b79f-bf6fd879f9fb", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "498532", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:05-05:00", "updated_at": "2026-09-04T12:56:05-05:00", "bank_billet": { "code": "07890156905466176440110729065551969977727259", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-426b-71b9-ac3d-2943e858f889", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-422c-7bc0-b52c-340b9e6c76e0", "payment_account_uid": "01a06d90-422a-7025-afdc-cdfb56330ff2", "batch_uid": "01a06d90-426f-7089-b79f-bf6fd879f9fb", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "64084", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:05-05:00", "updated_at": "2026-09-04T12:56:05-05:00", "bank_billet": { "code": "01790156901924514370009490073154958063742145", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } ] } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_payment_batch_command" } } } } } }, "422": { "description": "Lote de Pagamento não está aguardando liberação", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Reprovação de Lote de Pagamento.", "detail": "Lote de Pagamento não está aguardando aprovação." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/payment/batches/{uid}/cancel": { "put": { "summary": "Cancelar um Lote de Pagamento", "tags": [ "Todos" ], "security": [ { "bearerAuth": [] } ], "description": "\n > **Processamento Assíncrono:** cria um comando de cancelamento para o Lote de Pagamento.\n\n Quando o provedor financeiro expõe API de cancelamento de lote (ex.: Banco do Brasil),\n é criado 1 Comando de cancelamento no lote. Para provedores sem API de lote, o\n cancelamento é feito pagamento a pagamento (fallback per-item). Antes do registro, o\n lote é cancelado localmente sem interação com provedor.\n\n ## Eventos de Webhook\n\n Quando a requisição é realizada, um evento `payment.{type}_batch.cancel.requested` é disparado.\n Somente depois de confirmado na instituição financeira o lote é marcado como cancelado,\n disparando `payment.{type}_batch.cancel.confirmed`.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UUID do Lote de Pagamento", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Comando de cancelamento criado com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "id": 186, "uid": "01a06d90-4579-7c4b-99c3-04b4f96b68e3", "status": "pending", "operation": "cancel", "resource_type": "PaymentBatch", "resource_uid": "01a06d90-455d-7cf3-8179-611c352ca246", "financial_provider_slug": "bb", "params": null, "payload": null, "created_at": "2026-09-04T12:56:06-05:00", "updated_at": "2026-09-04T12:56:06-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "payment_batch": { "uid": "01a06d90-455d-7cf3-8179-611c352ca246", "status": "confirmed", "registration_status": "confirmed", "financial_account_uid": "01a06d90-451d-71af-adc2-57cdd02667f7", "payment_account_uid": "01a06d90-451b-7e8d-83e7-5e068dd0aed2", "created_at": "2026-09-04T12:56:06-05:00", "updated_at": "2026-09-04T12:56:06-05:00", "payments": [ { "uid": "01a06d90-4549-7711-b20a-9847261729b9", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-451d-71af-adc2-57cdd02667f7", "payment_account_uid": "01a06d90-451b-7e8d-83e7-5e068dd0aed2", "batch_uid": "01a06d90-455d-7cf3-8179-611c352ca246", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "972984", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:06-05:00", "updated_at": "2026-09-04T12:56:06-05:00", "bank_billet": { "code": "01690156904154196820366309108770467003874185", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-4551-70ec-a572-4de1c7dd56b8", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-451d-71af-adc2-57cdd02667f7", "payment_account_uid": "01a06d90-451b-7e8d-83e7-5e068dd0aed2", "batch_uid": "01a06d90-455d-7cf3-8179-611c352ca246", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "133437", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:06-05:00", "updated_at": "2026-09-04T12:56:06-05:00", "bank_billet": { "code": "00190156903966327540378992405753041073206659", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-455a-7b60-9f88-e37825bd9946", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-451d-71af-adc2-57cdd02667f7", "payment_account_uid": "01a06d90-451b-7e8d-83e7-5e068dd0aed2", "batch_uid": "01a06d90-455d-7cf3-8179-611c352ca246", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": "874299", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:06-05:00", "updated_at": "2026-09-04T12:56:06-05:00", "bank_billet": { "code": "00790156903568388870057003199419819059493399", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } ] } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_payment_batch_command" } } } } } }, "422": { "description": "Lote de Pagamento não pode ser cancelado no estado atual", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Cancelamento de Lote de Pagamento.", "detail": "Lote de Pagamento não pode ser cancelado no estado atual." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/payment/dda_accounts": { "get": { "summary": "Listar Contas de DDA", "tags": [ "Contas de DDA" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todas as contas DDA cadastradas na conta. Suporta paginação.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } } ], "responses": { "200": { "description": "Lista vazia quando não há contas DDA", "content": { "application/json": { "example": { "status": 200, "data": [], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_dda_account" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Scope obrigatório ausente.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"all payment.dda_accounts\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "post": { "summary": "Criar Conta de DDA", "tags": [ "Contas de DDA" ], "security": [ { "bearerAuth": [] } ], "description": "\nCria uma nova conta DDA.\n\n## Eventos de Webhook\n\nO evento `payment.dda.account.db.created` é disparado nesta operação.\n\nApós a criação, o sistema gera automaticamente a carta DDA (PDF), disparando os eventos `payment.dda.account.letter.pending`, `payment.dda.account.letter.waiting_signatures` e `payment.dda.account.letter.signed` à medida que o fluxo de assinatura progride.\n\nApós aprovação pelo Manager, os eventos `payment.dda.account.confirmed` ou `payment.dda.account.rejected` são disparados.\n\nApós `confirmed`, o sistema inicia o registro da conta no banco de forma assíncrona, disparando `payment.dda.account.register.requested` e `payment.dda.account.register.confirmed` (ou `failed`/`error`) conforme a resposta do provider.\n", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Conta de DDA criada com sucesso", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-50c6-70e1-b773-c6256cfcf950", "cnpj": "11.222.333/0001-81", "name": null, "signers": [ { "name": "Joao Silva", "document_number": "551.969.441-92", "email": "joao@example.com" } ], "editable": true, "status": "pending", "letter_status": "creating", "external_letter_status": null, "letter_signed_url": null, "error_message": null, "enabled_at": null, "disabled_at": null, "enable_requested_at": null, "disable_requested_at": null, "validated_at": null, "rejected_at": null, "rejection_reason": null, "bank_billets_sync_last_updated_at": null, "created_at": "2026-09-04T12:56:09-05:00", "updated_at": "2026-09-04T12:56:09-05:00", "business_legal_name": "Empresa Exemplo Ltda", "phone_number": "11987654321", "address": { "street": "Av. Paulista", "number": "1000", "complement": "Sala 101", "neighborhood": "Bela Vista", "state": "SP", "city_name": "São Paulo", "zip_code": "01310100" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `201`." }, "data": { "$ref": "#/components/schemas/v2_dda_account" } } } } } }, "422": { "description": "Subcampo de address com valor não escalar (array)", "content": { "application/json": { "example": { "status": 422, "errors": [ { "title": "address: valor(es) inválido(s) para: street", "code": "unprocessable_content", "param": "address" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticacao. Token invalido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissao. Scope de escrita obrigatorio.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_dda_account" } } }, "required": true } } }, "/v2/payment/dda_accounts/{uid}": { "get": { "summary": "Buscar Conta de DDA", "tags": [ "Contas de DDA" ], "security": [ { "bearerAuth": [] } ], "description": "Retorna os detalhes de uma conta de DDA específica pelo UID.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "required": true, "description": "UUID da conta de DDA", "example": "e596865f-07a4-4458-88c1-fbb4ffd196e1", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Conta de DDA encontrada", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-5211-797a-87d9-f66f9c2f3e41", "cnpj": "IC.ASJ.9XE/55IC-70", "name": "DDA Account 3", "signers": [ { "name": "João Silva", "document_number": "747.727.755-87", "email": "joao@example.com" } ], "editable": true, "status": "pending", "letter_status": "creating", "external_letter_status": null, "letter_signed_url": null, "error_message": null, "enabled_at": null, "disabled_at": null, "enable_requested_at": null, "disable_requested_at": null, "validated_at": null, "rejected_at": null, "rejection_reason": null, "bank_billets_sync_last_updated_at": null, "created_at": "2026-09-04T12:56:09-05:00", "updated_at": "2026-09-04T12:56:09-05:00", "business_legal_name": null, "phone_number": null, "address": {} } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_dda_account" } } } } } }, "404": { "description": "Conta de DDA não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Scope obrigatório ausente.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"all payment.dda_accounts\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "put": { "summary": "Atualizar Conta de DDA", "tags": [ "Contas de DDA" ], "security": [ { "bearerAuth": [] } ], "description": "\nAtualiza os signatários de uma conta DDA. Somente permitido quando a conta é editável (editable=true).\n\n## Eventos de Webhook\n\nO evento `payment.dda.account.db.updated` é disparado nesta operação.\n\nSe a conta possuía carta em `external_letter_status: waiting_signatures`, o sistema sincroniza os novos signatários com o provider de assinatura de forma assíncrona. Caso o provider reinicie o fluxo de assinatura, os eventos `payment.dda.account.letter.pending` e subsequentes serão disparados.\n", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "required": true, "description": "UUID da conta de DDA", "example": "e596865f-07a4-4458-88c1-fbb4ffd196e1", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Conta de DDA atualizada com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-52c7-7b16-a88d-110a58a7912b", "cnpj": "ZR.7E0.9TX/422Q-57", "name": "DDA Account 5", "signers": [ { "name": "Maria Souza", "document_number": "011.260.887-65", "email": "maria@example.com" } ], "editable": true, "status": "pending", "letter_status": "creating", "external_letter_status": null, "letter_signed_url": null, "error_message": null, "enabled_at": null, "disabled_at": null, "enable_requested_at": null, "disable_requested_at": null, "validated_at": null, "rejected_at": null, "rejection_reason": null, "bank_billets_sync_last_updated_at": null, "created_at": "2026-09-04T12:56:10-05:00", "updated_at": "2026-09-04T12:56:10-05:00", "business_legal_name": "Empresa Exemplo Ltda", "phone_number": "11987654321", "address": { "state": "SP", "city_name": "São Paulo", "zip_code": "01310100" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_dda_account" } } } } } }, "422": { "description": "Conta não editável", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "base", "detail": "não pode ser editado após a geração da carta" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_update_dda_account" } } }, "required": true } } }, "/v2/payment/dda_accounts/{uid}/enable": { "put": { "summary": "Habilitar Conta de DDA", "tags": [ "Contas de DDA" ], "security": [ { "bearerAuth": [] } ], "description": "\nSolicita a habilitação de uma conta DDA previamente desabilitada. Sujeito a período de cooldown de 21 minutos após desabilitação.\n\n## Eventos de Webhook\n\nO evento `payment.dda.account.db.updated` é disparado nesta operação, refletindo a mudança em `enable_requested_at`. A habilitação em si só é confirmada de forma assíncrona, quando o provedor responde: `payment.dda.account.enabled` (sucesso) ou `payment.dda.account.failed` (falha/resposta incompleta do provedor).\n", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "required": true, "description": "UUID da conta de DDA", "example": "e596865f-07a4-4458-88c1-fbb4ffd196e1", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Conta de DDA habilitada com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-5353-76fe-905c-8439cc11f1f6", "cnpj": "YX.7RO.P7F/86HW-20", "name": "DDA Account 7", "signers": [ { "name": "João Silva", "document_number": "747.727.755-87", "email": "joao@example.com" } ], "editable": false, "status": "approved", "letter_status": "creating", "external_letter_status": "signed", "letter_signed_url": null, "error_message": null, "enabled_at": null, "disabled_at": null, "enable_requested_at": "2026-09-04T12:56:10-05:00", "disable_requested_at": null, "validated_at": "2026-09-04T12:56:10-05:00", "rejected_at": null, "rejection_reason": null, "bank_billets_sync_last_updated_at": null, "created_at": "2026-09-04T12:56:10-05:00", "updated_at": "2026-09-04T12:56:10-05:00", "business_legal_name": null, "phone_number": null, "address": {} }, "outcome": "performed" }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_dda_account" }, "outcome": { "type": "string", "enum": [ "performed", "already_requested", "noop" ], "description": "performed: habilitação solicitada; already_requested: já havia uma solicitação pendente equivalente ou mais recente; noop: conta já confirmada habilitada, nada a fazer" } } } } } }, "422": { "description": "Conta de DDA não pode ser habilitada sem carta assinada e status aprovado", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "base", "detail": "conta DDA só pode ser habilitada quando a carta estiver assinada e o status for confirmado" } ] }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "errors": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Conta de DDA não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/payment/dda_accounts/{uid}/disable": { "put": { "summary": "Desabilitar Conta de DDA", "tags": [ "Contas de DDA" ], "security": [ { "bearerAuth": [] } ], "description": "\nSolicita a desabilitação de uma conta DDA existente. Não remove `enabled_at` diretamente.\n\n## Eventos de Webhook\n\nO evento `payment.dda.account.db.updated` é disparado nesta operação, refletindo a mudança em `disable_requested_at`. A desabilitação em si só é confirmada de forma assíncrona, quando o provedor responde: `payment.dda.account.disabled` (sucesso) ou `payment.dda.account.failed` (falha).\n", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "required": true, "description": "UUID da conta de DDA", "example": "e596865f-07a4-4458-88c1-fbb4ffd196e1", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Conta de DDA desabilitada com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-53f7-7228-8947-7150a6580baf", "cnpj": "7V.2LW.3VR/OAMT-91", "name": "DDA Account 9", "signers": [ { "name": "João Silva", "document_number": "747.727.755-87", "email": "joao@example.com" } ], "editable": false, "status": "approved", "letter_status": "creating", "external_letter_status": "signed", "letter_signed_url": null, "error_message": null, "enabled_at": "2026-09-04T12:56:10-05:00", "disabled_at": null, "enable_requested_at": null, "disable_requested_at": "2026-09-04T12:56:10-05:00", "validated_at": "2026-09-04T12:56:10-05:00", "rejected_at": null, "rejection_reason": null, "bank_billets_sync_last_updated_at": null, "created_at": "2026-09-04T12:56:10-05:00", "updated_at": "2026-09-04T12:56:10-05:00", "business_legal_name": null, "phone_number": null, "address": {} }, "outcome": "performed" }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_dda_account" }, "outcome": { "type": "string", "enum": [ "performed", "already_requested", "noop" ], "description": "performed: desabilitação solicitada; already_requested: já havia uma solicitação pendente equivalente ou mais recente; noop: nada a desabilitar (ex.: conta nunca habilitada)" } } } } } }, "404": { "description": "Conta de DDA não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Scope de escrita obrigatório.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/payment/dda_bank_billets": { "get": { "summary": "Listar Boletos DDA", "tags": [ "Boletos DDA" ], "security": [ { "bearerAuth": [] } ], "description": "\nLista todos os boletos DDA vinculados à conta. Suporta paginação.\n\n## Eventos de Webhook\n\nBoletos DDA chegam exclusivamente via sincronização automática (não há criação manual). Os eventos de webhook relacionados são:\n\n- `payment.dda.bank_billet.db.created` — disparado quando um novo boleto é sincronizado do provider\n- `payment.dda.bank_billet.external_status_changed` — disparado quando o status externo do boleto muda (ex: `open` → `paid`)\n", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } } ], "responses": { "200": { "description": "Lista vazia quando não há boletos DDA", "content": { "application/json": { "example": { "status": 200, "data": [], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_dda_bank_billet" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Scope obrigatório ausente.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"all payment.dda.bank_billets\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/payment/dda_bank_billets/{uid}": { "get": { "summary": "Buscar Boleto DDA", "tags": [ "Boletos DDA" ], "security": [ { "bearerAuth": [] } ], "description": "Retorna os detalhes de um boleto DDA específico pelo UID.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "required": true, "description": "UUID do boleto DDA", "example": "e596865f-07a4-4458-88c1-fbb4ffd196e1", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Boleto DDA encontrado", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-555f-73e8-ad1d-875e22d73165", "status": "pending", "external_status": "open", "barcode": "34193497900000150001740000000148050088825000", "line": "34191.74001 00000.148050 08882.500009 3 49790000015000", "our_number": "123556238", "description": "BOLETO DDA TESTE", "nominal_amount": 10.0, "amount": 7.6, "min_payment_amount": 1.0, "max_payment_amount": 10.0, "expire_at": "2026-09-07", "issue_date": "2026-09-04", "reference_month": null, "beneficiary_name": "Kobana Tecnologia Ltda.", "beneficiary_cnpj_cpf": "05.813.794/0001-26", "beneficiary_bank_name": "BANCO EXEMPLO", "beneficiary_bank_number": "101", "owner_cnpj_cpf": "83.191.445/0001-23", "owner_person_name": "EMPRESA PAGADORA", "fine_amount": 240.0, "fine_percentage": 2.0, "fine_date": "2026-09-05", "interest_amount": 240.0, "interest_percentage": 2.0, "interest_date": "2026-09-06", "discount_amount": 240.0, "discount_date": "2026-09-04", "reduction_amount": null, "allow_parcial_payment": false, "released_at": null, "rejected_at": null, "payment_uid": null, "dda_account_uid": "01a06d90-555a-7000-b9cc-f33b9cea53f9", "created_at": "2026-09-04T12:56:10-05:00", "updated_at": "2026-09-04T12:56:10-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_dda_bank_billet" } } } } } }, "404": { "description": "Boleto DDA não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Scope obrigatório ausente.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"all payment.dda.bank_billets\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "delete": { "summary": "Excluir Boleto DDA", "tags": [ "Boletos DDA" ], "security": [ { "bearerAuth": [] } ], "description": "Exclui (soft delete) um boleto DDA existente.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "required": true, "description": "UUID do boleto DDA", "example": "e596865f-07a4-4458-88c1-fbb4ffd196e1", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Boleto DDA excluído com sucesso" }, "404": { "description": "Boleto DDA não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Scope de escrita obrigatório.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/payment/dda_bank_billets/{uid}/reject": { "put": { "summary": "Rejeitar Boleto DDA", "tags": [ "Boletos DDA" ], "security": [ { "bearerAuth": [] } ], "description": "\nRejeita um boleto DDA com status `pending`. Boletos rejeitados não serão processados para pagamento.\n\n## Eventos de Webhook\n\nO evento `payment.dda.bank_billet.db.updated` é disparado nesta operação com as alterações de status (`pending` → `rejected`) e o campo `rejected_at`. Este evento é disparado em qualquer atualização do boleto DDA, não apenas nesta operação.\n", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "required": true, "description": "UUID do boleto DDA", "example": "e596865f-07a4-4458-88c1-fbb4ffd196e1", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Boleto DDA rejeitado com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-56da-7c92-a5ad-ad82d76aa0ae", "status": "rejected", "external_status": "open", "barcode": "34193497900000150001740000000148050088825000", "line": "34191.74001 00000.148050 08882.500009 3 49790000015000", "our_number": "123556238", "description": "BOLETO DDA TESTE", "nominal_amount": 10.0, "amount": 7.6, "min_payment_amount": 1.0, "max_payment_amount": 10.0, "expire_at": "2026-09-07", "issue_date": "2026-09-04", "reference_month": null, "beneficiary_name": "Kobana Tecnologia Ltda.", "beneficiary_cnpj_cpf": "05.813.794/0001-26", "beneficiary_bank_name": "BANCO EXEMPLO", "beneficiary_bank_number": "101", "owner_cnpj_cpf": "83.191.445/0001-23", "owner_person_name": "EMPRESA PAGADORA", "fine_amount": 240.0, "fine_percentage": 2.0, "fine_date": "2026-09-05", "interest_amount": 240.0, "interest_percentage": 2.0, "interest_date": "2026-09-06", "discount_amount": 240.0, "discount_date": "2026-09-04", "reduction_amount": null, "allow_parcial_payment": false, "released_at": null, "rejected_at": "2026-09-04T12:56:11-05:00", "payment_uid": null, "dda_account_uid": null, "created_at": "2026-09-04T12:56:11-05:00", "updated_at": "2026-09-04T12:56:11-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_dda_bank_billet" } } } } } }, "422": { "description": "Transição de estado inválida", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Ação não permitida", "detail": "O boleto DDA precisa estar pendente para ser rejeitado. Status atual: released" } ] }, "schema": { "$ref": "#/components/schemas/v2_unprocessable_content" } } } }, "404": { "description": "Boleto DDA não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Scope de escrita obrigatório.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/payment/dda_bank_billets/{uid}/release": { "put": { "summary": "Liberar Boleto DDA para Pagamento", "tags": [ "Boletos DDA" ], "security": [ { "bearerAuth": [] } ], "description": "\nLibera um boleto DDA com status `pending` para pagamento. Somente boletos com `external_status: open` podem ser liberados.\n\n## Eventos de Webhook\n\nO evento `payment.dda.bank_billet.db.updated` é disparado nesta operação com as alterações de status (`pending` → `released`) e o campo `released_at`. Este evento é disparado em qualquer atualização do boleto DDA, não apenas nesta operação.\n", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "required": true, "description": "UUID do boleto DDA", "example": "e596865f-07a4-4458-88c1-fbb4ffd196e1", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Boleto DDA liberado para pagamento com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-57ae-788b-acc8-db3f8e8e468b", "status": "released", "external_status": "open", "barcode": "34193497900000150001740000000148050088825000", "line": "34191.74001 00000.148050 08882.500009 3 49790000015000", "our_number": "123556238", "description": "BOLETO DDA TESTE", "nominal_amount": 10.0, "amount": 7.6, "min_payment_amount": 1.0, "max_payment_amount": 10.0, "expire_at": "2026-09-07", "issue_date": "2026-09-04", "reference_month": null, "beneficiary_name": "Kobana Tecnologia Ltda.", "beneficiary_cnpj_cpf": "05.813.794/0001-26", "beneficiary_bank_name": "BANCO EXEMPLO", "beneficiary_bank_number": "101", "owner_cnpj_cpf": "83.191.445/0001-23", "owner_person_name": "EMPRESA PAGADORA", "fine_amount": 240.0, "fine_percentage": 2.0, "fine_date": "2026-09-05", "interest_amount": 240.0, "interest_percentage": 2.0, "interest_date": "2026-09-06", "discount_amount": 240.0, "discount_date": "2026-09-04", "reduction_amount": null, "allow_parcial_payment": false, "released_at": "2026-09-04T12:56:11-05:00", "rejected_at": null, "payment_uid": null, "dda_account_uid": null, "created_at": "2026-09-04T12:56:11-05:00", "updated_at": "2026-09-04T12:56:11-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_dda_bank_billet" } } } } } }, "422": { "description": "Transição de estado inválida", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Ação não permitida", "detail": "O boleto DDA precisa estar pendente para ser liberado. Status atual: rejected" } ] }, "schema": { "$ref": "#/components/schemas/v2_unprocessable_content" } } } }, "404": { "description": "Boleto DDA não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Scope de escrita obrigatório.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/payment/accounts": { "get": { "summary": "Listar Contas de Pagamento", "tags": [ "Contas de Pagamento" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todas as contas de pagamento cadastradas na conta. Suporta paginação.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "financial_account_uid", "in": "query", "description": "Filtrar por UID da conta financeira", "required": false, "schema": { "type": "string" }, "example": "e596865f-07a4-4458-88c1-fbb4ffd196e1" } ], "responses": { "200": { "description": "Contas de Pagamento acessadas com escopo read", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d90-5a56-7167-9b42-f7115c7861ec", "financial_account_uid": "01a06d90-5a06-72ab-b1d9-c178a0314d69", "connection_uid": null, "agreement_code": "12345", "service_point_number": null, "provider_data": null, "balance_validation_enabled_at": null, "remittance_enabled_at": null, "external_id": null, "created_at": "2026-09-04T12:56:11-05:00", "updated_at": "2026-09-04T12:56:11-05:00" }, { "uid": "01a06d90-5a4c-74dc-b354-75cd65f56dc7", "financial_account_uid": "01a06d90-5a06-72ab-b1d9-c178a0314d69", "connection_uid": null, "agreement_code": "12345", "service_point_number": null, "provider_data": null, "balance_validation_enabled_at": null, "remittance_enabled_at": null, "external_id": null, "created_at": "2026-09-04T12:56:11-05:00", "updated_at": "2026-09-04T12:56:11-05:00" }, { "uid": "01a06d90-59fc-73bb-af95-7d17a60fe4cd", "financial_account_uid": "01a06d90-5a06-72ab-b1d9-c178a0314d69", "connection_uid": null, "agreement_code": null, "service_point_number": null, "provider_data": null, "balance_validation_enabled_at": null, "remittance_enabled_at": "2026-09-04T12:56:11-05:00", "external_id": null, "created_at": "2026-09-04T12:56:11-05:00", "updated_at": "2026-09-04T12:56:11-05:00" } ], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_payment_account" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "post": { "summary": "Criar Conta de Pagamento", "tags": [ "Contas de Pagamento" ], "security": [ { "bearerAuth": [] } ], "description": "Cria uma nova conta de pagamento associada a uma conta financeira. Use quando a conta financeira precisa de mais de uma conta de pagamento (por exemplo, múltiplos convênios no mesmo banco). A conta é criada sem conexão bancária (`connection_uid` retorna `null`); associe uma conexão antes de habilitar remessas/registro. Requer escopo `write` + `payment.accounts`.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Conta de Pagamento criada", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-5bf9-79cb-b3e0-4d9fd052d01c", "financial_account_uid": "01a06d90-5b9b-7c09-ba8f-de00b5f2f87c", "connection_uid": null, "agreement_code": "778899", "service_point_number": null, "provider_data": null, "balance_validation_enabled_at": null, "remittance_enabled_at": null, "external_id": null, "created_at": "2026-09-04T12:56:12-05:00", "updated_at": "2026-09-04T12:56:12-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `201`." }, "data": { "$ref": "#/components/schemas/v2_payment_account" } } } } } }, "404": { "description": "Conta Financeira não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "422": { "description": "Erro de validação. `agreement_code` acima do limite.", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "agreement_code", "detail": "Número do Convênio de Pagamento é muito longo (máximo: 30 caracteres)" } ] }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `422`." }, "errors": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Falha de permissão. Token sem o escopo `write`.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_payment_account" } } }, "required": true, "description": "Dados da nova conta de pagamento." } } }, "/v2/payment/accounts/{uid}": { "get": { "summary": "Buscar Conta de Pagamento", "tags": [ "Contas de Pagamento" ], "security": [ { "bearerAuth": [] } ], "description": "Retorna os detalhes de uma conta de pagamento específica pelo UID", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "required": true, "description": "UUID da conta de pagamento", "example": "e596865f-07a4-4458-88c1-fbb4ffd196e1", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Conta de Pagamento acessada com escopo read", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-5f9e-7a0c-8648-778fe429a7ab", "financial_account_uid": "01a06d90-5f7d-7e16-98ae-b565092196d1", "connection_uid": null, "agreement_code": "12345", "service_point_number": null, "provider_data": null, "balance_validation_enabled_at": null, "remittance_enabled_at": null, "external_id": null, "created_at": "2026-09-04T12:56:13-05:00", "updated_at": "2026-09-04T12:56:13-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_payment_account" } } } } } }, "404": { "description": "Conta de Pagamento não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "patch": { "summary": "Atualizar Conta de Pagamento", "tags": [ "Contas de Pagamento" ], "security": [ { "bearerAuth": [] } ], "description": "Atualiza atributos editáveis de uma conta de pagamento. Aceita `remittance_enabled` (booleano, controla a geração de remessas EDI), `provider_data.service_point_number` (string, ponto de atendimento — por exemplo `numeroPa` no Sicoob) e `provider_data.cooperative_cnpj` (string, CNPJ da cooperativa Sicoob). O corpo aceita PATCH parcial: envie apenas os campos que deseja atualizar.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "required": true, "description": "UUID da conta de pagamento", "example": "e596865f-07a4-4458-88c1-fbb4ffd196e1", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sicoob — configura cooperative_cnpj (armazenado no formato canônico)", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-613a-7bea-808d-78b08eb119e8", "financial_account_uid": "01a06d90-611b-7fa3-b1d3-9cfd8d2a67ba", "connection_uid": null, "agreement_code": "12345", "service_point_number": "001", "provider_data": { "service_point_number": "001", "cooperative_cnpj": "13.009.717/0001-46" }, "balance_validation_enabled_at": null, "remittance_enabled_at": null, "external_id": null, "created_at": "2026-09-04T12:56:13-05:00", "updated_at": "2026-09-04T12:56:13-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_payment_account" } } } } } }, "422": { "description": "Erro de validação. `remittance_enabled` deve ser verdadeiro ou falso.", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "remittance_enabled", "detail": "Remessa habilitada deve ser verdadeiro ou falso" } ] }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `422`." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Tipo do erro. Ex: `validation_error`." }, "param": { "type": "string", "description": "Parâmetro com erro. Ex: `remittance_enabled`." }, "detail": { "type": "string", "description": "Mensagem descritiva do erro." } } } } } } } } }, "403": { "description": "Falha de permissão. Token sem o escopo `write`.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Conta de Pagamento não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_payment_account" } } }, "required": true, "description": "Atributos a atualizar. Apenas campos graváveis são considerados; envie só os que deseja alterar (PATCH parcial)." } } }, "/v2/payment/pix_batches": { "post": { "summary": "Criar um Lote de Pagamento Pix", "tags": [ "Pix - Pagamento" ], "security": [ { "bearerAuth": [] } ], "description": "\nEsse endpoint é utilizado para a geração de um lote de pagamento.\n\n## Pré-requisito\n\nPara emitir um lote de pagamento é necessário ter uma Conta Financeira, informada em `financial_account_uid`. A conta de pagamento aplicada ao lote é definida em `payment_account_uid`; se omitida, usa-se a mais antiga vinculada à conta financeira; se informada, deve pertencer à `financial_account_uid`.\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.pix_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 ", "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": "01a06d90-6314-7991-a368-094699724866", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-62da-7dae-afde-7fb5dd1eec9c", "payment_account_uid": "01a06d90-62d8-7a80-bb15-b4ba12c1de7b", "created_at": "2026-09-04T12:56:14-05:00", "updated_at": "2026-09-04T12:56:14-05:00", "payments": [ { "uid": "01a06d90-6306-7e6c-b903-0b7bada60af1", "kind": "pix", "amount": 100.4, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-62da-7dae-afde-7fb5dd1eec9c", "payment_account_uid": "01a06d90-62d8-7a80-bb15-b4ba12c1de7b", "batch_uid": "01a06d90-6314-7991-a368-094699724866", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": null, "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:14-05:00", "updated_at": "2026-09-04T12:56:14-05:00", "pix": { "qrcode": "00020126330014br.gov.bcb.pix01111335366962052040000530398654040", "beneficiary": { "name": null, "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-630d-7a30-9de9-667849a04140", "kind": "pix", "amount": 100.4, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-62da-7dae-afde-7fb5dd1eec9c", "payment_account_uid": "01a06d90-62d8-7a80-bb15-b4ba12c1de7b", "batch_uid": "01a06d90-6314-7991-a368-094699724866", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": null, "external_id": "26843f45f68d3bc098a89c550a34845847", "financial_provider_external_id": null, "beneficiary": { "name": null, "document_number": "34.414.342/0000-99" }, "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:14-05:00", "updated_at": "2026-09-04T12:56:14-05:00", "pix": { "qrcode": "00020126330014br.gov.bcb.pix01111335366962052040000530398654040", "beneficiary": { "name": null, "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-6310-7d5c-8cca-89649ad69df0", "kind": "pix", "amount": 24.88, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-62da-7dae-afde-7fb5dd1eec9c", "payment_account_uid": "01a06d90-62d8-7a80-bb15-b4ba12c1de7b", "batch_uid": "01a06d90-6314-7991-a368-094699724866", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": null, "document_number": null }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:14-05:00", "updated_at": "2026-09-04T12:56:14-05:00", "pix": { "qrcode": "00020126480014BR.GOV.BCB.PIX0126rafaelaquilaah@hotmail.com520400005303986540524.885802BR5925Rafael Aquila Araujo de H6009SAO PAULO62140510ryDeHwkEiJ6304F623", "beneficiary": { "name": null, "document_number": null } } } ] } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_payment_batch_pix" } } } } } }, "422": { "description": "Erro de validação — external_id duplicado", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "payments.external_id", "detail": "ID externo já está em uso" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_payment_batch_pix" } } }, "required": true, "description": "Parametros para criação de um Lote de Pagamento" } } }, "/v2/payment/pix": { "get": { "summary": "Listar Pagamentos Pix", "tags": [ "Pix - Pagamento" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todos os pagamentos realizados via Pix. Suporta paginação e retorna informações detalhadas sobre cada pagamento.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } } ], "responses": { "200": { "description": "Pagamentos encontrados", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d90-67b7-7fea-b31f-fe01d06c5472", "kind": "pix", "amount": 100.0, "scheduled_to": "2026-09-04T12:56:14-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-678d-7c13-a669-8129eb23adb2", "payment_account_uid": "01a06d90-678b-7b17-b8e7-6d2a7407b855", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:15-05:00", "updated_at": "2026-09-04T12:56:15-05:00", "pix": { "qrcode": "00020126330014br.gov.bcb.pix01111335366962052040000530398654040", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-676a-764c-b2aa-492a04eb627d", "kind": "pix", "amount": 100.0, "scheduled_to": "2026-09-04T12:56:14-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-6740-7395-a8ef-5c505e68fe3a", "payment_account_uid": "01a06d90-673e-7e68-a96f-6cd242eaaa95", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:15-05:00", "updated_at": "2026-09-04T12:56:15-05:00", "pix": { "qrcode": "00020126330014br.gov.bcb.pix01111335366962052040000530398654040", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-671e-7c59-a440-8251bda8fcc7", "kind": "pix", "amount": 100.0, "scheduled_to": "2026-09-04T12:56:14-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-66f5-7122-b1de-ed2a17321ad2", "payment_account_uid": "01a06d90-66f3-7f23-9e35-c7fd68ac7e9d", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:15-05:00", "updated_at": "2026-09-04T12:56:15-05:00", "pix": { "qrcode": "00020126330014br.gov.bcb.pix01111335366962052040000530398654040", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-66d4-751c-966c-7afa192a4355", "kind": "pix", "amount": 100.0, "scheduled_to": "2026-09-04T12:56:14-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-66a9-71b1-80aa-ffb09a2934f4", "payment_account_uid": "01a06d90-66a7-7508-bd84-6461cd1350b5", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:15-05:00", "updated_at": "2026-09-04T12:56:15-05:00", "pix": { "qrcode": "00020126330014br.gov.bcb.pix01111335366962052040000530398654040", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-6689-7492-89f4-c54a5f105b87", "kind": "pix", "amount": 100.0, "scheduled_to": "2026-09-04T12:56:14-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-665e-7bb8-b78a-c4ce73f17c5c", "payment_account_uid": "01a06d90-665c-7228-8908-4f2f79d9289e", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:15-05:00", "updated_at": "2026-09-04T12:56:15-05:00", "pix": { "qrcode": "00020126330014br.gov.bcb.pix01111335366962052040000530398654040", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } ], "pagination": { "prev_url": null, "next_url": "/v2/payment/pix?per_page=5&page=2", "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_payment_pix" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } } } }, "post": { "summary": "Criar um Pagamento Pix", "tags": [ "Pix - Pagamento" ], "security": [ { "bearerAuth": [] } ], "description": "\nEsse endpoint é utilizado para a geração de um pagamento.\n\n## Pré-requisito\n\nPara emitir um pagamento é necessário ter uma Conta Financeira, informada em `financial_account_uid`. A conta de pagamento que registra a operação é definida em `payment_account_uid`; se omitida, usa-se a mais antiga vinculada à conta financeira; se informada, deve pertencer à `financial_account_uid`.\n\n## Eventos de Webhook\n\nO evento `payment.db.created` é disparado nesta operação.\n\n> **Próximos passos:** Após criar um pagamento, você desejará em algum momento enviar um Lote para a instituição financeira. Para isso, utilize o endpoint `POST /api/v2/payment/pix_batches`.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Pagamento criado", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-6831-7cab-b34c-4fef8e2f37af", "kind": "pix", "amount": 100.4, "scheduled_to": "2026-09-04T00:00:00-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-680c-7417-8b95-c4b0e8e9e740", "payment_account_uid": "01a06d90-680b-71a7-9801-10876c655fbf", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": "SID1234567890", "external_id": "26843f45f68d3bc098a89c550a34845847", "financial_provider_external_id": null, "beneficiary": { "name": null, "document_number": null }, "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:15-05:00", "updated_at": "2026-09-04T12:56:15-05:00", "pix": { "qrcode": "00020126330014br.gov.bcb.pix01111335366962052040000530398654040", "beneficiary": { "name": null, "document_number": null } } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_payment_pix" } } } } } }, "422": { "description": "Erro de validação", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "amount", "detail": "Quantia deve ser maior que 0" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_payment_pix_single" } } }, "required": true, "description": "Parametros para criação de um Pagamento" } } }, "/v2/payment/pix/{uid}": { "get": { "summary": "Visualizar um Pagamento Pix", "tags": [ "Pix - Pagamento" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de um Pagamento Pix.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UUID do Pagamento Pix", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Pagamento encontrado", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-695e-7868-a7f5-3ba9775dc544", "kind": "pix", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-6935-765b-afed-59491dfb3d6d", "payment_account_uid": "01a06d90-6933-7316-a80e-4b76669fab19", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": "018c9160-5c85-725f-b56e-4af36f2564be", "transaction_date": null, "source": "view", "identifier": "154785966666666", "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:15-05:00", "updated_at": "2026-09-04T12:56:15-05:00", "pix": { "qrcode": "00020126330014br.gov.bcb.pix01111335366962052040000530398654040", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_payment_pix" } } } } } }, "404": { "description": "Pagamento não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/payment/pix/{uid}/cancel": { "put": { "summary": "Cancelar um Pagamento Pix", "tags": [ "Pix - Pagamento" ], "security": [ { "bearerAuth": [] } ], "description": "\n> **Processamento Assíncrono:** Este endpoint é processado assincronamente e cria um comando de cancelamento para o Pagamento.\nO cancelamento de um Pagamento é feito assincronamente, ou seja, ao receber a requisição, a nossa API guarda a solicitação e cria um Comando. Esse comando é processado em segundo plano e depois de confirmado, o Pagamento tem seu status alterado para Cancelado. Você recebe na resposta desta requisição o ID do comando criado e pode consultá-lo a qualquer momento.\n\n## Eventos de Webhook\n\nQuando a requisição é realizada, um evento `payment.pix.cancel.requested` é disparado.\nO nosso servidor então começa as tentativas de envio do cancelamento para a instituição financeira.\nSomente depois de confirmado na instituição financeira, aí então o pagamento é marcado como cancelado em nosso banco de dados.\nNeste momento o evento `payment.pix.cancel.confirmed` é disparado.\n\n> ⚠️ **Atenção ao status Cancelado:** O status de Cancelado é terminal. O pagamento não poderá mais ser processado após o cancelamento.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "description": "UUID do Pagamento", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Pagamento cancelado sem interação com provedor", "content": { "application/json": { "example": { "status": 200, "data": { "id": 188, "uid": "01a06d90-6a25-7532-a217-0daa6f98655f", "status": "pending", "operation": "cancel", "resource_type": "Payment", "resource_uid": "01a06d90-6a10-7d85-8a23-325833f65a35", "financial_provider_slug": "btg", "params": null, "payload": null, "created_at": "2026-09-04T12:56:16-05:00", "updated_at": "2026-09-04T12:56:16-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "payment": { "uid": "01a06d90-6a10-7d85-8a23-325833f65a35", "kind": "pix", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "confirmed", "financial_account_uid": "01a06d90-69e5-7bac-ad7a-07c32a6395f6", "payment_account_uid": "01a06d90-69e3-794d-abe9-907a340969c7", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:16-05:00", "updated_at": "2026-09-04T12:56:16-05:00", "pix": { "qrcode": "00020126330014br.gov.bcb.pix01111335366962052040000530398654040", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } }, "message": "Pagamento cancelado com sucesso sem interação com provedor." }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_payment_command" }, "message": { "type": "string", "description": "Mensagem de sucesso" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "422": { "description": "Pagamento já foi confirmado ou rejeitado", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Cancelamento de Pagamento.", "detail": "Pagamento já foi confirmado ou rejeitado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/payment/tax_batches": { "post": { "summary": "Criar Lote de Pagamentos de Tributo", "tags": [ "Tributo (beta)" ], "security": [ { "bearerAuth": [] } ], "description": "Esse endpoint é utilizado para a geração de um lote de pagamento de tributos municipais, estaduais e federais.\n\n> ⚠️ **Novidade em Desenvolvimento!** Esta API está em versão beta - isso significa que estamos constantemente melhorando e ajustando suas funcionalidades. Embora seja totalmente funcional, algumas coisas podem mudar conforme recebemos feedback dos desenvolvedores.\n>\n> Para dúvidas sobre esta funcionalidade, entre em contato conosco.\n\n## Pré-requisito\n\nPara emitir um lote de pagamento é necessário ter uma Conta Financeira, informada em `financial_account_uid`. A conta de pagamento aplicada ao lote é definida em `payment_account_uid`; se omitida, usa-se a mais antiga vinculada à conta financeira; se informada, deve pertencer à `financial_account_uid`.\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.tax_batch.confirmed` é disparado.\n\nO evento `payment.db.created` também é disparado nesta operação caso o lote contenha um novo pagamento.\n", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Lote criado com format=data (GRU)", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-6cd9-7bdd-b046-955158ad2315", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-6c82-73ab-9333-1f93a8b4df78", "payment_account_uid": "01a06d90-6c80-778c-8e7d-6c9f04177ff8", "created_at": "2026-09-04T12:56:16-05:00", "updated_at": "2026-09-04T12:56:16-05:00", "payments": [ { "uid": "01a06d90-6ca5-708f-b101-254313190cf4", "kind": "tax", "amount": 250.5, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-6c82-73ab-9333-1f93a8b4df78", "payment_account_uid": "01a06d90-6c80-778c-8e7d-6c9f04177ff8", "batch_uid": "01a06d90-6cd9-7bdd-b046-955158ad2315", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": null, "document_number": null }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:16-05:00", "updated_at": "2026-09-04T12:56:16-05:00", "tax": { "format": "data", "kind": "gru", "code": null, "data": { "reference_number": "12345678901234", "expire_at": "2026-02-28", "total_amount": 250.5, "discount_amount": 10.0, "other_deduction_amount": null, "fine_amount": 15.0, "interest_amount": 8.5, "other_addition_amount": null }, "beneficiary": { "name": null, "document_number": null } } } ] } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `201`." }, "data": { "$ref": "#/components/schemas/v2_payment_batch_tax" } } } } } }, "422": { "description": "Erro de validação — external_id duplicado", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "payments.external_id", "detail": "ID externo já está em uso" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_payment_batch_tax" } } } } } }, "/v2/payment/taxes": { "get": { "summary": "Listar Pagamentos de Tributo", "tags": [ "Tributo (beta)" ], "security": [ { "bearerAuth": [] } ], "description": "Esse endpoint é utilizado para a geração de um pagamento de tributo municipal, estadual ou federal.\n\n> ⚠️ **Novidade em Desenvolvimento!** Esta API está em versão beta - isso significa que estamos constantemente melhorando e ajustando suas funcionalidades. Embora seja totalmente funcional, algumas coisas podem mudar conforme recebemos feedback dos desenvolvedores.\n>\n> Para dúvidas sobre esta funcionalidade, entre em contato conosco.\n", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } } ], "responses": { "200": { "description": "Pagamentos encontrados", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d90-7150-7f29-bf5b-17b81ecfac1e", "kind": "tax", "amount": 100.0, "scheduled_to": "2026-09-05T12:56:17-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-711d-78c5-8577-3c88b857bcc5", "payment_account_uid": "01a06d90-711b-724f-9222-a4c102673074", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": "018df180-7208-727b-a10a-ea545e4a75a8", "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Prefeitura Municipal", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:17-05:00", "updated_at": "2026-09-04T12:56:17-05:00", "tax": { "format": "code", "kind": "itbi", "code": "01390156902165481330686906869965501913139797", "data": null, "beneficiary": { "name": "Prefeitura Municipal", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-70fd-7dcf-aa53-9641d1340caa", "kind": "tax", "amount": 100.0, "scheduled_to": "2026-09-05T12:56:17-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-70d3-7126-9faa-329e49b3d0af", "payment_account_uid": "01a06d90-70d2-77ea-8ce2-b0a4940dc74b", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": "018df180-7208-727b-a10a-ea545e4a75a8", "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Prefeitura Municipal", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:17-05:00", "updated_at": "2026-09-04T12:56:17-05:00", "tax": { "format": "code", "kind": "itbi", "code": "00590156902188423640556289022188444879020634", "data": null, "beneficiary": { "name": "Prefeitura Municipal", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-70b3-7c06-a1fe-c928d966adca", "kind": "tax", "amount": 100.0, "scheduled_to": "2026-09-05T12:56:17-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-7088-7a5a-ae21-c9296ecea11d", "payment_account_uid": "01a06d90-7086-7c18-b36e-e9ff6ee407e9", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": "018df180-7208-727b-a10a-ea545e4a75a8", "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Prefeitura Municipal", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:17-05:00", "updated_at": "2026-09-04T12:56:17-05:00", "tax": { "format": "code", "kind": "itbi", "code": "04590156907924600890288151858138062641287013", "data": null, "beneficiary": { "name": "Prefeitura Municipal", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-7067-7af0-99f2-89429285dc3b", "kind": "tax", "amount": 100.0, "scheduled_to": "2026-09-05T12:56:17-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-703d-7e16-b5ae-9d0b73a69477", "payment_account_uid": "01a06d90-703b-7bcb-b6f5-78040762c9dc", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": "018df180-7208-727b-a10a-ea545e4a75a8", "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Prefeitura Municipal", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:17-05:00", "updated_at": "2026-09-04T12:56:17-05:00", "tax": { "format": "code", "kind": "itbi", "code": "00890156907238952570645430009593267996011375", "data": null, "beneficiary": { "name": "Prefeitura Municipal", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-701d-7ff2-98d5-504a64577bbf", "kind": "tax", "amount": 100.0, "scheduled_to": "2026-09-05T12:56:17-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-6ff2-7409-b7d7-0f7ee0e24b03", "payment_account_uid": "01a06d90-6ff0-75dc-aa25-2f6b80e6558d", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": "018df180-7208-727b-a10a-ea545e4a75a8", "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Prefeitura Municipal", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:17-05:00", "updated_at": "2026-09-04T12:56:17-05:00", "tax": { "format": "code", "kind": "itbi", "code": "04690156902278801630665693968444481138346779", "data": null, "beneficiary": { "name": "Prefeitura Municipal", "document_number": "34.414.342/0000-99" } } } ], "pagination": { "prev_url": null, "next_url": "/v2/payment/taxes?per_page=5&page=2", "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_payment_tax" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } } } }, "post": { "summary": "Criar Pagamento de Tributo", "tags": [ "Tributo (beta)" ], "security": [ { "bearerAuth": [] } ], "description": "## Pré-requisitos\n\nPara emitir um pagamento é necessário ter uma Conta Financeira, informada em `financial_account_uid`. A conta de pagamento que registra a operação é definida em `payment_account_uid`; se omitida, usa-se a mais antiga vinculada à conta financeira; se informada, deve pertencer à `financial_account_uid`.\n", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Pagamento criado com format=data (DARF)", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-7245-7d71-b3c3-b346f126ab2f", "kind": "tax", "amount": 150.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-7220-76b0-a232-c0dae73e7761", "payment_account_uid": "01a06d90-721e-72b7-98eb-44b2a0132e7b", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": null, "document_number": null }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:18-05:00", "updated_at": "2026-09-04T12:56:18-05:00", "tax": { "format": "data", "kind": "darf", "code": null, "data": { "tax_code": "0107", "reference_number": null, "taxpayer_type": "cnpj", "taxpayer_number": "12345678000199", "taxpayer_name": "Empresa LTDA", "calculation_date": "2026-01-15", "expire_at": "2026-02-28", "fine_amount": 15.0, "interest_amount": 5.5, "gross_income_amount": null }, "beneficiary": { "name": null, "document_number": null } } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `201`." }, "data": { "$ref": "#/components/schemas/v2_payment_tax" } } } } } }, "422": { "description": "Parâmetros inválidos", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "payable.code", "detail": "Código de Barras ou Linha Digitável precisa conter 44, 47 ou 48 caracteres numéricos" }, { "code": "validation_error", "param": "payable.code", "detail": "Código de Barras ou Linha Digitável não pode ficar em branco" }, { "code": "validation_error", "param": "amount", "detail": "Quantia não pode ficar em branco" } ] }, "schema": { "$ref": "#/components/schemas/v2_unprocessable_content" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_payment_tax" } } } } } }, "/v2/payment/taxes/{uid}": { "get": { "summary": "Exibir Pagamento de Tributo", "tags": [ "Tributo (beta)" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UID do Pagamento", "example": "018df180-7208-727b-a10a-ea545e4a75a8", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Pagamento encontrado", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-7362-76c4-b9d0-63ec88f5d304", "kind": "tax", "amount": 100.0, "scheduled_to": "2026-09-05T12:56:18-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-7339-78e9-9ac9-f76580f6cb38", "payment_account_uid": "01a06d90-7337-7fc7-965d-31d2f9acc784", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Prefeitura Municipal", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:18-05:00", "updated_at": "2026-09-04T12:56:18-05:00", "tax": { "format": "code", "kind": "itbi", "code": "00690156900636455860100000619811130778813192", "data": null, "beneficiary": { "name": "Prefeitura Municipal", "document_number": "34.414.342/0000-99" } } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_payment_tax" } } } } } }, "404": { "description": "Pagamento não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/payment/taxes/{uid}/cancel": { "put": { "summary": "Cancelar um Pagamento de Tributo", "tags": [ "Tributo (beta)" ], "security": [ { "bearerAuth": [] } ], "description": "\n> **Processamento Assíncrono:** Este endpoint é processado assincronamente e cria um comando de cancelamento para o Pagamento.\nO cancelamento de um Pagamento é feito assincronamente, ou seja, ao receber a requisição, a nossa API guarda a solicitação e cria um Comando. Esse comando é processado em segundo plano e depois de confirmado, o Pagamento tem seu status alterado para Cancelado. Você recebe na resposta desta requisição o ID do comando criado e pode consultá-lo a qualquer momento.\n\n## Eventos de Webhook\n\nQuando a requisição é realizada, um evento `payment.tax.cancel.requested` é disparado.\nO nosso servidor então começa as tentativas de envio do cancelamento para a instituição financeira.\nSomente depois de confirmado na instituição financeira, aí então o pagamento é marcado como cancelado em nosso banco de dados.\nNeste momento o evento `payment.tax.cancel.confirmed` é disparado.\n\n> ⚠️ **Atenção ao status Cancelado:** O status de Cancelado é terminal. O pagamento não poderá mais ser processado após o cancelamento.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "description": "UUID do Pagamento", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Pagamento cancelado sem interação com provedor", "content": { "application/json": { "example": { "status": 200, "message": "Pagamento cancelado com sucesso sem interação com provedor." }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "message": { "type": "string", "description": "Mensagem de sucesso" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "422": { "description": "Pagamento já foi confirmado ou rejeitado", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Cancelamento de Pagamento.", "detail": "Pagamento já foi confirmado ou rejeitado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/payment/utilities": { "get": { "summary": "Listar Pagamentos de Contas de Consumo", "tags": [ "Contas de Consumo" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todos os pagamentos de contas de consumo (água, luz, gás, telefone, etc.) realizados. Suporta paginação e retorna informações detalhadas.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } } ], "responses": { "200": { "description": "Pagamentos encontrados", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d90-7847-7d3c-b04b-53aa315f4fc3", "kind": "utility", "amount": 100.0, "scheduled_to": "2026-09-04T12:56:18-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-781b-7fba-a8b8-2782b3cb0dd5", "payment_account_uid": "01a06d90-7819-741e-97ea-f94dbbfdadf0", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:19-05:00", "updated_at": "2026-09-04T12:56:19-05:00", "utility": { "code": "06390156900692997630092065744834759050842206", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-77f7-715a-89fc-340b42a81612", "kind": "utility", "amount": 100.0, "scheduled_to": "2026-09-04T12:56:18-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-77c7-7068-a279-ab70dfc87298", "payment_account_uid": "01a06d90-77c5-7d80-b521-1855864e2c02", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:19-05:00", "updated_at": "2026-09-04T12:56:19-05:00", "utility": { "code": "08390156909339258390206550065597289339904343", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-77a4-7eb5-9d1f-b512ef2317b0", "kind": "utility", "amount": 100.0, "scheduled_to": "2026-09-04T12:56:18-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-7778-7d11-992b-6e733eb02b6f", "payment_account_uid": "01a06d90-7775-72ec-ad6d-da6e89adb321", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:19-05:00", "updated_at": "2026-09-04T12:56:19-05:00", "utility": { "code": "07390156900518952040923362603584373766467857", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-7754-7060-9345-0775c5c46f4b", "kind": "utility", "amount": 100.0, "scheduled_to": "2026-09-04T12:56:18-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-7725-7ca0-a782-483a67b4a9cb", "payment_account_uid": "01a06d90-7722-733b-9105-aad4d2b25549", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:19-05:00", "updated_at": "2026-09-04T12:56:19-05:00", "utility": { "code": "00390156902104499010870439161894184675883831", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-7700-7e6f-894b-27e7f6da733d", "kind": "utility", "amount": 100.0, "scheduled_to": "2026-09-04T12:56:18-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-76a4-7e6d-9717-c90171a28080", "payment_account_uid": "01a06d90-76a2-762b-8185-c0b32ea87284", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:19-05:00", "updated_at": "2026-09-04T12:56:19-05:00", "utility": { "code": "09190156902682797900102248460860695879020746", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } ], "pagination": { "prev_url": null, "next_url": "/v2/payment/utilities?per_page=5&page=2", "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_payment_utility" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } } } }, "post": { "summary": "Criar um Pagamento de Conta de Consumo", "tags": [ "Contas de Consumo" ], "security": [ { "bearerAuth": [] } ], "description": "\nEsse endpoint é utilizado para a geração de um pagamento.\n\n## Pré-requisito\n\nPara emitir um pagamento é necessário ter uma Conta Financeira, informada em `financial_account_uid`. A conta de pagamento que registra a operação é definida em `payment_account_uid`; se omitida, usa-se a mais antiga vinculada à conta financeira; se informada, deve pertencer à `financial_account_uid`.\n\n## Eventos de Webhook\n\nO evento `payment.db.created` é disparado nesta operação.\n\n> **Próximos passos:** Após criar um pagamento, você desejará em algum momento enviar um Lote para a instituição financeira. Para isso, utilize o endpoint `POST /api/v2/payment/utility_batches`.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Pagamento criado", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-78c6-79ec-bdea-ba8671eb41c1", "kind": "utility", "amount": 100.4, "scheduled_to": "2026-09-04T00:00:00-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-78a2-75c7-9858-da722c722f0d", "payment_account_uid": "01a06d90-78a0-7e0e-9f94-cf6df4d4d5f2", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": null, "external_id": "26843f45f68d3bc098a89c550a34845846", "financial_provider_external_id": null, "beneficiary": { "name": null, "document_number": null }, "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:19-05:00", "updated_at": "2026-09-04T12:56:19-05:00", "utility": { "code": "00196994400000100040000003128557120985944917", "beneficiary": { "name": null, "document_number": null } } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_payment_utility" } } } } } }, "422": { "description": "Erro de validação", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "payable.code", "detail": "Código de Barras ou Linha Digitável precisa conter 44, 47 ou 48 caracteres numéricos" }, { "code": "validation_error", "param": "amount", "detail": "Quantia não pode ficar em branco" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_payment_utility" } } }, "required": true, "description": "Parametros para criação de um Pagamento" } } }, "/v2/payment/utilities/{uid}": { "get": { "summary": "Visualizar um Pagamento de Conta de Consumo", "tags": [ "Contas de Consumo" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de um Pagamento de Conta de Consumo.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UUID do Pagamento de Conta de Consumo", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Pagamento encontrado", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-7a0a-7f67-914a-d1d2569621e4", "kind": "utility", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-79e1-7604-9bfe-6a7f9b2cb5a9", "payment_account_uid": "01a06d90-79df-750d-88f2-fde1cdd9f849", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": "018c9160-5c85-725f-b56e-4af36f2564be", "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:20-05:00", "updated_at": "2026-09-04T12:56:20-05:00", "utility": { "code": "00690156909004310480628013048353358562715160", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_payment_utility" } } } } } }, "404": { "description": "Pagamento não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/payment/utilities/{uid}/cancel": { "put": { "summary": "Cancelar um Pagamento de Conta de Consumo", "tags": [ "Contas de Consumo" ], "security": [ { "bearerAuth": [] } ], "description": "\n> **Processamento Assíncrono:** Este endpoint é processado assincronamente e cria um comando de cancelamento para o Pagamento.\nO cancelamento de um Pagamento é feito assincronamente, ou seja, ao receber a requisição, a nossa API guarda a solicitação e cria um Comando. Esse comando é processado em segundo plano e depois de confirmado, o Pagamento tem seu status alterado para Cancelado. Você recebe na resposta desta requisição o ID do comando criado e pode consultá-lo a qualquer momento.\n\n## Eventos de Webhook\n\nQuando a requisição é realizada, um evento `payment.utility.cancel.requested` é disparado.\nO nosso servidor então começa as tentativas de envio do cancelamento para a instituição financeira.\nSomente depois de confirmado na instituição financeira, aí então o pagamento é marcado como cancelado em nosso banco de dados.\nNeste momento o evento `payment.utility.cancel.confirmed` é disparado.\n\n> ⚠️ **Atenção ao status Cancelado:** O status de Cancelado é terminal. O pagamento não poderá mais ser processado após o cancelamento.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "description": "UUID do Pagamento", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Pagamento cancelado sem interação com provedor", "content": { "application/json": { "example": { "status": 200, "data": { "id": 189, "uid": "01a06d90-7ac4-73c4-91f7-e1007be364b0", "status": "pending", "operation": "cancel", "resource_type": "Payment", "resource_uid": "01a06d90-7aae-7f12-9322-0ca4f802b7bf", "financial_provider_slug": "btg", "params": null, "payload": null, "created_at": "2026-09-04T12:56:20-05:00", "updated_at": "2026-09-04T12:56:20-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "payment": { "uid": "01a06d90-7aae-7f12-9322-0ca4f802b7bf", "kind": "utility", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "confirmed", "financial_account_uid": "01a06d90-7a82-7ae4-83f6-edd148bc1863", "payment_account_uid": "01a06d90-7a80-73c8-b1d7-e1053ecf3046", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:20-05:00", "updated_at": "2026-09-04T12:56:20-05:00", "utility": { "code": "06690156900892194450106371908702122345356709", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } }, "message": "Pagamento cancelado com sucesso sem interação com provedor." }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_payment_command" }, "message": { "type": "string", "description": "Mensagem de sucesso" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "422": { "description": "Pagamento já foi confirmado ou rejeitado", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Cancelamento de Pagamento.", "detail": "Pagamento já foi confirmado ou rejeitado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/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 lote de pagamento é necessário ter uma Conta Financeira, informada em `financial_account_uid`. A conta de pagamento aplicada ao lote é definida em `payment_account_uid`; se omitida, usa-se a mais antiga vinculada à conta financeira; se informada, deve pertencer à `financial_account_uid`.\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 ", "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": "01a06d90-7ca9-75ad-a1b9-4a13ed771be4", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-7c7c-7539-bb8d-109c5f3cc819", "payment_account_uid": "01a06d90-7c7a-789d-9898-4362f2d53043", "created_at": "2026-09-04T12:56:20-05:00", "updated_at": "2026-09-04T12:56:20-05:00", "payments": [ { "uid": "01a06d90-7c9f-7e39-8aa1-f07c5ccbfb0a", "kind": "utility", "amount": 100.4, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-7c7c-7539-bb8d-109c5f3cc819", "payment_account_uid": "01a06d90-7c7a-789d-9898-4362f2d53043", "batch_uid": "01a06d90-7ca9-75ad-a1b9-4a13ed771be4", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": null, "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:20-05:00", "updated_at": "2026-09-04T12:56:20-05:00", "utility": { "code": "00196994400000100040000003128557120985944917", "beneficiary": { "name": null, "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-7ca6-72f8-a868-fdbbcfc1c527", "kind": "utility", "amount": 100.4, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-7c7c-7539-bb8d-109c5f3cc819", "payment_account_uid": "01a06d90-7c7a-789d-9898-4362f2d53043", "batch_uid": "01a06d90-7ca9-75ad-a1b9-4a13ed771be4", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": null, "external_id": "26843f45f68d3bc098a89c550a34845847", "financial_provider_external_id": null, "beneficiary": { "name": null, "document_number": "34.414.342/0000-99" }, "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:20-05:00", "updated_at": "2026-09-04T12:56:20-05:00", "utility": { "code": "00196994400000100040000003128557120985944918", "beneficiary": { "name": null, "document_number": "34.414.342/0000-99" } } } ] } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_payment_batch_utility" } } } } } }, "422": { "description": "Erro de validação — external_id duplicado", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "payments.external_id", "detail": "ID externo já está em uso" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_payment_batch_utility" } } }, "required": true, "description": "Parametros para criação de um Lote de Pagamento" } } }, "/v2/payments": { "get": { "summary": "Listar Pagamentos", "tags": [ "Pagamentos" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todos os pagamentos de qualquer tipo (PIX, Boleto, DARF, Tributos, Contas). Suporta filtros e paginação. Este é um endpoint unificado que retorna payments de todos os tipos através de uma única consulta.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "kind", "in": "query", "description": "Filtrar por tipo de pagamento", "required": false, "schema": { "type": "string", "enum": [ "bank_billet", "darf", "utility", "gru", "pix", "tax" ] } }, { "name": "status", "in": "query", "description": "Filtrar por status", "required": false, "schema": { "type": "string", "enum": [ "pending", "scheduled", "confirmed", "rejected", "canceled" ] } }, { "name": "created_from", "in": "query", "description": "Filtrar por data de criação inicial (formato: YYYY-MM-DD, inclusivo)", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "created_to", "in": "query", "description": "Filtrar por data de criação final (formato: YYYY-MM-DD, inclui o dia inteiro)", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "updated_from", "in": "query", "description": "Filtrar por data de atualização inicial (formato: YYYY-MM-DD, inclusivo)", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "updated_to", "in": "query", "description": "Filtrar por data de atualização final (formato: YYYY-MM-DD, inclui o dia inteiro)", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "scheduled_from", "in": "query", "description": "Filtrar por data de agendamento inicial (formato: YYYY-MM-DD)", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "scheduled_to", "in": "query", "description": "Filtrar por data de agendamento final (formato: YYYY-MM-DD)", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "scheduled", "in": "query", "description": "Filtrar apenas pagamentos agendados (true) ou não agendados (false)", "required": false, "schema": { "type": "boolean" } }, { "name": "identifier", "in": "query", "description": "Buscar por identificador (busca parcial)", "required": false, "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "Filtrar por ID externo", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Pagamentos encontrados", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d90-7ed9-7635-9353-20e2f8205840", "kind": "darf", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-7eb0-7312-a1e9-3ede1e870ee2", "payment_account_uid": "01a06d90-7eae-74ed-858c-90812aec72cb", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": null, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:21-05:00", "updated_at": "2026-09-04T12:56:21-05:00", "darf": { "code": null, "calculation_date": "2026-10-31", "expire_at": "2026-09-07", "reference_number": "1161307", "taxpayer_number": "05.813.794/0001-26", "taxpayer_name": "Kobana Tecnologia Ltda.", "tax_code": "0107", "fine_amount": 0.0, "interest_amount": 0.0, "gross_income_amount": 0.0 } }, { "uid": "01a06d90-7e94-71d5-b830-f5ab1675d445", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-7e6a-7cf3-904d-87d4262641cd", "payment_account_uid": "01a06d90-7e68-7337-acdd-89367e04dee9", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:21-05:00", "updated_at": "2026-09-04T12:56:21-05:00", "bank_billet": { "code": "05590156901420527320018154433207051081234207", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01a06d90-7e4c-7fdd-8288-d5d3b82385ea", "kind": "pix", "amount": 100.0, "scheduled_to": "2026-09-04T12:56:21-05:00", "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-7e23-7435-b713-d5ea5aa891a3", "payment_account_uid": "01a06d90-7e22-70b8-8e0c-c9b16da3e16d", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:21-05:00", "updated_at": "2026-09-04T12:56:21-05:00", "pix": { "qrcode": "00020126330014br.gov.bcb.pix01111335366962052040000530398654040", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } ], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_generic_payment" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } } } }, "post": { "summary": "Criar um Pagamento", "tags": [ "Pagamentos" ], "security": [ { "bearerAuth": [] } ], "description": "Endpoint genérico para criação de pagamentos de qualquer tipo. O tipo deve ser especificado no campo `kind`.\n\n## Pré-requisitos\n\nPara emitir um pagamento é necessário ter uma Conta Financeira, informada em `financial_account_uid`. A conta de pagamento que registra a operação é definida em `payment_account_uid`; se omitida, usa-se a mais antiga vinculada à conta financeira; se informada, deve pertencer à `financial_account_uid`.\n\n## Tipos Suportados\n\n### PIX\nUsar `kind: \"pix\"` e fornecer a chave `pix`:\n```json\n{\n \"kind\": \"pix\",\n \"financial_account_uid\": \"...\",\n \"amount\": 100.0,\n \"pix\": {\n \"qrcode\": \"00020126330014br.gov.bcb.pix...\"\n }\n}\n```\n\n### Boleto Bancário\nUsar `kind: \"bank_billet\"` e fornecer a chave `bank_billet`:\n```json\n{\n \"kind\": \"bank_billet\",\n \"financial_account_uid\": \"...\",\n \"amount\": 200.0,\n \"bank_billet\": {\n \"code\": \"81770000001-8 00005659970-7 41131079703-9 0014334-8\"\n }\n}\n```\n\n### DARF\nUsar `kind: \"darf\"` e fornecer a chave `darf`:\n```json\n{\n \"kind\": \"darf\",\n \"financial_account_uid\": \"...\",\n \"amount\": 300.0,\n \"darf\": {\n \"tax_code\": \"0107\",\n \"calculation_date\": \"2024-12-31\",\n \"expire_at\": \"2025-01-10\"\n }\n}\n```\n\n### Tributos (Tax)\nUsar `kind: \"tax\"` e fornecer a chave `tax` com código de barras:\n```json\n{\n \"kind\": \"tax\",\n \"financial_account_uid\": \"...\",\n \"amount\": 400.0,\n \"tax\": {\n \"kind\": \"iptu\",\n \"code\": \"81770000001-8 00005659970-7...\"\n }\n}\n```\n\n### Contas de Consumo (Utility)\nUsar `kind: \"utility\"` e fornecer a chave `utility`:\n```json\n{\n \"kind\": \"utility\",\n \"financial_account_uid\": \"...\",\n \"amount\": 500.0,\n \"utility\": {\n \"code\": \"81770000001-8 00005659970-7...\"\n }\n}\n```\n\n## Eventos de Webhook\n\nO evento `payment.db.created` é disparado nesta operação.\n\n> **Endpoint Unificado:** Este endpoint unifica a criação de todos os tipos de pagamento. Para criar pagamentos de um tipo específico, você também pode usar os endpoints dedicados em `/api/v2/payment/{type}`.\n", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Pagamento Conta de Consumo criado", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-822f-7230-8d87-0ae00f2f5f9f", "kind": "utility", "amount": 500.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-820a-7e93-b294-8aef7d6ffe87", "payment_account_uid": "01a06d90-8208-7977-a9a2-d93654204561", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": null, "document_number": null }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:22-05:00", "updated_at": "2026-09-04T12:56:22-05:00", "pix": { "qrcode": "00020126330014br.gov.bcb.pix01111335366962052040000530398654040", "beneficiary": { "name": null, "document_number": null } }, "bank_billet": { "code": "81770000001800005659970741131079703900143348", "beneficiary": { "name": null, "document_number": null } }, "darf": { "code": null, "calculation_date": "2026-10-31", "expire_at": "2026-09-07", "reference_number": "1161307", "taxpayer_number": "05.813.794/0001-26", "taxpayer_name": "Empresa Exemplo LTDA", "tax_code": "0107", "fine_amount": 0.0, "interest_amount": 0.0, "gross_income_amount": 0.0 }, "tax": { "format": "data", "kind": "gru", "code": null, "data": { "tax_code": "0107", "reference_number": "12345678901234", "taxpayer_type": "cpf", "taxpayer_number": "12345678901", "taxpayer_name": "João da Silva", "calculation_date": "2026-01-15", "expire_at": "2026-02-28", "fine_amount": 15.0, "interest_amount": 8.5, "gross_income_amount": 0.0, "total_amount": 250.5, "discount_amount": 10.0, "other_deduction_amount": 5.0, "other_addition_amount": 2.0 }, "beneficiary": { "name": null, "document_number": null } }, "utility": { "code": "81770000001800005659970741131079703900143348", "beneficiary": { "name": null, "document_number": null } } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `201`." }, "data": { "$ref": "#/components/schemas/v2_payment_utility" } } } } } }, "422": { "description": "Tributo com format=code e código ausente", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "payable.code", "detail": "Código de Barras ou Linha Digitável precisa conter 44, 47 ou 48 caracteres numéricos" }, { "code": "validation_error", "param": "payable.code", "detail": "Código de Barras ou Linha Digitável não pode ficar em branco" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_generic_payment" } } }, "required": true, "description": "Parâmetros para criação de um Pagamento" } } }, "/v2/payments/{uid}": { "get": { "summary": "Visualizar um Pagamento", "tags": [ "Pagamentos" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de um Pagamento de qualquer tipo. O tipo é identificado automaticamente e a resposta é serializada adequadamente.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UUID do Pagamento", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Tributo GRU com format=data", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-86d9-778c-9595-337f37341488", "kind": "tax", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01a06d90-86b3-72cb-b7d0-b0dd8635a709", "payment_account_uid": "01a06d90-86b1-7d2a-8961-58f4430211cc", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Receita Federal", "document_number": "00.394.460/0058-87" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:23-05:00", "updated_at": "2026-09-04T12:56:23-05:00", "pix": { "qrcode": "00020126330014br.gov.bcb.pix01111335366962052040000530398654040", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } }, "tax": { "format": "data", "kind": "gru", "code": null, "data": { "tax_code": "0107", "reference_number": "08390156902901663100004188536463931158229163", "taxpayer_type": "cnpj", "taxpayer_number": "05.813.794/0001-26", "taxpayer_name": "Kobana Tecnologia Ltda.", "calculation_date": "2026-09-04", "expire_at": "2026-09-07", "fine_amount": 0.0, "interest_amount": 0.0, "gross_income_amount": 0.0, "total_amount": 100.0, "discount_amount": 0.0, "other_deduction_amount": 0.0, "other_addition_amount": 0.0 }, "beneficiary": { "name": "Receita Federal", "document_number": "00.394.460/0058-87" } } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_payment_tax" } } } } } }, "404": { "description": "Pagamento não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/payments/{uid}/cancel": { "put": { "summary": "Cancelar um Pagamento", "tags": [ "Pagamentos" ], "security": [ { "bearerAuth": [] } ], "description": "\n> **Processamento Assíncrono:** Este endpoint é processado assincronamente e cria um comando de cancelamento para o Pagamento.\nO cancelamento de um Pagamento é feito assincronamente, ou seja, ao receber a requisição, a nossa API guarda a solicitação e cria um Comando. Esse comando é processado em segundo plano e depois de confirmado, o Pagamento tem seu status alterado para Cancelado. Você recebe na resposta desta requisição o ID do comando criado e pode consultá-lo a qualquer momento.\n\n## Eventos de Webhook\n\nQuando a requisição é realizada, um evento `payment.{type}.cancel.requested` é disparado (onde {type} pode ser pix, bank_billet, etc).\nO nosso servidor então começa as tentativas de envio do cancelamento para a instituição financeira.\nSomente depois de confirmado na instituição financeira, aí então o pagamento é marcado como cancelado em nosso banco de dados.\nNeste momento o evento `payment.{type}.cancel.confirmed` é disparado.\n\n> ⚠️ **Atenção ao status Cancelado:** O status de Cancelado é terminal. O pagamento não poderá mais ser processado após o cancelamento.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "description": "UUID do Pagamento", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Pagamento cancelado sem interação com provedor", "content": { "application/json": { "example": { "status": 200, "data": { "id": 190, "uid": "01a06d90-8789-74c4-91f9-961fda54d4d7", "status": "pending", "operation": "cancel", "resource_type": "Payment", "resource_uid": "01a06d90-8774-7b31-9a1b-e3bba2484735", "financial_provider_slug": "btg", "params": null, "payload": null, "created_at": "2026-09-04T12:56:23-05:00", "updated_at": "2026-09-04T12:56:23-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "payment": { "uid": "01a06d90-8774-7b31-9a1b-e3bba2484735", "kind": "pix", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "confirmed", "financial_account_uid": "01a06d90-874b-750d-a511-37db11f543d3", "payment_account_uid": "01a06d90-8749-7545-a2ac-5cd4902bf17f", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:23-05:00", "updated_at": "2026-09-04T12:56:23-05:00", "pix": { "qrcode": "00020126330014br.gov.bcb.pix01111335366962052040000530398654040", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } }, "message": "Pagamento cancelado com sucesso sem interação com provedor." }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_payment_command" }, "message": { "type": "string", "description": "Mensagem de sucesso" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "422": { "description": "Pagamento já foi confirmado ou rejeitado", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Cancelamento de Pagamento.", "detail": "Pagamento já foi confirmado ou rejeitado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/payments/{uid}/approve": { "put": { "summary": "Liberar (aprovar) um Pagamento", "tags": [ "Pagamentos" ], "security": [ { "bearerAuth": [] } ], "description": "\n> **Processamento Assíncrono:** cria um comando de liberação (approve) para um Pagamento registrado que está aguardando aprovação.\n\nA liberação é feita assincronamente: ao receber a requisição, criamos um Comando que é processado em segundo plano. Você recebe o ID do comando criado na resposta e pode consultá-lo a qualquer momento.\n\n> ⚠️ **Suporte por banco:** nem todos os provedores expõem liberação individual de pagamento via API. Quando o provedor não suporta a operação, a resposta é `422`.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UUID do Pagamento", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Comando de liberação criado com sucesso", "content": { "application/json": { "example": { "status": 200, "data": { "id": 191, "uid": "01a06d90-89ac-74cd-b68a-fffdbffa05b3", "status": "pending", "operation": "approve", "resource_type": "Payment", "resource_uid": "01a06d90-8995-7588-bcb3-7db8649592f5", "financial_provider_slug": "example_bank", "params": null, "payload": null, "created_at": "2026-09-04T12:56:24-05:00", "updated_at": "2026-09-04T12:56:24-05:00", "message": null, "error_message": null, "warning_message": null, "confirmation_via": null, "payment": { "uid": "01a06d90-8995-7588-bcb3-7db8649592f5", "kind": "bank_billet", "amount": 100.0, "scheduled_to": null, "status": "awaiting_approval", "registration_status": "confirmed", "financial_account_uid": "01a06d90-8964-7e3b-af66-bc4733145ae7", "payment_account_uid": "01a06d90-8961-73ea-8ac0-131baf55f7fa", "batch_uid": null, "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "financial_provider_external_id": null, "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" }, "custom_data": null, "tags": [], "tag_list": null, "formats": { "default": { "html": null, "png": null, "pdf": null } }, "created_at": "2026-09-04T12:56:24-05:00", "updated_at": "2026-09-04T12:56:24-05:00", "bank_billet": { "code": "07690156905098651400935913018176128027430011", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_payment_command" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "422": { "description": "Pagamento não está em estado que permita liberação ou provedor não suporta", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "unprocessable_content", "title": "Não foi possível gerar Comando de Liberação de Pagamento.", "detail": "Pagamento não está aguardando liberação" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/data/bank_billet_queries": { "post": { "summary": "Criar uma Consulta de Boleto", "tags": [ "Consulta de Boletos" ], "security": [ { "bearerAuth": [] } ], "description": "Cria uma nova consulta de boleto bancário através da linha digitável ou código de barras. A consulta é processada automaticamente e retorna informações detalhadas do boleto.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Consulta de Boleto criada", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d8f-cd4d-7599-b4b9-43733bd79bdc", "line": "75691.43279 01022.938508 07722.200016 1 99470000000200", "barcode": "75691994700000002001432701022938500772220001", "expire_at": "2024-12-31", "pay_due_date": "2025-01-10", "amount": 2.0, "minimum_amount": 2.0, "maximum_amount": 2.0, "original_amount": 2.0, "valid_for_payment": true, "payment_status_reason": null, "allow_change_value": false, "allow_partial_payment": false, "issue_bank": { "code": 1, "ispb": "00000000", "name": "BANCO DO BRASIL" }, "beneficiary": { "uid": "01a06d8f-cd54-7b89-9daf-b60e8d102602", "name": "KOBANA INSTITUICAO DE PAGAMENTO LTDA", "kind": "juridical", "document_type": "CNPJ", "document_number": "05.813.794/0001-26" }, "guarantor": null, "guarantor_drawer": null, "payer": { "uid": "01a06d8f-cd54-7699-b2ee-40df07f6294a", "name": "KIVANIO PEREIRA BARBOSA", "kind": "natural", "document_type": "CPF", "document_number": "000.233.771-19" }, "fine": { "value": 0.0 }, "interest": { "value": 0.0 }, "discount": { "value": 0.0 }, "status": "success", "tags": [ "tag1", "tag2" ], "custom_data": { "key1": "value1", "key2": "value2" }, "created_via_api": true, "external_id": "DH2YG348T7953T", "error_message": null, "processed_at": "2026-09-04T12:55:35-05:00", "created_at": "2026-09-04T12:55:35-05:00", "updated_at": "2026-09-04T12:55:35-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `201`." }, "data": { "type": "object", "$ref": "#/components/schemas/v2_bank_billet_query" } } } } } }, "422": { "description": "Consulta de Boleto inválida", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "line", "detail": "Linha Digitável não pode ficar em branco" }, { "code": "validation_error", "param": "barcode", "detail": "Código de Barras não pode ficar em branco" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_bank_billet_query" } } }, "required": true, "description": "Informações a serem salvas na consulta de boleto" } }, "get": { "summary": "Listar Consultas de Boletos", "tags": [ "Consulta de Boletos" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todas as consultas de boletos realizadas pela conta autenticada. Permite filtrar por status, tags, datas de criação e outros parâmetros.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } } ], "responses": { "200": { "description": "Sucesso na listagem de consultas de boletos", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d8f-ce22-7542-a61c-dc8abbb727ae", "line": "75691.43279 01022.938508 07722.200016 1 99470000000200", "barcode": "75691994700000002001432701022938500772220001", "expire_at": null, "pay_due_date": null, "amount": null, "minimum_amount": null, "maximum_amount": null, "original_amount": null, "valid_for_payment": null, "payment_status_reason": null, "allow_change_value": null, "allow_partial_payment": null, "issue_bank": null, "beneficiary": null, "guarantor": null, "guarantor_drawer": null, "payer": null, "fine": null, "interest": null, "discount": null, "status": "error", "tags": [], "custom_data": null, "created_via_api": false, "external_id": null, "error_message": "boleto not valid for payment", "processed_at": "2026-09-04T12:55:36-05:00", "created_at": "2026-09-04T12:55:36-05:00", "updated_at": "2026-09-04T12:55:36-05:00" }, { "uid": "01a06d8f-ce1f-7468-9fff-e88c6feae8e4", "line": "75691.43279 01022.938508 07722.200016 1 99470000000200", "barcode": "75691994700000002001432701022938500772220001", "expire_at": null, "pay_due_date": null, "amount": null, "minimum_amount": null, "maximum_amount": null, "original_amount": null, "valid_for_payment": null, "payment_status_reason": null, "allow_change_value": null, "allow_partial_payment": null, "issue_bank": null, "beneficiary": null, "guarantor": null, "guarantor_drawer": null, "payer": null, "fine": null, "interest": null, "discount": null, "status": "pending", "tags": [ "tag1", "tag2" ], "custom_data": { "id": 23991238, "codigo": "codigo-xpto", "payment": true }, "created_via_api": false, "external_id": "JNWDFR4Y7WFHB", "error_message": null, "processed_at": null, "created_at": "2026-09-04T12:55:36-05:00", "updated_at": "2026-09-04T12:55:36-05:00" }, { "uid": "01a06d8f-ce18-748f-bbb6-4845638972b8", "line": "75691.43279 01022.938508 07722.200016 1 99470000000200", "barcode": "75691994700000002001432701022938500772220001", "expire_at": "2023-12-31", "pay_due_date": "2024-01-10", "amount": 20.0, "minimum_amount": 15.0, "maximum_amount": 25.0, "original_amount": 20.0, "valid_for_payment": true, "payment_status_reason": null, "allow_change_value": false, "allow_partial_payment": false, "issue_bank": { "code": 1, "ispb": "00000000", "name": "BANCO DO BRASIL" }, "beneficiary": { "uid": "01a06d8f-ce17-7d52-9248-becc13bf8323", "name": "Beneficiário", "kind": "juridical", "document_type": "CNPJ", "document_number": "W8.F2I.5NE/OLA4-84" }, "guarantor": { "uid": "01a06d8f-ce17-76cf-873d-7d2474e5241d", "name": "Beneficiário Final", "kind": "juridical", "document_type": "CNPJ", "document_number": "NM.CL6.50S/F2XJ-69" }, "guarantor_drawer": { "uid": "01a06d8f-ce18-70e0-887c-c93b94258a4c", "name": "Sacador Avalista", "kind": "juridical", "document_type": "CNPJ", "document_number": "LD.0UI.ORD/AODC-98" }, "payer": { "uid": "01a06d8f-ce18-70f3-b8c7-e4c57c1c286e", "name": "Pagador", "kind": "juridical", "document_type": "CNPJ", "document_number": "OZ.VOI.KAL/LKGC-25" }, "fine": { "percentage": 2.0 }, "interest": { "daily_rate": 0.033 }, "discount": { "percentage": 5.0 }, "status": "success", "tags": [], "custom_data": null, "created_via_api": false, "external_id": null, "error_message": null, "processed_at": "2026-09-04T12:55:36-05:00", "created_at": "2026-09-04T12:55:36-05:00", "updated_at": "2026-09-04T12:55:36-05:00" } ], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_bank_billet_query" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/data/pix_qrcode_queries": { "post": { "summary": "Criar uma Consulta de Pix QR Code", "tags": [ "Consulta de Pix QR Code" ], "security": [ { "bearerAuth": [] } ], "description": "Cria uma nova consulta de Pix QR Code através do qrcode. A consulta é processada automaticamente e retorna informações detalhadas do QR Code Pix.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Consulta de Pix QR Code criada", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d8f-db16-7bec-a585-2c700acf619c", "qrcode": "00020126330014br.gov.bcb.pix0111123456789005204000053039865802BR5913EXAMPLE NAME6008BRASILIA62190515ABCDEF123456789630461D0", "pix_key": "test@example.com", "expires_at": null, "finality": null, "amount": 100.0, "amount_change": 0.0, "interest": 0.0, "fine": 0.0, "discount": 0.0, "total_amount": 100.0, "beneficiary": null, "debtor": null, "description": null, "can_be_paid": null, "can_be_paid_with_different_value": null, "cannot_be_paid_reason": null, "external_id": "Pix_DH2YG348T7953T", "custom_data": { "key1": "value1", "key2": "value2" }, "tags": [ "tag1", "tag2" ] } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `201`." }, "data": { "type": "object", "$ref": "#/components/schemas/v2_pix_qrcode_query" } } } } } }, "422": { "description": "Consulta de Pix QR Code inválida", "content": { "application/json": { "example": { "status": 422, "errors": [ "QR Code inválido" ] }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "errors": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "title": { "type": "string" }, "code": { "type": "string" } } } ] } } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_pix_qrcode_query" } } }, "required": true, "description": "Informações a serem salvas na consulta de Pix QR Code" } }, "get": { "summary": "Listar Consultas de Pix QR Code", "tags": [ "Consulta de Pix QR Code" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todas as consultas de Pix QR Code realizadas pela conta autenticada. Permite filtrar por tags, external_id e outros parâmetros.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da Página", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 } }, { "name": "external_id", "in": "query", "description": "Filtrar por ID externo", "required": false, "schema": { "type": "string" } }, { "name": "tags", "in": "query", "description": "Filtrar por tags", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true } ], "responses": { "200": { "description": "Sucesso na listagem de consultas de Pix QR Code", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d8f-dc6f-72aa-952a-98c2cfad53a5", "qrcode": "00020126330014br.gov.bcb.pix0111123456789005204000053039865802BR5913EXAMPLE NAME6008BRASILIA62190515ABCDEF123456789630461D0", "pix_key": "user@example.com", "expires_at": null, "finality": null, "amount": 100.0, "amount_change": 0.0, "interest": 0.0, "fine": 0.0, "discount": 0.0, "total_amount": 100.0, "beneficiary": null, "debtor": null, "description": null, "can_be_paid": null, "can_be_paid_with_different_value": null, "cannot_be_paid_reason": null, "external_id": "Pix_ABC123", "custom_data": {}, "tags": [] }, { "uid": "01a06d8f-dc65-75d2-bee9-e7ae747b26ea", "qrcode": "00020126330014br.gov.bcb.pix0111123456789005204000053039865802BR5913EXAMPLE NAME6008BRASILIA62190515ABCDEF123456789630461D0", "pix_key": "user@example.com", "expires_at": null, "finality": null, "amount": 100.0, "amount_change": 0.0, "interest": 0.0, "fine": 0.0, "discount": 0.0, "total_amount": 100.0, "beneficiary": null, "debtor": null, "description": null, "can_be_paid": null, "can_be_paid_with_different_value": null, "cannot_be_paid_reason": null, "external_id": "Pix_ABC123", "custom_data": {}, "tags": [] } ], "pagination": { "prev_url": null, "next_url": null, "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_pix_qrcode_query" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/edi/edi_boxes": { "get": { "summary": "Listar Caixas Postais", "tags": [ "Caixas Postais" ], "security": [ { "bearerAuth": [] } ], "description": "Lista Caixas Postais.", "parameters": [ { "name": "resource_type", "in": "query", "description": "Filtro por Tipo de Recurso. Carteira de Cobrança (`charge.bank_billet_account`) ou Conta Financeira (`financial.account`).", "required": false, "schema": { "type": "string" } }, { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página. Máximo de 50.", "example": 20, "required": false, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "Número da página.", "example": 1, "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Caixas Postais encontradas.", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d8f-e23d-70e5-8fa6-a27e6d7cdd98", "name": "EDI Name 62", "resource": { "type": "financial.account", "uid": "01a06d8f-e21a-71cb-b5e5-b9befec08bb0" }, "account_owner": { "uid": "01a06d8f-e23b-7672-b99e-a19774778ced", "name": "Margret Santos Filgueiras", "kind": "natural", "document_type": "CPF", "document_number": "448.557.085-18", "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "danika_douglas@mosciski-koelpin.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "external_code": "000001", "tags": [ "doloremque", "a", "id" ], "tag_list": "doloremque,a,id", "custom_data": { "numero_erp": 63126 } }, "letter_owner": null, "bank_manager": { "uid": "01a06d8f-e23c-7c1f-9354-396c364fa83d", "name": "Margret Santos Filgueiras", "kind": "natural", "document_type": "CPF", "document_number": "603.454.014-33", "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "deedee_flatley@rosenbaum.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "external_code": "000001", "tags": [ "eius", "ut", "voluptas" ], "tag_list": "eius,ut,voluptas", "custom_data": { "numero_erp": 63126 } }, "kind": "cnab400", "operation": "payment", "created_at": "2026-09-04T12:55:41-05:00", "updated_at": "2026-09-04T12:55:41-05:00", "validated_at": null, "enabled_at": null, "letter_status": "creating", "letter_creation_errors": null, "status": null, "letter_pdf": null }, { "uid": "01a06d8f-e1fa-7c02-a291-ea769bb8d64f", "name": "EDI Name 92", "resource": { "type": "charge.bank_billet_account", "uid": "01a06d8f-e1eb-78bf-ace9-616ba2dfe9db" }, "account_owner": { "uid": "01a06d8f-e1f8-7bf1-9959-b76e49cb9467", "name": "Margret Santos Filgueiras", "kind": "natural", "document_type": "CPF", "document_number": "678.779.223-96", "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "manda_spinka@davis.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "external_code": "000001", "tags": [ "sit", "quos", "animi" ], "tag_list": "sit,quos,animi", "custom_data": { "numero_erp": 63126 } }, "letter_owner": null, "bank_manager": { "uid": "01a06d8f-e1fa-70dc-bbfc-5815fc98ce03", "name": "Margret Santos Filgueiras", "kind": "natural", "document_type": "CPF", "document_number": "657.035.026-91", "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "kip.johnston@king.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "external_code": "000001", "tags": [ "et", "minima", "qui" ], "tag_list": "et,minima,qui", "custom_data": { "numero_erp": 63126 } }, "kind": "cnab400", "operation": "charge", "created_at": "2026-09-04T12:55:41-05:00", "updated_at": "2026-09-04T12:55:41-05:00", "validated_at": null, "enabled_at": null, "letter_status": "creating", "letter_creation_errors": null, "status": null, "letter_pdf": null } ], "pagination": { "prev_url": null, "next_url": "/v2/edi/edi_boxes?per_page=2&page=2", "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_edi_box" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } }, "401": { "description": "Usuário não autorizado", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o `scope` obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "post": { "summary": "Criar Caixa Postal", "tags": [ "Caixas Postais" ], "security": [ { "bearerAuth": [] } ], "description": "Cria uma nova Caixa Postal.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Caixa Postal criada", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d8f-e2e5-72d2-89ce-df8914e7dccf", "name": null, "resource": { "type": "charge.bank_billet_account", "uid": "01a06d8f-e2cc-7dda-99ff-2a258010f06d" }, "account_owner": { "uid": "01a06d8f-e2e4-7010-8e8b-128ce03f706a", "name": "Margret Santos Contas", "kind": "juridical", "document_type": "CNPJ", "document_number": "16.974.923/0001-84", "emails": [ { "label": "Pessoal", "address": "nome@example.com" } ], "phones": [ { "kind": null, "country_code": "55", "local_code": "21", "number": "30030386" } ] }, "letter_owner": { "uid": "01a06d8f-e2e5-74f0-b5cb-96daf4c686d4", "name": "Margret Santos Cartas", "emails": [ { "label": "Pessoal", "address": "nome@example.com" } ], "phones": [ { "kind": null, "country_code": "55", "local_code": "21", "number": "30030386" } ] }, "bank_manager": { "uid": "01a06d8f-e2e5-7542-8c1c-b88590360b28", "name": "Margret Santos Bancos", "emails": [ { "label": "Pessoal", "address": "nome@example.com" } ], "phones": [ { "kind": null, "country_code": "55", "local_code": "21", "number": "30030386" } ] }, "kind": "cnab400", "operation": "charge", "created_at": "2026-09-04T12:55:41-05:00", "updated_at": "2026-09-04T12:55:41-05:00", "validated_at": null, "enabled_at": null, "letter_status": "creating", "letter_creation_errors": null, "status": null, "letter_pdf": null } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `201`." }, "data": { "$ref": "#/components/schemas/v2_edi_box" } } } } } }, "401": { "description": "Usuário não autorizado", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o `scope` obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "422": { "description": "Falha na validação", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "account_owner", "detail": "Proprietário da conta não pode ficar em branco" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_edi_box" } } }, "required": true, "description": "Informações da Caixa Postal a ser criada." } } }, "/v2/edi/edi_boxes/{uid}": { "get": { "summary": "Visualizar Caixa Postal", "tags": [ "Caixas Postais" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações de uma Caixa Postal específica.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UID da Caixa Postal", "required": true, "example": "012ab34c-d567-8901-234e-5fghi6j789k0", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Caixa Postal encontrada", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d8f-e3f3-7256-9ea0-100e66a4d63c", "name": "EDI Name 21", "resource": { "type": "charge.bank_billet_account", "uid": "01a06d8f-e3e2-7368-bba5-667b08db396c" }, "account_owner": { "uid": "01a06d8f-e3f1-755a-a52f-26e14523eebb", "name": "Margret Santos Filgueiras", "kind": "natural", "document_type": "CPF", "document_number": "627.769.736-67", "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "irena@yost.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "external_code": "000001", "tags": [ "minus", "sapiente", "aut" ], "tag_list": "minus,sapiente,aut", "custom_data": { "numero_erp": 63126 } }, "letter_owner": null, "bank_manager": { "uid": "01a06d8f-e3f2-7c8d-a65d-e5d188fffd8d", "name": "Margret Santos Filgueiras", "kind": "natural", "document_type": "CPF", "document_number": "147.974.300-36", "addresses": [ { "street": "Av. Burkhard Hehn Simões", "number": "120", "complement": "709", "neighborhood": "São Francisco", "state": "RJ", "city_name": "Rio de Janeiro", "zip_code": "24360440" } ], "emails": [ { "label": null, "address": "joanna@macgyver-white.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "external_code": "000001", "tags": [ "tenetur", "eum", "nobis" ], "tag_list": "tenetur,eum,nobis", "custom_data": { "numero_erp": 63126 } }, "kind": "cnab400", "operation": "charge", "created_at": "2026-09-04T12:55:41-05:00", "updated_at": "2026-09-04T12:55:41-05:00", "validated_at": null, "enabled_at": null, "letter_status": "creating", "letter_creation_errors": null, "status": null, "letter_pdf": null } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_edi_box" } } } } } }, "403": { "description": "Falha de permissão. Você não tem o `scope` obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Caixa Postal não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] } } } } } }, "put": { "summary": "Atualizar Caixa Postal", "tags": [ "Caixas Postais" ], "security": [ { "bearerAuth": [] } ], "description": "Atualiza uma Caixa Postal específica.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UID da Caixa Postal", "required": true, "example": "012ab34c-d567-8901-234e-5fghi6j789k0", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Caixa Postal atualizada", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d8f-e4a5-7dad-8d82-672478ba7d10", "name": "EDI Name 64", "resource": { "type": "charge.bank_billet_account", "uid": "01a06d8f-e495-7a30-a8c9-617641e4e92c" }, "account_owner": { "uid": "01a06d8f-e4ba-7545-bed3-27120a7e9c2e", "name": "Nome do Dono", "kind": "juridical", "document_type": "CNPJ", "document_number": "16.974.923/0001-84", "emails": [ { "label": "Pessoal", "address": "nome@example.com" } ], "phones": [ { "kind": null, "country_code": "55", "local_code": "21", "number": "30030386" } ] }, "letter_owner": { "uid": "01a06d8f-e4ba-79e3-9a80-e18de5818488", "name": "Nome do Responsável pela Carta", "emails": [ { "label": "Pessoal", "address": "nome@example.com" } ], "phones": [ { "kind": null, "country_code": "55", "local_code": "21", "number": "30030386" } ] }, "bank_manager": { "uid": "01a06d8f-e4ba-74f1-bdf7-4bdbe78ab8c9", "name": "Nome do Gerente", "emails": [ { "label": "Pessoal", "address": "nome@example.com" } ], "phones": [ { "kind": null, "country_code": "55", "local_code": "21", "number": "30030386" } ] }, "kind": "cnab400", "operation": "charge", "created_at": "2026-09-04T12:55:41-05:00", "updated_at": "2026-09-04T12:55:41-05:00", "validated_at": null, "enabled_at": null, "letter_status": "creating", "letter_creation_errors": null, "status": null, "letter_pdf": null } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_edi_box" } } } } } }, "401": { "description": "Usuário não autorizado", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o `scope` obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Caixa Postal não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] } } } }, "422": { "description": "operation/resource não podem ser alterados sem editable: true", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "operation", "detail": "só pode ser alterado por um EDI habilitado para edição." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_edi_box" } } }, "required": true, "description": "Informações da Caixa Postal a ser atualizada." } } }, "/v2/security/access_tokens": { "post": { "summary": "Criar um Token de Acesso", "tags": [ "Tokens de Acesso" ], "security": [ { "bearerAuth": [] } ], "description": "Cria um novo token de acesso (access token) para autenticação na API. O token criado pode ter escopos limitados e data de expiração.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "Token criado", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-8aa8-72e1-a295-6353fbda37eb", "external_id": "ext_integration_test", "description": "My API Token", "scopes": [ "all", "read" ], "source": "api", "purpose": null, "expires_in": 15678215, "expires_at": "2027-03-04T23:59:59-05:00", "version": 2, "tags": [ "production", "api" ], "custom_data": { "client_id": "client_123", "environment": "production" }, "warning_flags": [], "reminder_emails": [ { "label": "Pessoal", "address": "reminder@example.com" } ], "created_at": "2026-09-04T12:56:24-05:00", "created_by": null, "updated_at": "2026-09-04T12:56:24-05:00", "updated_by": null, "enabled_at": "2026-09-04T12:56:24-05:00", "enabled_by": null, "disabled_at": null, "disabled_by": null, "revoked_at": null, "revoked_by": null, "last_used_at": null, "token": "eyJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJLMjNybEIwN2tiTjI1bWciLCJpYXQiOjE3ODg1NDQ1ODQsImF1ZCI6ImFwcC9kZXYiLCJqdGkiOiIwMWEwNmQ5MC04YWE4LTcyZTEtYTI5NS02MzUzZmJkYTM3ZWIiLCJzdWIiOiIwMWEwNmQ5MC04YTk0LTdmYjQtYjI1YS05NmEwNTJkYTVkOGEiLCJzcmMiOiJhcGkiLCJleHAiOjE4MDQyMjI3OTl9.EvtqLtEEPdpS7wkmosOc11COlwOyaOUDqtfAB2rCRTKrvZ9ROZ0y0pOaybTTWBIAoefvxxNdg1XnKXN2AtyHJw" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `201`." }, "data": { "$ref": "#/components/schemas/v2_access_token_with_token" } } } } } }, "422": { "description": "Dados do token inválidos", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "scopes", "detail": "Escopos não pode ficar em branco" }, { "code": "validation_error", "param": "description", "detail": "Descrição é muito longo (máximo: 100 caracteres)" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o Scope obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"all security.access_tokens\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_access_token_create" } } }, "required": true, "description": "Informações do token de acesso a ser criado." } } }, "/v2/security/access_tokens/{uid}": { "put": { "summary": "Atualizar Token de Acesso", "tags": [ "Tokens de Acesso" ], "security": [ { "bearerAuth": [] } ], "description": "Atualiza as informações de um token de acesso existente, incluindo descrição, escopos, tags e data de expiração. **Nota:** A data de expiração só pode ser definida se ainda não estava definida. Uma vez definida, não pode mais ser alterada.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "required": true, "description": "UID do Token de Acesso", "example": "acc_1234567890", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Token atualizado", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-8b25-76b7-b979-d186599f90b6", "external_id": "ext_updated", "description": "Updated Description", "scopes": [ "all", "read" ], "source": "user", "purpose": null, "expires_in": 7200, "expires_at": "2026-09-04T14:56:24-05:00", "version": 2, "tags": [ "updated", "production" ], "custom_data": { "updated": true, "version": "2.0" }, "warning_flags": [], "reminder_emails": [ { "label": "Tech Team", "address": "tech@example.com" } ], "created_at": "2026-09-04T12:56:24-05:00", "created_by": null, "updated_at": "2026-09-04T12:56:24-05:00", "updated_by": null, "enabled_at": "2026-09-04T12:56:24-05:00", "enabled_by": null, "disabled_at": null, "disabled_by": null, "revoked_at": null, "revoked_by": null, "last_used_at": null } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_access_token" } } } } } }, "404": { "description": "Token não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Token não pode ser atualizado", "content": { "application/json": { "example": { "status": 403, "errors": [ { "code": "forbidden", "title": "Esse token não pode ser atualizado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_access_token_update" } } }, "required": true, "description": "Informações do token de acesso a serem alteradas." } }, "delete": { "summary": "Excluir Token de Acesso", "tags": [ "Tokens de Acesso" ], "security": [ { "bearerAuth": [] } ], "description": "Remove permanentemente um token de acesso do sistema. Apenas tokens revogados ou expirados podem ser excluídos.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "required": true, "description": "UID do Token de Acesso", "example": "acc_1234567890", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Token excluído" }, "404": { "description": "Token não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Token não pode ser excluído", "content": { "application/json": { "example": { "status": 403, "errors": [ { "code": "forbidden", "title": "Esse token não pode ser removido." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/security/access_tokens/{uid}/enable": { "put": { "summary": "Habilitar Token de Acesso", "tags": [ "Tokens de Acesso" ], "security": [ { "bearerAuth": [] } ], "description": "Habilita um token de acesso desabilitado, permitindo seu uso para autenticação.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "required": true, "description": "UID do Token de Acesso", "example": "acc_1234567890", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Token habilitado", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-8c33-78bb-96f3-d3fea12ecb10", "external_id": null, "description": null, "scopes": [ "all", "read" ], "source": "user", "purpose": null, "expires_in": 7200, "expires_at": "2026-09-04T14:56:24-05:00", "version": 2, "tags": [], "custom_data": null, "warning_flags": [], "reminder_emails": [ { "label": "Tech Team", "address": "tech@example.com" } ], "created_at": "2026-09-04T12:56:24-05:00", "created_by": null, "updated_at": "2026-09-04T12:56:24-05:00", "updated_by": null, "enabled_at": "2026-09-04T12:56:24-05:00", "enabled_by": null, "disabled_at": null, "disabled_by": null, "revoked_at": null, "revoked_by": null, "last_used_at": null } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_access_token" } } } } } }, "403": { "description": "Token não pode ser habilitado", "content": { "application/json": { "example": { "status": 403, "errors": [ { "code": "forbidden", "title": "Esse token não pode ser habilitado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/security/access_tokens/{uid}/disable": { "put": { "summary": "Desabilitar Token de Acesso", "tags": [ "Tokens de Acesso" ], "security": [ { "bearerAuth": [] } ], "description": "Desabilita um token de acesso habilitado, impedindo temporariamente seu uso para autenticação.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "required": true, "description": "UID do Token de Acesso", "example": "acc_1234567890", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Token desabilitado", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-8c9a-77c2-aa16-09a3207e5c3a", "external_id": null, "description": null, "scopes": [ "all", "read" ], "source": "user", "purpose": null, "expires_in": 7200, "expires_at": "2026-09-04T14:56:24-05:00", "version": 2, "tags": [], "custom_data": null, "warning_flags": [], "reminder_emails": [ { "label": "Tech Team", "address": "tech@example.com" } ], "created_at": "2026-09-04T12:56:24-05:00", "created_by": null, "updated_at": "2026-09-04T12:56:24-05:00", "updated_by": null, "enabled_at": null, "enabled_by": null, "disabled_at": "2026-09-04T12:56:24-05:00", "disabled_by": null, "revoked_at": null, "revoked_by": null, "last_used_at": null } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_access_token" } } } } } }, "403": { "description": "Token não pode ser desabilitado", "content": { "application/json": { "example": { "status": 403, "errors": [ { "code": "forbidden", "title": "Esse token não pode ser desabilitado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/security/access_tokens/{uid}/renew": { "put": { "summary": "Renovar Token de Acesso", "tags": [ "Tokens de Acesso" ], "security": [ { "bearerAuth": [] } ], "description": "Cria um novo token de acesso com as mesmas configurações do token atual e revoga o token antigo. O novo token é retornado na resposta.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "required": true, "description": "UID do Token de Acesso", "example": "acc_1234567890", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Token renovado", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-8d24-7f93-afcc-8d26cf5113ea", "external_id": null, "description": "Old Token", "scopes": [ "all", "read" ], "source": "api", "purpose": null, "expires_in": 7200, "expires_at": "2026-09-04T14:56:24-05:00", "version": 2, "tags": [], "custom_data": {}, "warning_flags": [], "reminder_emails": [ { "label": "Tech Team", "address": "tech@example.com" } ], "created_at": "2026-09-04T12:56:24-05:00", "created_by": null, "updated_at": "2026-09-04T12:56:24-05:00", "updated_by": null, "enabled_at": "2026-09-04T12:56:24-05:00", "enabled_by": null, "disabled_at": null, "disabled_by": null, "revoked_at": null, "revoked_by": null, "last_used_at": null, "token": "eyJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJLMjNybEIwN2tiTjI1bWciLCJpYXQiOjE3ODg1NDQ1ODQsImF1ZCI6ImFwcC9kZXYiLCJqdGkiOiIwMWEwNmQ5MC04ZDI0LTdmOTMtYWZjYy04ZDI2Y2Y1MTEzZWEiLCJzdWIiOiIwMWEwNmQ5MC04ZDA3LTczZGQtYTBhNi05MmM2MTJmNzA3MjciLCJzcmMiOiJhcGkiLCJleHAiOjE3ODg1NTE3ODR9.4KMiJbyLpdAsBipzqsorHymT0HZ11rn7p8upLxeLc0oUIQ-bcWLrjJbc87dJRNCr5BPjBIefuBs_5waWfMjjrA" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_access_token_with_token" } } } } } }, "403": { "description": "Token não pode ser renovado", "content": { "application/json": { "example": { "status": 403, "errors": [ { "code": "forbidden", "title": "Esse token não pode ser renovado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/security/access_tokens/{uid}/revoke": { "put": { "summary": "Revogar Token de Acesso", "tags": [ "Tokens de Acesso" ], "security": [ { "bearerAuth": [] } ], "description": "Revoga permanentemente um token de acesso. Tokens v2 devem estar desabilitados antes de serem revogados. Tokens v1 podem ser revogados diretamente.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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" } }, { "name": "uid", "in": "path", "required": true, "description": "UID do Token de Acesso", "example": "acc_1234567890", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Token revogado", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-8d75-765e-ae5a-54d1be4784ee", "external_id": null, "description": null, "scopes": [ "all", "read" ], "source": "user", "purpose": null, "expires_in": 7200, "expires_at": "2026-09-04T14:56:25-05:00", "version": 2, "tags": [], "custom_data": null, "warning_flags": [], "reminder_emails": [ { "label": "Tech Team", "address": "tech@example.com" } ], "created_at": "2026-09-04T12:56:25-05:00", "created_by": null, "updated_at": "2026-09-04T12:56:25-05:00", "updated_by": null, "enabled_at": null, "enabled_by": null, "disabled_at": "2026-09-04T12:56:25-05:00", "disabled_by": null, "revoked_at": "2026-09-04T12:56:25-05:00", "revoked_by": null, "last_used_at": null } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_access_token" } } } } } }, "403": { "description": "Token não pode ser revogado", "content": { "application/json": { "example": { "status": 403, "errors": [ { "code": "forbidden", "title": "Esse token não pode ser revogado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/mailbox/entries/{entry_id}/email": { "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "entry_id", "in": "path", "required": true, "description": "UID da Caixa Postal", "schema": { "type": "string" } } ], "get": { "summary": "Exibir Canal de E-mail", "tags": [ "Canal Email" ], "security": [ { "bearerAuth": [] } ], "description": "Retorna o canal de e-mail configurado na Caixa Postal.", "responses": { "200": { "description": "Canal de e-mail encontrado.", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-173a-7da8-ae0f-9f155005a95f", "mailbox_entry": { "uid": "01a06d90-172a-7c56-95b8-a236b5003e1d", "slug": "mailbox-1", "name": "Mailbox Entry mailbox-1", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "email", "api" ], "channels": { "email": { "inbox_emails": [ { "label": null, "address": "elijah.franecki@zulauf-mann.test" }, { "label": null, "address": "sender@example.com" } ], "outbox_emails": [ { "label": null, "address": "shawn.stehr@anderson.example" } ] } }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:54-05:00", "updated_at": "2026-09-04T12:55:54-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:54-05:00", "updated_at": "2026-09-04T12:55:54-05:00", "inbox_emails": [ { "address": "elijah.franecki@zulauf-mann.test", "label": null }, { "address": "sender@example.com", "label": null } ], "outbox_emails": [ { "address": "shawn.stehr@anderson.example", "label": null } ] } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_email_channel" } } } } } }, "401": { "description": "Não autorizado.", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Canal não encontrado.", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "post": { "summary": "Criar Canal de E-mail", "tags": [ "Canal Email" ], "security": [ { "bearerAuth": [] } ], "description": "Cria um canal de e-mail para a Caixa Postal.", "parameters": [], "responses": { "201": { "description": "Canal criado.", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-1806-7328-b0bd-b290644c3253", "mailbox_entry": { "uid": "01a06d90-17f5-71e2-8975-1c5053ad7ca5", "slug": "mailbox-4", "name": "Mailbox Entry mailbox-4", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "email", "api" ], "channels": { "email": { "inbox_emails": [ { "label": "Entrada", "address": "inbox@example.com" } ], "outbox_emails": [ { "label": "Saída", "address": "outbox@example.com" } ] } }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:54-05:00", "updated_at": "2026-09-04T12:55:54-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": true, "created_at": "2026-09-04T12:55:55-05:00", "updated_at": "2026-09-04T12:55:55-05:00", "inbox_emails": [ { "address": "inbox@example.com", "label": "Entrada" } ], "outbox_emails": [ { "address": "outbox@example.com", "label": "Saída" } ] } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_email_channel" } } } } } }, "401": { "description": "Não autorizado.", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Sem permissão.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "inbox_emails": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "inbox@example.com" }, "label": { "type": "string", "example": "Entrada" } } } }, "outbox_emails": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "outbox@example.com" }, "label": { "type": "string", "example": "Saída" } } } } } } } }, "required": true } }, "patch": { "summary": "Atualizar Canal de E-mail", "tags": [ "Canal Email" ], "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Canal atualizado.", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-1894-728b-9fd0-ab988298c9d6", "mailbox_entry": { "uid": "01a06d90-1890-7ccf-8929-4f51bb0a1893", "slug": "mailbox-7", "name": "Mailbox Entry mailbox-7", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "email", "api" ], "channels": { "email": { "inbox_emails": [ { "label": null, "address": "new@example.com" } ], "outbox_emails": [ { "label": null, "address": "edmond_lemke@ebert-bradtke.test" } ] } }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:55-05:00", "updated_at": "2026-09-04T12:55:55-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:55-05:00", "updated_at": "2026-09-04T12:55:55-05:00", "inbox_emails": [ { "address": "new@example.com", "label": null } ], "outbox_emails": [ { "address": "edmond_lemke@ebert-bradtke.test", "label": null } ] } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_email_channel" } } } } } }, "404": { "description": "Canal não encontrado.", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "inbox_emails": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string" }, "label": { "type": "string" } } } }, "outbox_emails": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string" }, "label": { "type": "string" } } } } } } } }, "required": true } }, "delete": { "summary": "Excluir Canal de E-mail", "tags": [ "Canal Email" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "Canal excluído." }, "422": { "description": "Canal ativo não pode ser excluído.", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "channel_is_active", "title": "Canal ativo não pode ser excluído. Desative-o primeiro." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/mailbox/entries/{entry_id}/email/activate": { "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "put": { "summary": "Ativar Canal de E-mail", "tags": [ "Canal Email" ], "security": [ { "bearerAuth": [] } ], "responses": { "202": { "description": "Ativação enfileirada.", "content": { "application/json": { "example": { "status": 202, "data": { "uid": "01a06d90-1985-7a53-9238-91e315e1efcf", "mailbox_entry": { "uid": "01a06d90-1981-7f7c-a189-50adff5653aa", "slug": "mailbox-11", "name": "Mailbox Entry mailbox-11", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "email", "api" ], "channels": { "email": { "inbox_emails": [ { "label": null, "address": "pinkie@mcclure-gutmann.test" }, { "label": null, "address": "sender@example.com" } ], "outbox_emails": [ { "label": null, "address": "ross@waelchi-kilback.example" } ] } }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:55-05:00", "updated_at": "2026-09-04T12:55:55-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:55-05:00", "updated_at": "2026-09-04T12:55:55-05:00", "inbox_emails": [ { "address": "pinkie@mcclure-gutmann.test", "label": null }, { "address": "sender@example.com", "label": null } ], "outbox_emails": [ { "address": "ross@waelchi-kilback.example", "label": null } ] } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_email_channel" } } } } } } } } }, "/v2/mailbox/entries/{entry_id}/email/deactivate": { "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "put": { "summary": "Desativar Canal de E-mail", "tags": [ "Canal Email" ], "security": [ { "bearerAuth": [] } ], "responses": { "202": { "description": "Desativação enfileirada.", "content": { "application/json": { "example": { "status": 202, "data": { "uid": "01a06d90-19c9-7069-bcf2-ff511946f74b", "mailbox_entry": { "uid": "01a06d90-19c5-7650-a1cf-52b3794cff30", "slug": "mailbox-12", "name": "Mailbox Entry mailbox-12", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "email", "api" ], "channels": { "email": { "inbox_emails": [ { "label": null, "address": "alecia_schmeler@deckow.test" }, { "label": null, "address": "sender@example.com" } ], "outbox_emails": [ { "label": null, "address": "tien_christiansen@kulas-quigley.example" } ] } }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:55-05:00", "updated_at": "2026-09-04T12:55:55-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:55-05:00", "updated_at": "2026-09-04T12:55:55-05:00", "inbox_emails": [ { "address": "alecia_schmeler@deckow.test", "label": null }, { "address": "sender@example.com", "label": null } ], "outbox_emails": [ { "address": "tien_christiansen@kulas-quigley.example", "label": null } ] } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_email_channel" } } } } } } } } }, "/v2/mailbox/entries/{entry_id}/s3": { "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "entry_id", "in": "path", "required": true, "description": "UID da Caixa Postal", "schema": { "type": "string" } } ], "get": { "summary": "Exibir Canal S3", "tags": [ "Canal S3" ], "security": [ { "bearerAuth": [] } ], "description": "Retorna o canal S3 configurado na Caixa Postal.", "responses": { "200": { "description": "Canal S3 encontrado.", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-1a0c-7f44-8126-496069481962", "mailbox_entry": { "uid": "01a06d90-1a06-7def-a63c-1d5400a27170", "slug": "mailbox-13", "name": "Mailbox Entry mailbox-13", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "s3", "api" ], "channels": { "s3": {} }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:55-05:00", "updated_at": "2026-09-04T12:55:55-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:55-05:00", "updated_at": "2026-09-04T12:55:55-05:00", "connection": { "identity_pool_id": "us-east-1:39875bd3-5d60-4cda-bfc4-5b8ab3b8ee95", "user_pool_id": "us-east-1_Jv1zeJ3h6", "client_id": "3d1b1b4go217l283dhm1nvlau4", "username": "mailbox-13", "region": "us-east-1", "bucket": "kobana-mailbox-development-main", "inbox_path": null, "outbox_path": null } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_s3_channel" } } } } } }, "401": { "description": "Não autorizado.", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Canal não encontrado.", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "post": { "summary": "Criar Canal S3", "tags": [ "Canal S3" ], "security": [ { "bearerAuth": [] } ], "description": "Cria um canal S3 para a Caixa Postal.", "responses": { "201": { "description": "Canal criado.", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-1aaf-7165-a7c9-9f7cd4e3c577", "mailbox_entry": { "uid": "01a06d90-1aa1-749c-b8ac-a364fb9f1764", "slug": "mailbox-16", "name": "Mailbox Entry mailbox-16", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "s3", "api" ], "channels": { "s3": {} }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:55-05:00", "updated_at": "2026-09-04T12:55:55-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": true, "created_at": "2026-09-04T12:55:55-05:00", "updated_at": "2026-09-04T12:55:55-05:00", "connection": { "identity_pool_id": "us-east-1:39875bd3-5d60-4cda-bfc4-5b8ab3b8ee95", "user_pool_id": "us-east-1_Jv1zeJ3h6", "client_id": "3d1b1b4go217l283dhm1nvlau4", "username": "mailbox-16", "region": "us-east-1", "bucket": "kobana-mailbox-development-main", "inbox_path": null, "outbox_path": null } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_s3_channel" } } } } } }, "401": { "description": "Não autorizado.", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Sem permissão.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "delete": { "summary": "Excluir Canal S3", "tags": [ "Canal S3" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "Canal excluído." }, "422": { "description": "Canal ativo não pode ser excluído.", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "channel_is_active", "title": "Canal ativo não pode ser excluído. Desative-o primeiro." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/mailbox/entries/{entry_id}/s3/activate": { "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "put": { "summary": "Ativar Canal S3", "tags": [ "Canal S3" ], "security": [ { "bearerAuth": [] } ], "responses": { "202": { "description": "Ativação enfileirada.", "content": { "application/json": { "example": { "status": 202, "data": { "uid": "01a06d90-1bac-701f-8051-10609ae0b874", "mailbox_entry": { "uid": "01a06d90-1baa-74e6-a8c1-b0c6559735e7", "slug": "mailbox-21", "name": "Mailbox Entry mailbox-21", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "s3", "api" ], "channels": { "s3": {} }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:55-05:00", "updated_at": "2026-09-04T12:55:55-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:55-05:00", "updated_at": "2026-09-04T12:55:55-05:00", "connection": { "identity_pool_id": "us-east-1:39875bd3-5d60-4cda-bfc4-5b8ab3b8ee95", "user_pool_id": "us-east-1_Jv1zeJ3h6", "client_id": "3d1b1b4go217l283dhm1nvlau4", "username": "mailbox-21", "region": "us-east-1", "bucket": "kobana-mailbox-development-main", "inbox_path": null, "outbox_path": null } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_s3_channel" } } } } } } } } }, "/v2/mailbox/entries/{entry_id}/s3/deactivate": { "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "put": { "summary": "Desativar Canal S3", "tags": [ "Canal S3" ], "security": [ { "bearerAuth": [] } ], "responses": { "202": { "description": "Desativação enfileirada.", "content": { "application/json": { "example": { "status": 202, "data": { "uid": "01a06d90-1bf0-7675-9b46-b0664de10122", "mailbox_entry": { "uid": "01a06d90-1bed-7a97-b2bb-4b48a4af812a", "slug": "mailbox-22", "name": "Mailbox Entry mailbox-22", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "s3", "api" ], "channels": { "s3": {} }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:56-05:00", "updated_at": "2026-09-04T12:55:56-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:56-05:00", "updated_at": "2026-09-04T12:55:56-05:00", "connection": { "identity_pool_id": "us-east-1:39875bd3-5d60-4cda-bfc4-5b8ab3b8ee95", "user_pool_id": "us-east-1_Jv1zeJ3h6", "client_id": "3d1b1b4go217l283dhm1nvlau4", "username": "mailbox-22", "region": "us-east-1", "bucket": "kobana-mailbox-development-main", "inbox_path": null, "outbox_path": null } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_s3_channel" } } } } } } } } }, "/v2/mailbox/entries/{entry_id}/s3/fetch": { "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "put": { "summary": "Buscar arquivos do Canal S3", "tags": [ "Canal S3" ], "security": [ { "bearerAuth": [] } ], "description": "Enfileira a busca de arquivos do bucket S3 configurado.", "responses": { "202": { "description": "Busca enfileirada.", "content": { "application/json": { "example": { "status": 202, "data": { "uid": "01a06d90-1c33-7328-93a5-3436174a82f2", "mailbox_entry": { "uid": "01a06d90-1c31-7d7a-82f7-cd8c2993abe7", "slug": "mailbox-23", "name": "Mailbox Entry mailbox-23", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "s3", "api" ], "channels": { "s3": {} }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:56-05:00", "updated_at": "2026-09-04T12:55:56-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:56-05:00", "updated_at": "2026-09-04T12:55:56-05:00", "connection": { "identity_pool_id": "us-east-1:39875bd3-5d60-4cda-bfc4-5b8ab3b8ee95", "user_pool_id": "us-east-1_Jv1zeJ3h6", "client_id": "3d1b1b4go217l283dhm1nvlau4", "username": "mailbox-23", "region": "us-east-1", "bucket": "kobana-mailbox-development-main", "inbox_path": null, "outbox_path": null } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_s3_channel" } } } } } } } } }, "/v2/mailbox/entries/{entry_id}/s3/update_password": { "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "put": { "summary": "Atualizar credenciais AWS do Canal S3", "tags": [ "Canal S3" ], "security": [ { "bearerAuth": [] } ], "description": "Enfileira a atualização das credenciais AWS da Caixa Postal e define o canal como atualizando senha.", "responses": { "202": { "description": "Atualização enfileirada.", "content": { "application/json": { "example": { "status": 202, "data": { "uid": "01a06d90-1c75-7aaa-b20c-58274d6391e9", "mailbox_entry": { "uid": "01a06d90-1c73-7f8a-afc8-a09ebc31dd96", "slug": "mailbox-24", "name": "Mailbox Entry mailbox-24", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "s3", "api" ], "channels": { "s3": {} }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:56-05:00", "updated_at": "2026-09-04T12:55:56-05:00" }, "status": "updating_password", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:56-05:00", "updated_at": "2026-09-04T12:55:56-05:00", "connection": { "identity_pool_id": "us-east-1:39875bd3-5d60-4cda-bfc4-5b8ab3b8ee95", "user_pool_id": "us-east-1_Jv1zeJ3h6", "client_id": "3d1b1b4go217l283dhm1nvlau4", "username": "mailbox-24", "region": "us-east-1", "bucket": "kobana-mailbox-development-main", "inbox_path": null, "outbox_path": null } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_s3_channel" } } } } } } } } }, "/v2/mailbox/entries/{entry_id}/sftp": { "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "entry_id", "in": "path", "required": true, "description": "UID da Caixa Postal", "schema": { "type": "string" } } ], "get": { "summary": "Exibir Canal SFTP", "tags": [ "Canal SFTP" ], "security": [ { "bearerAuth": [] } ], "description": "Retorna o canal SFTP configurado na Caixa Postal.", "responses": { "200": { "description": "Canal SFTP encontrado.", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-1cbc-76c9-915a-9672bfc11e49", "mailbox_entry": { "uid": "01a06d90-1cb3-7d11-9a73-c5bf55433384", "slug": "mailbox-25", "name": "Mailbox Entry mailbox-25", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "sftp", "api" ], "channels": { "sftp": { "host": "sftp.example.com", "port": 22, "username": "sftpuser", "has_password": true, "has_key": false, "inbox_path": "/home/user/inbox", "outbox_path": "/home/user/outbox" } }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:56-05:00", "updated_at": "2026-09-04T12:55:56-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:56-05:00", "updated_at": "2026-09-04T12:55:56-05:00", "username": "sftpuser", "host": "sftp.example.com", "port": 22, "inbox_path": "/home/user/inbox", "outbox_path": "/home/user/outbox" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_sftp_channel" } } } } } }, "401": { "description": "Não autorizado.", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Canal não encontrado.", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "post": { "summary": "Criar Canal SFTP", "tags": [ "Canal SFTP" ], "security": [ { "bearerAuth": [] } ], "description": "Cria um canal SFTP para a Caixa Postal.", "parameters": [], "responses": { "201": { "description": "Canal criado.", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-1dca-7ce6-80b0-f35517d995bf", "mailbox_entry": { "uid": "01a06d90-1db4-7c9a-b225-ac3f1ef3435a", "slug": "mailbox-28", "name": "Mailbox Entry mailbox-28", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "sftp", "api" ], "channels": { "sftp": { "host": null, "port": 22, "username": null, "has_password": false, "has_key": false, "inbox_path": "/inbox", "outbox_path": "/outbox" } }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:56-05:00", "updated_at": "2026-09-04T12:55:56-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": true, "created_at": "2026-09-04T12:55:56-05:00", "updated_at": "2026-09-04T12:55:56-05:00", "username": null, "host": null, "port": 22, "inbox_path": "/inbox", "outbox_path": "/outbox" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_sftp_channel" } } } } } }, "401": { "description": "Não autorizado.", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Sem permissão.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "description": "Chave privada SSH (write-only)" } } } } } } }, "patch": { "summary": "Atualizar Canal SFTP", "tags": [ "Canal SFTP" ], "security": [ { "bearerAuth": [] } ], "description": "Atualiza o canal SFTP. Campo password e campos gerenciados pelo sistema (host, port, inbox_path, outbox_path) não são aceitos via API.", "parameters": [], "responses": { "200": { "description": "Canal atualizado.", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-1e7a-7d63-b944-81bd44967392", "mailbox_entry": { "uid": "01a06d90-1e77-7539-90b2-01a3c2d291f6", "slug": "mailbox-31", "name": "Mailbox Entry mailbox-31", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "sftp", "api" ], "channels": { "sftp": { "host": "sftp.example.com", "port": 22, "username": "sftpuser", "has_password": true, "has_key": false, "inbox_path": "/home/user/inbox", "outbox_path": "/home/user/outbox" } }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:56-05:00", "updated_at": "2026-09-04T12:55:56-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:56-05:00", "updated_at": "2026-09-04T12:55:56-05:00", "username": "sftpuser", "host": "sftp.example.com", "port": 22, "inbox_path": "/home/user/inbox", "outbox_path": "/home/user/outbox" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_sftp_channel" } } } } } }, "404": { "description": "Canal não encontrado.", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "description": "Chave privada SSH (write-only)" } } } } } } }, "delete": { "summary": "Excluir Canal SFTP", "tags": [ "Canal SFTP" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "Canal excluído." }, "422": { "description": "Canal ativo não pode ser excluído.", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "channel_is_active", "title": "Canal ativo não pode ser excluído. Desative-o primeiro." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/mailbox/entries/{entry_id}/sftp/activate": { "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "put": { "summary": "Ativar Canal SFTP", "tags": [ "Canal SFTP" ], "security": [ { "bearerAuth": [] } ], "responses": { "202": { "description": "Ativação enfileirada.", "content": { "application/json": { "example": { "status": 202, "data": { "uid": "01a06d90-1f7f-755a-8130-075fb715c16c", "mailbox_entry": { "uid": "01a06d90-1f7c-793b-9ded-807b19275584", "slug": "mailbox-35", "name": "Mailbox Entry mailbox-35", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "sftp", "api" ], "channels": { "sftp": { "host": "sftp.example.com", "port": 22, "username": "sftpuser", "has_password": true, "has_key": false, "inbox_path": "/home/user/inbox", "outbox_path": "/home/user/outbox" } }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:56-05:00", "updated_at": "2026-09-04T12:55:56-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:56-05:00", "updated_at": "2026-09-04T12:55:56-05:00", "username": "sftpuser", "host": "sftp.example.com", "port": 22, "inbox_path": "/home/user/inbox", "outbox_path": "/home/user/outbox" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_sftp_channel" } } } } } } } } }, "/v2/mailbox/entries/{entry_id}/sftp/deactivate": { "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "put": { "summary": "Desativar Canal SFTP", "tags": [ "Canal SFTP" ], "security": [ { "bearerAuth": [] } ], "responses": { "202": { "description": "Desativação enfileirada.", "content": { "application/json": { "example": { "status": 202, "data": { "uid": "01a06d90-1fc7-7233-a4d9-cafea8608222", "mailbox_entry": { "uid": "01a06d90-1fc5-7461-ac0b-41b031111580", "slug": "mailbox-36", "name": "Mailbox Entry mailbox-36", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "sftp", "api" ], "channels": { "sftp": { "host": "sftp.example.com", "port": 22, "username": "sftpuser", "has_password": true, "has_key": false, "inbox_path": "/home/user/inbox", "outbox_path": "/home/user/outbox" } }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:56-05:00", "updated_at": "2026-09-04T12:55:56-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:56-05:00", "updated_at": "2026-09-04T12:55:56-05:00", "username": "sftpuser", "host": "sftp.example.com", "port": 22, "inbox_path": "/home/user/inbox", "outbox_path": "/home/user/outbox" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_sftp_channel" } } } } } } } } }, "/v2/mailbox/entries/{entry_id}/sftp/fetch": { "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "put": { "summary": "Buscar arquivos do Canal SFTP", "tags": [ "Canal SFTP" ], "security": [ { "bearerAuth": [] } ], "description": "Enfileira a busca de arquivos do servidor SFTP configurado.", "responses": { "202": { "description": "Busca enfileirada.", "content": { "application/json": { "example": { "status": 202, "data": { "uid": "01a06d90-200c-70a3-9b4c-d702224b6817", "mailbox_entry": { "uid": "01a06d90-2009-7c36-aec4-09ba241aaf38", "slug": "mailbox-37", "name": "Mailbox Entry mailbox-37", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "sftp", "api" ], "channels": { "sftp": { "host": "sftp.example.com", "port": 22, "username": "sftpuser", "has_password": true, "has_key": false, "inbox_path": "/home/user/inbox", "outbox_path": "/home/user/outbox" } }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:57-05:00", "updated_at": "2026-09-04T12:55:57-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:57-05:00", "updated_at": "2026-09-04T12:55:57-05:00", "username": "sftpuser", "host": "sftp.example.com", "port": 22, "inbox_path": "/home/user/inbox", "outbox_path": "/home/user/outbox" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_sftp_channel" } } } } } } } } }, "/v2/mailbox/entries/{entry_id}/sftp/update_password": { "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "put": { "summary": "Atualizar credenciais SSH do Canal SFTP", "tags": [ "Canal SFTP" ], "security": [ { "bearerAuth": [] } ], "description": "Enfileira a atualização das credenciais SSH da Caixa Postal e define o canal como atualizando senha.", "responses": { "202": { "description": "Atualização enfileirada.", "content": { "application/json": { "example": { "status": 202, "data": { "uid": "01a06d90-2050-7e8a-aa05-2f051679739d", "mailbox_entry": { "uid": "01a06d90-204d-7877-b8ba-f6ad2abd9568", "slug": "mailbox-38", "name": "Mailbox Entry mailbox-38", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "sftp", "api" ], "channels": { "sftp": { "host": "sftp.example.com", "port": 22, "username": "sftpuser", "has_password": true, "has_key": false, "inbox_path": "/home/user/inbox", "outbox_path": "/home/user/outbox" } }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:57-05:00", "updated_at": "2026-09-04T12:55:57-05:00" }, "status": "updating_password", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:57-05:00", "updated_at": "2026-09-04T12:55:57-05:00", "username": "sftpuser", "host": "sftp.example.com", "port": 22, "inbox_path": "/home/user/inbox", "outbox_path": "/home/user/outbox" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_sftp_channel" } } } } } } } } }, "/v2/mailbox/entries/{entry_id}/syncthing": { "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "entry_id", "in": "path", "required": true, "description": "UID da Caixa Postal", "schema": { "type": "string" } } ], "get": { "summary": "Exibir Canal Syncthing", "tags": [ "Canal Syncthing" ], "security": [ { "bearerAuth": [] } ], "description": "Retorna o canal Syncthing configurado na Caixa Postal.", "responses": { "200": { "description": "Canal Syncthing encontrado.", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-209d-76c3-8ec5-fd71259eee73", "mailbox_entry": { "uid": "01a06d90-2093-7645-ae25-ef41ccfd3561", "slug": "mailbox-39", "name": "Mailbox Entry mailbox-39", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "syncthing", "api" ], "channels": { "syncthing": { "name": "Test Device", "device_id": "MFZWI3D-BONSGYC-YLTMRWG-C43ENR5-QXGZDMM-FZWI3DP-BONSGYY-LTMRWAD", "inbox_folder_id": "kobana-01a06d90-2093-7645-ae25-ef41ccfd3561-inbox", "outbox_folder_id": "kobana-01a06d90-2093-7645-ae25-ef41ccfd3561-outbox" } }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:57-05:00", "updated_at": "2026-09-04T12:55:57-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:57-05:00", "updated_at": "2026-09-04T12:55:57-05:00", "name": "Test Device", "device_id": "MFZWI3D-BONSGYC-YLTMRWG-C43ENR5-QXGZDMM-FZWI3DP-BONSGYY-LTMRWAD", "inbox_folder_id": "kobana-01a06d90-2093-7645-ae25-ef41ccfd3561-inbox", "outbox_folder_id": "kobana-01a06d90-2093-7645-ae25-ef41ccfd3561-outbox", "server_status": "disconnected", "error_message": null } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_syncthing_channel" } } } } } }, "401": { "description": "Não autorizado.", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Canal não encontrado.", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "post": { "summary": "Criar Canal Syncthing", "tags": [ "Canal Syncthing" ], "security": [ { "bearerAuth": [] } ], "description": "Cria um canal Syncthing para a Caixa Postal. O device_id deve seguir o formato padrão do Syncthing.", "parameters": [], "responses": { "201": { "description": "Canal criado.", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-2158-77cb-9a4e-316b222eb132", "mailbox_entry": { "uid": "01a06d90-2146-7fe5-97f0-5235001ac864", "slug": "mailbox-42", "name": "Mailbox Entry mailbox-42", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "syncthing", "api" ], "channels": { "syncthing": { "name": "Novo Dispositivo", "device_id": "MFZWI3D-BONSGYC-YLTMRWG-C43ENR5-QXGZDMM-FZWI3DP-BONSGYY-LTMRWAD", "inbox_folder_id": "kobana-01a06d90-2146-7fe5-97f0-5235001ac864-inbox", "outbox_folder_id": "kobana-01a06d90-2146-7fe5-97f0-5235001ac864-outbox" } }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:57-05:00", "updated_at": "2026-09-04T12:55:57-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": true, "created_at": "2026-09-04T12:55:57-05:00", "updated_at": "2026-09-04T12:55:57-05:00", "name": "Novo Dispositivo", "device_id": "MFZWI3D-BONSGYC-YLTMRWG-C43ENR5-QXGZDMM-FZWI3DP-BONSGYY-LTMRWAD", "inbox_folder_id": "kobana-01a06d90-2146-7fe5-97f0-5235001ac864-inbox", "outbox_folder_id": "kobana-01a06d90-2146-7fe5-97f0-5235001ac864-outbox", "server_status": "disconnected", "error_message": null } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_syncthing_channel" } } } } } }, "401": { "description": "Não autorizado.", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Sem permissão.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "device_id" ], "properties": { "name": { "type": "string", "example": "Meu Dispositivo" }, "device_id": { "type": "string", "example": "MFZWI3D-BONSGYC-YLTMRWG-C43ENR5-QXGZDMM-FZWI3DP-BONSGYY-LTMRWAD" } } } } }, "required": true } }, "patch": { "summary": "Atualizar Canal Syncthing", "tags": [ "Canal Syncthing" ], "security": [ { "bearerAuth": [] } ], "description": "Atualiza o nome ou device_id do canal Syncthing.", "parameters": [], "responses": { "200": { "description": "Canal atualizado.", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-21ef-79c6-b9ff-01e9ba80a9d3", "mailbox_entry": { "uid": "01a06d90-21ec-7d8c-afe8-f04e93149346", "slug": "mailbox-45", "name": "Mailbox Entry mailbox-45", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "syncthing", "api" ], "channels": { "syncthing": { "name": "Nome Atualizado", "device_id": "MFZWI3D-BONSGYC-YLTMRWG-C43ENR5-QXGZDMM-FZWI3DP-BONSGYY-LTMRWAD", "inbox_folder_id": "kobana-01a06d90-21ec-7d8c-afe8-f04e93149346-inbox", "outbox_folder_id": "kobana-01a06d90-21ec-7d8c-afe8-f04e93149346-outbox" } }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:57-05:00", "updated_at": "2026-09-04T12:55:57-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:57-05:00", "updated_at": "2026-09-04T12:55:57-05:00", "name": "Nome Atualizado", "device_id": "MFZWI3D-BONSGYC-YLTMRWG-C43ENR5-QXGZDMM-FZWI3DP-BONSGYY-LTMRWAD", "inbox_folder_id": "kobana-01a06d90-21ec-7d8c-afe8-f04e93149346-inbox", "outbox_folder_id": "kobana-01a06d90-21ec-7d8c-afe8-f04e93149346-outbox", "server_status": "disconnected", "error_message": null } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_syncthing_channel" } } } } } }, "404": { "description": "Canal não encontrado.", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Nome Atualizado" }, "device_id": { "type": "string", "example": "MFZWI3D-BONSGYC-YLTMRWG-C43ENR5-QXGZDMM-FZWI3DP-BONSGYY-LTMRWAD" } } } } }, "required": true } }, "delete": { "summary": "Excluir Canal Syncthing", "tags": [ "Canal Syncthing" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "Canal excluído." }, "422": { "description": "Canal ativo não pode ser excluído.", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "channel_is_active", "title": "Canal ativo não pode ser excluído. Desative-o primeiro." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/mailbox/entries/{entry_id}/syncthing/activate": { "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "put": { "summary": "Ativar Canal Syncthing", "tags": [ "Canal Syncthing" ], "security": [ { "bearerAuth": [] } ], "responses": { "202": { "description": "Ativação enfileirada.", "content": { "application/json": { "example": { "status": 202, "data": { "uid": "01a06d90-22ee-7402-9c96-7b451d2aa526", "mailbox_entry": { "uid": "01a06d90-22ec-722f-b7be-213468b17522", "slug": "mailbox-49", "name": "Mailbox Entry mailbox-49", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "syncthing", "api" ], "channels": { "syncthing": { "name": "Test Device", "device_id": "MFZWI3D-BONSGYC-YLTMRWG-C43ENR5-QXGZDMM-FZWI3DP-BONSGYY-LTMRWAD", "inbox_folder_id": "kobana-01a06d90-22ec-722f-b7be-213468b17522-inbox", "outbox_folder_id": "kobana-01a06d90-22ec-722f-b7be-213468b17522-outbox" } }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:57-05:00", "updated_at": "2026-09-04T12:55:57-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:57-05:00", "updated_at": "2026-09-04T12:55:57-05:00", "name": "Test Device", "device_id": "MFZWI3D-BONSGYC-YLTMRWG-C43ENR5-QXGZDMM-FZWI3DP-BONSGYY-LTMRWAD", "inbox_folder_id": "kobana-01a06d90-22ec-722f-b7be-213468b17522-inbox", "outbox_folder_id": "kobana-01a06d90-22ec-722f-b7be-213468b17522-outbox", "server_status": "disconnected", "error_message": null } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_syncthing_channel" } } } } } } } } }, "/v2/mailbox/entries/{entry_id}/syncthing/deactivate": { "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "put": { "summary": "Desativar Canal Syncthing", "tags": [ "Canal Syncthing" ], "security": [ { "bearerAuth": [] } ], "responses": { "202": { "description": "Desativação enfileirada.", "content": { "application/json": { "example": { "status": 202, "data": { "uid": "01a06d90-2331-746f-bcc8-c47163d8fe0b", "mailbox_entry": { "uid": "01a06d90-232e-7733-8eb4-7c5173f74193", "slug": "mailbox-50", "name": "Mailbox Entry mailbox-50", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "syncthing", "api" ], "channels": { "syncthing": { "name": "Test Device", "device_id": "MFZWI3D-BONSGYC-YLTMRWG-C43ENR5-QXGZDMM-FZWI3DP-BONSGYY-LTMRWAD", "inbox_folder_id": "kobana-01a06d90-232e-7733-8eb4-7c5173f74193-inbox", "outbox_folder_id": "kobana-01a06d90-232e-7733-8eb4-7c5173f74193-outbox" } }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:57-05:00", "updated_at": "2026-09-04T12:55:57-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:57-05:00", "updated_at": "2026-09-04T12:55:57-05:00", "name": "Test Device", "device_id": "MFZWI3D-BONSGYC-YLTMRWG-C43ENR5-QXGZDMM-FZWI3DP-BONSGYY-LTMRWAD", "inbox_folder_id": "kobana-01a06d90-232e-7733-8eb4-7c5173f74193-inbox", "outbox_folder_id": "kobana-01a06d90-232e-7733-8eb4-7c5173f74193-outbox", "server_status": "disconnected", "error_message": null } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_syncthing_channel" } } } } } } } } }, "/v2/mailbox/entries/{entry_id}/syncthing/resend_invites": { "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "put": { "summary": "Reenviar Convites Syncthing", "tags": [ "Canal Syncthing" ], "security": [ { "bearerAuth": [] } ], "description": "Reenvia os convites de ativação do canal Syncthing, forçando o processo de ativação.", "responses": { "202": { "description": "Reenvio de convites enfileirado.", "content": { "application/json": { "example": { "status": 202, "data": { "uid": "01a06d90-2373-7c5c-b479-6b3c96f00640", "mailbox_entry": { "uid": "01a06d90-2371-74a8-bad5-7bb7298c61b0", "slug": "mailbox-51", "name": "Mailbox Entry mailbox-51", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "syncthing", "api" ], "channels": { "syncthing": { "name": "Test Device", "device_id": "MFZWI3D-BONSGYC-YLTMRWG-C43ENR5-QXGZDMM-FZWI3DP-BONSGYY-LTMRWAD", "inbox_folder_id": "kobana-01a06d90-2371-74a8-bad5-7bb7298c61b0-inbox", "outbox_folder_id": "kobana-01a06d90-2371-74a8-bad5-7bb7298c61b0-outbox" } }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:57-05:00", "updated_at": "2026-09-04T12:55:57-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:57-05:00", "updated_at": "2026-09-04T12:55:57-05:00", "name": "Test Device", "device_id": "MFZWI3D-BONSGYC-YLTMRWG-C43ENR5-QXGZDMM-FZWI3DP-BONSGYY-LTMRWAD", "inbox_folder_id": "kobana-01a06d90-2371-74a8-bad5-7bb7298c61b0-inbox", "outbox_folder_id": "kobana-01a06d90-2371-74a8-bad5-7bb7298c61b0-outbox", "server_status": "disconnected", "error_message": null } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_syncthing_channel" } } } } } } } } }, "/v2/mailbox/entries/{entry_id}/syncthing/update_status": { "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "put": { "summary": "Atualizar Status do Servidor Syncthing", "tags": [ "Canal Syncthing" ], "security": [ { "bearerAuth": [] } ], "description": "Solicita atualização do status de conexão com o servidor Syncthing.", "responses": { "202": { "description": "Atualização de status enfileirada.", "content": { "application/json": { "example": { "status": 202, "data": { "uid": "01a06d90-23b4-7ef0-beb6-501586776657", "mailbox_entry": { "uid": "01a06d90-23b2-740a-9b9d-25e2468238bd", "slug": "mailbox-52", "name": "Mailbox Entry mailbox-52", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "syncthing", "api" ], "channels": { "syncthing": { "name": "Test Device", "device_id": "MFZWI3D-BONSGYC-YLTMRWG-C43ENR5-QXGZDMM-FZWI3DP-BONSGYY-LTMRWAD", "inbox_folder_id": "kobana-01a06d90-23b2-740a-9b9d-25e2468238bd-inbox", "outbox_folder_id": "kobana-01a06d90-23b2-740a-9b9d-25e2468238bd-outbox" } }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:58-05:00", "updated_at": "2026-09-04T12:55:58-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:58-05:00", "updated_at": "2026-09-04T12:55:58-05:00", "name": "Test Device", "device_id": "MFZWI3D-BONSGYC-YLTMRWG-C43ENR5-QXGZDMM-FZWI3DP-BONSGYY-LTMRWAD", "inbox_folder_id": "kobana-01a06d90-23b2-740a-9b9d-25e2468238bd-inbox", "outbox_folder_id": "kobana-01a06d90-23b2-740a-9b9d-25e2468238bd-outbox", "server_status": "updating", "error_message": null } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_syncthing_channel" } } } } } } } } }, "/v2/mailbox/entries/{entry_id}/whatsapp": { "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "entry_id", "in": "path", "required": true, "description": "UID da Caixa Postal", "schema": { "type": "string" } } ], "get": { "summary": "Exibir Canal WhatsApp", "tags": [ "Canal WhatsApp" ], "security": [ { "bearerAuth": [] } ], "description": "Retorna o canal WhatsApp configurado na Caixa Postal.", "responses": { "200": { "description": "Canal WhatsApp encontrado.", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-2403-7396-9147-9317dcfa6af7", "mailbox_entry": { "uid": "01a06d90-23f6-71a8-8de1-82fd20763e6d", "slug": "mailbox-53", "name": "Mailbox Entry mailbox-53", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "whatsapp", "api" ], "channels": { "whatsapp": { "inbox_phones": [ { "kind": null, "country_code": "55", "local_code": "21", "number": "999999999" }, { "kind": null, "country_code": "55", "local_code": "21", "number": "988888888" } ], "outbox_phones": [ { "kind": null, "country_code": "55", "local_code": "21", "number": "977777777" } ] } }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:58-05:00", "updated_at": "2026-09-04T12:55:58-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:58-05:00", "updated_at": "2026-09-04T12:55:58-05:00", "inbox_phones": [ { "country_code": "55", "local_code": "21", "number": "999999999", "complete": "+55 21 999999999" }, { "country_code": "55", "local_code": "21", "number": "988888888", "complete": "+55 21 988888888" } ], "outbox_phones": [ { "country_code": "55", "local_code": "21", "number": "977777777", "complete": "+55 21 977777777" } ], "activation_token": null } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_whatsapp_channel" } } } } } }, "401": { "description": "Não autorizado.", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Canal não encontrado.", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "post": { "summary": "Criar Canal WhatsApp", "tags": [ "Canal WhatsApp" ], "security": [ { "bearerAuth": [] } ], "description": "Cria um canal WhatsApp para a Caixa Postal. O activation_token é gerado automaticamente.", "parameters": [], "responses": { "201": { "description": "Canal criado.", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-24db-7254-9b33-70d031d61199", "mailbox_entry": { "uid": "01a06d90-24ca-775e-8956-5301de8b15a2", "slug": "mailbox-56", "name": "Mailbox Entry mailbox-56", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "whatsapp", "api" ], "channels": { "whatsapp": { "inbox_phones": [ { "kind": null, "country_code": "55", "local_code": "21", "number": "999999999" } ], "outbox_phones": [ { "kind": null, "country_code": "55", "local_code": "21", "number": "988888888" } ] } }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:58-05:00", "updated_at": "2026-09-04T12:55:58-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": true, "created_at": "2026-09-04T12:55:58-05:00", "updated_at": "2026-09-04T12:55:58-05:00", "inbox_phones": [ { "country_code": "55", "local_code": "21", "number": "999999999", "complete": "+55 21 999999999" } ], "outbox_phones": [ { "country_code": "55", "local_code": "21", "number": "988888888", "complete": "+55 21 988888888" } ], "activation_token": null } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_whatsapp_channel" } } } } } }, "401": { "description": "Não autorizado.", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Sem permissão.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "inbox_phones": { "type": "array", "items": { "type": "object", "properties": { "country_code": { "type": "string", "example": "55" }, "local_code": { "type": "string", "example": "21" }, "number": { "type": "string", "example": "999999999" } } } }, "outbox_phones": { "type": "array", "items": { "type": "object", "properties": { "country_code": { "type": "string", "example": "55" }, "local_code": { "type": "string", "example": "21" }, "number": { "type": "string", "example": "988888888" } } } } } } } }, "required": true } }, "patch": { "summary": "Atualizar Canal WhatsApp", "tags": [ "Canal WhatsApp" ], "security": [ { "bearerAuth": [] } ], "description": "Atualiza os telefones do canal WhatsApp. O activation_token não é aceito como parâmetro.", "parameters": [], "responses": { "200": { "description": "Canal atualizado.", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-257a-7f55-8c06-3ede9be359d3", "mailbox_entry": { "uid": "01a06d90-2574-7796-afe7-3ca5520bf80e", "slug": "mailbox-59", "name": "Mailbox Entry mailbox-59", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "whatsapp", "api" ], "channels": { "whatsapp": { "inbox_phones": [ { "kind": null, "country_code": "55", "local_code": "11", "number": "911111111" } ], "outbox_phones": [ { "kind": null, "country_code": "55", "local_code": "21", "number": "977777777" } ] } }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:58-05:00", "updated_at": "2026-09-04T12:55:58-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:58-05:00", "updated_at": "2026-09-04T12:55:58-05:00", "inbox_phones": [ { "country_code": "55", "local_code": "11", "number": "911111111", "complete": "+55 11 911111111" } ], "outbox_phones": [ { "country_code": "55", "local_code": "21", "number": "977777777", "complete": "+55 21 977777777" } ], "activation_token": null } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_whatsapp_channel" } } } } } }, "404": { "description": "Canal não encontrado.", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "inbox_phones": { "type": "array", "items": { "type": "object", "properties": { "country_code": { "type": "string" }, "local_code": { "type": "string" }, "number": { "type": "string" } } } }, "outbox_phones": { "type": "array", "items": { "type": "object", "properties": { "country_code": { "type": "string" }, "local_code": { "type": "string" }, "number": { "type": "string" } } } } } } } }, "required": true } }, "delete": { "summary": "Excluir Canal WhatsApp", "tags": [ "Canal WhatsApp" ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "Canal excluído." }, "422": { "description": "Canal ativo não pode ser excluído.", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "channel_is_active", "title": "Canal ativo não pode ser excluído. Desative-o primeiro." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/mailbox/entries/{entry_id}/whatsapp/activate": { "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "put": { "summary": "Ativar Canal WhatsApp", "tags": [ "Canal WhatsApp" ], "security": [ { "bearerAuth": [] } ], "responses": { "202": { "description": "Ativação enfileirada.", "content": { "application/json": { "example": { "status": 202, "data": { "uid": "01a06d90-2682-75e8-8b8e-bf1cfd4a64c6", "mailbox_entry": { "uid": "01a06d90-267d-70ed-9378-77a3cd3ed888", "slug": "mailbox-63", "name": "Mailbox Entry mailbox-63", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "whatsapp", "api" ], "channels": { "whatsapp": { "inbox_phones": [ { "kind": null, "country_code": "55", "local_code": "21", "number": "999999999" }, { "kind": null, "country_code": "55", "local_code": "21", "number": "988888888" } ], "outbox_phones": [ { "kind": null, "country_code": "55", "local_code": "21", "number": "977777777" } ] } }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:58-05:00", "updated_at": "2026-09-04T12:55:58-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:58-05:00", "updated_at": "2026-09-04T12:55:58-05:00", "inbox_phones": [ { "country_code": "55", "local_code": "21", "number": "999999999", "complete": "+55 21 999999999" }, { "country_code": "55", "local_code": "21", "number": "988888888", "complete": "+55 21 988888888" } ], "outbox_phones": [ { "country_code": "55", "local_code": "21", "number": "977777777", "complete": "+55 21 977777777" } ], "activation_token": null } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_whatsapp_channel" } } } } } } } } }, "/v2/mailbox/entries/{entry_id}/whatsapp/deactivate": { "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "put": { "summary": "Desativar Canal WhatsApp", "tags": [ "Canal WhatsApp" ], "security": [ { "bearerAuth": [] } ], "responses": { "202": { "description": "Desativação enfileirada.", "content": { "application/json": { "example": { "status": 202, "data": { "uid": "01a06d90-26c8-7913-97ae-d8e9be916d1d", "mailbox_entry": { "uid": "01a06d90-26c3-7b39-a0f7-21b7ae54c95a", "slug": "mailbox-64", "name": "Mailbox Entry mailbox-64", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "whatsapp", "api" ], "channels": { "whatsapp": { "inbox_phones": [ { "kind": null, "country_code": "55", "local_code": "21", "number": "999999999" }, { "kind": null, "country_code": "55", "local_code": "21", "number": "988888888" } ], "outbox_phones": [ { "kind": null, "country_code": "55", "local_code": "21", "number": "977777777" } ] } }, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:58-05:00", "updated_at": "2026-09-04T12:55:58-05:00" }, "status": "pending", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:58-05:00", "updated_at": "2026-09-04T12:55:58-05:00", "inbox_phones": [ { "country_code": "55", "local_code": "21", "number": "999999999", "complete": "+55 21 999999999" }, { "country_code": "55", "local_code": "21", "number": "988888888", "complete": "+55 21 988888888" } ], "outbox_phones": [ { "country_code": "55", "local_code": "21", "number": "977777777", "complete": "+55 21 977777777" } ], "activation_token": null } }, "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/v2_mailbox_whatsapp_channel" } } } } } } } } }, "/v2/mailbox/entries": { "get": { "summary": "Listar Caixas Postais", "tags": [ "Caixas Postais" ], "security": [ { "bearerAuth": [] } ], "description": "Lista as Caixas Postais da conta.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página. Máximo de 50.", "example": 20, "required": false, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "Número da página.", "example": 1, "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Caixas Postais encontradas.", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d90-270e-748b-8cc3-07670bae8bb0", "slug": "entry-3", "name": "Entry 3", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "api" ], "channels": {}, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:58-05:00", "updated_at": "2026-09-04T12:55:58-05:00" }, { "uid": "01a06d90-270b-7ec5-88e2-835835ba83d7", "slug": "entry-2", "name": "Entry 2", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "api" ], "channels": {}, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:58-05:00", "updated_at": "2026-09-04T12:55:58-05:00" } ], "pagination": { "prev_url": null, "next_url": "/v2/mailbox/entries?per_page=2&page=2", "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_mailbox_entry" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } }, "401": { "description": "Usuário não autorizado", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o `scope` obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "post": { "summary": "Criar Caixa Postal", "tags": [ "Caixas Postais" ], "security": [ { "bearerAuth": [] } ], "description": "Cria uma nova Caixa Postal.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Caixa Postal criada", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-278b-78fa-b536-7929a275e12a", "slug": "nova-caixa", "name": "Nova Caixa Postal", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "api" ], "channels": {}, "processed": [], "external_id": null, "custom_data": null, "tags": [ "api" ], "created_via_api": true, "created_at": "2026-09-04T12:55:58-05:00", "updated_at": "2026-09-04T12:55:58-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `201`." }, "data": { "$ref": "#/components/schemas/v2_mailbox_entry" } } } } } }, "401": { "description": "Usuário não autorizado", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o `scope` obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "422": { "description": "Falha na validação", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "kind", "detail": "Tipo não pode ficar em branco" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_mailbox_entry" } } }, "required": true, "description": "Informações da Caixa Postal a ser criada." } } }, "/v2/mailbox/entries/{uid}": { "get": { "summary": "Visualizar Caixa Postal", "tags": [ "Caixas Postais" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações de uma Caixa Postal específica.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UID da Caixa Postal", "required": true, "example": "012ab34c-d567-8901-234e-5fghi6j789k0", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Caixa Postal encontrada", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-2825-7dec-a134-8dae13bfadd9", "slug": "entry-1", "name": "Entry 1", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "api" ], "channels": {}, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:59-05:00", "updated_at": "2026-09-04T12:55:59-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_mailbox_entry" } } } } } }, "401": { "description": "Usuário não autorizado", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o `scope` obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Caixa Postal não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "patch": { "summary": "Atualizar Caixa Postal", "tags": [ "Caixas Postais" ], "security": [ { "bearerAuth": [] } ], "description": "Atualiza uma Caixa Postal específica.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UID da Caixa Postal", "required": true, "example": "012ab34c-d567-8901-234e-5fghi6j789k0", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Caixa Postal atualizada", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-28d2-7307-bc08-3e9978140232", "slug": "entry-original", "name": "Nome Atualizado", "kind": "document", "send_encrypted": false, "send_encryption_public_key": null, "receive_encrypted": false, "receive_encryption_keypair_id": null, "active_channels": [ "api" ], "channels": {}, "processed": [], "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "created_at": "2026-09-04T12:55:59-05:00", "updated_at": "2026-09-04T12:55:59-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_mailbox_entry" } } } } } }, "401": { "description": "Usuário não autorizado", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o `scope` obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Caixa Postal não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_mailbox_entry" } } }, "required": true, "description": "Informações da Caixa Postal a ser atualizada." } }, "delete": { "summary": "Deletar Caixa Postal", "tags": [ "Caixas Postais" ], "security": [ { "bearerAuth": [] } ], "description": "Deleta uma Caixa Postal específica. Não é possível deletar uma Caixa Postal que possui arquivos.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UID da Caixa Postal", "required": true, "example": "012ab34c-d567-8901-234e-5fghi6j789k0", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Caixa Postal deletada" }, "401": { "description": "Usuário não autorizado", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o `scope` obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Caixa Postal não encontrada", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "422": { "description": "Caixa Postal possui arquivos", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "mailbox_entry_has_files", "detail": "Mailbox entry cannot be deleted because it has files" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/mailbox/files": { "get": { "summary": "Listar Arquivos de Mailbox", "tags": [ "Arquivos de Mailbox" ], "security": [ { "bearerAuth": [] } ], "description": "Lista os Arquivos de Mailbox da conta.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "description": "Quantidade de registros por página. Máximo de 50.", "example": 20, "required": false, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "Número da página.", "example": 1, "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Arquivos encontrados.", "content": { "application/json": { "example": { "status": 200, "data": [ { "uid": "01a06d90-2aec-719d-b80e-f813104b3e43", "mailbox_entry_id": "01a06d90-2ae4-7ef7-8553-c986d7cabf04", "kind": "received", "name": "file-3.txt", "size": 1024, "mime_type": "text/plain", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "uploaded_at": "2026-09-04T12:55:59-05:00", "processed_at": null, "created_at": "2026-09-04T12:55:59-05:00", "updated_at": "2026-09-04T12:55:59-05:00" }, { "uid": "01a06d90-2ae9-7cfc-ab62-0f7e7a106d99", "mailbox_entry_id": "01a06d90-2ae4-7ef7-8553-c986d7cabf04", "kind": "received", "name": "file-2.txt", "size": 1024, "mime_type": "text/plain", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "uploaded_at": "2026-09-04T12:55:59-05:00", "processed_at": null, "created_at": "2026-09-04T12:55:59-05:00", "updated_at": "2026-09-04T12:55:59-05:00" } ], "pagination": { "prev_url": null, "next_url": "/v2/mailbox/files?per_page=2&page=2", "page": 1 } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2_mailbox_file" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } }, "401": { "description": "Usuário não autorizado", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o `scope` obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/mailbox/entries/{entry_uid}/files": { "post": { "summary": "Criar Arquivo de Mailbox", "tags": [ "Arquivos de Mailbox" ], "security": [ { "bearerAuth": [] } ], "description": "Cria um novo Arquivo de Mailbox associado a uma Caixa Postal.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "entry_uid", "in": "path", "description": "UID da Caixa Postal", "required": true, "example": "012ab34c-d567-8901-234e-5fghi6j789k0", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Arquivo criado", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01a06d90-2b87-71b7-8332-7bd5b3c09c20", "mailbox_entry_id": "01a06d90-2b76-7b21-9227-9f0a7d97f860", "kind": "received", "name": "remessa.txt", "size": null, "mime_type": null, "external_id": null, "custom_data": null, "tags": [ "api" ], "created_via_api": true, "uploaded_at": "2026-09-04T12:56:00-05:00", "processed_at": null, "created_at": "2026-09-04T12:56:00-05:00", "updated_at": "2026-09-04T12:56:00-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `201`." }, "data": { "$ref": "#/components/schemas/v2_mailbox_file" } } } } } }, "401": { "description": "Usuário não autorizado", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o `scope` obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "422": { "description": "Base64 inválido.", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "invalid_base64", "title": "Invalid base64 content", "detail": "invalid base64" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_mailbox_file" } } }, "required": true, "description": "Informações do Arquivo de Mailbox a ser criado." } } }, "/v2/mailbox/files/{uid}": { "get": { "summary": "Visualizar Arquivo de Mailbox", "tags": [ "Arquivos de Mailbox" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações de um Arquivo de Mailbox específico.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UID do Arquivo de Mailbox", "required": true, "example": "012ab34c-d567-8901-234e-5fghi6j789k0", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Arquivo encontrado", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-2c6c-7b7d-b863-8e0c380ce8a1", "mailbox_entry_id": "01a06d90-2c68-766e-9a78-4b0d80594ffd", "kind": "received", "name": "file.txt", "size": 1024, "mime_type": "text/plain", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "uploaded_at": "2026-09-04T12:56:00-05:00", "processed_at": null, "created_at": "2026-09-04T12:56:00-05:00", "updated_at": "2026-09-04T12:56:00-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_mailbox_file" } } } } } }, "401": { "description": "Usuário não autorizado", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o `scope` obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Arquivo não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "patch": { "summary": "Atualizar Arquivo de Mailbox", "tags": [ "Arquivos de Mailbox" ], "security": [ { "bearerAuth": [] } ], "description": "Atualiza um Arquivo de Mailbox específico.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UID do Arquivo de Mailbox", "required": true, "example": "012ab34c-d567-8901-234e-5fghi6j789k0", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Arquivo atualizado", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01a06d90-2d14-7706-adc0-8f521f3db987", "mailbox_entry_id": "01a06d90-2d11-7081-96b6-2db6c25429d7", "kind": "received", "name": "arquivo-atualizado.txt", "size": 1024, "mime_type": "text/plain", "external_id": null, "custom_data": null, "tags": [], "created_via_api": false, "uploaded_at": "2026-09-04T12:56:00-05:00", "processed_at": null, "created_at": "2026-09-04T12:56:00-05:00", "updated_at": "2026-09-04T12:56:00-05:00" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`." }, "data": { "$ref": "#/components/schemas/v2_mailbox_file" } } } } } }, "401": { "description": "Usuário não autorizado", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o `scope` obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Arquivo não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_mailbox_file" } } }, "required": true, "description": "Informações do Arquivo de Mailbox a ser atualizado." } }, "delete": { "summary": "Deletar Arquivo de Mailbox", "tags": [ "Arquivos de Mailbox" ], "security": [ { "bearerAuth": [] } ], "description": "Deleta um Arquivo de Mailbox específico.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } }, { "name": "uid", "in": "path", "description": "UID do Arquivo de Mailbox", "required": true, "example": "012ab34c-d567-8901-234e-5fghi6j789k0", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Arquivo deletado" }, "401": { "description": "Usuário não autorizado", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "403": { "description": "Falha de permissão. Você não tem o `scope` obrigatório para essa chamada.", "content": { "application/json": { "example": { "status": 403, "errors": [ { "title": "Para acessar esse recurso você precisa de pelo menos um destes escopos: \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "404": { "description": "Arquivo não encontrado", "content": { "application/json": { "example": { "status": 404, "errors": [ { "title": "Não foi possível encontrar o registro", "code": "not_found", "detail": "Este registro não existe, ou foi deletado." } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/me": { "get": { "summary": "Obter informações do usuário autenticado", "tags": [ "Informações do Usuário" ], "security": [ { "bearerAuth": [] } ], "description": "Retorna informações sobre o usuário autenticado, incluindo dados da conta, usuário e token de acesso.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Informações do usuário sem usuário associado ao token", "content": { "application/json": { "example": { "status": 200, "data": { "account": { "id": 947, "uid": "01a06d90-2e8b-7821-a7da-c4fa1083cb1a", "email": "39cf87abf6a0c84d2dc768c63bb14004@hettinger.example", "account_type": "individual", "gender": "Feminino", "cpf": "824.842.508-86", "address_street_name": "Av. Burkhard Hehn Simões", "address_state": "RJ", "address_neighborhood": "São Francisco", "address_postal_code": "24360440", "address_number": "120", "address_complement": "709", "phone_number": "2199999999", "first_name": "Margret", "middle_name": "Simões", "last_name": "Gonçalo", "date_of_birth": "1970-03-01", "business_category": null, "business_subcategory": null, "business_website": null, "business_name": null, "business_legal_name": null, "business_type": null, "business_cnpj": null, "address_city_name": "Rio de Janeiro", "full_name": "Margret Simões Gonçalo", "mother_name": "Lenadra Simões Gonçalo", "father_name": "José Simões Gonçalo", "billing_email": null, "configuration": null, "simple_opting": false, "rate_limits": {}, "parent_id": null, "parent_uid": null, "nickname": null, "feature_flags": [], "intercom_id": 947, "subscription": null }, "user": null, "access_token": { "uid": "01a06d90-2e94-7d35-9c9f-ffc944bc8259", "external_id": null, "description": null, "scopes": [ "all", "read", "login" ], "source": "user", "purpose": null, "expires_in": 7200, "expires_at": "2026-09-04T14:56:00-05:00", "version": 2, "tags": [], "custom_data": null, "warning_flags": [], "reminder_emails": [ { "label": "Tech Team", "address": "tech@example.com" } ], "created_at": "2026-09-04T12:56:00-05:00", "created_by": null, "updated_at": "2026-09-04T12:56:00-05:00", "updated_by": null, "enabled_at": "2026-09-04T12:56:00-05:00", "enabled_by": null, "disabled_at": null, "disabled_by": null, "revoked_at": null, "revoked_by": null, "last_used_at": null } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `200`.", "example": 200 }, "data": { "type": "object", "properties": { "account": { "$ref": "#/components/schemas/v2_account" }, "user": { "oneOf": [ { "$ref": "#/components/schemas/v2_user" }, { "type": "null" } ], "description": "Será `null` quando o token não foi criado por um usuário.", "type": "null" }, "access_token": { "type": "object", "description": "Informações do token de acesso" } } } } } } } }, "401": { "description": "Falha de autenticação. Token inválido", "content": { "application/json": { "example": { "status": 401, "errors": [ { "title": "Token de API inválido (Servidor: development)", "code": "unauthorized", "detail": "O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } } }, "components": { "schemas": { "v1_errors_object": { "type": "object", "properties": { "errors": { "$ref": "#/components/schemas/v1_errors_map" } } }, "v1_errors_map": { "type": "object", "items": { "type": "array", "items": { "type": "string", "description": "Detalhe da validação que gerou o erro. Ex: `não pode ficar em branco`." } } }, "v1_error": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP do erro. Ex: `400`." }, "errors": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "description": "Descrição breve do erro. Ex: `Token de API inválido`." }, "code": { "type": "string", "description": "Código do erro. Ex: `unprocessable_content`." }, "detail": { "type": "string", "description": "Descrição do erro em detalhe. Ex: `\"O Token de API é diferente para cada Servidor/URL, mais em https://docs.banking.kobana.com.br/pt/api/overview/authentication/access-token\"`." } } } } } }, "v1_split_accounts_object": { "type": "object", "properties": { "bank_number": { "type": "string", "maxLength": 3, "description": "Número do banco" }, "agency_number": { "type": "string", "maxLength": 5, "description": "Agência (Sem dígito)" }, "agency_digit": { "type": "string", "maxLength": 1, "description": "Dígito da Agência" }, "account_number": { "type": "string", "maxLength": 12, "description": "Conta (Sem dígito)" }, "account_digit": { "type": "string", "maxLength": 1, "description": "Dígito da Conta" }, "cnpj_cpf": { "type": "string", "maxLength": 20, "description": "CNPJ/CPF do Beneficiário" }, "name": { "type": "string", "maxLength": 40, "description": "Nome do Beneficiário" }, "amount": { "type": "string", "format": "float", "description": "Quantia (R$)" }, "floating": { "type": "integer", "description": "Quantidade de Dias para Crédito. Padrão 5 dias. Máximo 30 dias." }, "financial_provider_external_id": { "type": "string", "maxLength": 2, "description": "Código de partilha do Santander (2 dígitos, pré-cadastrado no convênio). Quando informado, os dados bancários do recebedor são dispensados." } } }, "v1_bank_billet_object": { "type": "object", "required": [ "expire_at", "amount", "customer_person_name", "customer_cnpj_cpf", "customer_zipcode", "customer_address", "customer_neighborhood", "customer_city_name", "customer_state" ], "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do boleto" }, "bank_billet_account_id": { "type": "integer", "description": "ID da Carteira de Cobrança. Se não informado, usará a carteira padrão.", "example": null }, "bank_billet_layout_id": { "type": "integer", "nullable": true, "description": "ID do Modelo de Boleto", "example": null }, "amount": { "type": "number", "format": "float", "description": "Quantia", "example": 10.99 }, "expire_at": { "type": "string", "format": "date", "description": "Data de vencimento", "example": "2023-12-12" }, "customer_id": { "type": "integer", "nullable": true, "description": "ID do Cliente. Quando esse ID é passado, os campos `customer_person_name`, `customer_cnpj_cpf`, `customer_zipcode`, `customer_address`, `customer_city_name`, `customer_state` e `customer_neighborhood` não são obrigatórios.", "example": null }, "customer_person_name": { "type": "string", "maxLength": 120, "description": "Nome do cliente", "example": "João Silva" }, "customer_cnpj_cpf": { "type": "string", "maxLength": 20, "description": "CPF/CNPJ do cliente", "example": "16.974.923/0001-84" }, "customer_state": { "type": "string", "maxLength": 2, "description": "Estado", "example": "SP" }, "customer_city_name": { "type": "string", "maxLength": 60, "description": "Cidade(Nome deve estar correto e completo)", "example": "São Paulo" }, "customer_zipcode": { "type": "string", "maxLength": 8, "description": "CEP (formato 99999999)", "example": "01310100" }, "customer_address": { "type": "string", "maxLength": 255, "description": "Endereço", "example": "Rua F, alamenda G" }, "customer_address_complement": { "type": "string", "maxLength": 120, "description": "Complemento", "example": null }, "customer_address_number": { "type": "string", "maxLength": 10, "description": "Número", "example": null }, "customer_email": { "type": "string", "format": "email", "maxLength": 80, "description": "E-mail do Pagador", "example": null }, "customer_email_cc": { "type": "string", "format": "email", "maxLength": 80, "description": "E-mail alternativo do Pagador", "example": null }, "customer_neighborhood": { "type": "string", "maxLength": 80, "description": "Bairro", "example": "Centro" }, "customer_phone_number": { "type": "string", "maxLength": 15, "description": "Telefone (com DDD, DDI é opcional)", "example": null }, "customer_ignore_email": { "type": "boolean", "nullable": true, "description": "Nunca enviar e-mail para este cliente", "example": null }, "customer_ignore_sms": { "type": "boolean", "nullable": true, "description": "Nunca enviar SMS para este cliente", "example": null }, "customer_mobile_local_code": { "type": "string", "nullable": true, "maxLength": 2, "description": "DDD do Celular", "example": null }, "customer_mobile_number": { "type": "string", "nullable": true, "maxLength": 9, "description": "Celular", "example": null }, "customer_nickname": { "type": "string", "nullable": true, "maxLength": 255, "description": "Apelido ou Nome Fantasia do Pagador", "example": null }, "customer_notes": { "type": "string", "nullable": true, "description": "Observações do Pagador", "example": null }, "customer_contact_person": { "type": "string", "nullable": true, "maxLength": 120, "description": "Contato", "example": null }, "interest_type": { "type": "integer", "nullable": true, "description": "Tipo de juros/mora:\n* `0` Inexistente (Padrão)\n* `1` Para porcentagem diária\n* `2` Para valor diário\n* `7` Para porcentagem mensal - Bancos suportados: Bradesco, BB, BTG, Caixa, Inter, Itaú, Safra, Santander, Sicoob e Sicredi", "enum": [ 0, 1, 2, 7 ], "default": 0 }, "days_for_interest": { "type": "integer", "nullable": true, "description": "Quantidade de dias após o vencimento que a mora começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento).", "example": null }, "interest_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Porcentagem de juros. De 0.0 a 100.0 (Ex 1.5% = 1.5) Obrigatório se interest_type é igual a 1 ou 7. Até 2 casas decimais.", "example": null }, "interest_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor diário de juros (R$). Obrigatório se interest_type é igual a 2. Até 2 casas decimais.", "example": null }, "interest_days_type": { "type": "integer", "nullable": true, "description": "Tipo de Dias para juros:\n* `0` Corridos\n* `1` Úteis", "enum": [ 0, 1 ], "default": 0 }, "fine_type": { "type": "integer", "nullable": true, "description": "Tipo de multa:\n* `0` Inexistente (Padrão)\n* `1` Para percentual do valor do boleto\n* `2` Para valor fixo", "enum": [ 0, 1, 2 ], "default": 0 }, "days_for_fine": { "type": "integer", "nullable": true, "description": "Quantidade de dias após o vencimento que a multa começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento).", "example": null }, "fine_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Porcentagem de Multa por Atraso Ex: 2% x R$ 250,00 = R$ 5,00. Obrigatória se fine_type é igual a 1. Até 2 casas decimais.", "example": null }, "fine_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor da multa (R$). Obrigatório se fine_type é igual a 2. Até 2 casas decimais.", "example": null }, "discount_type": { "type": "integer", "nullable": true, "description": "Tipo de desconto:\nO tipo de desconto será o mesmo para todos os três descontos, caso existam. :\n* `0` Inexistente (Padrão)\n* `1` Para valor fixo\n* `2` Para percentual do valor do boleto", "enum": [ 0, 1, 2 ], "default": 0 }, "days_for_discount": { "type": "integer", "nullable": true, "description": "Dias para desconto. Obrigatório se discount_type é diferente de 0(zero)", "example": null }, "discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao desconto. Obrigatório se discount_type é igual a 2", "example": null }, "discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do desconto (R$). Obrigatório se discount_type é igual a 1.", "example": null }, "days_for_second_discount": { "type": "integer", "nullable": true, "description": "Dias para segundo desconto.", "example": null }, "second_discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao segundo desconto.", "example": null }, "second_discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do segundo desconto (R$).", "example": null }, "days_for_third_discount": { "type": "integer", "nullable": true, "description": "Dias para terceiro desconto.", "example": null }, "third_discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao terceiro desconto.", "example": null }, "third_discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do terceiro desconto (R$).", "example": null }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas ao boleto", "example": null, "items": { "type": "string" } }, "tag_list": { "type": "string", "nullable": true, "readOnly": true, "description": "Tags associadas ao boleto" }, "charge_type": { "type": "integer", "nullable": true, "description": "Tipo de Cobrança:\n* `1` Simples\n* `2` Vinculada\n* `3` Descontada\n* `4` Vendor", "enum": [ 1, 2, 3, 4 ], "default": 1 }, "dispatch_type": { "type": "integer", "nullable": true, "description": "Tipo de Cobrança:\nQuando o boleto precisa ser enviado pelo correio. É preciso contratar o serviço junto ao banco e pagará tarifa.\n* `1` Cliente\n* `2` Banco", "enum": [ 1, 2 ], "default": 1 }, "guarantor_name": { "type": "string", "nullable": true, "maxLength": 100, "description": "Nome do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_cnpj_cpf": { "type": "string", "nullable": true, "maxLength": 20, "description": "CNPJ/CPF do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_address_number": { "type": "string", "nullable": true, "maxLength": 10, "description": "Número do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_neighborhood": { "type": "string", "nullable": true, "maxLength": 80, "description": "Bairro do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_phone_number": { "type": "string", "nullable": true, "maxLength": 11, "description": "Telefone (com DDD) do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_city_name": { "type": "string", "nullable": true, "maxLength": 60, "description": "Cidade(Nome deve estar correto e completo) do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_state": { "type": "string", "nullable": true, "maxLength": 2, "description": "Estado do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_zipcode": { "type": "string", "nullable": true, "maxLength": 8, "description": "CEP (formato 99999999) do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_address": { "type": "string", "nullable": true, "maxLength": 255, "description": "Endereço do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_address_complement": { "type": "string", "nullable": true, "maxLength": 60, "description": "Complemento do Beneficiário final (Sacador/Avalista)", "example": null }, "description": { "type": "string", "nullable": true, "description": "Descrição do produto ou serviço", "example": null }, "instructions": { "type": "string", "nullable": true, "description": "Instruções para o Caixa", "example": null }, "document_date": { "type": "string", "format": "date", "nullable": true, "description": "Data do Documento", "example": null }, "document_type": { "type": "string", "maxLength": 2, "description": "Tipo de Documento:\n\n* `Código` | `Sigla` | Descrição\n* `01` | `CH` | Cheque\n* `02` | `DM` | Duplicata Mercantil (Padrão)\n* `03` | `DMI` | Duplicata Mercantil p/ Indicação\n* `04` | `DS` | Duplicata de Serviço\n* `05` | `DSI` | Duplicata de Serviço p/ Indicação\n* `06` | `DR` | Duplicata Rural\n* `07` | `LC` | Letra de Câmbio\n* `08` | `NCC` | Nota de Crédito Comercial\n* `09` | `NCE` | Nota de Crédito a Exportação\n* `10` | `NCI` | Nota de Crédito Industrial\n* `11` | `NCR` | Nota de Crédito Rural\n* `12` | `NP` | Nota Promissória\n* `13` | `NPR` | Nota Promissória Rural\n* `14` | `TM` | Triplicata Mercantil\n* `15` | `TS` | Triplicata de Serviço\n* `16` | `NS` | Nota de Seguro\n* `17` | `RC` | Recibo\n* `18` | `FAT` | Fatura\n* `19` | `ND` | Nota de Débito\n* `20` | `AP` | Apólice de Seguro\n* `21` | `ME` | Mensalidade Escolar\n* `22` | `PC` | Parcela de Consórcio\n* `23` | `NF` | Nota Fiscal\n* `24` | `DD` | Documento de Dívida\n* `25` | `CPR` | Cédula de Produto Rural\n* `26` | `CTR` | Contrato\n* `27` | `CSG` | Cosseguros\n* `28` | `EC` | Encargos Condominiais\n* `29` | `CPS` | Conta de Prestação de Serviços\n* `30` | `WR` | Warrant\n* `31` | `DP` | Duplicata Prestação\n* `32` | `CSR` | Cobrança Seriada\n* `33` | `CAR` | Carnê\n* `34` | `ARE` | Apólice Ramos Elementares\n* `35` | `CC` | Cartão de Crédito\n* `36` | `BDP` | Boleto de Proposta\n* `37` | `NPD` | Nota Promissória Direta\n* `38` | `DAE` | Dívida Ativa de Estado\n* `39` | `DAM` | Divida Ativa de Município\n* `40` | `DAU` | Dívida Ativa União\n* `41` | `CCB` | Célula de Crédito Bancário\n* `42` | `FI` | Financiamento\n* `43` | `RD` | Rateio de Despesas\n* `44` | `DRI` | Duplicata Rural p/ Indicação\n* `45` | `ECI` | Encargos Condominiais p/ Indicação\n* `99` | `Outros` | Outros\n ", "default": "02", "enum": [ "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "99" ] }, "document_type_label": { "type": "string", "nullable": true, "readOnly": true, "description": "Tipo de Documento (Sigla)" }, "document_number": { "type": "string", "nullable": true, "example": null, "description": "Número do Documento, Tamanho depende do banco e formato do arquivo Remessa:\n * Banco |\tFormato| Tamanho |\n * Abc |`Cnab240`|\t15\t|\n * Ailos |`Cnab240`|\t15 |\n * Arbi |`Cnab240`|\t15\t|\n * Banese |`Cnab240`|\t15\t|\n * Banestes |`Cnab400`|\t10\t|\n * Banrisul |`Cnab240`|\t15\t|\n * Banrisul |`Cnab400`|\t10\t|\n * Bb |`Cnab240`|\t15\t|\n * Bb |`Cnab400`|\t10\t|\n * Bib |`Cnab240`|\t15\t|\n * Bnb |`Cnab400`|\t10\t|\n * Bnpparibas |`Cnab400`|\t10\t|\n * Bradesco |`Cnab240`|\t15\t|\n * Bradesco |`Cnab400`|\t10\t|\n * Brb |`Cnab400`|\t10\t|\n * Caixa |`Cnab240`|\t11\t|\n * Caixa |`Cnab400`|\t10\t|\n * Caruana |`Cnab400`|\t10\t|\n * Citibank |`Cnab400`|\t10\t|\n * Credisis |`Cnab240`|\t15\t|\n * Cresol |`Cnab240`|\t10\t|\n * Cresol |`Cnab400`|\t10\t|\n * Cresol Bradesco |`Cnab240`|\t15\t|\n * Cresol Bradesco |`Cnab400`|\t10\t|\n * Daycoval |`Cnab400`|\t10\t|\n * Itau |`Cnab240`|\t10\t|\n * Itau |`Cnab400`|\t10\t|\n * Mercantil |`Cnab240`|\t10\t|\n * Moneyplus |`Cnab240`|\t10\t|\n * Rendimento |`Cnab400`|\t10\t|\n * Safra |`Cnab400`|\t102\t|\n * Santander |`Cnab240`|\t15\t|\n * Santander |`Cnab400`|\t10\t|\n * Semear |`Cnab400`|\t10\t|\n * Sicoob |`Cnab240`|\t15\t|\n * Sicoob |`Cnab400`|\t10\t|\n * Sicredi |`Cnab240`|\t15\t|\n * Sicredi |`Cnab400`|\t10\t|\n * Sofisa |`Cnab240`|\t15\t|\n * Unicred |`Cnab240`|\t15\t|\n * Uniprime |`Cnab400`|\t10\t|\n * Uniprime99 |`Cnab400`|\t10\t|\n * Santander |`Cnab400`|\t10 " }, "acceptance": { "type": "string", "description": "Aceite:\n* `N` Não (Padrão)\n* `S` Sim", "default": "N", "enum": [ "N", "S" ] }, "our_number": { "type": "string", "nullable": true, "description": "Nosso Número. Se não informado, usará o Próximo Nosso Número da Carteira de Cobrança.", "example": null }, "processed_our_number": { "type": "string", "readOnly": true, "nullable": true, "description": "Nosso Número calculado com DV (formatado)" }, "processed_our_number_raw": { "type": "string", "readOnly": true, "nullable": true, "description": "Nosso Número calculado com DV (limpo)" }, "paid_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor pago", "example": null }, "paid_at": { "type": "string", "format": "date", "nullable": true, "description": "Data do pagamento", "example": null }, "days_for_revoke": { "type": "integer", "nullable": true, "description": "Dias corridos para Baixa/Devolução:\n\n Nulo/Branco: Obedece ao padrão do banco.\n 0: Baixa/Devolução no mesmo dia do vencimento.\n 1 ou mais: Baixa/Devolução após o vencimento(Vencimento + X dias corridos).\n ", "example": null }, "credit_bureau": { "type": "integer", "nullable": true, "example": null, "enum": [ null, 0, 1, 2 ], "description": "Birô de Crédito/Órgão Negativador.\n\n`0`: Serasa.\n`1`: Quod.\n`2`: SPC\n\nOpções disponíveis para cada banco suportado:\n\n* Banco do Brasil: Serasa e Quod.\n" }, "days_for_negativation": { "type": "integer", "nullable": true, "example": null, "description": "Dias corridos para Negativação:\n\nDisponível apenas para os seguintes bancos e formatos.\n\n* Banco |\tCNAB 240|\tCNAB 400 |Webservice\n* Bradesco |\tSim |\tSim\t| Não\n* Itaú | Não | Sim | Não\n " }, "days_for_sue_type": { "type": "integer", "nullable": true, "description": "Tipo de dias para protesto:\n * `0` Corridos\n * `1` Úteis", "enum": [ null, 0, 1 ], "example": null }, "days_for_sue": { "type": "integer", "nullable": true, "description": "Dias corridos para Protesto", "example": null }, "sue_history": { "type": "array", "readOnly": true, "description": "Histórico de eventos de protesto do boleto", "items": { "type": "object", "properties": { "status": { "type": "string", "description": "Status do evento de protesto:\n* `order_issued` - Emissão da ordem de protesto\n* `order_generated` - Geração da ordem de protesto\n* `registry_sent` - Envio para o cartório\n* `protested` - Protesto efetivado\n* `order_cancelled` - Cancelamento da ordem de protesto\n* `withdrawal_requested` - Solicitação de retirada do registro\n* `registry_withdrawn` - Retirada do registro (baixa no cartório)\n* `registry_withdrawal_dispatched` - Envio da retirada do registro\n* `suspended` - Suspensão do protesto\n* `cancellation_requested` - Solicitação de cancelamento do protesto\n* `cancellation_released` - Liberação do cancelamento\n* `cancellation_sent` - Envio do cancelamento ao cartório\n* `cancelled` - Protesto cancelado", "enum": [ "order_issued", "order_generated", "registry_sent", "protested", "order_cancelled", "withdrawal_requested", "registry_withdrawn", "registry_withdrawal_dispatched", "suspended", "cancellation_requested", "cancellation_released", "cancellation_sent", "cancelled" ] }, "occurred_at": { "type": "string", "format": "date-time", "description": "Data e hora do evento" } } } }, "sue_code": { "type": "string", "maxLength": 2, "nullable": true, "description": "Código de Protesto(CNAB 240). Consulte os possíveis valores para cada banco.", "example": null }, "revoke_code": { "type": "string", "nullable": true, "description": "Código de Baixa(CNAB 240). Consulte os possíveis valores para cada banco.", "example": null }, "first_instruction": { "type": "string", "maxLength": 2, "nullable": true, "description": "Primeira Instrução(CNAB 400). Consulte os possíveis valores para cada banco.", "example": null }, "second_instruction": { "type": "string", "maxLength": 2, "nullable": true, "description": "Segunda Instrução(CNAB 400). Consulte os possíveis valores para cada banco.", "example": null }, "watermark": { "type": "boolean", "description": "Endereço", "example": null }, "payment_count": { "type": "integer", "nullable": true, "description": "Quantidade de pagamentos parciais aceitos para este boleto." }, "divergent_payment_type": { "type": "integer", "nullable": true, "example": null, "description": "Tipo de pagamento divergente:\nVálido apenas para Itaú e Caixa.\n* `1` Aceita qualquer valor divergente\n* `2` Aceita pagamentos dentro de uma faixa de valores ou percentuais\n* `3` Não aceita pagamento de valores divergentes\n* `4` Aceita pagamentos de valores superiores a um valor ou percentual mínimo", "enum": [ null, 1, 2, 3, 4 ] }, "divergent_payment_value_type": { "type": "integer", "nullable": true, "example": null, "description": "Tipo de valor a considerar para os limites de pagamentos:\nVálido apenas para Itaú e Caixa.\n* `1` Informa pagamentos divergentes por valores\n* `2` Informa pagamentos divergentes por percentuais", "enum": [ null, 1, 2 ] }, "divergent_payment_maximum_value": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Valor máximo para a faixa de pagamentos divergentes. " }, "divergent_payment_minimum_value": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Valor mínimo para a faixa de pagamentos divergentes. " }, "divergent_payment_maximum_percentage": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Percentual máximo para a faixa de pagamentos divergentes. " }, "divergent_payment_minimum_percentage": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Percentual mínimo para a faixa de pagamentos divergentes." }, "divergent_payment_limit": { "type": "integer", "nullable": true, "example": null, "description": "Quantidade de pagamentos permitida. Obrigatório se informados dados para pagamento divergente. Usado somente pela Caixa." }, "prevent_registration": { "type": "boolean", "nullable": true, "example": null, "description": "Impedir envio de registro ao banco:\n\nCaso `true`, impede que o boleto seja registrado. Para ser usado nos casos em que o boleto já foi registrado fora da KOBANA mas deseja-se incluí-lo no sistema." }, "issued_at": { "type": "string", "format": "date-time", "nullable": true, "example": null, "description": "Data de emissão do boleto. Aceito somente quando `prevent_registration: true`." }, "control_number": { "type": "string", "nullable": true, "maxLength": 25, "example": null, "description": "Número de controle:\n\nPode conter qualquer informação de interesse da Empresa. A informação contida neste campo sempre retornará com o respectivo título no arquivo-retorno." }, "ignore_email": { "type": "boolean", "default": false, "nullable": true, "example": null, "description": "Não enviar este boleto por email" }, "ignore_sms": { "type": "boolean", "default": false, "nullable": true, "description": "Nunca enviar este boleto por SMS", "example": null }, "ignore_whatsapp": { "type": "boolean", "default": false, "nullable": true, "description": "Nunca enviar este boleto por WhatsApp", "example": null }, "addons": { "type": "string", "format": "jsonb", "nullable": true, "example": null, "description": "Endereço" }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "meta": { "type": "object", "deprecated": true, "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "notes": { "type": "string", "nullable": true, "example": null, "description": "Observações" }, "custom_attachment_name": { "type": "string", "nullable": true, "example": null, "description": "Nome para ser usado nos arquivos de boleto enviados para o cliente em notificações. Aceita uso de variáveis. Caso seja deixado vazio, o padrão é a palavra “boleto” acompanhada do ID." }, "split_payment": { "type": "boolean", "nullable": true, "example": null, "description": "Split de Pagamento.\nVálido apenas para ABC Brasil, Bradesco e Itaú.\nCaso true, o rateio do boleto será registrado.\nInformar as contas para rateio em `split_accounts`.\nPara o Itaú, é necessário informar o tipo de split de pagamento em `split_payment_type`" }, "split_payment_type": { "type": "integer", "nullable": true, "example": null, "description": "Tipo de Split de Pagamento:\nVálido apenas para Itau. Usado apenas com Split de Pagamento true.\n* `1` Rateio de crédito por percentual (%) – Valor nominal do título\n* `2` Rateio de crédito em valor (R$) – Valor nominal do título\n* `3` Rateio de crédito por percentual (%) – Valor líquido recebido\n* `4` Rateio de crédito em valor (R$) – Valor líquido recebido, rateado proporcionalmente", "enum": [ 1, 2, 3, 4 ] }, "split_accounts": { "type": "array", "nullable": true, "example": null, "description": "Contas para Split de pagamento.", "items": { "$ref": "#/components/schemas/v1_split_accounts_object" } }, "payment_place": { "type": "string", "nullable": true, "maxLength": 100, "example": null, "description": "Local de Pagamento" }, "installment_id": { "type": "integer", "nullable": true, "readOnly": true, "description": "ID do Carnê" }, "installment_number": { "type": "integer", "nullable": true, "description": "Número da parcela do carnê" }, "installment_total": { "type": "integer", "nullable": true, "readOnly": true, "description": "Total de parcelas do carnê" }, "customer_subscription_id": { "type": "integer", "nullable": true, "readOnly": true, "description": "ID da Assinatura" }, "beneficiary_name": { "type": "string", "readOnly": true, "description": "Nome do Beneficiário" }, "beneficiary_cnpj_cpf": { "type": "string", "readOnly": true, "description": "CNPJ/CPF do Beneficiário" }, "beneficiary_address": { "type": "string", "readOnly": true, "description": "Endereço do Beneficiário" }, "beneficiary_assignor_code": { "type": "string", "nullable": true, "readOnly": true, "description": "Agência/Código do Beneficiário" }, "bank_contract_slug": { "type": "string", "nullable": true, "readOnly": true, "description": "Slug da Carteira" }, "agency_number": { "type": "string", "readOnly": true, "description": "Agência" }, "agency_digit": { "type": "string", "readOnly": true, "description": "Dígito da Agência" }, "account_number": { "type": "string", "readOnly": true, "description": "Conta" }, "account_digit": { "type": "string", "readOnly": true, "description": "Dígito da Conta" }, "extra1": { "type": "string", "readOnly": true, "description": "Campo extra 1" }, "extra1_digit": { "type": "string", "nullable": true, "readOnly": true, "description": "Digito do Campo extra 1" }, "extra2": { "type": "string", "nullable": true, "readOnly": true, "description": "Campo extra 2" }, "extra2_digit": { "type": "string", "nullable": true, "readOnly": true, "description": "Dígito do Campo extra 2" }, "created_via_api": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se o boleto foi criado por API" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do boleto" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do boleto" }, "registration_status": { "type": "string", "readOnly": true, "description": "Situação do registro no banco:\n* `pending` Pendente\n* `skipped` Ignorado\n* `requested` Requisitado\n* `confirmed` Confirmado\n* `rejected` Rejeitado (ainda será tentado novamente)\n* `failed` Falha (não será tentado novamente)", "enum": [ "pending", "skipped", "requested", "confirmed", "rejected", "failed" ] }, "registered_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora do registro (quando confirmado)" }, "register_type": { "type": "integer", "readOnly": true, "description": "Tipo de Registro:\n* `1` API\n* `2` Banco", "enum": [ 1, 2 ] }, "cancel_type": { "type": "integer", "readOnly": true, "nullable": true, "description": "Tipo de Cancelamento:\n * `1` Cliente\n * `2` Banco", "enum": [ null, 1, 2 ] }, "cancellation_reason": { "type": "integer", "readOnly": false, "nullable": true, "description": "Motivo de Cancelamento:\n* `1` Outro\n* `2` Fraude\n* `3` Óbito\n* `4` Erro operacional\n* `5` Quitação paga", "enum": [ null, 1, 2, 3, 4, 5 ] }, "line": { "type": "string", "nullable": true, "readOnly": true, "description": "Linha Digitável" }, "barcode": { "type": "string", "nullable": true, "readOnly": true, "description": "Código de Barras" }, "shorten_url": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true, "description": "URL para visualização do boleto" }, "url": { "type": "string", "nullable": true, "readOnly": true, "description": "URL para visualização do boleto" }, "carne_url": { "type": "string", "nullable": true, "readOnly": true, "description": "URL para visualização do carnê(Quando for parcela)" }, "formats": { "type": "object", "nullable": true, "readOnly": true, "description": "URLs com formatos disponíveis. Ex.: PDF, Imagem, Pix e etc" }, "pix_enabled": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se o boleto é híbrido e tem QRcode Pix" }, "pix_qrcode": { "type": "string", "nullable": true, "readOnly": true, "description": "QRcode Pix do boleto híbrido" }, "pix_txid": { "type": "string", "nullable": true, "description": "Campo txid do Pix. Gerado automaticamente por default caso não fornecido." }, "prevent_pix": { "type": "boolean", "nullable": true, "default": false, "description": "Caso verdadeiro, impede a criação do Pix para carteiras com Pix habilitado. Não é considerado se a carteira não tem Pix habilitado." }, "status": { "type": "string", "readOnly": true, "description": "Situação do boleto:\n* `generating` Gerando\n* `draft` Rascunho\n* `generation_failed` Falha ao gerar\n* `opened` Aberto\n* `canceled` Cancelado\n* `paid` Pago\n* `overdue` Vencido\n* `validation_failed` Inválido\n* `chargeback` Estornado", "enum": [ "generating", "draft", "generation_failed", "validation_failed", "opened", "canceled", "paid", "overdue", "blocked", "chargeback" ] }, "recipient_account": { "type": "string", "nullable": true, "maxLength": 10, "description": "Conta Destinatária + Dígito" }, "reduction_type": { "type": "integer", "nullable": true, "example": null, "enum": [ 1, 2, 3 ], "description": "Tipo de abatimento:\n\n`1`: Valor.\n`2`: Porcentagem.\n`3`: Sem abatimento\n" }, "reduction_amount": { "type": "number", "nullable": true, "format": "float", "description": "Valor do abatimento. Obrigatório se reduction_type é igual a 1.", "example": 30.25 }, "reduction_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Porcentagem de Abatimento. Ex: 2% x R$ 250,00 = R$ 5,00. Obrigatória se reduction_type é igual a 2. Até 2 casas decimais.", "example": null }, "instructions_mode": { "type": "integer", "nullable": true, "readOnly": false, "description": "Cálculo de datas na Instrução para o Caixa:\n* `0` Não preencher as instruções para o caixa\n* `1` Calcular data pela via de registro (API/CNAB)\n* `2` Usar a data configurada no boleto", "enum": [ 0, 1, 2 ], "default": 1 }, "import_id": { "type": "integer", "nullable": true, "readOnly": true, "description": "ID da Importação" }, "virtual_bank_billet_id": { "type": "integer", "nullable": true, "description": "ID do Boleto gerado por membro de contrato BackOffice. (BackOffice precisa estar habilitado).", "example": null }, "external_id": { "type": "string", "nullable": true, "description": "ID do boleto no sistema do cliente. Opcional para controle e busca interna." }, "financial_provider_external_id": { "type": "string", "nullable": true, "description": "ID na instituição financeira" }, "after_create": { "type": "array", "nullable": true, "description": "Execução automática de comandos após o boleto ser criado.\n Valores permitidos:\n * `sync`: Sincronização com o provedor financeiro.", "example": null, "items": { "type": "string" } } } }, "v1_bank_billet_duplicate_object": { "type": "object", "properties": { "expire_at_in_days": { "type": "integer", "description": "Nº de dias para vencimento a partir da data de hoje. Default: 7", "example": null }, "amount": { "type": "number", "format": "float", "description": "Valor do novo Boleto", "example": 10.99 }, "cancel": { "type": "boolean", "nullable": true, "description": "Cancelar o boleto que está sendo duplicado. Default: true", "example": null }, "with_fines": { "type": "boolean", "nullable": true, "description": "Atualizar o valor do novo boleto com juros e multa. Default: false", "example": null }, "bank_billet_account_id": { "type": "integer", "description": "ID da Carteira de Cobrança. Se não informado, usará a carteira padrão.", "example": null }, "bank_billet_layout_id": { "type": "integer", "nullable": true, "description": "ID do Modelo de Boleto", "example": null }, "customer_id": { "type": "integer", "nullable": true, "description": "ID do Cliente. Quando esse ID é passado, os campos `customer_person_name`, `customer_cnpj_cpf`, `customer_zipcode`, `customer_address`, `customer_city_name`, `customer_state` e `customer_neighborhood` não são obrigatórios.", "example": null }, "customer_person_name": { "type": "string", "maxLength": 120, "description": "Nome do cliente", "example": "João Silva" }, "customer_cnpj_cpf": { "type": "string", "maxLength": 20, "description": "CPF/CNPJ do cliente", "example": "16.974.923/0001-84" }, "customer_state": { "type": "string", "maxLength": 2, "description": "Estado", "example": "SP" }, "customer_city_name": { "type": "string", "maxLength": 60, "description": "Cidade(Nome deve estar correto e completo)", "example": "São Paulo" }, "customer_zipcode": { "type": "string", "maxLength": 8, "description": "CEP (formato 99999999)", "example": "01310100" }, "customer_address": { "type": "string", "maxLength": 255, "description": "Endereço", "example": "Rua F, alamenda G" }, "customer_address_complement": { "type": "string", "maxLength": 120, "description": "Complemento", "example": null }, "customer_address_number": { "type": "string", "maxLength": 10, "description": "Número", "example": null }, "customer_email": { "type": "string", "format": "email", "maxLength": 80, "description": "E-mail do Pagador", "example": null }, "customer_email_cc": { "type": "string", "format": "email", "maxLength": 80, "description": "E-mail alternativo do Pagador", "example": null }, "customer_neighborhood": { "type": "string", "maxLength": 80, "description": "Bairro", "example": "Centro" }, "customer_phone_number": { "type": "string", "maxLength": 15, "description": "Telefone (com DDD, DDI é opcional)", "example": null }, "customer_ignore_email": { "type": "boolean", "nullable": true, "description": "Nunca enviar e-mail para este cliente", "example": null }, "customer_ignore_sms": { "type": "boolean", "nullable": true, "description": "Nunca enviar SMS para este cliente", "example": null }, "customer_mobile_local_code": { "type": "string", "nullable": true, "maxLength": 2, "description": "DDD do Celular", "example": null }, "customer_mobile_number": { "type": "string", "nullable": true, "maxLength": 9, "description": "Celular", "example": null }, "customer_nickname": { "type": "string", "nullable": true, "maxLength": 255, "description": "Apelido ou Nome Fantasia do Pagador", "example": null }, "customer_notes": { "type": "string", "nullable": true, "description": "Observações do Pagador", "example": null }, "customer_contact_person": { "type": "string", "nullable": true, "maxLength": 120, "description": "Contato", "example": null }, "interest_type": { "type": "integer", "nullable": true, "description": "Tipo de juros/mora:\n* `0` Inexistente (Padrão)\n* `1` Para porcentagem diária\n* `2` Para valor diário", "enum": [ 0, 1, 2 ], "default": 0 }, "days_for_interest": { "type": "integer", "nullable": true, "description": "Quantidade de dias após o vencimento que a mora começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento).", "example": null }, "interest_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Porcentagem diária de juros. De 0.0 a 100.0 (Ex 1.5% = 1.5) Obrigatório se interest_type é igual a 1.", "example": null }, "interest_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor diário de juros (R$). Obrigatório se interest_type é igual a 2.", "example": null }, "interest_days_type": { "type": "integer", "nullable": true, "description": "Tipo de Dias para juros:\n* `0` Corridos\n* `1` Úteis", "enum": [ 0, 1 ], "default": 0 }, "fine_type": { "type": "integer", "nullable": true, "description": "Tipo de multa:\n* `0` Inexistente (Padrão)\n* `1` Para percentual do valor do boleto\n* `2` Para valor fixo", "enum": [ 0, 1, 2 ], "default": 0 }, "days_for_fine": { "type": "integer", "nullable": true, "description": "Quantidade de dias após o vencimento que a multa começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento).", "example": null }, "fine_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Porcentagem de Multa por Atraso Ex: 2% x R$ 250,00 = R$ 5,00. Obrigatória se fine_type é igual a 1", "example": null }, "fine_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor da multa (R$). Obrigatório se fine_type é igual a 2.", "example": null }, "discount_type": { "type": "integer", "nullable": true, "description": "Tipo de desconto:\nO tipo de desconto será o mesmo para todos os três descontos, caso existam. :\n* `0` Inexistente (Padrão)\n* `1` Para valor fixo\n* `2` Para percentual do valor do boleto", "enum": [ 0, 1, 2 ], "default": 0 }, "days_for_discount": { "type": "integer", "nullable": true, "description": "Dias para desconto. Obrigatório se discount_type é diferente de 0(zero)", "example": null }, "discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao desconto. Obrigatório se discount_type é igual a 2", "example": null }, "discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do desconto (R$). Obrigatório se discount_type é igual a 1.", "example": null }, "days_for_second_discount": { "type": "integer", "nullable": true, "description": "Dias para segundo desconto.", "example": null }, "second_discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao segundo desconto.", "example": null }, "second_discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do segundo desconto (R$).", "example": null }, "days_for_third_discount": { "type": "integer", "nullable": true, "description": "Dias para terceiro desconto.", "example": null }, "third_discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao terceiro desconto.", "example": null }, "third_discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do terceiro desconto (R$).", "example": null }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas ao boleto", "example": null, "items": { "type": "string" } }, "tag_list": { "type": "string", "nullable": true, "readOnly": true, "description": "Tags associadas ao boleto" }, "charge_type": { "type": "integer", "nullable": true, "description": "Tipo de Cobrança:\n* `1` Simples\n* `2` Vinculada\n* `3` Descontada\n* `4` Vendor", "enum": [ 1, 2, 3, 4 ], "default": 1 }, "dispatch_type": { "type": "integer", "nullable": true, "description": "Tipo de Cobrança:\nQuando o boleto precisa ser enviado pelo correio. É preciso contratar o serviço junto ao banco e pagará tarifa.\n* `1` Cliente\n* `2` Banco", "enum": [ 1, 2 ], "default": 1 }, "guarantor_name": { "type": "string", "nullable": true, "maxLength": 100, "description": "Nome do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_cnpj_cpf": { "type": "string", "nullable": true, "maxLength": 20, "description": "CNPJ/CPF do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_address_number": { "type": "string", "nullable": true, "maxLength": 10, "description": "Número do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_neighborhood": { "type": "string", "nullable": true, "maxLength": 80, "description": "Bairro do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_phone_number": { "type": "string", "nullable": true, "maxLength": 11, "description": "Telefone (com DDD) do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_city_name": { "type": "string", "nullable": true, "maxLength": 60, "description": "Cidade(Nome deve estar correto e completo) do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_state": { "type": "string", "nullable": true, "maxLength": 2, "description": "Estado do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_zipcode": { "type": "string", "nullable": true, "maxLength": 8, "description": "CEP (formato 99999999) do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_address": { "type": "string", "nullable": true, "maxLength": 255, "description": "Endereço do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_address_complement": { "type": "string", "nullable": true, "maxLength": 60, "description": "Complemento do Beneficiário final (Sacador/Avalista)", "example": null }, "description": { "type": "string", "nullable": true, "description": "Descrição do produto ou serviço", "example": null }, "instructions": { "type": "string", "nullable": true, "description": "Instruções para o Caixa", "example": null }, "document_date": { "type": "string", "format": "date", "nullable": true, "description": "Data do Documento", "example": null }, "document_type": { "type": "string", "description": "Tipo de Documento:\n\n* `Código` | `Sigla` | Descrição\n* `01` | `CH` | Cheque\n* `02` | `DM` | Duplicata Mercantil (Padrão)\n* `03` | `DMI` | Duplicata Mercantil p/ Indicação\n* `04` | `DS` | Duplicata de Serviço\n* `05` | `DSI` | Duplicata de Serviço p/ Indicação\n* `06` | `DR` | Duplicata Rural\n* `07` | `LC` | Letra de Câmbio\n* `08` | `NCC` | Nota de Crédito Comercial\n* `09` | `NCE` | Nota de Crédito a Exportação\n* `10` | `NCI` | Nota de Crédito Industrial\n* `11` | `NCR` | Nota de Crédito Rural\n* `12` | `NP` | Nota Promissória\n* `13` | `NPR` | Nota Promissória Rural\n* `14` | `TM` | Triplicata Mercantil\n* `15` | `TS` | Triplicata de Serviço\n* `16` | `NS` | Nota de Seguro\n* `17` | `RC` | Recibo\n* `18` | `FAT` | Fatura\n* `19` | `ND` | Nota de Débito\n* `20` | `AP` | Apólice de Seguro\n* `21` | `ME` | Mensalidade Escolar\n* `22` | `PC` | Parcela de Consórcio\n* `23` | `NF` | Nota Fiscal\n* `24` | `DD` | Documento de Dívida\n* `25` | `CPR` | Cédula de Produto Rural\n* `26` | `CTR` | Contrato\n* `27` | `CSG` | Cosseguros\n* `28` | `EC` | Encargos Condominiais\n* `29` | `CPS` | Conta de Prestação de Serviços\n* `30` | `WR` | Warrant\n* `31` | `DP` | Duplicata Prestação\n* `32` | `CSR` | Cobrança Seriada\n* `33` | `CAR` | Carnê\n* `34` | `ARE` | Apólice Ramos Elementares\n* `35` | `CC` | Cartão de Crédito\n* `36` | `BDP` | Boleto de Proposta\n* `37` | `NPD` | Nota Promissória Direta\n* `38` | `DAE` | Dívida Ativa de Estado\n* `39` | `DAM` | Divida Ativa de Município\n* `40` | `DAU` | Dívida Ativa União\n* `41` | `CCB` | Célula de Crédito Bancário\n* `42` | `FI` | Financiamento\n* `43` | `RD` | Rateio de Despesas\n* `44` | `DRI` | Duplicata Rural p/ Indicação\n* `45` | `ECI` | Encargos Condominiais p/ Indicação\n* `99` | `Outros` | Outros\n ", "default": "02", "enum": [ "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "99" ] }, "document_type_label": { "type": "string", "nullable": true, "readOnly": true, "description": "Tipo de Documento (Sigla)" }, "document_number": { "type": "string", "nullable": true, "description": "Número do Documento", "example": null }, "acceptance": { "type": "string", "description": "Aceite:\n* `N` Não (Padrão)\n* `S` Sim", "default": "N", "enum": [ "N", "S" ] }, "our_number": { "type": "string", "nullable": true, "description": "Nosso Número. Se não informado, usará o Próximo Nosso Número da Carteira de Cobrança.", "example": null }, "processed_our_number": { "type": "string", "readOnly": true, "nullable": true, "description": "Nosso Número calculado com DV (formatado)" }, "processed_our_number_raw": { "type": "string", "readOnly": true, "nullable": true, "description": "Nosso Número calculado com DV (limpo)" }, "paid_amount": { "type": "number", "format": "float", "description": "Valor pago", "example": null }, "paid_at": { "type": "string", "format": "date", "nullable": true, "description": "Data do pagamento", "example": null }, "days_for_revoke": { "type": "integer", "nullable": true, "description": "Dias corridos para Baixa/Devolução:\n\n Nulo/Branco: Obedece ao padrão do banco.\n 0: Baixa/Devolução no mesmo dia do vencimento.\n 1 ou mais: Baixa/Devolução após o vencimento(Vencimento + X dias corridos).\n ", "example": null }, "days_for_negativation": { "type": "integer", "nullable": true, "example": null, "description": "Dias corridos para Negativação:\n\nDisponível apenas para os seguintes bancos e formatos.\n\n* Banco |\tCNAB 240|\tCNAB 400 |Webservice\n* Bradesco |\tSim |\tSim\t| Não\n* Itaú | Não | Sim | Não\n " }, "days_for_sue_type": { "type": "integer", "nullable": true, "description": "Tipo de dias para protesto:\n * `0` Corridos\n * `1` Úteis", "enum": [ null, 0, 1 ], "example": null }, "days_for_sue": { "type": "integer", "nullable": true, "description": "Dias corridos para Protesto", "example": null }, "sue_code": { "type": "string", "nullable": true, "description": "Código de Protesto(CNAB 240). Consulte os possíveis valores para cada banco.", "example": null }, "revoke_code": { "type": "string", "nullable": true, "description": "Código de Baixa(CNAB 240). Consulte os possíveis valores para cada banco.", "example": null }, "first_instruction": { "type": "string", "nullable": true, "description": "Primeira Instrução(CNAB 400). Consulte os possíveis valores para cada banco.", "example": null }, "second_instruction": { "type": "string", "nullable": true, "description": "Segunda Instrução(CNAB 400). Consulte os possíveis valores para cada banco.", "example": null }, "watermark": { "type": "boolean", "description": "Endereço", "example": null }, "divergent_payment_type": { "type": "integer", "nullable": true, "example": null, "description": "Tipo de pagamento divergente:\nVálido apenas para Itaú e Caixa.\n* `1` Aceita qualquer valor divergente\n* `2` Aceita pagamentos dentro de uma faixa de valores ou percentuais\n* `3` Não aceita pagamento de valores divergentes\n* `4` Aceita pagamentos de valores superiores a um valor ou percentual mínimo", "enum": [ null, 1, 2, 3, 4 ] }, "divergent_payment_value_type": { "type": "integer", "nullable": true, "example": null, "description": "Tipo de valor a considerar para os limites de pagamentos:\nVálido apenas para Itaú e Caixa.\n* `1` Informa pagamentos divergentes por valores\n* `2` Informa pagamentos divergentes por percentuais", "enum": [ null, 1, 2 ] }, "divergent_payment_maximum_value": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Valor mínimo para a faixa de pagamentos divergentes. " }, "divergent_payment_minimum_value": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Valor máximo para a faixa de pagamentos divergentes. " }, "divergent_payment_maximum_percentage": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Percentual mínimo para a faixa de pagamentos divergentes. " }, "divergent_payment_minimum_percentage": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Percentual máximo para a faixa de pagamentos divergentes." }, "divergent_payment_limit": { "type": "integer", "nullable": true, "example": null, "description": "Quantidade de pagamentos permitida. Obrigatório se informados dados para pagamento divergente. Usado somente pela Caixa." }, "prevent_registration": { "type": "boolean", "nullable": true, "example": null, "description": "Impedir envio de registro ao banco:\n\nCaso `true`, impede que o boleto seja registrado. Para ser usado nos casos em que o boleto já foi registrado fora da KOBANA mas deseja-se incluí-lo no sistema." }, "control_number": { "type": "string", "nullable": true, "example": null, "description": "Número de controle:\n\nPode conter qualquer informação de interesse da Empresa. A informação contida neste campo sempre retornará com o respectivo título no arquivo-retorno." }, "ignore_email": { "type": "boolean", "default": false, "nullable": true, "example": null, "description": "Não enviar este boleto por email" }, "ignore_sms": { "type": "boolean", "default": false, "nullable": true, "description": "Nunca enviar este boleto por SMS", "example": null }, "ignore_whatsapp": { "type": "boolean", "default": false, "nullable": true, "description": "Nunca enviar este boleto por WhatsApp", "example": null }, "addons": { "type": "string", "format": "jsonb", "nullable": true, "example": null, "description": "Endereço" }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "meta": { "type": "object", "deprecated": true, "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "notes": { "type": "string", "nullable": true, "example": null, "description": "Observações" }, "custom_attachment_name": { "type": "string", "nullable": true, "example": null, "description": "Nome para ser usado nos arquivos de boleto enviados para o cliente em notificações. Aceita uso de variáveis. Caso seja deixado vazio, o padrão é a palavra “boleto” acompanhada do ID." }, "split_payment": { "type": "boolean", "nullable": true, "example": null, "description": "Split de Pagamento.\nVálido apenas para ABC Brasil (remessa CNAB 240), Itaú e Bradesco (remessa CNAB 400).\nCaso true, o rateio do boleto será registrado.\nInformar as contas para rateio em `split_accounts`" }, "split_payment_type": { "type": "integer", "nullable": true, "example": null, "description": "Tipo de Split de Pagamento:\nVálido apenas para Itau. Usado apenas com Split de Pagamento true.\n* `1` Rateio de crédito por percentual (%) – Valor nominal do título\n* `2` Rateio de crédito em valor (R$) – Valor nominal do título\n* `3` Rateio de crédito por percentual (%) – Valor líquido recebido\n* `4` Rateio de crédito em valor (R$) – Valor líquido recebido, rateado proporcionalmente", "enum": [ 1, 2, 3, 4 ] }, "split_accounts": { "type": "array", "nullable": true, "example": null, "description": "Contas para Split de pagamento.", "items": { "$ref": "#/components/schemas/v1_split_accounts_object" } }, "payment_place": { "type": "string", "nullable": true, "maxLength": 100, "example": null, "description": "Local de Pagamento" }, "installment_id": { "type": "integer", "nullable": true, "readOnly": true, "description": "ID do Carnê" }, "installment_number": { "type": "integer", "nullable": true, "readOnly": true, "description": "Número da parcela do carnê" }, "installment_total": { "type": "integer", "nullable": true, "readOnly": true, "description": "Total de parcelas do carnê" }, "customer_subscription_id": { "type": "integer", "nullable": true, "readOnly": true, "description": "ID da Assinatura" }, "beneficiary_name": { "type": "string", "readOnly": true, "description": "Nome do Beneficiário" }, "beneficiary_cnpj_cpf": { "type": "string", "readOnly": true, "description": "CNPJ/CPF do Beneficiário" }, "beneficiary_address": { "type": "string", "readOnly": true, "description": "Endereço do Beneficiário" }, "beneficiary_assignor_code": { "type": "string", "nullable": true, "readOnly": true, "description": "Agência/Código do Beneficiário" }, "bank_contract_slug": { "type": "string", "nullable": true, "readOnly": true, "description": "Slug da Carteira" }, "agency_number": { "type": "string", "readOnly": true, "description": "Agência" }, "agency_digit": { "type": "string", "readOnly": true, "description": "Dígito da Agência" }, "account_number": { "type": "string", "readOnly": true, "description": "Conta" }, "account_digit": { "type": "string", "readOnly": true, "description": "Dígito da Conta" }, "extra1": { "type": "string", "readOnly": true, "description": "Campo extra 1" }, "extra1_digit": { "type": "string", "nullable": true, "readOnly": true, "description": "Digito do Campo extra 1" }, "extra2": { "type": "string", "nullable": true, "readOnly": true, "description": "Campo extra 2" }, "extra2_digit": { "type": "string", "nullable": true, "readOnly": true, "description": "Dígito do Campo extra 2" }, "created_via_api": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se o boleto foi criado por API" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do boleto" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do boleto" }, "registered_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora do registro" }, "register_type": { "type": "integer", "readOnly": true, "description": "Tipo de Registro:\n* `1` API\n* `2` Banco", "enum": [ 1, 2 ] }, "cancel_type": { "type": "integer", "readOnly": true, "description": "Tipo de Cancelamento:\n * `1` Cliente\n * `2` Banco", "enum": [ 1, 2 ] }, "payment_count": { "type": "integer", "nullable": true, "description": "Quantidade de pagamentos parciais aceitos para este boleto." }, "line": { "type": "string", "nullable": true, "readOnly": true, "description": "Linha Digitável" }, "barcode": { "type": "string", "nullable": true, "readOnly": true, "description": "Endereço" }, "shorten_url": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true, "description": "URL para visualização do boleto" }, "url": { "type": "string", "nullable": true, "readOnly": true, "description": "URL para visualização do boleto" }, "carne_url": { "type": "string", "nullable": true, "readOnly": true, "description": "URL para visualização do carnê(Quando for parcela)" }, "formats": { "type": "object", "nullable": true, "readOnly": true, "description": "URLs com formatos disponíveis. Ex.: PDF, Imagem, Pix e etc" }, "pix_enabled": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se o boleto é híbrido e tem QRcode Pix" }, "pix_qrcode": { "type": "string", "nullable": true, "readOnly": true, "description": "QRcode Pix do boleto híbrido" }, "status": { "type": "string", "readOnly": true, "description": "Situação do boleto:\n* `generating` Gerando\n* `draft` Rascunho\n* `generation_failed` Falha ao gerar\n* `opened` Aberto\n* `canceled` Cancelado\n* `paid` Pago\n* `overdue` Vencido\n* `validation_failed` Inválido\n* `chargeback` Estornado", "enum": [ "generating", "draft", "generation_failed", "validation_failed", "opened", "canceled", "paid", "overdue", "blocked", "chargeback" ] }, "recipient_account": { "type": "string", "nullable": true, "maxLength": 10, "description": "Conta Destinatária + Dígito" } } }, "v1_bank_billet_pay_object": { "type": "object", "required": [ "paid_at", "paid_amount" ], "properties": { "paid_amount": { "type": "number", "format": "float", "description": "Valor pago do boleto.", "example": 1345.56 }, "paid_at": { "type": "string", "format": "date", "description": "Data de pagamento do boleto", "example": "2023-12-12" }, "bank_rate": { "type": "string", "nullable": true, "description": "Valor da taxa bancária.", "example": "4,02" }, "direct_payment": { "type": "boolean", "nullable": true, "description": "Informa se o pagamento foi feito diretamente ao beneficiário.", "example": null } } }, "v1_bank_billet_update_object": { "type": "object", "properties": { "amount": { "type": "number", "format": "float", "description": "Valor do Boleto", "example": 10.99 }, "expire_at": { "type": "string", "format": "date", "description": "Data de vencimento", "example": "2023-12-12" }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas ao boleto", "example": null, "items": { "type": "string" } }, "notes": { "type": "string", "nullable": true, "example": null, "description": "Observações" }, "days_for_sue_type": { "type": "integer", "nullable": true, "description": "Tipo de dias para protesto:\n * `0` Corridos\n * `1` Úteis", "enum": [ null, 0, 1 ], "example": null }, "days_for_sue": { "type": "integer", "nullable": true, "description": "Dias corridos para Protesto", "example": null }, "days_for_revoke": { "type": "integer", "nullable": true, "description": "Dias corridos para Baixa\nBancos Suportados: Itaú", "example": null }, "sue_code": { "type": "string", "nullable": true, "description": "Código de Protesto(Somente por CNAB 240). Consulte os possíveis valores para cada banco.", "example": null }, "instructions": { "type": "string", "nullable": true, "description": "Instruções para o Caixa", "example": null }, "description": { "type": "string", "nullable": true, "description": "Descrição do produto ou serviço", "example": null }, "interest_type": { "type": "integer", "nullable": true, "description": "Tipo de juros/mora:\n* `0` Inexistente (Padrão)\n* `1` Para porcentagem diária\n* `2` Para valor diário\n* `7` Para porcentagem mensal - Bancos suportados: Bradesco, BB, BTG, Caixa, Inter, Itaú, Safra, Santander, Sicoob e Sicredi", "enum": [ 0, 1, 2, 7 ], "default": 0 }, "days_for_interest": { "type": "integer", "nullable": true, "description": "Quantidade de dias após o vencimento que a mora começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento).", "example": null }, "interest_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Porcentagem de juros. De 0.0 a 100.0 (Ex 1.5% = 1.5) Obrigatório se interest_type é igual a 1 ou 7. Até 2 casas decimais.", "example": null }, "interest_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor diário de juros (R$). Obrigatório se interest_type é igual a 2. Até 2 casas decimais.", "example": null }, "discount_type": { "type": "integer", "nullable": true, "description": "Tipo de desconto:\n O tipo de desconto será o mesmo para todos os três descontos, caso existam. :\n * `0` Inexistente (Padrão)\n * `1` Para valor fixo\n * `2` Para percentual do valor do boleto", "enum": [ 0, 1, 2 ], "default": 0 }, "days_for_discount": { "type": "integer", "nullable": true, "description": "Dias para desconto. Obrigatório se discount_type é diferente de 0(zero)", "example": null }, "discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao desconto. Obrigatório se discount_type é igual a 2", "example": null }, "discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do desconto (R$). Obrigatório se discount_type é igual a 1.", "example": null }, "days_for_second_discount": { "type": "integer", "nullable": true, "description": "Dias para segundo desconto.", "example": null }, "second_discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao segundo desconto.", "example": null }, "second_discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do segundo desconto (R$).", "example": null }, "days_for_third_discount": { "type": "integer", "nullable": true, "description": "Dias para terceiro desconto.", "example": null }, "third_discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao terceiro desconto.", "example": null }, "third_discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do terceiro desconto (R$).", "example": null }, "reduction_type": { "type": "integer", "nullable": true, "example": null, "enum": [ 1, 2, 3 ], "description": "Tipo de abatimento:\n\n`1`: Valor.\n`2`: Porcentagem.\n`3`: Sem abatimento\n" }, "reduction_amount": { "type": "number", "format": "float", "description": "Valor do abatimento. Obrigatório se reduction_type é igual a 1.", "example": 30.25 }, "reduction_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Porcentagem de Abatimento. Ex: 2% x R$ 250,00 = R$ 5,00. Obrigatória se reduction_type é igual a 2. Até 2 casas decimais.", "example": null }, "divergent_payment_type": { "type": "integer", "nullable": true, "example": null, "description": "Tipo de pagamento divergente:\n* `1` Aceita qualquer valor divergente\n* `2` Aceita pagamentos dentro de uma faixa de valores ou percentuais\n* `3` Não aceita pagamento de valores divergentes\n* `4` Aceita pagamentos de valores superiores a um valor ou percentual mínimo\nBancos suportados: Itaú", "enum": [ null, 1, 2, 3, 4 ] }, "divergent_payment_value_type": { "type": "integer", "nullable": true, "example": null, "description": "Tipo de valor a considerar para os limites de pagamentos:\nVálido apenas para Itaú e Caixa.\n* `1` Informa pagamentos divergentes por valores\n* `2` Informa pagamentos divergentes por percentuais\nBancos suportados: Itaú", "enum": [ null, 1, 2 ] }, "divergent_payment_maximum_value": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Valor máximo para a faixa de pagamentos divergentes.\nBancos suportados: Itaú" }, "divergent_payment_minimum_value": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Valor mínimo para a faixa de pagamentos divergentes.\nBancos suportados: Itaú" }, "divergent_payment_maximum_percentage": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Percentual máximo para a faixa de pagamentos divergentes.\nBancos suportados: Itaú" }, "divergent_payment_minimum_percentage": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Percentual mínimo para a faixa de pagamentos divergentes.\nBancos suportados: Itaú" }, "fine_type": { "type": "integer", "nullable": true, "description": "Tipo de multa:\n* `0` Inexistente (Padrão)\n* `1` Para percentual do valor do boleto\n* `2` Para valor fixo", "enum": [ 0, 1, 2 ], "default": 0 }, "days_for_fine": { "type": "integer", "nullable": true, "description": "Quantidade de dias após o vencimento que a multa começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento).", "example": null }, "credit_bureau": { "type": "integer", "nullable": true, "example": null, "enum": [ null, 0, 1, 2 ], "description": "Birô de Crédito/Órgão Negativador.\n\n`0`: Serasa.\n`1`: Quod.\n`2`: SPC\n\nOpções disponíveis para cada banco suportado:\n\n* Banco do Brasil: Serasa e Quod.\n" }, "days_for_negativation": { "type": "integer", "nullable": true, "description": "Quantidade de dias após o vencimento para negativar o título.", "example": null }, "fine_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Porcentagem de Multa por Atraso Ex: 2% x R$ 250,00 = R$ 5,00. Obrigatória se fine_type é igual a 1. Até 2 casas decimais.", "example": null }, "fine_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor da multa (R$). Obrigatório se fine_type é igual a 2. Até 2 casas decimais.", "example": null }, "document_number": { "type": "string", "nullable": true, "example": null, "description": "Número do Documento, Tamanho depende do banco, formato e forma de envio (API / EDI):\n * Itau |`Cnab240`|\t10\t|\n * Itau |`Cnab400`|\t10\t|" }, "customer_person_name": { "type": "string", "maxLength": 120, "description": "Nome do cliente. Bancos Suportados: Santander", "example": "João Silva" }, "customer_cnpj_cpf": { "type": "string", "maxLength": 20, "description": "CPF/CNPJ do cliente. Bancos Suportados: Santander", "example": "16.974.923/0001-84" }, "customer_state": { "type": "string", "maxLength": 2, "description": "Estado. Bancos Suportados: Santander", "example": "SP" }, "customer_city_name": { "type": "string", "maxLength": 60, "description": "Cidade(Nome deve estar correto e completo). Bancos Suportados: Santander", "example": "São Paulo" }, "customer_zipcode": { "type": "string", "maxLength": 8, "description": "CEP (formato 99999999). Bancos Suportados: Santander", "example": "01310100" }, "customer_address": { "type": "string", "maxLength": 255, "description": "Endereço. Bancos Suportados: Santander", "example": "Rua F, alamenda G" }, "customer_neighborhood": { "type": "string", "maxLength": 80, "description": "Bairro. Bancos Suportados: Santander", "example": "Centro" }, "guarantor_name": { "type": "string", "nullable": true, "maxLength": 100, "description": "Nome do Beneficiário final (Sacador/Avalista). Bancos Suportados: Santander", "example": null }, "guarantor_cnpj_cpf": { "type": "string", "nullable": true, "maxLength": 20, "description": "CNPJ/CPF do Beneficiário final (Sacador/Avalista). Bancos Suportados: Santander", "example": null }, "document_type": { "type": "string", "description": "Tipo de Documento:\n * `Código` | `Sigla` | Descrição\n * `01` | `CH` | Cheque\n * `02` | `DM` | Duplicata Mercantil (Padrão)\n * `03` | `DMI` | Duplicata Mercantil p/ Indicação\n * `04` | `DS` | Duplicata de Serviço\n * `05` | `DSI` | Duplicata de Serviço p/ Indicação\n * `06` | `DR` | Duplicata Rural\n * `07` | `LC` | Letra de Câmbio\n * `08` | `NCC` | Nota de Crédito Comercial\n * `09` | `NCE` | Nota de Crédito a Exportação\n * `10` | `NCI` | Nota de Crédito Industrial\n * `11` | `NCR` | Nota de Crédito Rural\n * `12` | `NP` | Nota Promissória\n * `13` | `NPR` | Nota Promissória Rural\n * `14` | `TM` | Triplicata Mercantil\n * `15` | `TS` | Triplicata de Serviço\n * `16` | `NS` | Nota de Seguro\n * `17` | `RC` | Recibo\n * `18` | `FAT` | Fatura\n * `19` | `ND` | Nota de Débito\n * `20` | `AP` | Apólice de Seguro\n * `21` | `ME` | Mensalidade Escolar\n * `22` | `PC` | Parcela de Consórcio\n * `23` | `NF` | Nota Fiscal\n * `24` | `DD` | Documento de Dívida\n * `25` | `CPR` | Cédula de Produto Rural\n * `26` | `CTR` | Contrato\n * `27` | `CSG` | Cosseguros\n * `28` | `EC` | Encargos Condominiais\n * `29` | `CPS` | Conta de Prestação de Serviços\n * `30` | `WR` | Warrant\n * `31` | `DP` | Duplicata Prestação\n * `32` | `CSR` | Cobrança Seriada\n * `33` | `CAR` | Carnê\n * `34` | `ARE` | Apólice Ramos Elementares\n * `35` | `CC` | Cartão de Crédito\n * `36` | `BDP` | Boleto de Proposta\n * `37` | `NPD` | Nota Promissória Direta\n * `38` | `DAE` | Dívida Ativa de Estado\n * `39` | `DAM` | Divida Ativa de Município\n * `40` | `DAU` | Dívida Ativa União\n * `41` | `CCB` | Célula de Crédito Bancário\n * `42` | `FI` | Financiamento\n * `43` | `RD` | Rateio de Despesas\n * `44` | `DRI` | Duplicata Rural p/ Indicação\n * `45` | `ECI` | Encargos Condominiais p/ Indicação\n * `99` | `Outros` | Outros\n\n Bancos Suportados: Santander", "default": "02", "enum": [ "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "99" ] }, "control_number": { "type": "string", "nullable": true, "example": null, "description": "Número de controle:\n Pode conter qualquer informação de interesse da Empresa. A informação contida neste campo sempre retornará com o respectivo título no arquivo-retorno. Bancos Suportados: Santander" }, "payment_count": { "type": "integer", "nullable": true, "description": "Quantidade de pagamentos parciais aceitos para este boleto. Bancos Suportados: Santander" }, "issued_at": { "type": "string", "nullable": true, "format": "date", "example": "2023-12-12", "description": "Data de emissão. Bancos Suportados: Santander" }, "bolepix_key": { "type": "string", "nullable": true, "example": null, "description": "Chave do bolepix. Bancos Suportados: Santander" }, "pix_txid": { "type": "string", "nullable": true, "example": null, "description": "TxId do pix. Bancos Suportados: Santander" } } }, "v1_bank_billet_cancel_object": { "type": "object", "properties": { "cancellation_reason": { "type": "integer", "nullable": true, "description": "Motivo do cancelamento:\n* `1` Outro\n* `2` Fraude\n* `3` Óbito\n* `4` Erro operacional\n* `5` Quitação paga", "enum": [ 1, 2, 3, 4, 5 ] } } }, "v1_bank_billet_cancel_all_object": { "type": "object", "properties": { "status": { "type": "string", "readOnly": true, "description": "Situação do boleto:\n* `generating` Gerando\n* `draft` Rascunho\n* `generation_failed` Falha ao gerar\n* `opened` Aberto\n* `canceled` Cancelado\n* `paid` Pago\n* `overdue` Vencido\n* `validation_failed` Inválido\n* `chargeback` Estornado", "enum": [ "generating", "draft", "generation_failed", "validation_failed", "opened", "canceled", "paid", "overdue", "blocked", "chargeback" ] }, "expire_from": { "type": "string", "format": "date", "description": "A partir de Data de vencimento", "example": "2023-12-12" }, "expire_to": { "type": "string", "format": "date", "description": "Até a Data de vencimento", "example": "2023-12-12" }, "cnpj_cpf": { "type": "string", "description": "CNPJ ou CPF do Pagador", "example": "16.974.923/0001-84" }, "bank_billet_ids": { "type": "array", "nullable": true, "description": "IDs de boletos a serem cancelados", "example": null, "items": { "type": "integer" } } } }, "v1_bank_billet_send_email_object": { "type": "object", "required": [ "form" ], "properties": { "form": { "type": "object", "required": [ "email_account_id" ], "description": "Formulário de E-mail.", "properties": { "to": { "type": "string", "format": "email", "description": "E-mail do pagador", "example": null }, "subject": { "type": "string", "description": "Nome do pagador", "example": null }, "message": { "type": "string", "description": "Mensagem de e-mail", "example": null }, "email_account_id": { "type": "integer", "description": "ID da conta de e-email", "example": null }, "email_template_id": { "type": "integer", "description": "ID do template de e-email. O template de email é criado via interface e Régua de Comunicação > E-mails > Templates", "example": null }, "bank_billet_in_pdf": { "type": "boolean", "description": "Boleto como PDF", "example": null }, "bank_billet_in_png": { "type": "boolean", "description": "Boleto como PNG", "example": null } } } } }, "v1_bank_billet_send_sms_object": { "type": "object", "required": [ "form" ], "properties": { "form": { "type": "object", "required": [ "sms_notification_id" ], "description": "Formulário de SMS.", "properties": { "phone_to": { "type": "string", "maxLength": 11, "description": "Telefone (com DDD) do pagador", "example": null }, "message": { "type": "string", "description": "Mensagem de sms", "example": null }, "sms_notification_id": { "type": "integer", "description": "ID da notificação", "example": null }, "sms_account_id": { "type": "integer", "description": "ID da conta de sms", "example": null } } } } }, "v1_customer_object": { "type": "object", "required": [ "person_name", "zipcode", "address", "neighborhood", "city_name" ], "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID" }, "external_code": { "type": "string", "nullable": true, "maxLength": 255, "description": "Código Externo", "example": "C0001" }, "cnpj_cpf": { "type": "string", "maxLength": 20, "description": "CPF/CNPJ", "example": "16.974.923/0001-84" }, "person_name": { "type": "string", "maxLength": 120, "description": "Nome ou Razão Social", "example": "João Silva" }, "contact_person": { "type": "string", "nullable": true, "maxLength": 120, "description": "Pessoa de Contato (quando Empresa)", "example": null }, "nickname": { "type": "string", "nullable": true, "maxLength": 255, "description": "Apelido ou Nome Fantasia do Pagador", "example": null }, "birthday": { "type": "string", "nullable": true, "format": "date", "description": "Data de Nascimento", "example": "1978-06-12" }, "email": { "type": "string", "format": "email", "maxLength": 80, "description": "E-mail principal", "example": "cliente@example.com" }, "email_cc": { "type": "string", "format": "email", "maxLength": 80, "description": "E-mail alternativo", "example": "outroemail@example.com" }, "address": { "type": "string", "maxLength": 255, "description": "Endereço", "example": "Rua F, alamenda G" }, "address_complement": { "type": "string", "nullable": true, "maxLength": 120, "description": "Complemento do Endereço", "example": null }, "address_number": { "type": "string", "maxLength": 10, "description": "Número", "example": null }, "neighborhood": { "type": "string", "maxLength": 80, "description": "Bairro", "example": "Centro" }, "zipcode": { "type": "string", "maxLength": 8, "description": "CEP (formato 99999999)", "example": "01310100" }, "state": { "type": "string", "maxLength": 2, "description": "Estado", "example": "SP" }, "city_name": { "type": "string", "maxLength": 60, "description": "Cidade (Nome deve estar correto e completo)", "example": "São Paulo" }, "phone_number": { "type": "string", "nullable": true, "maxLength": 15, "description": "Telefone (com DDD, DDI é opcional)", "example": null }, "mobile_local_code": { "type": "string", "nullable": true, "maxLength": 2, "description": "DDD do Celular", "example": null }, "mobile_number": { "type": "string", "nullable": true, "maxLength": 9, "description": "Celular", "example": null }, "ignore_email": { "type": "boolean", "default": false, "nullable": true, "description": "Nunca enviar e-mail para este cliente", "example": null }, "ignore_sms": { "type": "boolean", "default": false, "nullable": true, "description": "Nunca enviar SMS para este cliente", "example": null }, "ignore_whatsapp": { "type": "boolean", "default": false, "nullable": true, "description": "Nunca enviar Whatsapp para este cliente", "example": null }, "notes": { "type": "string", "nullable": true, "description": "Observações", "example": null }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas ao registro", "example": null, "items": { "type": "string" } }, "tag_list": { "type": "string", "nullable": true, "readOnly": true, "description": "Tags associadas ao registro" }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "created_via_api": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se o registro foi criado por API" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do registro" } } }, "v1_customer_update_object": { "type": "object", "required": [ "person_name", "zipcode", "address", "neighborhood", "city_name" ], "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID" }, "external_code": { "type": "string", "nullable": true, "maxLength": 255, "description": "Código Externo", "example": "C0001" }, "person_name": { "type": "string", "maxLength": 120, "description": "Nome ou Razão Social", "example": "João Silva" }, "contact_person": { "type": "string", "nullable": true, "maxLength": 120, "description": "Pessoa de Contato (quando Empresa)", "example": null }, "nickname": { "type": "string", "nullable": true, "maxLength": 255, "description": "Apelido ou Nome Fantasia do Pagador", "example": null }, "birthday": { "type": "string", "nullable": true, "format": "date", "description": "Data de Nascimento", "example": "1978-06-12" }, "email": { "type": "string", "format": "email", "maxLength": 80, "description": "E-mail principal", "example": "cliente@example.com" }, "email_cc": { "type": "string", "format": "email", "maxLength": 80, "description": "E-mail alternativo", "example": "outroemail@example.com" }, "address": { "type": "string", "maxLength": 255, "description": "Endereço", "example": "Rua F, alamenda G" }, "address_complement": { "type": "string", "nullable": true, "maxLength": 120, "description": "Complemento do Endereço", "example": null }, "address_number": { "type": "string", "maxLength": 10, "description": "Número", "example": null }, "neighborhood": { "type": "string", "maxLength": 80, "description": "Bairro", "example": "Centro" }, "zipcode": { "type": "string", "maxLength": 8, "description": "CEP (formato 99999999)", "example": "01310100" }, "state": { "type": "string", "maxLength": 2, "description": "Estado", "example": "SP" }, "city_name": { "type": "string", "maxLength": 60, "description": "Cidade (Nome deve estar correto e completo)", "example": "São Paulo" }, "phone_number": { "type": "string", "nullable": true, "maxLength": 15, "description": "Telefone (com DDD, DDI é opcional)", "example": null }, "mobile_local_code": { "type": "string", "nullable": true, "maxLength": 2, "description": "DDD do Celular", "example": null }, "mobile_number": { "type": "string", "nullable": true, "maxLength": 9, "description": "Celular", "example": null }, "ignore_email": { "type": "boolean", "default": false, "nullable": true, "description": "Nunca enviar e-mail para este cliente", "example": null }, "ignore_sms": { "type": "boolean", "default": false, "nullable": true, "description": "Nunca enviar SMS para este cliente", "example": null }, "ignore_whatsapp": { "type": "boolean", "default": false, "nullable": true, "description": "Nunca enviar Whatsapp para este cliente", "example": null }, "notes": { "type": "string", "nullable": true, "description": "Observações", "example": null }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas ao registro", "example": null, "items": { "type": "string" } }, "tag_list": { "type": "string", "nullable": true, "readOnly": true, "description": "Tags associadas ao registro" }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "created_via_api": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se o registro foi criado por API" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do registro" } } }, "v1_installment_object": { "type": "object", "required": [ "amount", "customer_person_name", "customer_cnpj_cpf", "customer_zipcode", "customer_address", "customer_neighborhood", "customer_city_name", "customer_state", "bank_billet_account_id", "start_at", "total", "document_type" ], "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do carnê" }, "bank_billet_account_id": { "type": "integer", "description": "ID da Carteira de Cobrança. Se não informado, usará a carteira padrão.", "example": null }, "bank_billet_layout_id": { "type": "integer", "nullable": true, "description": "ID do Modelo de Boleto", "example": null }, "amount": { "type": "number", "format": "float", "description": "Quantia", "example": 10.99 }, "customer_id": { "type": "integer", "nullable": true, "description": "ID do Cliente. Quando esse ID é passado, os campos `customer_person_name`, `customer_cnpj_cpf`, `customer_zipcode`, `customer_address`, `customer_city_name`, `customer_state` e `customer_neighborhood` não são obrigatórios.", "example": null }, "customer_person_name": { "type": "string", "maxLength": 120, "description": "Nome do cliente", "example": "João Silva" }, "customer_cnpj_cpf": { "type": "string", "maxLength": 20, "description": "CPF/CNPJ do cliente", "example": "16.974.923/0001-84" }, "customer_state": { "type": "string", "maxLength": 2, "description": "Estado", "example": "SP" }, "customer_city_name": { "type": "string", "maxLength": 60, "description": "Cidade(Nome deve estar correto e completo)", "example": "São Paulo" }, "customer_zipcode": { "type": "string", "maxLength": 8, "description": "CEP (formato 99999999)", "example": "01310100" }, "customer_address": { "type": "string", "maxLength": 255, "description": "Endereço", "example": "Rua F, alamenda G" }, "customer_address_complement": { "type": "string", "maxLength": 120, "description": "Complemento", "example": null }, "customer_address_number": { "type": "string", "maxLength": 10, "description": "Número", "example": null }, "customer_email": { "type": "string", "format": "email", "maxLength": 80, "description": "E-mail do Pagador", "example": null }, "customer_email_cc": { "type": "string", "format": "email", "maxLength": 80, "description": "E-mail alternativo do Pagador", "example": null }, "customer_neighborhood": { "type": "string", "maxLength": 80, "description": "Bairro", "example": "Centro" }, "customer_phone_number": { "type": "string", "maxLength": 11, "description": "Telefone (com DDD)", "example": null }, "customer_ignore_email": { "type": "boolean", "nullable": true, "description": "Nunca enviar e-mail para este cliente", "example": null }, "customer_ignore_sms": { "type": "boolean", "nullable": true, "description": "Nunca enviar SMS para este cliente", "example": null }, "customer_mobile_local_code": { "type": "string", "nullable": true, "maxLength": 2, "description": "DDD do Celular", "example": null }, "customer_mobile_number": { "type": "string", "nullable": true, "maxLength": 9, "description": "Celular", "example": null }, "customer_nickname": { "type": "string", "nullable": true, "maxLength": 255, "description": "Apelido ou Nome Fantasia do Pagador", "example": null }, "customer_notes": { "type": "string", "nullable": true, "description": "Observações do Pagador", "example": null }, "customer_contact_person": { "type": "string", "nullable": true, "maxLength": 120, "description": "Contato", "example": null }, "customer_update": { "type": "string", "nullable": true, "maxLength": 120, "description": "Contato", "example": null }, "start_at": { "type": "string", "format": "date", "description": "Data da primeira cobrança", "example": null }, "end_at": { "type": "string", "format": "date", "nullable": true, "description": "Data da última cobrança", "example": null }, "cycle": { "type": "string", "nullable": true, "maxLength": 20, "description": "Ciclo do carnê. Default: monthly\n* `biweekly` Quinzenal\n* `bimonthly` Bimestral\n* `monthly` Mensal\n* `quarterly` Trimestral\n* `semiannual` Semestral\n* `annual` Anual", "enum": [ "biweekly", "bimonthly", "monthly", "quarterly", "semiannual", "annual" ] }, "total": { "type": "integer", "maximum": 300, "description": "Quantidade de parcelas", "example": null }, "custom_bank_billets": { "type": "array", "nullable": true, "description": "Carnê customizado. Quando enviado, os valores de amount, start_at e end_at serão ignorados.", "example": null, "items": { "$ref": "#/components/schemas/v1_custom_bank_billets_object" } }, "bank_billet_ids": { "type": "array", "nullable": true, "readOnly": true, "description": "IDs de boletos vinculados ao carnê", "example": null, "items": { "type": "integer" } }, "interest_type": { "type": "integer", "nullable": true, "description": "Tipo de juros/mora:\n* `0` Inexistente (Padrão)\n* `1` Para porcentagem diária\n* `2` Para valor diário", "enum": [ 0, 1, 2 ], "default": 0 }, "days_for_interest": { "type": "integer", "nullable": true, "description": "Quantidade de dias após o vencimento que a mora começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento).", "example": null }, "interest_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Porcentagem diária de juros. De 0.0 a 100.0 (Ex 1.5% = 1.5) Obrigatório se interest_type é igual a 1.", "example": null }, "interest_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor diário de juros (R$). Obrigatório se interest_type é igual a 2.", "example": null }, "interest_days_type": { "type": "integer", "nullable": true, "description": "Tipo de Dias para juros:\n* `0` Corridos\n* `1` Úteis", "enum": [ 0, 1 ], "default": 0 }, "fine_type": { "type": "integer", "nullable": true, "description": "Tipo de multa:\n* `0` Inexistente (Padrão)\n* `1` Para percentual do valor do boleto\n* `2` Para valor fixo", "enum": [ 0, 1, 2 ], "default": 0 }, "days_for_fine": { "type": "integer", "nullable": true, "description": "Quantidade de dias após o vencimento que a multa começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento).", "example": null }, "fine_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Porcentagem de Multa por Atraso Ex: 2% x R$ 250,00 = R$ 5,00. Obrigatória se fine_type é igual a 1", "example": null }, "fine_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor da multa (R$). Obrigatório se fine_type é igual a 2.", "example": null }, "discount_type": { "type": "integer", "nullable": true, "description": "Tipo de desconto:\nO tipo de desconto será o mesmo para todos os três descontos, caso existam. :\n* `0` Inexistente (Padrão)\n* `1` Para valor fixo\n* `2` Para percentual do valor do boleto", "enum": [ 0, 1, 2 ], "default": 0 }, "days_for_discount": { "type": "integer", "nullable": true, "description": "Dias para desconto. Obrigatório se discount_type é diferente de 0(zero), Não pode resultar numa data passada referente a criação.", "example": null }, "discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao desconto. Obrigatório se discount_type é igual a 2", "example": null }, "discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do desconto (R$). Obrigatório se discount_type é igual a 1.", "example": null }, "days_for_second_discount": { "type": "integer", "nullable": true, "description": "Dias para segundo desconto.", "example": null }, "second_discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao segundo desconto.", "example": null }, "second_discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do segundo desconto (R$).", "example": null }, "days_for_third_discount": { "type": "integer", "nullable": true, "description": "Dias para terceiro desconto.", "example": null }, "third_discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao terceiro desconto.", "example": null }, "third_discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do terceiro desconto (R$).", "example": null }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas ao boleto", "example": null, "items": { "type": "string" } }, "guarantor_name": { "type": "string", "nullable": true, "maxLength": 100, "description": "Nome do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_cnpj_cpf": { "type": "string", "nullable": true, "maxLength": 20, "description": "CNPJ/CPF do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_address_number": { "type": "string", "nullable": true, "maxLength": 10, "description": "Número do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_neighborhood": { "type": "string", "nullable": true, "maxLength": 80, "description": "Bairro do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_phone_number": { "type": "string", "nullable": true, "maxLength": 11, "description": "Telefone (com DDD) do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_city_name": { "type": "string", "nullable": true, "maxLength": 60, "description": "Cidade(Nome deve estar correto e completo) do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_state": { "type": "string", "nullable": true, "maxLength": 2, "description": "Estado do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_zipcode": { "type": "string", "nullable": true, "maxLength": 8, "description": "CEP (formato 99999999) do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_address": { "type": "string", "nullable": true, "maxLength": 255, "description": "Endereço do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_address_complement": { "type": "string", "nullable": true, "maxLength": 60, "description": "Complemento do Beneficiário final (Sacador/Avalista)", "example": null }, "description": { "type": "string", "nullable": true, "description": "Descrição do produto ou serviço", "example": null }, "instructions": { "type": "string", "nullable": true, "description": "Instruções para o Caixa", "example": null }, "document_date": { "type": "string", "format": "date", "nullable": true, "description": "Data do Documento", "example": null }, "document_type": { "type": "string", "maxLength": 2, "description": "Tipo de Documento:\n\n* `Código` | `Sigla` | Descrição\n* `01` | `CH` | Cheque\n* `02` | `DM` | Duplicata Mercantil (Padrão)\n* `03` | `DMI` | Duplicata Mercantil p/ Indicação\n* `04` | `DS` | Duplicata de Serviço\n* `05` | `DSI` | Duplicata de Serviço p/ Indicação\n* `06` | `DR` | Duplicata Rural\n* `07` | `LC` | Letra de Câmbio\n* `08` | `NCC` | Nota de Crédito Comercial\n* `09` | `NCE` | Nota de Crédito a Exportação\n* `10` | `NCI` | Nota de Crédito Industrial\n* `11` | `NCR` | Nota de Crédito Rural\n* `12` | `NP` | Nota Promissória\n* `13` | `NPR` | Nota Promissória Rural\n* `14` | `TM` | Triplicata Mercantil\n* `15` | `TS` | Triplicata de Serviço\n* `16` | `NS` | Nota de Seguro\n* `17` | `RC` | Recibo\n* `18` | `FAT` | Fatura\n* `19` | `ND` | Nota de Débito\n* `20` | `AP` | Apólice de Seguro\n* `21` | `ME` | Mensalidade Escolar\n* `22` | `PC` | Parcela de Consórcio\n* `23` | `NF` | Nota Fiscal\n* `24` | `DD` | Documento de Dívida\n* `25` | `CPR` | Cédula de Produto Rural\n* `26` | `CTR` | Contrato\n* `27` | `CSG` | Cosseguros\n* `28` | `EC` | Encargos Condominiais\n* `29` | `CPS` | Conta de Prestação de Serviços\n* `30` | `WR` | Warrant\n* `31` | `DP` | Duplicata Prestação\n* `32` | `CSR` | Cobrança Seriada\n* `33` | `CAR` | Carnê\n* `34` | `ARE` | Apólice Ramos Elementares\n* `35` | `CC` | Cartão de Crédito\n* `36` | `BDP` | Boleto de Proposta\n* `37` | `NPD` | Nota Promissória Direta\n* `38` | `DAE` | Dívida Ativa de Estado\n* `39` | `DAM` | Divida Ativa de Município\n* `40` | `DAU` | Dívida Ativa União\n* `41` | `CCB` | Célula de Crédito Bancário\n* `42` | `FI` | Financiamento\n* `43` | `RD` | Rateio de Despesas\n* `44` | `DRI` | Duplicata Rural p/ Indicação\n* `45` | `ECI` | Encargos Condominiais p/ Indicação\n* `99` | `Outros` | Outros\n ", "default": "02", "enum": [ "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "99" ] }, "document_number": { "type": "string", "nullable": true, "example": null, "description": "Número do Documento, Tamanho depende do banco e formato do arquivo Remessa:\n * Banco |\tFormato| Tamanho |\n * Abc |`Cnab240`|\t15\t|\n * Ailos |`Cnab240`|\t15 |\n * Arbi |`Cnab240`|\t15\t|\n * Banese |`Cnab240`|\t15\t|\n * Banestes |`Cnab400`|\t10\t|\n * Banrisul |`Cnab240`|\t15\t|\n * Banrisul |`Cnab400`|\t10\t|\n * Bb |`Cnab240`|\t15\t|\n * Bb |`Cnab400`|\t10\t|\n * Bib |`Cnab240`|\t15\t|\n * Bnb |`Cnab400`|\t10\t|\n * Bnpparibas |`Cnab400`|\t10\t|\n * Bradesco |`Cnab240`|\t15\t|\n * Bradesco |`Cnab400`|\t10\t|\n * Brb |`Cnab400`|\t10\t|\n * Caixa |`Cnab240`|\t11\t|\n * Caixa |`Cnab400`|\t10\t|\n * Caruana |`Cnab400`|\t10\t|\n * Citibank |`Cnab400`|\t10\t|\n * Credisis |`Cnab240`|\t15\t|\n * Cresol |`Cnab240`|\t10\t|\n * Cresol |`Cnab400`|\t10\t|\n * Cresol Bradesco |`Cnab240`|\t15\t|\n * Cresol Bradesco |`Cnab400`|\t10\t|\n * Daycoval |`Cnab400`|\t10\t|\n * Itau |`Cnab240`|\t10\t|\n * Itau |`Cnab400`|\t10\t|\n * Mercantil |`Cnab240`|\t10\t|\n * Moneyplus |`Cnab240`|\t10\t|\n * Rendimento |`Cnab400`|\t10\t|\n * Safra |`Cnab400`|\t102\t|\n * Santander |`Cnab240`|\t15\t|\n * Santander |`Cnab400`|\t10\t|\n * Semear |`Cnab400`|\t10\t|\n * Sicoob |`Cnab240`|\t15\t|\n * Sicoob |`Cnab400`|\t10\t|\n * Sicredi |`Cnab240`|\t15\t|\n * Sicredi |`Cnab400`|\t10\t|\n * Sofisa |`Cnab240`|\t15\t|\n * Unicred |`Cnab240`|\t15\t|\n * Uniprime |`Cnab400`|\t10\t|\n * Uniprime99 |`Cnab400`|\t10\t|\n * Santander |`Cnab400`|\t10 " }, "days_for_revoke": { "type": "integer", "nullable": true, "description": "Dias corridos para Baixa/Devolução:\n\n Nulo/Branco: Obedece ao padrão do banco.\n 0: Baixa/Devolução no mesmo dia do vencimento.\n 1 ou mais: Baixa/Devolução após o vencimento(Vencimento + X dias corridos).\n ", "example": null }, "days_for_negativation": { "type": "integer", "maxLength": 99, "nullable": true, "example": null, "description": "Dias corridos para Negativação:\n\nDisponível apenas para os seguintes bancos e formatos.\n\n* Banco |\tCNAB 240|\tCNAB 400 |Webservice\n* Bradesco |\tSim |\tSim\t| Não\n* Itaú | Não | Sim | Não\n " }, "days_for_sue": { "type": "integer", "nullable": true, "description": "Dias corridos para Protesto", "example": null }, "divergent_payment_type": { "type": "integer", "nullable": true, "example": null, "description": "Tipo de pagamento divergente:\nVálido apenas para Itaú e Caixa.\n* `1` Aceita qualquer valor divergente\n* `2` Aceita pagamentos dentro de uma faixa de valores ou percentuais\n* `3` Não aceita pagamento de valores divergentes\n* `4` Aceita pagamentos de valores superiores a um valor ou percentual mínimo", "enum": [ null, 1, 2, 3, 4 ] }, "divergent_payment_value_type": { "type": "integer", "nullable": true, "example": null, "description": "Tipo de valor a considerar para os limites de pagamentos:\nVálido apenas para Itaú e Caixa.\n* `1` Informa pagamentos divergentes por valores\n* `2` Informa pagamentos divergentes por percentuais", "enum": [ null, 1, 2 ] }, "divergent_payment_maximum_value": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Valor máximo para a faixa de pagamentos divergentes. " }, "divergent_payment_minimum_value": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Valor mínimo para a faixa de pagamentos divergentes. " }, "divergent_payment_maximum_percentage": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Percentual máximo para a faixa de pagamentos divergentes. " }, "divergent_payment_minimum_percentage": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Percentual mínimo para a faixa de pagamentos divergentes." }, "divergent_payment_limit": { "type": "integer", "nullable": true, "example": null, "description": "Quantidade de pagamentos permitida. Obrigatório se informados dados para pagamento divergente. Usado somente pela Caixa." }, "prevent_registration": { "type": "boolean", "nullable": true, "example": null, "description": "Impedir envio de registro ao banco:\n\nCaso `true`, impede que o boleto seja registrado. Para ser usado nos casos em que o boleto já foi registrado fora da KOBANA mas deseja-se incluí-lo no sistema." }, "notes": { "type": "string", "nullable": true, "example": null, "description": "Observações" }, "custom_attachment_name": { "type": "string", "nullable": true, "example": null, "description": "Nome para ser usado nos arquivos de boleto enviados para o cliente em notificações. Aceita uso de variáveis. Caso seja deixado vazio, o padrão é a palavra “boleto” acompanhada do ID." }, "created_via_api": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se o boleto foi criado por API" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do boleto" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do boleto" }, "payment_count": { "type": "integer", "nullable": true, "description": "Quantidade de pagamentos parciais aceitos para este boleto." }, "url": { "type": "string", "nullable": true, "readOnly": true, "description": "URL para visualização do carnê" }, "status": { "type": "string", "readOnly": true, "description": "Situação do carnê:\n* `created` Gerando\n* `processed` Parcelas criadas\n* `generated` Aberto", "enum": [ "created", "processed", "generated" ] }, "import_id": { "type": "integer", "nullable": true, "readOnly": true, "description": "ID da Importação" }, "ignore_whatsapp": { "type": "boolean", "default": false, "nullable": true, "description": "Nunca enviar este carnê por WhatsApp", "example": null } } }, "v1_custom_bank_billets_object": { "type": "object", "required": [ "expire_at", "amount_cents" ], "properties": { "amount_cents": { "type": "integer", "maxLength": 15, "description": "Valor da parcela (R$) com 2 casas decimais. Formato: 134556 corresponde 1.345,56" }, "expire_at": { "type": "string", "format": "date", "description": "Data de vencimento", "example": "2023-12-12" } } }, "v1_customer_subscription_object": { "type": "object", "required": [ "amount", "customer_person_name", "customer_cnpj_cpf", "customer_zipcode", "customer_address", "customer_neighborhood", "customer_city_name", "customer_state", "bank_billet_account_id" ], "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID da assinatura" }, "customer_id": { "type": "integer", "nullable": true, "description": "ID do Cliente. Quando esse ID é passado, os campos `customer_person_name`, `customer_cnpj_cpf`, `customer_zipcode`, `customer_address`, `customer_city_name`, `customer_state` e `customer_neighborhood` não são obrigatórios.", "example": null }, "customer_person_name": { "type": "string", "maxLength": 120, "description": "Nome do cliente", "example": "João Silva" }, "customer_nickname": { "type": "string", "nullable": true, "maxLength": 255, "description": "Apelido ou Nome Fantasia do Pagador", "example": null }, "customer_cnpj_cpf": { "type": "string", "maxLength": 20, "description": "CPF/CNPJ do cliente", "example": "16.974.923/0001-84" }, "customer_zipcode": { "type": "string", "maxLength": 8, "description": "CEP (formato 99999999)", "example": "01310100" }, "customer_email": { "type": "string", "nullable": true, "format": "email", "maxLength": 80, "description": "E-mail do Pagador", "example": null }, "customer_email_cc": { "type": "string", "nullable": true, "format": "email", "maxLength": 80, "description": "E-mail alternativo do Pagador", "example": null }, "customer_address": { "type": "string", "maxLength": 255, "description": "Endereço", "example": "Rua F, alamenda G" }, "customer_city_name": { "type": "string", "maxLength": 60, "description": "Cidade(Nome deve estar correto e completo)", "example": "São Paulo" }, "customer_state": { "type": "string", "maxLength": 2, "description": "Estado", "example": "SP" }, "customer_neighborhood": { "type": "string", "maxLength": 80, "description": "Bairro", "example": "Centro" }, "customer_address_number": { "type": "string", "maxLength": 10, "description": "Número", "example": null }, "customer_address_complement": { "type": "string", "nullable": true, "maxLength": 120, "description": "Complemento", "example": null }, "customer_phone_number": { "type": "string", "nullable": true, "maxLength": 15, "description": "Telefone (com DDD, DDI é opcional)", "example": null }, "customer_person_type": { "type": "string", "readOnly": true, "nullable": true, "maxLength": 10, "description": "Tipo de Pagador.\n* `individual` Pessoa Física\n* `juridical` Pessoa Jurídica", "enum": [ "individual", "juridical" ] }, "customer_mobile_local_code": { "type": "string", "nullable": true, "maxLength": 2, "description": "DDD do Celular", "example": null }, "customer_mobile_number": { "type": "string", "nullable": true, "maxLength": 9, "description": "Celular", "example": null }, "customer_notes": { "type": "string", "nullable": true, "description": "Observações do Pagador", "example": null }, "customer_ignore_email": { "type": "boolean", "nullable": true, "description": "Nunca enviar e-mail para este cliente", "example": null }, "customer_ignore_sms": { "type": "boolean", "nullable": true, "description": "Nunca enviar SMS para este cliente", "example": null }, "customer_contact_person": { "type": "string", "nullable": true, "maxLength": 120, "description": "Contato", "example": null }, "customer_update": { "type": "string", "nullable": true, "maxLength": 120, "description": "Contato", "example": null }, "bank_billet_account_id": { "type": "integer", "description": "ID da Carteira de Cobrança. Se não informado, usará a carteira padrão.", "example": null }, "amount": { "type": "number", "format": "float", "description": "Valor da Assinatura (R$)", "example": 10.99 }, "cycle": { "type": "string", "readOnly": true, "nullable": true, "maxLength": 20, "description": "Ciclo da assinatura. Default: monthly\n\n* `biweekly` Quinzenal\n* `bimonthly` Bimestral\n* `monthly` Mensal\n* `quarterly` Trimestral\n* `semiannual` Semestral\n* `annual` Anual", "enum": [ "biweekly", "bimonthly", "monthly", "quarterly", "semiannual", "annual" ] }, "next_billing": { "type": "string", "format": "date", "description": "Data da Primeira ou Próxima cobrança. Caso não seja enviado uma data, esse campo será calculado para ter o valor do dia da criação da assinatura mais o ciclo escolhido. Ex.: Mensal(Hoje + 30 dias)", "example": "2022-12-12" }, "end_at": { "type": "string", "format": "date", "nullable": true, "description": "Data em que deseja parar as cobranças. Caso em branco, as cobranças serão geradas automaticamente até que se informe uma data ou se exclua a assinatura.", "example": "2023-12-12" }, "description": { "type": "string", "nullable": true, "description": "Descrição do produto ou serviço", "example": null }, "instructions": { "type": "string", "nullable": true, "description": "Instruções para o Caixa", "example": null }, "days_in_advance": { "type": "integer", "description": "Com quantos dias de antecedência à data de vencimento a cobrança será gerada. Default: 7.", "example": 10 }, "fine_type": { "type": "integer", "nullable": true, "description": "Tipo de multa:\n* `0` Inexistente (Padrão)\n* `1` Para percentual do valor do boleto\n* `2` Para valor fixo", "enum": [ 0, 1, 2 ], "default": 0 }, "days_for_fine": { "type": "integer", "nullable": true, "description": "Quantidade de dias após o vencimento que a multa começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento).", "example": null }, "fine_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Porcentagem de Multa por Atraso Ex: 2% x R$ 250,00 = R$ 5,00. Obrigatória se fine_type é igual a 1", "example": null }, "fine_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor da multa (R$). Obrigatório se fine_type é igual a 2.", "example": null }, "interest_type": { "type": "integer", "nullable": true, "description": "Tipo de juros/mora:\n* `0` Inexistente (Padrão)\n* `1` Para porcentagem diária\n* `2` Para valor diário", "enum": [ 0, 1, 2 ], "default": 0 }, "days_for_interest": { "type": "integer", "nullable": true, "description": "Quantidade de dias após o vencimento que a mora começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento).", "example": null }, "interest_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Porcentagem diária de juros. De 0.0 a 100.0 (Ex 1.5% = 1.5) Obrigatório se interest_type é igual a 1.", "example": null }, "interest_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor diário de juros (R$). Obrigatório se interest_type é igual a 2.", "example": null }, "discount_type": { "type": "integer", "nullable": true, "description": "Tipo de desconto:\n\nO tipo de desconto será o mesmo para todos os três descontos, caso existam. :\n* `0` Inexistente (Padrão)\n* `1` Para valor fixo\n* `2` Para percentual do valor do boleto", "enum": [ 0, 1, 2 ], "default": 0 }, "days_for_discount": { "type": "integer", "nullable": true, "description": "Dias para desconto. Obrigatório se discount_type é diferente de 0(zero)", "example": null }, "discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao desconto. Obrigatório se discount_type é igual a 2", "example": null }, "discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do desconto (R$). Obrigatório se discount_type é igual a 1.", "example": null }, "days_for_second_discount": { "type": "integer", "nullable": true, "description": "Dias para segundo desconto.", "example": null }, "second_discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao segundo desconto.", "example": null }, "second_discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do segundo desconto (R$).", "example": null }, "days_for_third_discount": { "type": "integer", "nullable": true, "description": "Dias para terceiro desconto.", "example": null }, "third_discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao terceiro desconto.", "example": null }, "third_discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do terceiro desconto (R$).", "example": null }, "bank_billet_layout_id": { "type": "integer", "nullable": true, "description": "ID do Modelo de Boleto", "example": null }, "notes": { "type": "string", "nullable": true, "example": null, "description": "Observações" }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas ao boleto", "example": null, "items": { "type": "string" } }, "bank_billet_ids": { "type": "array", "nullable": true, "readOnly": true, "description": "IDs de boletos vinculados ao carnê", "example": null, "items": { "type": "integer" } }, "prevent_registration": { "type": "boolean", "nullable": true, "example": null, "description": "Impedir envio de registro ao banco:\nCaso `true`, impede que o boleto seja registrado. Para ser usado nos casos em que o boleto já foi registrado fora da KOBANA mas deseja-se incluí-lo no sistema." }, "divergent_payment_type": { "type": "integer", "nullable": true, "example": null, "description": "Tipo de pagamento divergente:\n\nVálido apenas para Itaú e Caixa.\n* `1` Aceita qualquer valor divergente\n* `2` Aceita pagamentos dentro de uma faixa de valores ou percentuais\n* `3` Não aceita pagamento de valores divergentes\n* `4` Aceita pagamentos de valores superiores a um valor ou percentual mínimo", "enum": [ null, 1, 2, 3, 4 ] }, "divergent_payment_value_type": { "type": "integer", "nullable": true, "example": null, "description": "Tipo de valor a considerar para os limites de pagamentos:\n\nVálido apenas para Itaú e Caixa.\n* `1` Informa pagamentos divergentes por valores\n* `2` Informa pagamentos divergentes por percentuais", "enum": [ null, 1, 2 ] }, "divergent_payment_maximum_value": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Valor máximo para a faixa de pagamentos divergentes. " }, "divergent_payment_minimum_value": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Valor mínimo para a faixa de pagamentos divergentes. " }, "divergent_payment_maximum_percentage": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Percentual máximo para a faixa de pagamentos divergentes. " }, "divergent_payment_minimum_percentage": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Percentual mínimo para a faixa de pagamentos divergentes." }, "divergent_payment_limit": { "type": "integer", "nullable": true, "example": null, "description": "Quantidade de pagamentos permitida. Obrigatório se informados dados para pagamento divergente. Usado somente pela Caixa." }, "custom_attachment_name": { "type": "string", "nullable": true, "example": null, "description": "Nome para ser usado nos arquivos de boleto enviados para o cliente em notificações. Aceita uso de variáveis. Caso seja deixado vazio, o padrão é a palavra “boleto” acompanhada do ID." }, "guarantor_name": { "type": "string", "nullable": true, "maxLength": 100, "description": "Nome do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_cnpj_cpf": { "type": "string", "nullable": true, "maxLength": 20, "description": "CNPJ/CPF do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_address_number": { "type": "string", "nullable": true, "maxLength": 10, "description": "Número do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_neighborhood": { "type": "string", "nullable": true, "maxLength": 80, "description": "Bairro do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_phone_number": { "type": "string", "nullable": true, "maxLength": 11, "description": "Telefone (com DDD) do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_city_name": { "type": "string", "nullable": true, "maxLength": 60, "description": "Cidade(Nome deve estar correto e completo) do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_state": { "type": "string", "nullable": true, "maxLength": 2, "description": "Estado do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_zipcode": { "type": "string", "nullable": true, "maxLength": 8, "description": "CEP (formato 99999999) do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_address": { "type": "string", "nullable": true, "maxLength": 255, "description": "Endereço do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_address_complement": { "type": "string", "nullable": true, "maxLength": 60, "description": "Complemento do Beneficiário final (Sacador/Avalista)", "example": null }, "days_for_revoke": { "type": "integer", "nullable": true, "description": "Dias corridos para Baixa/Devolução:\n\n Nulo/Branco: Obedece ao padrão do banco.\n 0: Baixa/Devolução no mesmo dia do vencimento.\n 1 ou mais: Baixa/Devolução após o vencimento(Vencimento + X dias corridos).\n ", "example": null }, "days_for_negativation": { "type": "integer", "nullable": true, "maximum": 99, "example": null, "description": "Dias corridos para Negativação:\n\nDisponível apenas para os seguintes bancos e formatos.\n\n* Banco |\tCNAB 240|\tCNAB 400 |Webservice\n* Bradesco |\tSim |\tSim\t| Não\n* Itaú | Não | Sim | Não\n " }, "days_for_sue": { "type": "integer", "nullable": true, "description": "Dias corridos para Protesto", "example": null }, "payment_count": { "type": "integer", "nullable": true, "description": "Quantidade de pagamentos parciais aceitos para este boleto." }, "import_id": { "type": "integer", "nullable": true, "readOnly": true, "description": "ID da Importação" }, "ignore_whatsapp": { "type": "boolean", "default": false, "nullable": true, "description": "Nunca enviar esta asinatura por WhatsApp", "example": null }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do registro" } } }, "v1_bank_billet_account_object": { "type": "object", "required": [ "bank_contract_slug", "agency_number", "account_number", "account_digit", "beneficiary_name", "beneficiary_cnpj_cpf", "beneficiary_address_street", "beneficiary_address_street_number", "beneficiary_address_complement", "beneficiary_address_neighborhood", "beneficiary_address_city", "beneficiary_address_state", "beneficiary_address_zipcode", "beneficiary_address" ], "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID da carteira" }, "bank_contract_slug": { "type": "string", "maxLength": 50, "description": "[Slug da Carteira](/reference/bancos-suportados)" }, "next_our_number": { "type": "integer", "maxLength": 40, "nullable": true, "description": "Próximo Nosso Número. Default: 1", "example": 1 }, "next_remittance_number": { "type": "integer", "maxLength": 40, "nullable": true, "example": 1, "description": "Último sequencial da remessa Default: 1" }, "agency_number": { "type": "string", "maxLength": 20, "description": "Agência" }, "agency_digit": { "type": "string", "maxLength": 2, "nullable": true, "description": "Dígito da Agência. Opcional: será calculado automaticamente usando Módulo 11 quando o banco exigir e não for fornecido." }, "account_number": { "type": "string", "maxLength": 20, "description": "Conta" }, "account_digit": { "type": "string", "maxLength": 2, "description": "Dígito da Conta" }, "extra1": { "type": "string", "nullable": true, "maxLength": 15, "description": "Campo extra 1. Dependendo da carteira escolhida poderá ser obrigátorio." }, "extra1_digit": { "type": "string", "nullable": true, "maxLength": 3, "description": "Digito do Campo extra 1. Dependendo da carteira escolhida poderá ser obrigátorio." }, "extra2": { "type": "string", "nullable": true, "maxLength": 15, "description": "Campo extra 2. Dependendo da carteira escolhida poderá ser obrigátorio." }, "extra2_digit": { "type": "string", "nullable": true, "maxLength": 3, "description": "Dígito do Campo extra 2. Dependendo da carteira escolhida poderá ser obrigátorio." }, "extra3": { "type": "string", "nullable": true, "maxLength": 30, "description": "Código de Remessa" }, "payment_place": { "type": "string", "nullable": true, "maxLength": 100, "example": null, "description": "Local de Pagamento" }, "contract": { "type": "string", "maxLength": 15, "description": "Contrato" }, "contract_type": { "type": "string", "maxLength": 2, "description": "Tipo do Contrato" }, "beneficiary_name": { "type": "string", "maxLength": 100, "description": "Nome do Beneficiário" }, "beneficiary_cnpj_cpf": { "type": "string", "maxLength": 20, "description": "CNPJ/CPF do Beneficiário" }, "beneficiary_address_street": { "type": "string", "maxLength": 255, "nullable": true, "description": "Rua do Beneficiário" }, "beneficiary_address_street_number": { "type": "string", "maxLength": 30, "nullable": true, "description": "Numero da rua do Beneficiário" }, "beneficiary_address_complement": { "type": "string", "maxLength": 255, "nullable": true, "description": "Complemento do endereço do Beneficiário" }, "beneficiary_address_neighborhood": { "type": "string", "maxLength": 255, "nullable": true, "description": "Bairro do Beneficiário" }, "beneficiary_address_city": { "type": "string", "maxLength": 50, "nullable": true, "description": "Cidade do Beneficiário" }, "beneficiary_address_state": { "type": "string", "maxLength": 2, "nullable": true, "description": "Estado do Beneficiário" }, "beneficiary_address_zipcode": { "type": "string", "maxLength": 8, "nullable": true, "description": "CEP do Beneficiário (formato 99999999)", "example": "01310100" }, "beneficiary_address": { "type": "string", "deprecated": true, "nullable": true, "readOnly": true, "description": "Endereço completo do Beneficiário." }, "financial_account": { "type": "object", "nullable": true, "readOnly": true, "description": "Conta Financeira associada à carteira", "properties": { "uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira" } } }, "bolepix_enabled_at": { "type": "string", "nullable": true, "readOnly": true, "description": "Data e Hora em que o boleto híbrido foi habilitado." }, "bolepix": { "type": "object", "nullable": true, "description": "Configuração de Boleto Híbrido", "properties": { "pix_mode": { "type": "integer", "nullable": true, "example": 2, "description": "Quem irá gerenciar o pix\n * 1 - Gerenciado pela Kobana\n * 2 - Gerenciado pelo Banco\n * 3 - Não configurado" }, "pix_account_id": { "type": "integer", "nullable": true, "description": "ID da conta pix que será usada na configuração do boleto híbrido.\n Se o responsável pelo gerenciamento do pix for o banco, a conta pix deve informada deve ser obrigatóriamente uma conta pix mesmo banco", "example": null }, "pix_account": { "type": "object", "nullable": true, "description": "Conta Pix que será usada na configuração do boleto híbrido.", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID da Conta Pix" }, "uid": { "type": "string", "readOnly": true, "description": "UID da Conta Pix" }, "custom_name": { "type": "string", "description": "Nome personalizado para a conta pix", "example": "Conta Pix Kobana" }, "key": { "type": "string", "description": "Chave pix da conta", "example": "+55999999999" }, "financial_provider_slug": { "type": "string", "description": "Instituição financeira da conta pix", "example": "bradesco" }, "enabled": { "type": "boolean", "description": "Indica se a conta pix está habilitada", "example": true }, "default": { "type": "boolean", "description": "Indica se a conta pix é a padrão", "example": false }, "beneficiary": { "type": "object", "description": "Beneficiário da Conta Pix", "properties": { "name": { "type": "string", "description": "Nome do Beneficiário" }, "document": { "type": "string", "description": "Documento do Beneficiário (CNPJ ou CPF)", "example": "12345678901" }, "address": { "type": "object", "description": "Endereço do Beneficiário", "properties": { "street": { "type": "string", "description": "Rua do beneficiário", "example": "Rua do Beneficiário" }, "number": { "type": "string", "description": "Número da rua do beneficiário", "example": "123" }, "complement": { "type": "string", "description": "Complemento do endereço do beneficiário", "example": "Apto 101" }, "neighborhood": { "type": "string", "description": "Bairro do beneficiário", "example": "Bairro do Beneficiário" }, "city_name": { "type": "string", "description": "Cidade do beneficiário", "example": "Cidade do Beneficiário" }, "state": { "type": "string", "description": "Estado do beneficiário", "example": "SP" }, "zip_code": { "type": "string", "description": "CEP do beneficiário (formato 99999999)", "example": "01310100" } } } } } } }, "pix_billing_options": { "type": "object", "nullable": true, "description": "Opções de cobrança do pix no boleto. Deve ser enviado quando o pix for gerenciado pela Kobana.", "properties": { "kind": { "type": "string", "nullable": false, "example": "instant", "description": "Tipo de cobrança\n * instant - Cobrança imediata\n * billing - Cobrança com vencimento" }, "interest": { "type": "boolean", "nullable": true, "description": "Habilitar juros", "example": true }, "fine": { "type": "boolean", "nullable": true, "description": "Habilitar multa", "example": true }, "discount": { "type": "boolean", "nullable": true, "description": "Habilitar desconto", "example": true }, "revoke_days": { "type": "boolean", "nullable": true, "description": "Habilitar dias para revogação", "example": true } } } } }, "name": { "type": "string", "maxLength": 255, "description": "Nome da Conta. Não é recebido na criação e nem na atualização, só é retornado na consulta e listagem" }, "status": { "type": "string", "readOnly": true, "description": "Situação da carteira:\nQuando a carteira acaba de ser cadastrada, ela ganha o status `pending`.\n\nNesse momento o usuário deve aceitar os termos e iniciar a homologação.\n\nAo clicar em “Prosseguir com a Homologação”, o status passa para `homologating`.\n\nSerá gerado um boleto e uma remessa de Homologação para ser enviada ao banco. Após o término, o status passa para `validating`.\n\nA partir desse momento o usuário precisa informar o valor do boleto que foi gerado ou enviar o retorno processado pelo banco.\n\nQuando o valor é informado corretamente, ou no retorno processado, o banco diz estar tudo certo, o status passa para `active`.\n\n* `pending` Homologação não iniciada\n* `homologating` Em homologação, aguardando pagamento do boleto\n* `validating` Boleto pago, aguardando validação\n* `active` Ativa e pronta para uso", "enum": [ "pending", "homologating", "validating", "active" ] }, "default": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Padrão.\nO campo `default` determina a carteira de cobrança que será usada na criação do boleto quando nenhuma carteira for informada.\n\nNo momento que a primeira carteira é homologada (passa para o `status` = `active`), ela recebe o valor `default` = `true`" }, "configuration": { "type": "object", "nullable": true, "description": "Configuração de dados padrões para boleto" }, "bank_contract": { "type": "object", "readOnly": true, "description": "Dados da Carteira. Não é recebido na criação e nem na atualização, só é retornado na consulta e listagem." }, "custom_name": { "type": "string", "maxLength": 255, "description": "Nome da Carteira para identificação dentro da Kobana." }, "kind": { "type": "string", "description": "Tipo de CNAB:\n* `cnab400` CNAB 400\n* `cnab240` CNAB 240", "enum": [ "cnab400", "cnab240" ] }, "remittance_disabled": { "type": "boolean", "nullable": true, "description": "Desabilita geração de remessas." }, "remittance_disabled_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora em que a geração de remessa foi desabilitada." }, "allow_expiration_on_weekends": { "type": "boolean", "nullable": true, "description": "Permitir vencimento em fim de semana e feriados" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação da carteira" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização da carteira" }, "created_via_api": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se a carteira foi criada por API" } } }, "v1_bank_billet_account_update_object": { "type": "object", "properties": { "kind": { "type": "string", "description": "Tipo de CNAB:\n* `cnab400` CNAB 400\n* `cnab240` CNAB 240", "enum": [ "cnab400", "cnab240" ] }, "bank_contract_slug": { "type": "string", "maxLength": 50, "description": "[Slug da Carteira](/reference/bancos-suportados).\n Carteiras ativas não poderão ter o campo bank_contract_slug alterados." }, "financial_account": { "type": "object", "nullable": true, "readOnly": true, "description": "Conta Financeira associada à carteira", "properties": { "uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira" } } }, "payment_place": { "type": "string", "nullable": true, "maxLength": 100, "example": null, "description": "Local de Pagamento" }, "custom_name": { "type": "string", "maxLength": 255, "description": "Nome da Carteira para identificação dentro da Kobana." }, "allow_expiration_on_weekends": { "type": "boolean", "nullable": true, "description": "Permitir vencimento em fim de semana e feriados" }, "beneficiary_name": { "type": "string", "maxLength": 255, "description": "Nome do Beneficiário" }, "beneficiary_cnpj_cpf": { "type": "string", "maxLength": 20, "description": "CNPJ/CPF do Beneficiário" }, "agency_number": { "type": "string", "maxLength": 20, "readOnly": true, "description": "Agência. Preenchido automaticamente quando financial_account_uid é fornecido." }, "agency_digit": { "type": "string", "maxLength": 2, "nullable": true, "readOnly": true, "description": "Dígito da Agência. Opcional: será calculado automaticamente usando Módulo 11 quando o banco exigir e não for fornecido. Preenchido automaticamente quando financial_account_uid é fornecido." }, "account_number": { "type": "string", "maxLength": 20, "readOnly": true, "description": "Conta. Preenchida automaticamente quando financial_account_uid é fornecido." }, "account_digit": { "type": "string", "maxLength": 2, "readOnly": true, "description": "Dígito da Conta. Preenchido automaticamente quando financial_account_uid é fornecido." }, "extra1": { "type": "string", "nullable": true, "maxLength": 15, "description": "Campo extra 1." }, "extra1_digit": { "type": "string", "nullable": true, "maxLength": 3, "description": "Digito do Campo extra 1." }, "extra2": { "type": "string", "nullable": true, "maxLength": 15, "description": "Campo extra 2." }, "extra2_digit": { "type": "string", "nullable": true, "maxLength": 3, "description": "Dígito do Campo extra 2." }, "contract": { "type": "string", "maxLength": 15, "readOnly": true, "description": "Contrato" }, "contract_type": { "type": "string", "maxLength": 2, "description": "Tipo do Contrato" }, "extra3": { "type": "string", "nullable": true, "maxLength": 30, "description": "Código de Remessa" }, "beneficiary_address_street": { "type": "string", "maxLength": 255, "nullable": true, "description": "Rua do Beneficiário" }, "beneficiary_address_street_number": { "type": "string", "maxLength": 30, "nullable": true, "description": "Numero da rua do Beneficiário" }, "beneficiary_address_complement": { "type": "string", "maxLength": 255, "nullable": true, "description": "Complemento do endereço do Beneficiário" }, "beneficiary_address_neighborhood": { "type": "string", "maxLength": 255, "nullable": true, "description": "Bairro do Beneficiário" }, "beneficiary_address_city": { "type": "string", "maxLength": 50, "nullable": true, "description": "Cidade do Beneficiário" }, "beneficiary_address_state": { "type": "string", "maxLength": 2, "nullable": true, "description": "Estado do Beneficiário" }, "beneficiary_address_zipcode": { "type": "string", "maxLength": 8, "nullable": true, "description": "CEP do Beneficiário (formato 99999999)", "example": "01310100" }, "beneficiary_address": { "type": "string", "deprecated": true, "nullable": true, "readOnly": true, "description": "Endereço completo do Beneficiário." }, "bolepix_enabled": { "type": "boolean", "nullable": true, "deprecated": true, "description": "Habilitar Bolepix (legado — prefira o objeto `bolepix`)" }, "bolepix": { "type": "object", "nullable": true, "description": "Configuração de Boleto Híbrido", "properties": { "pix_mode": { "type": "integer", "nullable": true, "example": 2, "description": "Quem irá gerenciar o pix\n * 1 - Gerenciado pela Kobana\n * 2 - Gerenciado pelo Banco\n * 3 - Não configurado" }, "pix_account": { "type": "object", "description": "Escolha um dos formatos para associar uma conta pix a esta carteira", "oneOf": [ { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "description": "UID da Conta Pix", "example": "018df180-7208-727b-a10a-ea545e4a75a8" } } }, { "type": "object", "properties": { "id": { "type": "string", "description": "ID da Conta Pix", "example": "018df180-7208-727b-a10a-ea545e4a75a8" } } } ] }, "pix_billing_options": { "type": "object", "nullable": true, "description": "Opções de cobrança do pix no boleto. Deve ser enviado quando o pix for gerenciado pela Kobana.", "properties": { "kind": { "type": "string", "nullable": false, "example": "instant", "description": "Tipo de cobrança\n * instant - Cobrança imediata\n * billing - Cobrança com vencimento" }, "interest": { "type": "boolean", "nullable": true, "description": "Habilitar juros", "example": true }, "fine": { "type": "boolean", "nullable": true, "description": "Habilitar multa", "example": true }, "discount": { "type": "boolean", "nullable": true, "description": "Habilitar desconto", "example": true }, "revoke_days": { "type": "boolean", "nullable": true, "description": "Habilitar dias para revogação", "example": true } } } } }, "bolepix_key": { "type": "string", "nullable": true, "description": "Chave Pix que será usada no Bolepix" }, "default": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Padrão.\n O campo `default` determina a carteira de cobrança que será usada na criação do boleto quando nenhuma carteira for informada.\n\n No momento que a primeira carteira é homologada (passa para o `status` = `active`), ela recebe o valor `default` = `true`" }, "remittance_disabled": { "type": "boolean", "nullable": true, "description": "Desabilita geração de remessas." }, "next_our_number": { "type": "integer", "nullable": true, "maxLength": 100, "example": null, "description": "Último nosso número" }, "next_remittance_number": { "type": "integer", "maxLength": 40, "nullable": true, "example": 1, "description": "Último sequencial da remessa Default: 1" }, "bank_billet_account_next_our_number_attributes": { "type": "object", "required": [ "next_our_number" ], "properties": { "next_our_number": { "type": "integer", "maxLength": 40, "nullable": true, "readOnly": true, "description": "Próximo Nosso Número. Default: 1", "example": 1 } } }, "bank_billet_account_next_remittance_number_attributes": { "type": "object", "required": [ "next_remittance_number" ], "properties": { "next_remittance_number": { "type": "integer", "nullable": true, "readOnly": true, "description": "Próximo Número da Remessa. Default: 1", "example": 1 } } } } }, "v1_new_bank_billet_account_object": { "type": "object", "required": [ "bank_contract_slug", "financial_account_uid", "beneficiary_name", "beneficiary_cnpj_cpf", "beneficiary_address_street", "beneficiary_address_street_number", "beneficiary_address_complement", "beneficiary_address_neighborhood", "beneficiary_address_city", "beneficiary_address_state", "beneficiary_address_zipcode", "beneficiary_address" ], "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID da carteira" }, "bank_contract_slug": { "type": "string", "maxLength": 50, "description": "[Slug da Carteira](/reference/bancos-suportados)" }, "financial_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "UID da Conta Financeira. Quando informado, os dados de agência e conta serão preenchidos automaticamente a partir da conta financeira." }, "next_our_number": { "type": "integer", "maxLength": 40, "nullable": true, "description": "Próximo Nosso Número. Default: 1", "example": 1 }, "next_remittance_number": { "type": "integer", "maxLength": 40, "nullable": true, "example": 1, "description": "Último sequencial da remessa Default: 1" }, "agency_number": { "type": "string", "maxLength": 20, "readOnly": true, "description": "Agência. Preenchido automaticamente quando financial_account_uid é fornecido." }, "agency_digit": { "type": "string", "maxLength": 2, "readOnly": true, "description": "Dígito da Agência. Preenchido automaticamente quando financial_account_uid é fornecido." }, "account_number": { "type": "string", "maxLength": 20, "readOnly": true, "description": "Conta. Preenchida automaticamente quando financial_account_uid é fornecido." }, "account_digit": { "type": "string", "maxLength": 2, "readOnly": true, "description": "Dígito da Conta. Preenchido automaticamente quando financial_account_uid é fornecido." }, "extra1": { "type": "string", "nullable": true, "maxLength": 15, "description": "Campo extra 1. Dependendo da carteira escolhida poderá ser obrigátorio." }, "extra1_digit": { "type": "string", "nullable": true, "maxLength": 3, "description": "Digito do Campo extra 1. Dependendo da carteira escolhida poderá ser obrigátorio." }, "extra2": { "type": "string", "nullable": true, "maxLength": 15, "description": "Campo extra 2. Dependendo da carteira escolhida poderá ser obrigátorio." }, "extra2_digit": { "type": "string", "nullable": true, "maxLength": 3, "description": "Dígito do Campo extra 2. Dependendo da carteira escolhida poderá ser obrigátorio." }, "extra3": { "type": "string", "nullable": true, "maxLength": 30, "description": "Código de Remessa" }, "payment_place": { "type": "string", "nullable": true, "maxLength": 100, "example": null, "description": "Local de Pagamento" }, "contract": { "type": "string", "maxLength": 15, "description": "Contrato" }, "contract_type": { "type": "string", "maxLength": 2, "description": "Tipo do Contrato" }, "beneficiary_name": { "type": "string", "maxLength": 100, "description": "Nome do Beneficiário" }, "beneficiary_cnpj_cpf": { "type": "string", "maxLength": 20, "description": "CNPJ/CPF do Beneficiário" }, "beneficiary_address_street": { "type": "string", "maxLength": 255, "nullable": true, "description": "Rua do Beneficiário" }, "beneficiary_address_street_number": { "type": "string", "maxLength": 30, "nullable": true, "description": "Numero da rua do Beneficiário" }, "beneficiary_address_complement": { "type": "string", "maxLength": 255, "nullable": true, "description": "Complemento do endereço do Beneficiário" }, "beneficiary_address_neighborhood": { "type": "string", "maxLength": 255, "nullable": true, "description": "Bairro do Beneficiário" }, "beneficiary_address_city": { "type": "string", "maxLength": 50, "nullable": true, "description": "Cidade do Beneficiário" }, "beneficiary_address_state": { "type": "string", "maxLength": 2, "nullable": true, "description": "Estado do Beneficiário" }, "beneficiary_address_zipcode": { "type": "string", "maxLength": 8, "nullable": true, "description": "CEP do Beneficiário (formato 99999999)", "example": "01310100" }, "beneficiary_address": { "type": "string", "deprecated": true, "nullable": true, "readOnly": true, "description": "Endereço completo do Beneficiário." }, "financial_account": { "type": "object", "nullable": true, "readOnly": true, "description": "Conta Financeira associada à carteira", "properties": { "uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira" } } }, "bolepix_enabled_at": { "type": "string", "nullable": true, "readOnly": true, "description": "Data e Hora em que o boleto híbrido foi habilitado." }, "bolepix": { "type": "object", "nullable": true, "description": "Configuração de Boleto Híbrido", "properties": { "pix_mode": { "type": "integer", "nullable": true, "example": 2, "description": "Quem irá gerenciar o pix\n * 1 - Gerenciado pela Kobana\n * 2 - Gerenciado pelo Banco\n * 3 - Não configurado" }, "pix_account": { "type": "object", "description": "Conta pix que será usada na configuração do boleto híbrido.\n Se o responsável pelo gerenciamento do pix for o banco, a conta pix deve informada deve ser obrigatóriamente uma conta pix mesmo banco\n Escolha um dos formatos para associar uma conta pix a esta carteira:", "oneOf": [ { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID da Conta Pix" }, "uid": { "type": "string", "readOnly": true, "description": "UID da Conta Cix" }, "custom_name": { "type": "string", "description": "Nome personalizado para a conta pix", "example": "Conta Pix Kobana" }, "key": { "type": "string", "description": "Chave pix da conta", "example": "+55999999999" }, "financial_provider_slug": { "type": "string", "description": "Instituição financeira da conta pix", "example": "bradesco" }, "enabled": { "type": "boolean", "description": "Indica se a conta pix está habilitada", "example": true }, "default": { "type": "boolean", "description": "Indica se a conta pix é a padrão", "example": false }, "beneficiary": { "type": "object", "description": "Beneficiário da conta pix", "properties": { "name": { "type": "string", "description": "Nome do beneficiário" }, "document": { "type": "string", "description": "Documento do beneficiário (CNPJ ou CPF)", "example": "12345678901" }, "address": { "type": "object", "description": "Endereço do beneficiário", "properties": { "street": { "type": "string", "description": "Rua do beneficiário", "example": "Rua do Beneficiário" }, "number": { "type": "string", "description": "Número da rua do beneficiário", "example": "123" }, "complement": { "type": "string", "description": "Complemento do endereço do beneficiário", "example": "Apto 101" }, "neighborhood": { "type": "string", "description": "Bairro do beneficiário", "example": "Bairro do Beneficiário" }, "city_name": { "type": "string", "description": "Cidade do beneficiário", "example": "Cidade do Beneficiário" }, "state": { "type": "string", "description": "Estado do beneficiário", "example": "SP" }, "zip_code": { "type": "string", "description": "CEP do beneficiário (formato 99999999)", "example": "01310100" } } } } } } }, { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "description": "UID da Conta Pix", "example": "018df180-7208-727b-a10a-ea545e4a75a8" } } }, { "type": "object", "properties": { "id": { "type": "string", "description": "ID da Conta Pix", "example": "018df180-7208-727b-a10a-ea545e4a75a8" } } } ] }, "pix_billing_options": { "type": "object", "nullable": true, "description": "Opções de cobrança do pix no boleto. Deve ser enviado quando o pix for gerenciado pela Kobana.", "properties": { "kind": { "type": "string", "nullable": false, "example": "instant", "description": "Tipo de cobrança\n * instant - Cobrança imediata\n * billing - Cobrança com vencimento" }, "interest": { "type": "boolean", "nullable": true, "description": "Habilitar juros", "example": true }, "fine": { "type": "boolean", "nullable": true, "description": "Habilitar multa", "example": true }, "discount": { "type": "boolean", "nullable": true, "description": "Habilitar desconto", "example": true }, "revoke_days": { "type": "boolean", "nullable": true, "description": "Habilitar dias para revogação", "example": true } } } } }, "name": { "type": "string", "maxLength": 255, "description": "Nome da Conta. Não é recebido na criação e nem na atualização, só é retornado na consulta e listagem" }, "status": { "type": "string", "readOnly": true, "description": "Situação da carteira:\nQuando a carteira acaba de ser cadastrada, ela ganha o status `pending`.\n\nNesse momento o usuário deve aceitar os termos e iniciar a homologação.\n\nAo clicar em “Prosseguir com a Homologação”, o status passa para `homologating`.\n\nSerá gerado um boleto e uma remessa de Homologação para ser enviada ao banco. Após o término, o status passa para `validating`.\n\nA partir desse momento o usuário precisa informar o valor do boleto que foi gerado ou enviar o retorno processado pelo banco.\n\nQuando o valor é informado corretamente, ou no retorno processado, o banco diz estar tudo certo, o status passa para `active`.\n\n* `pending` Homologação não iniciada\n* `homologating` Em homologação, aguardando pagamento do boleto\n* `validating` Boleto pago, aguardando validação\n* `active` Ativa e pronta para uso", "enum": [ "pending", "homologating", "validating", "active" ] }, "default": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Padrão.\nO campo `default` determina a carteira de cobrança que será usada na criação do boleto quando nenhuma carteira for informada.\n\nNo momento que a primeira carteira é homologada (passa para o `status` = `active`), ela recebe o valor `default` = `true`" }, "configuration": { "type": "object", "nullable": true, "description": "Configuração de dados padrões para boleto" }, "bank_contract": { "type": "object", "readOnly": true, "description": "Dados da Carteira. Não é recebido na criação e nem na atualização, só é retornado na consulta e listagem." }, "custom_name": { "type": "string", "maxLength": 255, "description": "Nome da Carteira para identificação dentro da Kobana." }, "kind": { "type": "string", "description": "Tipo de CNAB:\n* `cnab400` CNAB 400\n* `cnab240` CNAB 240", "enum": [ "cnab400", "cnab240" ] }, "remittance_disabled": { "type": "boolean", "nullable": true, "description": "Desabilita geração de remessas." }, "remittance_disabled_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora em que a geração de remessa foi desabilitada." }, "allow_expiration_on_weekends": { "type": "boolean", "nullable": true, "description": "Permitir vencimento em fim de semana e feriados" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação da carteira" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização da carteira" }, "created_via_api": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se a carteira foi criada por API" } } }, "v1_bank_billet_account_pix_account_object": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID da Conta Pix" }, "uid": { "type": "string", "readOnly": true, "description": "UID da Conta Cix" }, "custom_name": { "type": "string", "description": "Nome personalizado para a conta pix", "example": "Conta Pix Kobana" }, "key": { "type": "string", "description": "Chave pix da conta", "example": "+55999999999" }, "financial_provider_slug": { "type": "string", "description": "Instituição financeira da conta pix", "example": "bradesco" }, "enabled": { "type": "boolean", "description": "Indica se a conta pix está habilitada", "example": true }, "default": { "type": "boolean", "description": "Indica se a conta pix é a padrão", "example": false }, "beneficiary": { "type": "object", "description": "Beneficiário da conta pix", "properties": { "name": { "type": "string", "description": "Nome do beneficiário" }, "document": { "type": "string", "description": "Documento do beneficiário (CNPJ ou CPF)", "example": "12345678901" }, "address": { "type": "object", "description": "Endereço do beneficiário", "properties": { "street": { "type": "string", "description": "Rua do beneficiário", "example": "Rua do Beneficiário" }, "number": { "type": "string", "description": "Número da rua do beneficiário", "example": "123" }, "complement": { "type": "string", "description": "Complemento do endereço do beneficiário", "example": "Apto 101" }, "neighborhood": { "type": "string", "description": "Bairro do beneficiário", "example": "Bairro do Beneficiário" }, "city_name": { "type": "string", "description": "Cidade do beneficiário", "example": "Cidade do Beneficiário" }, "state": { "type": "string", "description": "Estado do beneficiário", "example": "SP" }, "zip_code": { "type": "string", "description": "CEP do beneficiário (formato 99999999)", "example": "01310100" } } } } } } }, "v1_event_object": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Evento" }, "code": { "type": "string", "readOnly": true, "example": "bank_billet.created", "description": "Código do evento.\n* `ping` Ping\n* `access_token.db.created` Token de Acesso criado.\n* `access_token.db.updated` Token de Acesso atualizado.\n* `access_token.db.deleted` Token de Acesso excluído.\n* `access_token.reminder` Lembrete de expiração do Token de Acesso.\n* `access_token.expired` Token de Acesso expirou.\n* `account.updated` Conta atualizada.\n* `account.blocked` Conta bloqueada.\n* `account.bank_billet_creation_blocked` Emissão de boletos bloqueada.\n* `bank_billet.created` Boleto criado.\n* `bank_billet.updated` Boleto atualizado.\n* `bank_billet.generated` PDF do Boleto Gerado ou Atualizado.\n* `bank_billet.canceled` Boleto cancelado.\n* `bank_billet.blocked` Boleto foi bloqueado.\n* `bank_billet.overdue` Boleto ficou vencido.\n* `bank_billet.paid` Boleto foi pago.\n* `bank_billet.due_date` Notifica boleto com 15, 7, 3 e 1 dias antes do vencimento.\n* `bank_billet.rejected` Boleto rejeitado.\n* `bank_billet.cancel.requested` Cancelamento do Boleto solicitado.\n* `bank_billet.cancel.confirmed` Cancelamento do Boleto confirmado.\n* `bank_billet.cancel.failed` Falha no cancelamento do Boleto.\n* `bank_billet.cancel.error` Ocorreu um erro no cancelamento do Boleto.\n* `bank_billet.register.requested` Registro do Boleto solicitado.\n* `bank_billet.register.confirmed` Registro do Boleto confirmado.\n* `bank_billet.register.failed` Falha no registro do Boleto.\n* `bank_billet.register.error` Ocorreu um erro no registro do Boleto.\n* `bank_billet.update.requested` Atualização do Boleto solicitada.\n* `bank_billet.update.confirmed` Atualização do Boleto confirmada.\n* `bank_billet.update.failed` Falha na atualização do Boleto.\n* `bank_billet.update.error` Ocorreu um erro na atualização do Boleto.\n* `bank_billet.registered` Boleto registrado.\n* `bank_billet.deleted` Boleto excluído.\n* `bank_billet.sync.requested` Sincronização do Boleto solicitada.\n* `bank_billet.sync.confirmed` Sincronização do Boleto confirmada.\n* `bank_billet.sync.failed` Falha na sincronização do Boleto.\n* `bank_billet.sync.error` Ocorreu um erro na sincronização do Boleto.\n* `bank_billet.get.requested` Informação do Boleto solicitada.\n* `bank_billet.get.confirmed` Informação do Boleto confirmada.\n* `bank_billet.get.failed` Falha na informação do Boleto.\n* `bank_billet.get.error` Ocorreu um erro na informação do Boleto.\n* `bank_billet.get_child.requested` Informação do Boleto filho solicitada.\n* `bank_billet.get_child.confirmed` Informação do Boleto filho confirmada.\n* `bank_billet.get_child.failed` Falha na informação do Boleto filho.\n* `bank_billet.get_child.error` Ocorreu um erro na informação do Boleto filho.\n* `bank_billet.find.requested` Busca de Boleto solicitada.\n* `bank_billet.find.confirmed` Busca de Boleto confirmada.\n* `bank_billet.find.failed` Falha na busca de Boleto.\n* `bank_billet.find.error` Ocorreu um erro na busca de Boleto.\n* `bank_billet.add_pix.requested` Adição do Pix ao Boleto solicitada.\n* `bank_billet.add_pix.confirmed` Adição do Pix ao Boleto confirmada.\n* `bank_billet.add_pix.failed` Falha na adição do Pix ao Boleto.\n* `bank_billet.add_pix.error` Ocorreu um erro na adição do Pix ao Boleto.\n* `bank_billet.get_pix.requested` Consulta do Pix do Boleto solicitada.\n* `bank_billet.get_pix.confirmed` Consulta do Pix do Boleto confirmada.\n* `bank_billet.get_pix.failed` Falha na consulta do Pix do Boleto.\n* `bank_billet.get_pix.error` Ocorreu um erro na consulta do Pix do Boleto.\n* `bank_billet.protest.requested` Protesto do Boleto solicitado.\n* `bank_billet.protest.confirmed` Protesto do Boleto confirmado.\n* `bank_billet.protest.failed` Falha no protesto do Boleto.\n* `bank_billet.protest.error` Ocorreu um erro no protesto do Boleto.\n* `bank_billet_discharge.created` Registro de retorno criado.\n* `bank_billet_discharge.updated` Registro de retorno atualizado.\n* `bank_billet_discharge.deleted` Registro de retorno excluído.\n* `bank_billet_remittance.created` Registro de remessa criado.\n* `bank_billet_remittance.updated` Registro de remessa atualizado.\n* `bank_billet_remittance.deleted` Registro de remessa excluído.\n* `bank_billet_registration.created` Registro de Boleto criado.\n* `bank_billet_registration.updated` Registro de Boleto atualizado.\n* `bank_billet_registration.deleted` Registro de Boleto excluído.\n* `bank_billet_payment.created` Recebimento criado.\n* `bank_billet_payment.updated` Recebimento atualizado.\n* `bank_billet_payment.deleted` Recebimento excluído.\n* `customer.created` Cliente criado.\n* `customer.updated` Cliente atualizado.\n* `customer.portal_password_updated` Senha do portal do cliente atualizada.\n* `customer.deleted` Cliente excluído.\n* `transaction.created` Transação criada.\n* `transaction.updated` Transação atualizada.\n* `transaction.processed` Transação processada.\n* `withdrawal.transferred` Saque transferido.\n* `withdrawal.requested` Saque solicitado.\n* `addon.activated` Addon ativado.\n* `addon.removed` Addon removido.\n* `plan_subscription.activated` Plano ativado.\n* `plan_subscription.removed` Plano removido.\n* `plan_subscription.fee` Cobrança do plano.\n* `plan_subscription.updated` Plano atualizado.\n* `user.created` Usuário criado.\n* `user.updated` Usuário atualizado.\n* `user.deleted` Usuário excluído.\n* `remittance.created` Remessa criada.\n* `remittance.processed` Remessa processada.\n* `remittance.downloaded` Download de Remessa realizado.\n* `remittance.sent` Remessa enviada.\n* `remittance.deleted` Remessa excluída.\n* `remittance.line.db.created` Linha de Remessa criada.\n* `remittance.line.db.updated` Linha de Remessa atualizada.\n* `remittance.line.db.deleted` Linha de Remessa excluída.\n* `discharge.created` Retorno criado.\n* `discharge.processed` Retorno processado.\n* `discharge.deleted` Retorno excluído.\n* `bank_billet_account.created` Conta de Cobrança criada.\n* `bank_billet_account.homologated` Conta de Cobrança enviada para homologação.\n* `bank_billet_account.homologation_failed` Falha na homologação da Conta de Cobrança.\n* `bank_billet_account.homologation_started` Conta de Cobrança enviada para homologação.\n* `bank_billet_account.validated` Conta de Cobrança homologada.\n* `bank_billet_account.validation_released` Conta de Cobrança homologada.\n* `bank_billet_account.activated` Conta de Cobrança ativada.\n* `bank_billet_account.updated` Conta de Cobrança atualizada.\n* `bank_billet_account.deleted` Conta de Cobrança excluída.\n* `edi.remittance_line.created` Linha de Remessa criada.\n* `edi.remittance_line.updated` Linha de Remessa atualizada.\n* `edi.remittance_line.deleted` Linha de Remessa excluída.\n* `edi.edi_box.activated` EDI ativado.\n* `edi.edi_box.db.created` EDI criado.\n* `edi.edi_box.db.deleted` EDI excluído.\n* `edi.edi_box.db.updated` EDI atualizado.\n* `edi.edi_box.generated` Carta Gerada\n* `edi.edi_box.demand_received` Demanda recepcionada\n* `edi.edi_box.confirming_at_bank` Aguardando confirmação do banco\n* `edi.edi_box.testing_by_customer` Aguardando teste do cliente\n* `edi.edi_box.waiting_for_validations` Aguardando validações\n* `customer_subscription.created` Assinatura criada.\n* `customer_subscription.updated` Assinatura atualizada.\n* `customer_subscription.deleted` Assinatura excluída.\n* `installment.created` Carnê criado.\n* `installment.processed` Carnê processado.\n* `installment.generated` Carnê gerado.\n* `installment.deleted` Carnê excluído.\n* `import.created` Importação criada.\n* `import.processed` Importação processada.\n* `import.deleted` Importação excluída.\n* `export.db.created` Exportação criada.\n* `export.db.updated` Exportação atualizada.\n* `export.db.deleted` Exportação excluída.\n* `pix.db.created` Pix criado.\n* `pix.db.updated` Pix atualizado.\n* `pix.db.deleted` Pix excluído.\n* `pix.register.requested` Registro do Pix solicitado.\n* `pix.register.confirmed` Registro do Pix confirmado.\n* `pix.register.failed` Falha no registro do Pix.\n* `pix.register.error` Ocorreu um erro no registro do Pix.\n* `pix.update.requested` Atualização do Pix solicitada.\n* `pix.update.confirmed` Atualização do Pix confirmada.\n* `pix.update.failed` Falha na atualização do Pix.\n* `pix.update.error` Ocorreu um erro na atualização do Pix.\n* `pix.paid` Pix pago.\n* `pix.overdue` Pix vencido (somente Pix Cobrança).\n* `pix.cancel.requested` Cancelamento do Pix solicitado.\n* `pix.cancel.confirmed` Cancelamento do Pix confirmado.\n* `pix.cancel.failed` Falha no cancelamento do Pix.\n* `pix.cancel.error` Ocorreu um erro no cancelamento do Pix.\n* `pix.sync.requested` Sincronização do Pix solicitada.\n* `pix.sync.confirmed` Sincronização do Pix confirmada.\n* `pix.sync.failed` Falha na sincronização do Pix.\n* `pix.sync.error` Ocorreu um erro na sincronização do Pix.\n* `pix.get.requested` Informação do Pix solicitada.\n* `pix.get.confirmed` Informação do Pix confirmada.\n* `pix.get.failed` Falha na informação do Pix.\n* `pix.get.error` Ocorreu um erro na informação do Pix.\n* `financial.account.balance_sync.requested` Sincronização do Saldo solicitada.\n* `financial.account.balance_sync.confirmed` Sincronização do Saldo confirmada.\n* `financial.account.balance_sync.failed` Falha na sincronização do Saldo.\n* `financial.account.balance_sync.error` Ocorreu um erro na sincronização do Saldo.\n* `financial.account.statement_sync.requested` Sincronização do Extrato solicitada.\n* `financial.account.statement_sync.confirmed` Sincronização do Extrato confirmada.\n* `financial.account.statement_sync.failed` Falha na sincronização do Extrato.\n* `financial.account.statement_sync.error` Ocorreu um erro na sincronização do Extrato.\n* `financial.account.db.created` Conta Financeira criada.\n* `financial.account.db.updated` Conta Financeira atualizada.\n* `financial.account.db.deleted` Conta Financeira excluída.\n* `financial.account.statement.updated` Extrato atualizado.\n* `financial.account.balance.updated` Saldo da conta financeira atualizado.\n* `financial.account_balance.db.created` Saldo criado.\n* `transfer.batch.db.created` Lote de transferência criado.\n* `transfer.batch.db.updated` Lote de transferência atualizado.\n* `transfer.batch.db.deleted` Lote de transferência excluído.\n* `transfer.batch.awaiting_approval` Lote de transferência aguardando liberação.\n* `transfer.pix_batch.awaiting_approval` Lote de Transferência Pix aguardando liberação.\n* `transfer.pix_batch.get.requested` Informação do Lote de Transferência Pix solicitada.\n* `transfer.pix_batch.get.confirmed` Informação do Lote de Transferência Pix confirmada.\n* `transfer.pix_batch.get.failed` Falha na informação do Lote de Transferência Pix.\n* `transfer.pix_batch.get.error` Ocorreu um erro na informação do Lote de Transferência Pix.\n* `transfer.pix_batch.sync.requested` Sincronização de Lote de transferência Pix solicitada.\n* `transfer.pix_batch.sync.confirmed` Sincronização de Lote de transferência Pix confirmada.\n* `transfer.pix_batch.sync.failed` Falha na sincronização de Lote de transferência Pix.\n* `transfer.pix_batch.sync.error` Ocorreu um erro na sincronização de Lote de transferência Pix.\n* `transfer.pix_batch.register.requested` Lote de Transferência Pix solicitado.\n* `transfer.pix_batch.register.confirmed` Lote de Transferência Pix confirmado.\n* `transfer.pix_batch.register.failed` Falha no envio de Lote de Transferência Pix.\n* `transfer.pix_batch.register.error` Ocorreu um erro no envio de Lote de Transferência Pix.\n* `transfer.pix_batch.approve.requested` Liberação de Lote de Transferência Pix solicitada.\n* `transfer.pix_batch.approve.confirmed` Liberação de Lote de Transferência Pix confirmada.\n* `transfer.pix_batch.approve.failed` Falha na liberação de Lote de Transferência Pix.\n* `transfer.pix_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência Pix.\n* `transfer.pix_batch.reprove.requested` Rejeição de Lote de Transferência Pix solicitada.\n* `transfer.pix_batch.reprove.confirmed` Rejeição de Lote de transferência Pix confirmada.\n* `transfer.pix_batch.reprove.failed` Falha na rejeição de Lote de Transferência Pix.\n* `transfer.pix_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência Pix.\n* `transfer.pix_batch.cancel.requested` Cancelamento de Lote de Transferência Pix solicitado.\n* `transfer.pix_batch.cancel.confirmed` Cancelamento de Lote de Transferência Pix confirmado.\n* `transfer.pix_batch.cancel.failed` Falha no cancelamento de Lote de Transferência Pix.\n* `transfer.pix_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Transferência Pix.\n* `transfer.ted_batch.awaiting_approval` Lote de Transferência TED aguardando liberação.\n* `transfer.ted_batch.get.requested` Informação do Lote de Transferência TED solicitada.\n* `transfer.ted_batch.get.confirmed` Informação do Lote de Transferência TED confirmada.\n* `transfer.ted_batch.get.failed` Falha na informação do Lote de Transferência TED.\n* `transfer.ted_batch.get.error` Ocorreu um erro na informação do Lote de Transferência TED.\n* `transfer.ted_batch.sync.requested` Sincronização de Lote de transferência TED solicitada.\n* `transfer.ted_batch.sync.confirmed` Sincronização de Lote de transferência TED confirmada.\n* `transfer.ted_batch.sync.failed` Falha na sincronização de Lote de transferência TED.\n* `transfer.ted_batch.sync.error` Ocorreu um erro na sincronização de Lote de transferência TED.\n* `transfer.ted_batch.register.requested` Lote de Transferência TED solicitado.\n* `transfer.ted_batch.register.confirmed` Lote de Transferência TED confirmado.\n* `transfer.ted_batch.register.failed` Falha no envio de Lote de Transferência TED.\n* `transfer.ted_batch.register.error` Ocorreu um erro no envio de Lote de Transferência TED.\n* `transfer.ted_batch.approve.requested` Liberação de Lote de Transferência TED solicitada.\n* `transfer.ted_batch.approve.confirmed` Liberação de Lote de Transferência TED confirmada.\n* `transfer.ted_batch.approve.failed` Falha na liberação de Lote de Transferência TED.\n* `transfer.ted_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência TED.\n* `transfer.ted_batch.reprove.requested` Rejeição de Lote de Transferência TED solicitada.\n* `transfer.ted_batch.reprove.confirmed` Rejeição de Lote de transferência TED confirmada.\n* `transfer.ted_batch.reprove.failed` Falha na rejeição de Lote de Transferência TED.\n* `transfer.ted_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência TED.\n* `transfer.ted_batch.cancel.requested` Cancelamento de Lote de Transferência TED solicitado.\n* `transfer.ted_batch.cancel.confirmed` Cancelamento de Lote de Transferência TED confirmado.\n* `transfer.ted_batch.cancel.failed` Falha no cancelamento de Lote de Transferência TED.\n* `transfer.ted_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Transferência TED.\n* `transfer.internal_batch.awaiting_approval` Lote de Transferência Entre Contas do Mesmo Banco aguardando liberação.\n* `transfer.internal_batch.get.requested` Informação do Lote de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.get.confirmed` Informação do Lote de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.get.failed` Falha na informação do Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.get.error` Ocorreu um erro na informação do Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.sync.requested` Sincronização de Lote de transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.sync.confirmed` Sincronização de Lote de transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.sync.failed` Falha na sincronização de Lote de transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.sync.error` Ocorreu um erro na sincronização de Lote de transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.register.requested` Lote de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal_batch.register.confirmed` Lote de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal_batch.register.failed` Falha no envio de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.register.error` Ocorreu um erro no envio de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.approve.requested` Liberação de Lote de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.approve.confirmed` Liberação de Lote de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.approve.failed` Falha na liberação de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.reprove.requested` Rejeição de Lote de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.reprove.confirmed` Rejeição de Lote de transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.reprove.failed` Falha na rejeição de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.cancel.requested` Cancelamento de Lote de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal_batch.cancel.confirmed` Cancelamento de Lote de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal_batch.cancel.failed` Falha no cancelamento de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.db.created` Transferência criada.\n* `transfer.db.updated` Transferência atualizada.\n* `transfer.db.deleted` Transferência excluída.\n* `transfer.pix.register.requested` Transferência Pix solicitada.\n* `transfer.pix.register.confirmed` Transferência Pix confirmada.\n* `transfer.pix.register.failed` Falha no envio da Transferência Pix.\n* `transfer.pix.register.error` Ocorreu um erro no envio da Transferência Pix.\n* `transfer.pix.reschedule.requested` Reagendamento de Transferência Pix solicitado.\n* `transfer.pix.reschedule.confirmed` Reagendamento de Transferência Pix confirmado.\n* `transfer.pix.reschedule.failed` Falha no reagendamento da Transferência Pix.\n* `transfer.pix.reschedule.error` Ocorreu um erro no reagendamento da Transferência Pix.\n* `transfer.pix.approve.requested` Liberação de Transferência Pix solicitada.\n* `transfer.pix.approve.confirmed` Liberação de Transferência Pix confirmada.\n* `transfer.pix.approve.failed` Falha na liberação da transferência Pix.\n* `transfer.pix.approve.error` Ocorreu um erro na liberação da Transferência Pix.\n* `transfer.pix.reprove.requested` Rejeição de Transferência Pix solicitada.\n* `transfer.pix.reprove.confirmed` Rejeição de Transferência Pix confirmada.\n* `transfer.pix.reprove.failed` Falha na rejeição da transferência Pix.\n* `transfer.pix.reprove.error` Ocorreu um erro na rejeição da Transferência Pix.\n* `transfer.pix.cancel.requested` Cancelamento de Transferência Pix solicitado.\n* `transfer.pix.cancel.confirmed` Cancelamento de Transferência Pix confirmado.\n* `transfer.pix.cancel.failed` Falha no cancelamento da Transferência Pix.\n* `transfer.pix.cancel.error` Ocorreu um erro no cancelamento da Transferência Pix.\n* `transfer.pix.get.requested` Informação da Transferência Pix solicitada.\n* `transfer.pix.get.confirmed` Informação da Transferência Pix confirmada.\n* `transfer.pix.get.failed` Falha na informação da Transferência Pix.\n* `transfer.pix.get.error` Ocorreu um erro na informação da Transferência Pix.\n* `transfer.pix.sync.requested` Sincronização da Transferência Pix solicitada.\n* `transfer.pix.sync.confirmed` Sincronização da Transferência Pix confirmada.\n* `transfer.pix.sync.failed` Falha na sincronização da Transferência Pix.\n* `transfer.pix.sync.error` Ocorreu um erro na sincronização da Transferência Pix.\n* `transfer.ted.register.requested` Transferência TED solicitada.\n* `transfer.ted.register.confirmed` Transferência TED confirmada.\n* `transfer.ted.register.failed` Falha no envio da Transferência TED.\n* `transfer.ted.register.error` Ocorreu um erro no envio da Transferência TED.\n* `transfer.ted.reschedule.requested` Reagendamento de Transferência TED solicitado.\n* `transfer.ted.reschedule.confirmed` Reagendamento de Transferência TED confirmado.\n* `transfer.ted.reschedule.failed` Falha no Reagendamento de Transferência TED.\n* `transfer.ted.reschedule.error` Ocorreu um erro no Reagendamento de Transferência TED.\n* `transfer.ted.approve.requested` Liberação de Transferência TED solicitada.\n* `transfer.ted.approve.confirmed` Liberação de Transferência TED confirmada.\n* `transfer.ted.approve.failed` Falha na liberação da transferência TED.\n* `transfer.ted.approve.error` Ocorreu um erro na liberação da Transferência TED.\n* `transfer.ted.reprove.requested` Rejeição de Transferência TED solicitada.\n* `transfer.ted.reprove.confirmed` Rejeição de Transferência TED confirmada.\n* `transfer.ted.reprove.failed` Falha na rejeição da transferência TED.\n* `transfer.ted.reprove.error` Ocorreu um erro na rejeição da Transferência TED.\n* `transfer.ted.cancel.requested` Cancelamento de Transferência TED solicitado.\n* `transfer.ted.cancel.confirmed` Cancelamento de Transferência TED confirmado.\n* `transfer.ted.cancel.failed` Falha no cancelamento de Transferência TED.\n* `transfer.ted.cancel.error` Ocorreu um erro no cancelamento de Transferência TED.\n* `transfer.ted.get.requested` Informação da Transferência TED solicitada.\n* `transfer.ted.get.confirmed` Informação da Transferência TED confirmada.\n* `transfer.ted.get.failed` Falha na informação da Transferência TED.\n* `transfer.ted.get.error` Ocorreu um erro na informação da Transferência TED.\n* `transfer.ted.sync.requested` Sincronização da Transferência TED solicitada.\n* `transfer.ted.sync.confirmed` Sincronização da Transferência TED confirmada.\n* `transfer.ted.sync.failed` Falha na sincronização da Transferência TED.\n* `transfer.ted.sync.error` Ocorreu um erro na sincronização da Transferência TED.\n* `transfer.internal.register.requested` Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.register.confirmed` Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.register.failed` Falha no envio da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.register.error` Ocorreu um erro no envio da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reschedule.requested` Reagendamento de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal.reschedule.confirmed` Reagendamento de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal.reschedule.failed` Falha no Reagendamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reschedule.error` Ocorreu um erro no Reagendamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.approve.requested` Liberação de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.approve.confirmed` Liberação de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.approve.failed` Falha na liberação da transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.approve.error` Ocorreu um erro na liberação da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reprove.requested` Rejeição de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.reprove.confirmed` Rejeição de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.reprove.failed` Falha na rejeição da transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reprove.error` Ocorreu um erro na rejeição da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.cancel.requested` Cancelamento de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal.cancel.confirmed` Cancelamento de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal.cancel.failed` Falha no cancelamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.cancel.error` Ocorreu um erro no cancelamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.get.requested` Informação da Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.get.confirmed` Informação da Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.get.failed` Falha na informação da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.get.error` Ocorreu um erro na informação da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.sync.requested` Sincronização da Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.sync.confirmed` Sincronização da Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.sync.failed` Falha na sincronização da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.sync.error` Ocorreu um erro na sincronização da Transferência Entre Contas do Mesmo Banco.\n* `payment.db.created` Pagamento criado.\n* `payment.db.updated` Pagamento atualizado.\n* `payment.db.deleted` Pagamento excluído.\n* `payment.bank_billet.register.requested` Pagamento de Boleto solicitado.\n* `payment.bank_billet.register.confirmed` Pagamento de Boleto confirmado.\n* `payment.bank_billet.register.failed` Falha no envio do Pagamento de Boleto.\n* `payment.bank_billet.register.error` Ocorreu um erro no envio de Pagamento de Boleto.\n* `payment.bank_billet.approve.requested` Liberação de Pagamento de Boleto solicitada.\n* `payment.bank_billet.approve.confirmed` Liberação de Pagamento de Boleto confirmada.\n* `payment.bank_billet.approve.failed` Falha na liberação de Pagamento de Boleto.\n* `payment.bank_billet.approve.error` Ocorreu um erro na liberação de Pagamento de Boleto.\n* `payment.bank_billet.reprove.requested` Rejeição de Pagamento de Boleto solicitada.\n* `payment.bank_billet.reprove.confirmed` Rejeição de Pagamento de Boleto confirmada.\n* `payment.bank_billet.reprove.failed` Falha na rejeição de Pagamento de Boleto.\n* `payment.bank_billet.reprove.error` Ocorreu um erro na rejeição de Pagamento de Boleto.\n* `payment.bank_billet.reschedule.requested` Reagendamento de Pagamento de Boleto solicitado.\n* `payment.bank_billet.reschedule.confirmed` Reagendamento de Pagamento de Boleto confirmado.\n* `payment.bank_billet.reschedule.failed` Falha no Reagendamento de Pagamento de Boleto.\n* `payment.bank_billet.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Boleto.\n* `payment.bank_billet.cancel.requested` Cancelamento de Pagamento de Boleto solicitado.\n* `payment.bank_billet.cancel.confirmed` Cancelamento de Pagamento de Boleto confirmada.\n* `payment.bank_billet.cancel.failed` Falha no cancelamento de Pagamento de Boleto.\n* `payment.bank_billet.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Boleto.\n* `payment.bank_billet.get.requested` Informação do Pagamento de Boleto solicitada.\n* `payment.bank_billet.get.confirmed` Informação do Pagamento de Boleto confirmada.\n* `payment.bank_billet.get.failed` Falha na informação do Pagamento de Boleto.\n* `payment.bank_billet.get.error` Ocorreu um erro na informação do Pagamento de Boleto.\n* `payment.bank_billet.sync.requested` Sincronização do Pagamento de Boleto solicitada.\n* `payment.bank_billet.sync.confirmed` Sincronização do Pagamento de Boleto confirmada.\n* `payment.bank_billet.sync.failed` Falha na sincronização do Pagamento de Boleto.\n* `payment.bank_billet.sync.error` Ocorreu um erro na sincronização do Pagamento de Boleto.\n* `payment.darf.register.requested` Pagamento de DARF solicitado.\n* `payment.darf.register.confirmed` Pagamento de DARF confirmado.\n* `payment.darf.register.failed` Falha no envio do Pagamento de DARF.\n* `payment.darf.register.error` Ocorreu um erro no envio de Pagamento de DARF.\n* `payment.darf.approve.requested` Liberação de Pagamento de DARF solicitada.\n* `payment.darf.approve.confirmed` Liberação de Pagamento de DARF confirmada.\n* `payment.darf.approve.failed` Falha na liberação de Pagamento de DARF.\n* `payment.darf.approve.error` Ocorreu um erro na liberação de Pagamento de DARF.\n* `payment.darf.reprove.requested` Rejeição de Pagamento de DARF solicitada.\n* `payment.darf.reprove.confirmed` Rejeição de Pagamento de DARF confirmada.\n* `payment.darf.reprove.failed` Falha na rejeição de Pagamento de DARF.\n* `payment.darf.reprove.error` Ocorreu um erro na rejeição de Pagamento de DARF.\n* `payment.darf.reschedule.requested` Reagendamento de Pagamento de DARF solicitado.\n* `payment.darf.reschedule.confirmed` Reagendamento de Pagamento de DARF confirmado.\n* `payment.darf.reschedule.failed` Falha no Reagendamento de Pagamento de DARF.\n* `payment.darf.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de DARF.\n* `payment.darf.cancel.requested` Cancelamento de Pagamento de DARF solicitado.\n* `payment.darf.cancel.confirmed` Cancelamento de Pagamento de DARF confirmada.\n* `payment.darf.cancel.failed` Falha no cancelamento de Pagamento de DARF.\n* `payment.darf.cancel.error` Ocorreu um erro no cancelamento de Pagamento de DARF.\n* `payment.darf.get.requested` Informação do Pagamento de DARF solicitada.\n* `payment.darf.get.confirmed` Informação do Pagamento de DARF confirmada.\n* `payment.darf.get.failed` Falha na informação do Pagamento de DARF.\n* `payment.darf.get.error` Ocorreu um erro na informação do Pagamento de DARF.\n* `payment.darf.sync.requested` Sincronização do Pagamento de DARF solicitada.\n* `payment.darf.sync.confirmed` Sincronização do Pagamento de DARF confirmada.\n* `payment.darf.sync.failed` Falha na sincronização do Pagamento de DARF.\n* `payment.darf.sync.error` Ocorreu um erro na sincronização do Pagamento de DARF.\n* `payment.utility.register.requested` Pagamento de Conta de Consumo solicitado.\n* `payment.utility.register.confirmed` Pagamento de Conta de Consumo confirmado.\n* `payment.utility.register.failed` Falha no envio do Pagamento de Conta de Consumo.\n* `payment.utility.register.error` Ocorreu um erro no envio de Pagamento de Conta de Consumo.\n* `payment.utility.approve.requested` Liberação de Pagamento de Conta de Consumo solicitada.\n* `payment.utility.approve.confirmed` Liberação de Pagamento de Conta de Consumo confirmada.\n* `payment.utility.approve.failed` Falha na liberação de Pagamento de Conta de Consumo.\n* `payment.utility.approve.error` Ocorreu um erro na liberação de Pagamento de Conta de Consumo.\n* `payment.utility.reprove.requested` Rejeição de Pagamento de Conta de Consumo solicitada.\n* `payment.utility.reprove.confirmed` Rejeição de Pagamento de Conta de Consumo confirmada.\n* `payment.utility.reprove.failed` Falha na rejeição de Pagamento de Conta de Consumo.\n* `payment.utility.reprove.error` Ocorreu um erro na rejeição de Pagamento de Conta de Consumo.\n* `payment.utility.reschedule.requested` Reagendamento de Pagamento de Conta de Consumo solicitado.\n* `payment.utility.reschedule.confirmed` Reagendamento de Pagamento de Conta de Consumo confirmado.\n* `payment.utility.reschedule.failed` Falha no Reagendamento de Pagamento de Conta de Consumo.\n* `payment.utility.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Conta de Consumo.\n* `payment.utility.cancel.requested` Cancelamento de Pagamento de Conta de Consumo solicitado.\n* `payment.utility.cancel.confirmed` Cancelamento de Pagamento de Conta de Consumo confirmada.\n* `payment.utility.cancel.failed` Falha no cancelamento de Pagamento de Conta de Consumo.\n* `payment.utility.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Conta de Consumo.\n* `payment.utility.get.requested` Informação do Pagamento de Conta de Consumo solicitada.\n* `payment.utility.get.confirmed` Informação do Pagamento de Conta de Consumo confirmada.\n* `payment.utility.get.failed` Falha na informação do Pagamento de Conta de Consumo.\n* `payment.utility.get.error` Ocorreu um erro na informação do Pagamento de Conta de Consumo.\n* `payment.utility.sync.requested` Sincronização do Pagamento de Conta de Consumo solicitada.\n* `payment.utility.sync.confirmed` Sincronização do Pagamento de Conta de Consumo confirmada.\n* `payment.utility.sync.failed` Falha na sincronização do Pagamento de Conta de Consumo.\n* `payment.utility.sync.error` Ocorreu um erro na sincronização do Pagamento de Conta de Consumo.\n* `payment.gru.register.requested` Pagamento de GRU solicitado.\n* `payment.gru.register.confirmed` Pagamento de GRU confirmado.\n* `payment.gru.register.failed` Falha no envio do Pagamento de GRU.\n* `payment.gru.register.error` Ocorreu um erro no envio de Pagamento de GRU.\n* `payment.gru.approve.requested` Liberação de Pagamento de GRU solicitada.\n* `payment.gru.approve.confirmed` Liberação de Pagamento de GRU confirmada.\n* `payment.gru.approve.failed` Falha na liberação de Pagamento de GRU.\n* `payment.gru.approve.error` Ocorreu um erro na liberação de Pagamento de GRU.\n* `payment.gru.reprove.requested` Rejeição de Pagamento de GRU solicitada.\n* `payment.gru.reprove.confirmed` Rejeição de Pagamento de GRU confirmada.\n* `payment.gru.reprove.failed` Falha na rejeição de Pagamento de GRU.\n* `payment.gru.reprove.error` Ocorreu um erro na rejeição de Pagamento de GRU.\n* `payment.gru.reschedule.requested` Reagendamento de Pagamento de GRU solicitado.\n* `payment.gru.reschedule.confirmed` Reagendamento de Pagamento de GRU confirmado.\n* `payment.gru.reschedule.failed` Falha no Reagendamento de Pagamento de GRU.\n* `payment.gru.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de GRU.\n* `payment.gru.cancel.requested` Cancelamento de Pagamento de GRU solicitado.\n* `payment.gru.cancel.confirmed` Cancelamento de Pagamento de GRU confirmada.\n* `payment.gru.cancel.failed` Falha no cancelamento de Pagamento de GRU.\n* `payment.gru.cancel.error` Ocorreu um erro no cancelamento de Pagamento de GRU.\n* `payment.gru.get.requested` Informação do Pagamento de GRU solicitada.\n* `payment.gru.get.confirmed` Informação do Pagamento de GRU confirmada.\n* `payment.gru.get.failed` Falha na informação do Pagamento de GRU.\n* `payment.gru.get.error` Ocorreu um erro na informação do Pagamento de GRU.\n* `payment.gru.sync.requested` Sincronização do Pagamento de GRU solicitada.\n* `payment.gru.sync.confirmed` Sincronização do Pagamento de GRU confirmada.\n* `payment.gru.sync.failed` Falha na sincronização do Pagamento de GRU.\n* `payment.gru.sync.error` Ocorreu um erro na sincronização do Pagamento de GRU.\n* `payment.pix.register.requested` Pagamento de Pix solicitado.\n* `payment.pix.register.confirmed` Pagamento de Pix confirmado.\n* `payment.pix.register.failed` Falha no envio do Pagamento de Pix.\n* `payment.pix.register.error` Ocorreu um erro no envio de Pagamento de Pix.\n* `payment.pix.approve.requested` Liberação de Pagamento de Pix solicitada.\n* `payment.pix.approve.confirmed` Liberação de Pagamento de Pix confirmada.\n* `payment.pix.approve.failed` Falha na liberação de Pagamento de Pix.\n* `payment.pix.approve.error` Ocorreu um erro na liberação de Pagamento de Pix.\n* `payment.pix.reprove.requested` Rejeição de Pagamento de Pix solicitada.\n* `payment.pix.reprove.confirmed` Rejeição de Pagamento de Pix confirmada.\n* `payment.pix.reprove.failed` Falha na rejeição de Pagamento de Pix.\n* `payment.pix.reprove.error` Ocorreu um erro na rejeição de Pagamento de Pix.\n* `payment.pix.reschedule.requested` Reagendamento de Pagamento de Pix solicitado.\n* `payment.pix.reschedule.confirmed` Reagendamento de Pagamento de Pix confirmado.\n* `payment.pix.reschedule.failed` Falha no Reagendamento de Pagamento de Pix.\n* `payment.pix.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Pix.\n* `payment.pix.cancel.requested` Cancelamento de Pagamento de Pix solicitado.\n* `payment.pix.cancel.confirmed` Cancelamento de Pagamento de Pix confirmada.\n* `payment.pix.cancel.failed` Falha no cancelamento de Pagamento de Pix.\n* `payment.pix.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Pix.\n* `payment.pix.get.requested` Informação do Pagamento de Pix solicitada.\n* `payment.pix.get.confirmed` Informação do Pagamento de Pix confirmada.\n* `payment.pix.get.failed` Falha na informação do Pagamento de Pix.\n* `payment.pix.get.error` Ocorreu um erro na informação do Pagamento de Pix.\n* `payment.pix.sync.requested` Sincronização do Pagamento de Pix solicitada.\n* `payment.pix.sync.confirmed` Sincronização do Pagamento de Pix confirmada.\n* `payment.pix.sync.failed` Falha na sincronização do Pagamento de Pix.\n* `payment.pix.sync.error` Ocorreu um erro na sincronização do Pagamento de Pix.\n* `payment.tax.register.requested` Pagamento de Tributo solicitado.\n* `payment.tax.register.confirmed` Pagamento de Tributo confirmado.\n* `payment.tax.register.failed` Falha no envio do Pagamento de Tributo.\n* `payment.tax.register.error` Ocorreu um erro no envio de Pagamento de Tributo.\n* `payment.tax.approve.requested` Liberação de Pagamento de Tributo solicitada.\n* `payment.tax.approve.confirmed` Liberação de Pagamento de Tributo confirmada.\n* `payment.tax.approve.failed` Falha na liberação de Pagamento de Tributo.\n* `payment.tax.approve.error` Ocorreu um erro na liberação de Pagamento de Tributo.\n* `payment.tax.reprove.requested` Rejeição de Pagamento de Tributo solicitada.\n* `payment.tax.reprove.confirmed` Rejeição de Pagamento de Tributo confirmada.\n* `payment.tax.reprove.failed` Falha na rejeição de Pagamento de Tributo.\n* `payment.tax.reprove.error` Ocorreu um erro na rejeição de Pagamento de Tributo.\n* `payment.tax.reschedule.requested` Reagendamento de Pagamento de Tributo solicitado.\n* `payment.tax.reschedule.confirmed` Reagendamento de Pagamento de Tributo confirmado.\n* `payment.tax.reschedule.failed` Falha no Reagendamento de Pagamento de Tributo.\n* `payment.tax.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Tributo.\n* `payment.tax.cancel.requested` Cancelamento de Pagamento de Tributo solicitado.\n* `payment.tax.cancel.confirmed` Cancelamento de Pagamento de Tributo confirmada.\n* `payment.tax.cancel.failed` Falha no cancelamento de Pagamento de Tributo.\n* `payment.tax.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Tributo.\n* `payment.tax.get.requested` Informação do Pagamento de Tributo solicitada.\n* `payment.tax.get.confirmed` Informação do Pagamento de Tributo confirmada.\n* `payment.tax.get.failed` Falha na informação do Pagamento de Tributo.\n* `payment.tax.get.error` Ocorreu um erro na informação do Pagamento de Tributo.\n* `payment.tax.sync.requested` Sincronização do Pagamento de Tributo solicitada.\n* `payment.tax.sync.confirmed` Sincronização do Pagamento de Tributo confirmada.\n* `payment.tax.sync.failed` Falha na sincronização do Pagamento de Tributo.\n* `payment.tax.sync.error` Ocorreu um erro na sincronização do Pagamento de Tributo.\n* `payment.batch.db.created` Lote de Pagamento criado.\n* `payment.batch.db.updated` Lote de Pagamento atualizado.\n* `payment.batch.db.deleted` Lote de Pagamento excluído.\n* `payment.batch.awaiting_approval` Lote de pagamento aguardando liberação.\n* `payment.bank_billet_batch.awaiting_approval` Lote de Pagamento de Boleto aguardando liberação.\n* `payment.bank_billet_batch.get.requested` Informação do Lote de Pagamento de Boleto solicitada.\n* `payment.bank_billet_batch.get.confirmed` Informação do Lote de Pagamento de Boleto confirmada.\n* `payment.bank_billet_batch.get.failed` Falha na informação do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.sync.requested` Sincronização de Lote de Pagamento de Boleto solicitada.\n* `payment.bank_billet_batch.sync.confirmed` Sincronização de Lote de Pagamento de Boleto confirmada.\n* `payment.bank_billet_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.register.requested` Lote de Pagamento de Boleto solicitado.\n* `payment.bank_billet_batch.register.confirmed` Lote de Pagamento de Boleto confirmado.\n* `payment.bank_billet_batch.register.failed` Falha no envio do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.approve.requested` Liberação de Lote de Pagamento de Boleto solicitado.\n* `payment.bank_billet_batch.approve.confirmed` Liberação de Lote de Pagamento de Boleto confirmado.\n* `payment.bank_billet_batch.approve.failed` Falha na liberação de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.reprove.requested` Rejeição de Lote de Pagamento de Boleto solicitado.\n* `payment.bank_billet_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Boleto confirmado.\n* `payment.bank_billet_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.bank_billet_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.bank_billet_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.bank_billet_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.darf_batch.awaiting_approval` Lote de Pagamento de DARF aguardando liberação.\n* `payment.darf_batch.get.requested` Informação do Lote de Pagamento de DARF solicitada.\n* `payment.darf_batch.get.confirmed` Informação do Lote de Pagamento de DARF confirmada.\n* `payment.darf_batch.get.failed` Falha na informação do Lote de Pagamento de DARF.\n* `payment.darf_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de DARF.\n* `payment.darf_batch.sync.requested` Sincronização de Lote de Pagamento de DARF solicitada.\n* `payment.darf_batch.sync.confirmed` Sincronização de Lote de Pagamento de DARF confirmada.\n* `payment.darf_batch.sync.failed` Falha na sincronização de Lote de Pagamento de DARF.\n* `payment.darf_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de DARF.\n* `payment.darf_batch.register.requested` Lote de Pagamento de DARF solicitado.\n* `payment.darf_batch.register.confirmed` Lote de Pagamento de DARF confirmado.\n* `payment.darf_batch.register.failed` Falha no envio do Lote de Pagamento de DARF.\n* `payment.darf_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de DARF.\n* `payment.darf_batch.approve.requested` Liberação de Lote de Pagamento de DARF solicitado.\n* `payment.darf_batch.approve.confirmed` Liberação de Lote de Pagamento de DARF confirmado.\n* `payment.darf_batch.approve.failed` Falha na liberação de Lote de Pagamento de DARF.\n* `payment.darf_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de DARF.\n* `payment.darf_batch.reprove.requested` Rejeição de Lote de Pagamento de DARF solicitado.\n* `payment.darf_batch.reprove.confirmed` Rejeição de Lote de Pagamento de DARF confirmado.\n* `payment.darf_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de DARF.\n* `payment.darf_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de DARF.\n* `payment.darf_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.darf_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.darf_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.darf_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.utility_batch.awaiting_approval` Lote de Pagamento de Conta de Consumo aguardando liberação.\n* `payment.utility_batch.get.requested` Informação do Lote de Pagamento de Conta de Consumo solicitada.\n* `payment.utility_batch.get.confirmed` Informação do Lote de Pagamento de Conta de Consumo confirmada.\n* `payment.utility_batch.get.failed` Falha na informação do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.sync.requested` Sincronização de Lote de Pagamento de Conta de Consumo solicitada.\n* `payment.utility_batch.sync.confirmed` Sincronização de Lote de Pagamento de Conta de Consumo confirmada.\n* `payment.utility_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.register.requested` Lote de Pagamento de Conta de Consumo solicitado.\n* `payment.utility_batch.register.confirmed` Lote de Pagamento de Conta de Consumo confirmado.\n* `payment.utility_batch.register.failed` Falha no envio do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.approve.requested` Liberação de Lote de Pagamento de Conta de Consumo solicitado.\n* `payment.utility_batch.approve.confirmed` Liberação de Lote de Pagamento de Conta de Consumo confirmado.\n* `payment.utility_batch.approve.failed` Falha na liberação de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.reprove.requested` Rejeição de Lote de Pagamento de Conta de Consumo solicitado.\n* `payment.utility_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Conta de Consumo confirmado.\n* `payment.utility_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.utility_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.utility_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.utility_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.gru_batch.awaiting_approval` Lote de Pagamento de GRU aguardando liberação.\n* `payment.gru_batch.get.requested` Informação do Lote de Pagamento de GRU solicitada.\n* `payment.gru_batch.get.confirmed` Informação do Lote de Pagamento de GRU confirmada.\n* `payment.gru_batch.get.failed` Falha na informação do Lote de Pagamento de GRU.\n* `payment.gru_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de GRU.\n* `payment.gru_batch.sync.requested` Sincronização de Lote de Pagamento de GRU solicitada.\n* `payment.gru_batch.sync.confirmed` Sincronização de Lote de Pagamento de GRU confirmada.\n* `payment.gru_batch.sync.failed` Falha na sincronização de Lote de Pagamento de GRU.\n* `payment.gru_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de GRU.\n* `payment.gru_batch.register.requested` Lote de Pagamento de GRU solicitado.\n* `payment.gru_batch.register.confirmed` Lote de Pagamento de GRU confirmado.\n* `payment.gru_batch.register.failed` Falha no envio do Lote de Pagamento de GRU.\n* `payment.gru_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de GRU.\n* `payment.gru_batch.approve.requested` Liberação de Lote de Pagamento de GRU solicitado.\n* `payment.gru_batch.approve.confirmed` Liberação de Lote de Pagamento de GRU confirmado.\n* `payment.gru_batch.approve.failed` Falha na liberação de Lote de Pagamento de GRU.\n* `payment.gru_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de GRU.\n* `payment.gru_batch.reprove.requested` Rejeição de Lote de Pagamento de GRU solicitado.\n* `payment.gru_batch.reprove.confirmed` Rejeição de Lote de Pagamento de GRU confirmado.\n* `payment.gru_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de GRU.\n* `payment.gru_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de GRU.\n* `payment.gru_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.gru_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.gru_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.gru_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.pix_batch.awaiting_approval` Lote de Pagamento de Pix aguardando liberação.\n* `payment.pix_batch.get.requested` Informação do Lote de Pagamento de Pix solicitada.\n* `payment.pix_batch.get.confirmed` Informação do Lote de Pagamento de Pix confirmada.\n* `payment.pix_batch.get.failed` Falha na informação do Lote de Pagamento de Pix.\n* `payment.pix_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Pix.\n* `payment.pix_batch.sync.requested` Sincronização de Lote de Pagamento de Pix solicitada.\n* `payment.pix_batch.sync.confirmed` Sincronização de Lote de Pagamento de Pix confirmada.\n* `payment.pix_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Pix.\n* `payment.pix_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Pix.\n* `payment.pix_batch.register.requested` Lote de Pagamento de Pix solicitado.\n* `payment.pix_batch.register.confirmed` Lote de Pagamento de Pix confirmado.\n* `payment.pix_batch.register.failed` Falha no envio do Lote de Pagamento de Pix.\n* `payment.pix_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Pix.\n* `payment.pix_batch.approve.requested` Liberação de Lote de Pagamento de Pix solicitado.\n* `payment.pix_batch.approve.confirmed` Liberação de Lote de Pagamento de Pix confirmado.\n* `payment.pix_batch.approve.failed` Falha na liberação de Lote de Pagamento de Pix.\n* `payment.pix_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Pix.\n* `payment.pix_batch.reprove.requested` Rejeição de Lote de Pagamento de Pix solicitado.\n* `payment.pix_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Pix confirmado.\n* `payment.pix_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Pix.\n* `payment.pix_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Pix.\n* `payment.pix_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.pix_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.pix_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.pix_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.tax_batch.awaiting_approval` Lote de Pagamento de Tributo aguardando liberação.\n* `payment.tax_batch.get.requested` Informação do Lote de Pagamento de Tributo solicitada.\n* `payment.tax_batch.get.confirmed` Informação do Lote de Pagamento de Tributo confirmada.\n* `payment.tax_batch.get.failed` Falha na informação do Lote de Pagamento de Tributo.\n* `payment.tax_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Tributo.\n* `payment.tax_batch.sync.requested` Sincronização de Lote de Pagamento de Tributo solicitada.\n* `payment.tax_batch.sync.confirmed` Sincronização de Lote de Pagamento de Tributo confirmada.\n* `payment.tax_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Tributo.\n* `payment.tax_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Tributo.\n* `payment.tax_batch.register.requested` Lote de Pagamento de Tributo solicitado.\n* `payment.tax_batch.register.confirmed` Lote de Pagamento de Tributo confirmado.\n* `payment.tax_batch.register.failed` Falha no envio do Lote de Pagamento de Tributo.\n* `payment.tax_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Tributo.\n* `payment.tax_batch.approve.requested` Liberação de Lote de Pagamento de Tributo solicitado.\n* `payment.tax_batch.approve.confirmed` Liberação de Lote de Pagamento de Tributo confirmado.\n* `payment.tax_batch.approve.failed` Falha na liberação de Lote de Pagamento de Tributo.\n* `payment.tax_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Tributo.\n* `payment.tax_batch.reprove.requested` Rejeição de Lote de Pagamento de Tributo solicitado.\n* `payment.tax_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Tributo confirmado.\n* `payment.tax_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Tributo.\n* `payment.tax_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Tributo.\n* `payment.tax_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.tax_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.tax_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.tax_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.dda.account.db.created` Conta de DDA criada\n* `payment.dda.account.register.requested` Conta de DDA solicitada.\n* `payment.dda.account.register.failed` Falha na criação da conta DDA.\n* `payment.dda.account.register.error` Ocorreu um erro no registro da conta DDA.\n* `payment.dda.account.register.confirmed` Conta de DDA confirmada.\n* `payment.dda.account.bank_billets_sync.requested` Sincronização de Boletos solicitada.\n* `payment.dda.account.bank_billets_sync.failed` Falha na sincronização de Boleto.\n* `payment.dda.account.bank_billets_sync.error` Ocorreu um erro na sincronização de Boletos.\n* `payment.dda.account.bank_billets_sync.confirmed` Sincronização de Boletos confirmada.\n* `payment.dda.account.unregister.requested` Descadastramento da conta DDA solicitado.\n* `payment.dda.account.unregister.failed` Falha no descadastramento da conta DDA.\n* `payment.dda.account.unregister.error` Ocorreu um erro no descadastramento da conta DDA.\n* `payment.dda.account.unregister.confirmed` Descadastramento da conta DDA confirmado.\n* `payment.dda.bank_billet.db.created` Boleto DDA criado\n* `payment.dda.bank_billet.db.updated` Boleto DDA atualizado.\n* `payment.dda.bank_billet.external_status_changed` Status externo do Boleto DDA alterado.\n* `payment.dda.bank_billet.get.requested` Informação do Boleto solicitada.\n* `payment.dda.bank_billet.get.confirmed` Informação do Boleto confirmada.\n* `payment.dda.bank_billet.get.failed` Falha na informação do Boleto.\n* `payment.dda.bank_billet.get.error` Ocorreu um erro na informação do Boleto.\n* `payment.dda.bank_billet.sync.requested` Sincronização do Boleto solicitada.\n* `payment.dda.bank_billet.sync.confirmed` Sincronização do Boleto confirmada.\n* `payment.dda.bank_billet.sync.failed` Falha na sincronização do Boleto.\n* `payment.dda.bank_billet.sync.error` Ocorreu um erro na sincronização do Boleto.\n* `payment.dda.account.db.updated` Conta de DDA atualizada.\n* `payment.dda.account.db.deleted` Conta de DDA excluída.\n* `payment.dda.account.letter.pending` Carta DDA gerada.\n* `payment.dda.account.letter.waiting_signatures` Carta DDA aguardando assinaturas.\n* `payment.dda.account.letter.signed` Carta DDA assinada.\n* `payment.dda.account.letter.failed` Falha no processo de assinatura da carta DDA.\n* `payment.dda.account.confirmed` Assinatura da conta DDA aprovada.\n* `payment.dda.account.rejected` Assinatura da conta DDA rejeitada.\n* `payment.dda.account.failed` Falha na conta DDA.\n* `payment.dda.account.disabled` Conta DDA desabilitada.\n* `payment.dda.account.enabled` Conta DDA reabilitada.\n* `credit.restriction.add.requested` Inclusão da restrição de crédito solicitada.\n* `credit.restriction.add.failed` Falha na inclusão da restrição de crédito.\n* `credit.restriction.add.error` Ocorreu um erro na inclusão da restrição de crédito.\n* `credit.restriction.add.confirmed` Inclusão da restrição de crédito confirmada.\n* `credit.restriction.remove.requested` Remoção da restrição de crédito solicitada.\n* `credit.restriction.remove.confirmed` Remoção da restrição de crédito confirmada.\n* `credit.restriction.remove.failed` Falha na remoção da restrição de crédito.\n* `credit.restriction.remove.error` Ocorreu um erro na remoção da restrição de crédito.\n* `charge.automatic_pix.account.db.created` Conta de Pix Automático criada.\n* `charge.automatic_pix.account.db.updated` Conta de Pix Automático atualizada.\n* `charge.automatic_pix.account.db.deleted` Conta de Pix Automático excluída.\n* `charge.automatic_pix.recurrence.db.created` Recorrência de Pix Automático criada.\n* `charge.automatic_pix.recurrence.db.updated` Recorrência de Pix Automático atualizada.\n* `charge.automatic_pix.recurrence.db.deleted` Recorrência de Pix Automático excluída.\n* `charge.automatic_pix.recurrence.cancel.requested` Cancelamento da Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.recurrence.cancel.confirmed` Cancelamento da Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.recurrence.cancel.failed` Falha no cancelamento da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.cancel.error` Ocorreu um erro no cancelamento da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.register.requested` Registro da Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.recurrence.register.confirmed` Registro da Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.recurrence.register.failed` Falha no registro da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.register.error` Ocorreu um erro no registro da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.update.requested` Atualização da Recorrência de Pix Automático solicitada.\n* `charge.automatic_pix.recurrence.update.confirmed` Atualização da Recorrência de Pix Automático confirmada.\n* `charge.automatic_pix.recurrence.update.failed` Falha na atualização da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.update.error` Ocorreu um erro na atualização da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.pending` Recorrência de Pix Automático pendente.\n* `charge.automatic_pix.recurrence.created` Recorrência de Pix Automático criada no provedor financeiro.\n* `charge.automatic_pix.recurrence.approved` Recorrência de Pix Automático aprovada.\n* `charge.automatic_pix.recurrence.rejected` Recorrência de Pix Automático rejeitada.\n* `charge.automatic_pix.recurrence.expired` Recorrência de Pix Automático expirada.\n* `charge.automatic_pix.recurrence.canceled` Recorrência de Pix Automático cancelada.\n* `charge.automatic_pix.request.db.created` Solicitações de Recorrência de Pix Automático criada.\n* `charge.automatic_pix.request.db.updated` Solicitações de Recorrência de Pix Automático atualizada.\n* `charge.automatic_pix.request.db.deleted` Solicitações de Recorrência de Pix Automático excluída.\n* `charge.automatic_pix.request.cancel.requested` Cancelamento da Solicitação de Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.request.cancel.confirmed` Cancelamento da Solicitação de Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.request.cancel.failed` Falha no cancelamento da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.cancel.error` Ocorreu um erro no cancelamento da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.register.requested` Registro da Solicitação de Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.request.register.confirmed` Registro da Solicitação de Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.request.register.failed` Falha no registro da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.register.error` Ocorreu um erro no registro da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.pending` Solicitação de Recorrência de Pix Automático pendente.\n* `charge.automatic_pix.request.created` Solicitação de Recorrência de Pix Automático criada no provedor financeiro.\n* `charge.automatic_pix.request.sent` Solicitação de Recorrência de Pix Automático enviada ao pagador.\n* `charge.automatic_pix.request.received` Solicitação de Recorrência de Pix Automático recebida pelo pagador.\n* `charge.automatic_pix.request.rejected` Solicitação de Recorrência de Pix Automático rejeitada.\n* `charge.automatic_pix.request.accepted` Solicitação de Recorrência de Pix Automático aceita.\n* `charge.automatic_pix.request.expired` Solicitação de Recorrência de Pix Automático expirada.\n* `charge.automatic_pix.request.canceled` Solicitação de Recorrência de Pix Automático cancelada.\n* `charge.automatic_pix.pix.db.created` Cobrança de Pix Automático criada.\n* `charge.automatic_pix.pix.db.updated` Cobrança de Pix Automático atualizada.\n* `charge.automatic_pix.pix.db.deleted` Cobrança de Pix Automático excluída.\n* `charge.automatic_pix.pix.cancel.requested` Cancelamento da Cobrança de Pix Automático solicitado.\n* `charge.automatic_pix.pix.cancel.confirmed` Cancelamento da Cobrança de Pix Automático confirmado.\n* `charge.automatic_pix.pix.cancel.failed` Falha no cancelamento da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.cancel.error` Ocorreu um erro no cancelamento da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.register.requested` Registro da Cobrança de Pix Automático solicitado.\n* `charge.automatic_pix.pix.register.confirmed` Registro da Cobrança de Pix Automático confirmado.\n* `charge.automatic_pix.pix.register.failed` Falha no registro da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.register.error` Ocorreu um erro no registro da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.update.requested` Atualização da Cobrança de Pix Automático solicitada.\n* `charge.automatic_pix.pix.update.confirmed` Atualização da Cobrança de Pix Automático confirmada.\n* `charge.automatic_pix.pix.update.failed` Falha na atualização da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.update.error` Ocorreu um erro na atualização da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.pending` Cobrança de Pix Automático pendente.\n* `charge.automatic_pix.pix.created` Cobrança de Pix Automático criada no provedor financeiro.\n* `charge.automatic_pix.pix.active` Cobrança de Pix Automático ativa.\n* `charge.automatic_pix.pix.paid` Cobrança de Pix Automático paga.\n* `charge.automatic_pix.pix.expired` Cobrança de Pix Automático expirada.\n* `charge.automatic_pix.pix.rejected` Cobrança de Pix Automático rejeitada.\n* `charge.automatic_pix.pix.canceled` Cobrança de Pix Automático cancelada.\n* `charge.automatic_pix.location.db.created` Localização de Pix Automático criada.\n* `charge.automatic_pix.location.db.updated` Localização de Pix Automático atualizada.\n* `charge.automatic_pix.location.db.deleted` Localização de Pix Automático excluída.\n* `charge.automatic_pix.location.register.requested` Registro da Localização de Pix Automático solicitado.\n* `charge.automatic_pix.location.register.confirmed` Registro da Localização de Pix Automático confirmado.\n* `charge.automatic_pix.location.register.failed` Falha no registro da Localização de Pix Automático.\n* `charge.automatic_pix.location.register.error` Ocorreu um erro no registro da Localização de Pix Automático.\n* `charge.payment.db.created` Recebimento de cobrança criado.\n* `charge.payment.db.updated` Recebimento de cobrança atualizado.\n* `charge.payment.db.deleted` Recebimento de cobrança excluído.\n* `charge.payment.notified` Recebimento notificado.\n* `charge.payment.canceled` Recebimento cancelado.\n* `charge.payment.confirmed` Recebimento confirmado.\n* `charge.payment.duplicated` Recebimento duplicado.\n* `charge.bank_billet.payment.notified` Baixa operacional de boleto notificada.\n* `charge.bank_billet.payment.canceled` Baixa operacional de boleto cancelada.\n* `charge.bank_billet.payment.confirmed` Baixa operacional de boleto liquidada.\n* `data.bank_billet_query.success` Consulta de boleto realizada com sucesso.\n* `data.bank_billet_query.error` Consulta de boleto com erro.\n* `data.bank_billet_query.db.created` Consulta de boleto criada.\n* `data.bank_billet_query.db.updated` Consulta de boleto atualizada.\n* `data.bank_billet_query.db.deleted` Consulta de boleto excluída.\n* `data.pix_qrcode_query.success` Consulta de Pix via QR Code realizada com sucesso.\n* `data.pix_qrcode_query.error` Consulta de Pix via QR Code com erro.\n* `data.pix_qrcode_query.db.created` Consulta de Pix via QR Code criada.\n* `data.pix_qrcode_query.db.updated` Consulta de Pix via QR Code atualizada.\n* `data.pix_qrcode_query.db.deleted` Consulta de Pix via QR Code excluída.\n* `mailbox.entry.db.created` Caixa Postal criado.\n* `mailbox.entry.db.updated` Caixa Postal atualizado.\n* `mailbox.entry.db.deleted` Caixa Postal excluída.\n* `mailbox.entry.file.received` Arquivo recebido na caixa de entrada.\n* `mailbox.entry.file.sent` Arquivo enviado para a caixa de saída.\n* `mailbox.file.db.created` Arquivo criado.\n* `mailbox.file.db.updated` Arquivo atualizado.\n* `mailbox.file.db.deleted` Arquivo excluído.\n* `mailbox.channel.s3.db.created` Canal S3 criado.\n* `mailbox.channel.s3.db.updated` Canal S3 atualizado.\n* `mailbox.channel.s3.db.deleted` Canal S3 excluído.\n* `mailbox.channel.s3.fetch_all` Arquivo obtido do canal S3.\n* `mailbox.channel.email.db.created` Canal de Email criado.\n* `mailbox.channel.email.db.updated` Canal de Email atualizado.\n* `mailbox.channel.email.db.deleted` Canal de Email excluído.\n* `mailbox.channel.whatsapp.db.created` Canal WhatsApp criado.\n* `mailbox.channel.whatsapp.db.updated` Canal WhatsApp atualizado.\n* `mailbox.channel.whatsapp.db.deleted` Canal WhatsApp excluído.\n* `mailbox.channel.sftp.db.created` Canal SFTP criado.\n* `mailbox.channel.sftp.db.updated` Canal SFTP atualizado.\n* `mailbox.channel.sftp.db.deleted` Canal SFTP excluído.\n* `mailbox.channel.sftp.fetch_all` Arquivo obtido do canal SFTP.\n* `mailbox.channel.syncthing.db.created` Canal Syncthing criado.\n* `mailbox.channel.syncthing.db.updated` Canal Syncthing atualizado.\n* `mailbox.channel.syncthing.db.deleted` Canal Syncthing excluído.\n* `email_account.db.created` Conta de e-mail criada.\n* `email_account.db.updated` Conta de e-mail atualizada.\n* `email_account.db.deleted` Conta de e-mail excluída.\n* `email_account.identity.pending` Aguardando identidade\n* `email_account.identity.created` Identidade criada\n* `email_account.identity.error` Identidade já existente\n* `email_account.identity.failure` Falha da identidade\n* `email_account.dns.not_ready` DNS não pronto\n* `email_account.dns.awaiting` Aguardando validação DNS\n* `email_account.dns.validated` DNS validado\n* `email_account.dns.error` Falha na validação do DNS\n* `email_account.dns.failure` Falha na tentativa do DNS\n* `integration.connection.db.created` Conexão criada.\n* `integration.connection.db.updated` Conexão atualizada.\n* `integration.connection.db.deleted` Conexão excluída.\n* `webhook.db.created` Webhook criado.\n* `webhook.db.updated` Webhook atualizado.\n* `webhook.db.deleted` Webhook excluído.\n* `enotas.nfe.generated` Enotas: nota fiscal gerada" }, "data": { "type": "object", "description": "Mais informações relativas ao evento. Ver possíveis valores em [Payloads](/reference/payloads)" }, "bank_billet_account_id": { "type": "integer", "readOnly": true, "nullable": true, "description": "ID da Carteira de Cobrança", "example": null }, "resource_owner_id": { "type": "integer", "nullable": true, "description": "ID do Objeto associado ao evento", "example": null }, "occurred_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de quando o evento ocorreu." }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do evento" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de atualização do evento" } } }, "v1_email_delivery_object": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do e-mail enviado" }, "uid": { "type": "string", "maxLength": 36, "description": "UID usado no cabeçalho da requisição" }, "delivered_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora que a entrega foi realizada" }, "failed_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora que a entrega falhou" }, "event_code": { "type": "string", "maxLength": 255, "example": "bank_billet.created", "description": "Código do evento.\n* `ping` Ping\n* `access_token.db.created` Token de Acesso criado.\n* `access_token.db.updated` Token de Acesso atualizado.\n* `access_token.db.deleted` Token de Acesso excluído.\n* `access_token.reminder` Lembrete de expiração do Token de Acesso.\n* `access_token.expired` Token de Acesso expirou.\n* `account.updated` Conta atualizada.\n* `account.blocked` Conta bloqueada.\n* `account.bank_billet_creation_blocked` Emissão de boletos bloqueada.\n* `bank_billet.created` Boleto criado.\n* `bank_billet.updated` Boleto atualizado.\n* `bank_billet.generated` PDF do Boleto Gerado ou Atualizado.\n* `bank_billet.canceled` Boleto cancelado.\n* `bank_billet.blocked` Boleto foi bloqueado.\n* `bank_billet.overdue` Boleto ficou vencido.\n* `bank_billet.paid` Boleto foi pago.\n* `bank_billet.due_date` Notifica boleto com 15, 7, 3 e 1 dias antes do vencimento.\n* `bank_billet.rejected` Boleto rejeitado.\n* `bank_billet.cancel.requested` Cancelamento do Boleto solicitado.\n* `bank_billet.cancel.confirmed` Cancelamento do Boleto confirmado.\n* `bank_billet.cancel.failed` Falha no cancelamento do Boleto.\n* `bank_billet.cancel.error` Ocorreu um erro no cancelamento do Boleto.\n* `bank_billet.register.requested` Registro do Boleto solicitado.\n* `bank_billet.register.confirmed` Registro do Boleto confirmado.\n* `bank_billet.register.failed` Falha no registro do Boleto.\n* `bank_billet.register.error` Ocorreu um erro no registro do Boleto.\n* `bank_billet.update.requested` Atualização do Boleto solicitada.\n* `bank_billet.update.confirmed` Atualização do Boleto confirmada.\n* `bank_billet.update.failed` Falha na atualização do Boleto.\n* `bank_billet.update.error` Ocorreu um erro na atualização do Boleto.\n* `bank_billet.registered` Boleto registrado.\n* `bank_billet.deleted` Boleto excluído.\n* `bank_billet.sync.requested` Sincronização do Boleto solicitada.\n* `bank_billet.sync.confirmed` Sincronização do Boleto confirmada.\n* `bank_billet.sync.failed` Falha na sincronização do Boleto.\n* `bank_billet.sync.error` Ocorreu um erro na sincronização do Boleto.\n* `bank_billet.get.requested` Informação do Boleto solicitada.\n* `bank_billet.get.confirmed` Informação do Boleto confirmada.\n* `bank_billet.get.failed` Falha na informação do Boleto.\n* `bank_billet.get.error` Ocorreu um erro na informação do Boleto.\n* `bank_billet.get_child.requested` Informação do Boleto filho solicitada.\n* `bank_billet.get_child.confirmed` Informação do Boleto filho confirmada.\n* `bank_billet.get_child.failed` Falha na informação do Boleto filho.\n* `bank_billet.get_child.error` Ocorreu um erro na informação do Boleto filho.\n* `bank_billet.find.requested` Busca de Boleto solicitada.\n* `bank_billet.find.confirmed` Busca de Boleto confirmada.\n* `bank_billet.find.failed` Falha na busca de Boleto.\n* `bank_billet.find.error` Ocorreu um erro na busca de Boleto.\n* `bank_billet.add_pix.requested` Adição do Pix ao Boleto solicitada.\n* `bank_billet.add_pix.confirmed` Adição do Pix ao Boleto confirmada.\n* `bank_billet.add_pix.failed` Falha na adição do Pix ao Boleto.\n* `bank_billet.add_pix.error` Ocorreu um erro na adição do Pix ao Boleto.\n* `bank_billet.get_pix.requested` Consulta do Pix do Boleto solicitada.\n* `bank_billet.get_pix.confirmed` Consulta do Pix do Boleto confirmada.\n* `bank_billet.get_pix.failed` Falha na consulta do Pix do Boleto.\n* `bank_billet.get_pix.error` Ocorreu um erro na consulta do Pix do Boleto.\n* `bank_billet.protest.requested` Protesto do Boleto solicitado.\n* `bank_billet.protest.confirmed` Protesto do Boleto confirmado.\n* `bank_billet.protest.failed` Falha no protesto do Boleto.\n* `bank_billet.protest.error` Ocorreu um erro no protesto do Boleto.\n* `bank_billet_discharge.created` Registro de retorno criado.\n* `bank_billet_discharge.updated` Registro de retorno atualizado.\n* `bank_billet_discharge.deleted` Registro de retorno excluído.\n* `bank_billet_remittance.created` Registro de remessa criado.\n* `bank_billet_remittance.updated` Registro de remessa atualizado.\n* `bank_billet_remittance.deleted` Registro de remessa excluído.\n* `bank_billet_registration.created` Registro de Boleto criado.\n* `bank_billet_registration.updated` Registro de Boleto atualizado.\n* `bank_billet_registration.deleted` Registro de Boleto excluído.\n* `bank_billet_payment.created` Recebimento criado.\n* `bank_billet_payment.updated` Recebimento atualizado.\n* `bank_billet_payment.deleted` Recebimento excluído.\n* `customer.created` Cliente criado.\n* `customer.updated` Cliente atualizado.\n* `customer.portal_password_updated` Senha do portal do cliente atualizada.\n* `customer.deleted` Cliente excluído.\n* `transaction.created` Transação criada.\n* `transaction.updated` Transação atualizada.\n* `transaction.processed` Transação processada.\n* `withdrawal.transferred` Saque transferido.\n* `withdrawal.requested` Saque solicitado.\n* `addon.activated` Addon ativado.\n* `addon.removed` Addon removido.\n* `plan_subscription.activated` Plano ativado.\n* `plan_subscription.removed` Plano removido.\n* `plan_subscription.fee` Cobrança do plano.\n* `plan_subscription.updated` Plano atualizado.\n* `user.created` Usuário criado.\n* `user.updated` Usuário atualizado.\n* `user.deleted` Usuário excluído.\n* `remittance.created` Remessa criada.\n* `remittance.processed` Remessa processada.\n* `remittance.downloaded` Download de Remessa realizado.\n* `remittance.sent` Remessa enviada.\n* `remittance.deleted` Remessa excluída.\n* `remittance.line.db.created` Linha de Remessa criada.\n* `remittance.line.db.updated` Linha de Remessa atualizada.\n* `remittance.line.db.deleted` Linha de Remessa excluída.\n* `discharge.created` Retorno criado.\n* `discharge.processed` Retorno processado.\n* `discharge.deleted` Retorno excluído.\n* `bank_billet_account.created` Conta de Cobrança criada.\n* `bank_billet_account.homologated` Conta de Cobrança enviada para homologação.\n* `bank_billet_account.homologation_failed` Falha na homologação da Conta de Cobrança.\n* `bank_billet_account.homologation_started` Conta de Cobrança enviada para homologação.\n* `bank_billet_account.validated` Conta de Cobrança homologada.\n* `bank_billet_account.validation_released` Conta de Cobrança homologada.\n* `bank_billet_account.activated` Conta de Cobrança ativada.\n* `bank_billet_account.updated` Conta de Cobrança atualizada.\n* `bank_billet_account.deleted` Conta de Cobrança excluída.\n* `edi.remittance_line.created` Linha de Remessa criada.\n* `edi.remittance_line.updated` Linha de Remessa atualizada.\n* `edi.remittance_line.deleted` Linha de Remessa excluída.\n* `edi.edi_box.activated` EDI ativado.\n* `edi.edi_box.db.created` EDI criado.\n* `edi.edi_box.db.deleted` EDI excluído.\n* `edi.edi_box.db.updated` EDI atualizado.\n* `edi.edi_box.generated` Carta Gerada\n* `edi.edi_box.demand_received` Demanda recepcionada\n* `edi.edi_box.confirming_at_bank` Aguardando confirmação do banco\n* `edi.edi_box.testing_by_customer` Aguardando teste do cliente\n* `edi.edi_box.waiting_for_validations` Aguardando validações\n* `customer_subscription.created` Assinatura criada.\n* `customer_subscription.updated` Assinatura atualizada.\n* `customer_subscription.deleted` Assinatura excluída.\n* `installment.created` Carnê criado.\n* `installment.processed` Carnê processado.\n* `installment.generated` Carnê gerado.\n* `installment.deleted` Carnê excluído.\n* `import.created` Importação criada.\n* `import.processed` Importação processada.\n* `import.deleted` Importação excluída.\n* `export.db.created` Exportação criada.\n* `export.db.updated` Exportação atualizada.\n* `export.db.deleted` Exportação excluída.\n* `pix.db.created` Pix criado.\n* `pix.db.updated` Pix atualizado.\n* `pix.db.deleted` Pix excluído.\n* `pix.register.requested` Registro do Pix solicitado.\n* `pix.register.confirmed` Registro do Pix confirmado.\n* `pix.register.failed` Falha no registro do Pix.\n* `pix.register.error` Ocorreu um erro no registro do Pix.\n* `pix.update.requested` Atualização do Pix solicitada.\n* `pix.update.confirmed` Atualização do Pix confirmada.\n* `pix.update.failed` Falha na atualização do Pix.\n* `pix.update.error` Ocorreu um erro na atualização do Pix.\n* `pix.paid` Pix pago.\n* `pix.overdue` Pix vencido (somente Pix Cobrança).\n* `pix.cancel.requested` Cancelamento do Pix solicitado.\n* `pix.cancel.confirmed` Cancelamento do Pix confirmado.\n* `pix.cancel.failed` Falha no cancelamento do Pix.\n* `pix.cancel.error` Ocorreu um erro no cancelamento do Pix.\n* `pix.sync.requested` Sincronização do Pix solicitada.\n* `pix.sync.confirmed` Sincronização do Pix confirmada.\n* `pix.sync.failed` Falha na sincronização do Pix.\n* `pix.sync.error` Ocorreu um erro na sincronização do Pix.\n* `pix.get.requested` Informação do Pix solicitada.\n* `pix.get.confirmed` Informação do Pix confirmada.\n* `pix.get.failed` Falha na informação do Pix.\n* `pix.get.error` Ocorreu um erro na informação do Pix.\n* `financial.account.balance_sync.requested` Sincronização do Saldo solicitada.\n* `financial.account.balance_sync.confirmed` Sincronização do Saldo confirmada.\n* `financial.account.balance_sync.failed` Falha na sincronização do Saldo.\n* `financial.account.balance_sync.error` Ocorreu um erro na sincronização do Saldo.\n* `financial.account.statement_sync.requested` Sincronização do Extrato solicitada.\n* `financial.account.statement_sync.confirmed` Sincronização do Extrato confirmada.\n* `financial.account.statement_sync.failed` Falha na sincronização do Extrato.\n* `financial.account.statement_sync.error` Ocorreu um erro na sincronização do Extrato.\n* `financial.account.db.created` Conta Financeira criada.\n* `financial.account.db.updated` Conta Financeira atualizada.\n* `financial.account.db.deleted` Conta Financeira excluída.\n* `financial.account.statement.updated` Extrato atualizado.\n* `financial.account.balance.updated` Saldo da conta financeira atualizado.\n* `financial.account_balance.db.created` Saldo criado.\n* `transfer.batch.db.created` Lote de transferência criado.\n* `transfer.batch.db.updated` Lote de transferência atualizado.\n* `transfer.batch.db.deleted` Lote de transferência excluído.\n* `transfer.batch.awaiting_approval` Lote de transferência aguardando liberação.\n* `transfer.pix_batch.awaiting_approval` Lote de Transferência Pix aguardando liberação.\n* `transfer.pix_batch.get.requested` Informação do Lote de Transferência Pix solicitada.\n* `transfer.pix_batch.get.confirmed` Informação do Lote de Transferência Pix confirmada.\n* `transfer.pix_batch.get.failed` Falha na informação do Lote de Transferência Pix.\n* `transfer.pix_batch.get.error` Ocorreu um erro na informação do Lote de Transferência Pix.\n* `transfer.pix_batch.sync.requested` Sincronização de Lote de transferência Pix solicitada.\n* `transfer.pix_batch.sync.confirmed` Sincronização de Lote de transferência Pix confirmada.\n* `transfer.pix_batch.sync.failed` Falha na sincronização de Lote de transferência Pix.\n* `transfer.pix_batch.sync.error` Ocorreu um erro na sincronização de Lote de transferência Pix.\n* `transfer.pix_batch.register.requested` Lote de Transferência Pix solicitado.\n* `transfer.pix_batch.register.confirmed` Lote de Transferência Pix confirmado.\n* `transfer.pix_batch.register.failed` Falha no envio de Lote de Transferência Pix.\n* `transfer.pix_batch.register.error` Ocorreu um erro no envio de Lote de Transferência Pix.\n* `transfer.pix_batch.approve.requested` Liberação de Lote de Transferência Pix solicitada.\n* `transfer.pix_batch.approve.confirmed` Liberação de Lote de Transferência Pix confirmada.\n* `transfer.pix_batch.approve.failed` Falha na liberação de Lote de Transferência Pix.\n* `transfer.pix_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência Pix.\n* `transfer.pix_batch.reprove.requested` Rejeição de Lote de Transferência Pix solicitada.\n* `transfer.pix_batch.reprove.confirmed` Rejeição de Lote de transferência Pix confirmada.\n* `transfer.pix_batch.reprove.failed` Falha na rejeição de Lote de Transferência Pix.\n* `transfer.pix_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência Pix.\n* `transfer.pix_batch.cancel.requested` Cancelamento de Lote de Transferência Pix solicitado.\n* `transfer.pix_batch.cancel.confirmed` Cancelamento de Lote de Transferência Pix confirmado.\n* `transfer.pix_batch.cancel.failed` Falha no cancelamento de Lote de Transferência Pix.\n* `transfer.pix_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Transferência Pix.\n* `transfer.ted_batch.awaiting_approval` Lote de Transferência TED aguardando liberação.\n* `transfer.ted_batch.get.requested` Informação do Lote de Transferência TED solicitada.\n* `transfer.ted_batch.get.confirmed` Informação do Lote de Transferência TED confirmada.\n* `transfer.ted_batch.get.failed` Falha na informação do Lote de Transferência TED.\n* `transfer.ted_batch.get.error` Ocorreu um erro na informação do Lote de Transferência TED.\n* `transfer.ted_batch.sync.requested` Sincronização de Lote de transferência TED solicitada.\n* `transfer.ted_batch.sync.confirmed` Sincronização de Lote de transferência TED confirmada.\n* `transfer.ted_batch.sync.failed` Falha na sincronização de Lote de transferência TED.\n* `transfer.ted_batch.sync.error` Ocorreu um erro na sincronização de Lote de transferência TED.\n* `transfer.ted_batch.register.requested` Lote de Transferência TED solicitado.\n* `transfer.ted_batch.register.confirmed` Lote de Transferência TED confirmado.\n* `transfer.ted_batch.register.failed` Falha no envio de Lote de Transferência TED.\n* `transfer.ted_batch.register.error` Ocorreu um erro no envio de Lote de Transferência TED.\n* `transfer.ted_batch.approve.requested` Liberação de Lote de Transferência TED solicitada.\n* `transfer.ted_batch.approve.confirmed` Liberação de Lote de Transferência TED confirmada.\n* `transfer.ted_batch.approve.failed` Falha na liberação de Lote de Transferência TED.\n* `transfer.ted_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência TED.\n* `transfer.ted_batch.reprove.requested` Rejeição de Lote de Transferência TED solicitada.\n* `transfer.ted_batch.reprove.confirmed` Rejeição de Lote de transferência TED confirmada.\n* `transfer.ted_batch.reprove.failed` Falha na rejeição de Lote de Transferência TED.\n* `transfer.ted_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência TED.\n* `transfer.ted_batch.cancel.requested` Cancelamento de Lote de Transferência TED solicitado.\n* `transfer.ted_batch.cancel.confirmed` Cancelamento de Lote de Transferência TED confirmado.\n* `transfer.ted_batch.cancel.failed` Falha no cancelamento de Lote de Transferência TED.\n* `transfer.ted_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Transferência TED.\n* `transfer.internal_batch.awaiting_approval` Lote de Transferência Entre Contas do Mesmo Banco aguardando liberação.\n* `transfer.internal_batch.get.requested` Informação do Lote de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.get.confirmed` Informação do Lote de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.get.failed` Falha na informação do Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.get.error` Ocorreu um erro na informação do Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.sync.requested` Sincronização de Lote de transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.sync.confirmed` Sincronização de Lote de transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.sync.failed` Falha na sincronização de Lote de transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.sync.error` Ocorreu um erro na sincronização de Lote de transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.register.requested` Lote de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal_batch.register.confirmed` Lote de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal_batch.register.failed` Falha no envio de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.register.error` Ocorreu um erro no envio de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.approve.requested` Liberação de Lote de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.approve.confirmed` Liberação de Lote de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.approve.failed` Falha na liberação de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.reprove.requested` Rejeição de Lote de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.reprove.confirmed` Rejeição de Lote de transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.reprove.failed` Falha na rejeição de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.cancel.requested` Cancelamento de Lote de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal_batch.cancel.confirmed` Cancelamento de Lote de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal_batch.cancel.failed` Falha no cancelamento de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.db.created` Transferência criada.\n* `transfer.db.updated` Transferência atualizada.\n* `transfer.db.deleted` Transferência excluída.\n* `transfer.pix.register.requested` Transferência Pix solicitada.\n* `transfer.pix.register.confirmed` Transferência Pix confirmada.\n* `transfer.pix.register.failed` Falha no envio da Transferência Pix.\n* `transfer.pix.register.error` Ocorreu um erro no envio da Transferência Pix.\n* `transfer.pix.reschedule.requested` Reagendamento de Transferência Pix solicitado.\n* `transfer.pix.reschedule.confirmed` Reagendamento de Transferência Pix confirmado.\n* `transfer.pix.reschedule.failed` Falha no reagendamento da Transferência Pix.\n* `transfer.pix.reschedule.error` Ocorreu um erro no reagendamento da Transferência Pix.\n* `transfer.pix.approve.requested` Liberação de Transferência Pix solicitada.\n* `transfer.pix.approve.confirmed` Liberação de Transferência Pix confirmada.\n* `transfer.pix.approve.failed` Falha na liberação da transferência Pix.\n* `transfer.pix.approve.error` Ocorreu um erro na liberação da Transferência Pix.\n* `transfer.pix.reprove.requested` Rejeição de Transferência Pix solicitada.\n* `transfer.pix.reprove.confirmed` Rejeição de Transferência Pix confirmada.\n* `transfer.pix.reprove.failed` Falha na rejeição da transferência Pix.\n* `transfer.pix.reprove.error` Ocorreu um erro na rejeição da Transferência Pix.\n* `transfer.pix.cancel.requested` Cancelamento de Transferência Pix solicitado.\n* `transfer.pix.cancel.confirmed` Cancelamento de Transferência Pix confirmado.\n* `transfer.pix.cancel.failed` Falha no cancelamento da Transferência Pix.\n* `transfer.pix.cancel.error` Ocorreu um erro no cancelamento da Transferência Pix.\n* `transfer.pix.get.requested` Informação da Transferência Pix solicitada.\n* `transfer.pix.get.confirmed` Informação da Transferência Pix confirmada.\n* `transfer.pix.get.failed` Falha na informação da Transferência Pix.\n* `transfer.pix.get.error` Ocorreu um erro na informação da Transferência Pix.\n* `transfer.pix.sync.requested` Sincronização da Transferência Pix solicitada.\n* `transfer.pix.sync.confirmed` Sincronização da Transferência Pix confirmada.\n* `transfer.pix.sync.failed` Falha na sincronização da Transferência Pix.\n* `transfer.pix.sync.error` Ocorreu um erro na sincronização da Transferência Pix.\n* `transfer.ted.register.requested` Transferência TED solicitada.\n* `transfer.ted.register.confirmed` Transferência TED confirmada.\n* `transfer.ted.register.failed` Falha no envio da Transferência TED.\n* `transfer.ted.register.error` Ocorreu um erro no envio da Transferência TED.\n* `transfer.ted.reschedule.requested` Reagendamento de Transferência TED solicitado.\n* `transfer.ted.reschedule.confirmed` Reagendamento de Transferência TED confirmado.\n* `transfer.ted.reschedule.failed` Falha no Reagendamento de Transferência TED.\n* `transfer.ted.reschedule.error` Ocorreu um erro no Reagendamento de Transferência TED.\n* `transfer.ted.approve.requested` Liberação de Transferência TED solicitada.\n* `transfer.ted.approve.confirmed` Liberação de Transferência TED confirmada.\n* `transfer.ted.approve.failed` Falha na liberação da transferência TED.\n* `transfer.ted.approve.error` Ocorreu um erro na liberação da Transferência TED.\n* `transfer.ted.reprove.requested` Rejeição de Transferência TED solicitada.\n* `transfer.ted.reprove.confirmed` Rejeição de Transferência TED confirmada.\n* `transfer.ted.reprove.failed` Falha na rejeição da transferência TED.\n* `transfer.ted.reprove.error` Ocorreu um erro na rejeição da Transferência TED.\n* `transfer.ted.cancel.requested` Cancelamento de Transferência TED solicitado.\n* `transfer.ted.cancel.confirmed` Cancelamento de Transferência TED confirmado.\n* `transfer.ted.cancel.failed` Falha no cancelamento de Transferência TED.\n* `transfer.ted.cancel.error` Ocorreu um erro no cancelamento de Transferência TED.\n* `transfer.ted.get.requested` Informação da Transferência TED solicitada.\n* `transfer.ted.get.confirmed` Informação da Transferência TED confirmada.\n* `transfer.ted.get.failed` Falha na informação da Transferência TED.\n* `transfer.ted.get.error` Ocorreu um erro na informação da Transferência TED.\n* `transfer.ted.sync.requested` Sincronização da Transferência TED solicitada.\n* `transfer.ted.sync.confirmed` Sincronização da Transferência TED confirmada.\n* `transfer.ted.sync.failed` Falha na sincronização da Transferência TED.\n* `transfer.ted.sync.error` Ocorreu um erro na sincronização da Transferência TED.\n* `transfer.internal.register.requested` Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.register.confirmed` Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.register.failed` Falha no envio da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.register.error` Ocorreu um erro no envio da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reschedule.requested` Reagendamento de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal.reschedule.confirmed` Reagendamento de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal.reschedule.failed` Falha no Reagendamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reschedule.error` Ocorreu um erro no Reagendamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.approve.requested` Liberação de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.approve.confirmed` Liberação de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.approve.failed` Falha na liberação da transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.approve.error` Ocorreu um erro na liberação da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reprove.requested` Rejeição de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.reprove.confirmed` Rejeição de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.reprove.failed` Falha na rejeição da transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reprove.error` Ocorreu um erro na rejeição da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.cancel.requested` Cancelamento de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal.cancel.confirmed` Cancelamento de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal.cancel.failed` Falha no cancelamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.cancel.error` Ocorreu um erro no cancelamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.get.requested` Informação da Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.get.confirmed` Informação da Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.get.failed` Falha na informação da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.get.error` Ocorreu um erro na informação da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.sync.requested` Sincronização da Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.sync.confirmed` Sincronização da Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.sync.failed` Falha na sincronização da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.sync.error` Ocorreu um erro na sincronização da Transferência Entre Contas do Mesmo Banco.\n* `payment.db.created` Pagamento criado.\n* `payment.db.updated` Pagamento atualizado.\n* `payment.db.deleted` Pagamento excluído.\n* `payment.bank_billet.register.requested` Pagamento de Boleto solicitado.\n* `payment.bank_billet.register.confirmed` Pagamento de Boleto confirmado.\n* `payment.bank_billet.register.failed` Falha no envio do Pagamento de Boleto.\n* `payment.bank_billet.register.error` Ocorreu um erro no envio de Pagamento de Boleto.\n* `payment.bank_billet.approve.requested` Liberação de Pagamento de Boleto solicitada.\n* `payment.bank_billet.approve.confirmed` Liberação de Pagamento de Boleto confirmada.\n* `payment.bank_billet.approve.failed` Falha na liberação de Pagamento de Boleto.\n* `payment.bank_billet.approve.error` Ocorreu um erro na liberação de Pagamento de Boleto.\n* `payment.bank_billet.reprove.requested` Rejeição de Pagamento de Boleto solicitada.\n* `payment.bank_billet.reprove.confirmed` Rejeição de Pagamento de Boleto confirmada.\n* `payment.bank_billet.reprove.failed` Falha na rejeição de Pagamento de Boleto.\n* `payment.bank_billet.reprove.error` Ocorreu um erro na rejeição de Pagamento de Boleto.\n* `payment.bank_billet.reschedule.requested` Reagendamento de Pagamento de Boleto solicitado.\n* `payment.bank_billet.reschedule.confirmed` Reagendamento de Pagamento de Boleto confirmado.\n* `payment.bank_billet.reschedule.failed` Falha no Reagendamento de Pagamento de Boleto.\n* `payment.bank_billet.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Boleto.\n* `payment.bank_billet.cancel.requested` Cancelamento de Pagamento de Boleto solicitado.\n* `payment.bank_billet.cancel.confirmed` Cancelamento de Pagamento de Boleto confirmada.\n* `payment.bank_billet.cancel.failed` Falha no cancelamento de Pagamento de Boleto.\n* `payment.bank_billet.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Boleto.\n* `payment.bank_billet.get.requested` Informação do Pagamento de Boleto solicitada.\n* `payment.bank_billet.get.confirmed` Informação do Pagamento de Boleto confirmada.\n* `payment.bank_billet.get.failed` Falha na informação do Pagamento de Boleto.\n* `payment.bank_billet.get.error` Ocorreu um erro na informação do Pagamento de Boleto.\n* `payment.bank_billet.sync.requested` Sincronização do Pagamento de Boleto solicitada.\n* `payment.bank_billet.sync.confirmed` Sincronização do Pagamento de Boleto confirmada.\n* `payment.bank_billet.sync.failed` Falha na sincronização do Pagamento de Boleto.\n* `payment.bank_billet.sync.error` Ocorreu um erro na sincronização do Pagamento de Boleto.\n* `payment.darf.register.requested` Pagamento de DARF solicitado.\n* `payment.darf.register.confirmed` Pagamento de DARF confirmado.\n* `payment.darf.register.failed` Falha no envio do Pagamento de DARF.\n* `payment.darf.register.error` Ocorreu um erro no envio de Pagamento de DARF.\n* `payment.darf.approve.requested` Liberação de Pagamento de DARF solicitada.\n* `payment.darf.approve.confirmed` Liberação de Pagamento de DARF confirmada.\n* `payment.darf.approve.failed` Falha na liberação de Pagamento de DARF.\n* `payment.darf.approve.error` Ocorreu um erro na liberação de Pagamento de DARF.\n* `payment.darf.reprove.requested` Rejeição de Pagamento de DARF solicitada.\n* `payment.darf.reprove.confirmed` Rejeição de Pagamento de DARF confirmada.\n* `payment.darf.reprove.failed` Falha na rejeição de Pagamento de DARF.\n* `payment.darf.reprove.error` Ocorreu um erro na rejeição de Pagamento de DARF.\n* `payment.darf.reschedule.requested` Reagendamento de Pagamento de DARF solicitado.\n* `payment.darf.reschedule.confirmed` Reagendamento de Pagamento de DARF confirmado.\n* `payment.darf.reschedule.failed` Falha no Reagendamento de Pagamento de DARF.\n* `payment.darf.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de DARF.\n* `payment.darf.cancel.requested` Cancelamento de Pagamento de DARF solicitado.\n* `payment.darf.cancel.confirmed` Cancelamento de Pagamento de DARF confirmada.\n* `payment.darf.cancel.failed` Falha no cancelamento de Pagamento de DARF.\n* `payment.darf.cancel.error` Ocorreu um erro no cancelamento de Pagamento de DARF.\n* `payment.darf.get.requested` Informação do Pagamento de DARF solicitada.\n* `payment.darf.get.confirmed` Informação do Pagamento de DARF confirmada.\n* `payment.darf.get.failed` Falha na informação do Pagamento de DARF.\n* `payment.darf.get.error` Ocorreu um erro na informação do Pagamento de DARF.\n* `payment.darf.sync.requested` Sincronização do Pagamento de DARF solicitada.\n* `payment.darf.sync.confirmed` Sincronização do Pagamento de DARF confirmada.\n* `payment.darf.sync.failed` Falha na sincronização do Pagamento de DARF.\n* `payment.darf.sync.error` Ocorreu um erro na sincronização do Pagamento de DARF.\n* `payment.utility.register.requested` Pagamento de Conta de Consumo solicitado.\n* `payment.utility.register.confirmed` Pagamento de Conta de Consumo confirmado.\n* `payment.utility.register.failed` Falha no envio do Pagamento de Conta de Consumo.\n* `payment.utility.register.error` Ocorreu um erro no envio de Pagamento de Conta de Consumo.\n* `payment.utility.approve.requested` Liberação de Pagamento de Conta de Consumo solicitada.\n* `payment.utility.approve.confirmed` Liberação de Pagamento de Conta de Consumo confirmada.\n* `payment.utility.approve.failed` Falha na liberação de Pagamento de Conta de Consumo.\n* `payment.utility.approve.error` Ocorreu um erro na liberação de Pagamento de Conta de Consumo.\n* `payment.utility.reprove.requested` Rejeição de Pagamento de Conta de Consumo solicitada.\n* `payment.utility.reprove.confirmed` Rejeição de Pagamento de Conta de Consumo confirmada.\n* `payment.utility.reprove.failed` Falha na rejeição de Pagamento de Conta de Consumo.\n* `payment.utility.reprove.error` Ocorreu um erro na rejeição de Pagamento de Conta de Consumo.\n* `payment.utility.reschedule.requested` Reagendamento de Pagamento de Conta de Consumo solicitado.\n* `payment.utility.reschedule.confirmed` Reagendamento de Pagamento de Conta de Consumo confirmado.\n* `payment.utility.reschedule.failed` Falha no Reagendamento de Pagamento de Conta de Consumo.\n* `payment.utility.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Conta de Consumo.\n* `payment.utility.cancel.requested` Cancelamento de Pagamento de Conta de Consumo solicitado.\n* `payment.utility.cancel.confirmed` Cancelamento de Pagamento de Conta de Consumo confirmada.\n* `payment.utility.cancel.failed` Falha no cancelamento de Pagamento de Conta de Consumo.\n* `payment.utility.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Conta de Consumo.\n* `payment.utility.get.requested` Informação do Pagamento de Conta de Consumo solicitada.\n* `payment.utility.get.confirmed` Informação do Pagamento de Conta de Consumo confirmada.\n* `payment.utility.get.failed` Falha na informação do Pagamento de Conta de Consumo.\n* `payment.utility.get.error` Ocorreu um erro na informação do Pagamento de Conta de Consumo.\n* `payment.utility.sync.requested` Sincronização do Pagamento de Conta de Consumo solicitada.\n* `payment.utility.sync.confirmed` Sincronização do Pagamento de Conta de Consumo confirmada.\n* `payment.utility.sync.failed` Falha na sincronização do Pagamento de Conta de Consumo.\n* `payment.utility.sync.error` Ocorreu um erro na sincronização do Pagamento de Conta de Consumo.\n* `payment.gru.register.requested` Pagamento de GRU solicitado.\n* `payment.gru.register.confirmed` Pagamento de GRU confirmado.\n* `payment.gru.register.failed` Falha no envio do Pagamento de GRU.\n* `payment.gru.register.error` Ocorreu um erro no envio de Pagamento de GRU.\n* `payment.gru.approve.requested` Liberação de Pagamento de GRU solicitada.\n* `payment.gru.approve.confirmed` Liberação de Pagamento de GRU confirmada.\n* `payment.gru.approve.failed` Falha na liberação de Pagamento de GRU.\n* `payment.gru.approve.error` Ocorreu um erro na liberação de Pagamento de GRU.\n* `payment.gru.reprove.requested` Rejeição de Pagamento de GRU solicitada.\n* `payment.gru.reprove.confirmed` Rejeição de Pagamento de GRU confirmada.\n* `payment.gru.reprove.failed` Falha na rejeição de Pagamento de GRU.\n* `payment.gru.reprove.error` Ocorreu um erro na rejeição de Pagamento de GRU.\n* `payment.gru.reschedule.requested` Reagendamento de Pagamento de GRU solicitado.\n* `payment.gru.reschedule.confirmed` Reagendamento de Pagamento de GRU confirmado.\n* `payment.gru.reschedule.failed` Falha no Reagendamento de Pagamento de GRU.\n* `payment.gru.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de GRU.\n* `payment.gru.cancel.requested` Cancelamento de Pagamento de GRU solicitado.\n* `payment.gru.cancel.confirmed` Cancelamento de Pagamento de GRU confirmada.\n* `payment.gru.cancel.failed` Falha no cancelamento de Pagamento de GRU.\n* `payment.gru.cancel.error` Ocorreu um erro no cancelamento de Pagamento de GRU.\n* `payment.gru.get.requested` Informação do Pagamento de GRU solicitada.\n* `payment.gru.get.confirmed` Informação do Pagamento de GRU confirmada.\n* `payment.gru.get.failed` Falha na informação do Pagamento de GRU.\n* `payment.gru.get.error` Ocorreu um erro na informação do Pagamento de GRU.\n* `payment.gru.sync.requested` Sincronização do Pagamento de GRU solicitada.\n* `payment.gru.sync.confirmed` Sincronização do Pagamento de GRU confirmada.\n* `payment.gru.sync.failed` Falha na sincronização do Pagamento de GRU.\n* `payment.gru.sync.error` Ocorreu um erro na sincronização do Pagamento de GRU.\n* `payment.pix.register.requested` Pagamento de Pix solicitado.\n* `payment.pix.register.confirmed` Pagamento de Pix confirmado.\n* `payment.pix.register.failed` Falha no envio do Pagamento de Pix.\n* `payment.pix.register.error` Ocorreu um erro no envio de Pagamento de Pix.\n* `payment.pix.approve.requested` Liberação de Pagamento de Pix solicitada.\n* `payment.pix.approve.confirmed` Liberação de Pagamento de Pix confirmada.\n* `payment.pix.approve.failed` Falha na liberação de Pagamento de Pix.\n* `payment.pix.approve.error` Ocorreu um erro na liberação de Pagamento de Pix.\n* `payment.pix.reprove.requested` Rejeição de Pagamento de Pix solicitada.\n* `payment.pix.reprove.confirmed` Rejeição de Pagamento de Pix confirmada.\n* `payment.pix.reprove.failed` Falha na rejeição de Pagamento de Pix.\n* `payment.pix.reprove.error` Ocorreu um erro na rejeição de Pagamento de Pix.\n* `payment.pix.reschedule.requested` Reagendamento de Pagamento de Pix solicitado.\n* `payment.pix.reschedule.confirmed` Reagendamento de Pagamento de Pix confirmado.\n* `payment.pix.reschedule.failed` Falha no Reagendamento de Pagamento de Pix.\n* `payment.pix.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Pix.\n* `payment.pix.cancel.requested` Cancelamento de Pagamento de Pix solicitado.\n* `payment.pix.cancel.confirmed` Cancelamento de Pagamento de Pix confirmada.\n* `payment.pix.cancel.failed` Falha no cancelamento de Pagamento de Pix.\n* `payment.pix.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Pix.\n* `payment.pix.get.requested` Informação do Pagamento de Pix solicitada.\n* `payment.pix.get.confirmed` Informação do Pagamento de Pix confirmada.\n* `payment.pix.get.failed` Falha na informação do Pagamento de Pix.\n* `payment.pix.get.error` Ocorreu um erro na informação do Pagamento de Pix.\n* `payment.pix.sync.requested` Sincronização do Pagamento de Pix solicitada.\n* `payment.pix.sync.confirmed` Sincronização do Pagamento de Pix confirmada.\n* `payment.pix.sync.failed` Falha na sincronização do Pagamento de Pix.\n* `payment.pix.sync.error` Ocorreu um erro na sincronização do Pagamento de Pix.\n* `payment.tax.register.requested` Pagamento de Tributo solicitado.\n* `payment.tax.register.confirmed` Pagamento de Tributo confirmado.\n* `payment.tax.register.failed` Falha no envio do Pagamento de Tributo.\n* `payment.tax.register.error` Ocorreu um erro no envio de Pagamento de Tributo.\n* `payment.tax.approve.requested` Liberação de Pagamento de Tributo solicitada.\n* `payment.tax.approve.confirmed` Liberação de Pagamento de Tributo confirmada.\n* `payment.tax.approve.failed` Falha na liberação de Pagamento de Tributo.\n* `payment.tax.approve.error` Ocorreu um erro na liberação de Pagamento de Tributo.\n* `payment.tax.reprove.requested` Rejeição de Pagamento de Tributo solicitada.\n* `payment.tax.reprove.confirmed` Rejeição de Pagamento de Tributo confirmada.\n* `payment.tax.reprove.failed` Falha na rejeição de Pagamento de Tributo.\n* `payment.tax.reprove.error` Ocorreu um erro na rejeição de Pagamento de Tributo.\n* `payment.tax.reschedule.requested` Reagendamento de Pagamento de Tributo solicitado.\n* `payment.tax.reschedule.confirmed` Reagendamento de Pagamento de Tributo confirmado.\n* `payment.tax.reschedule.failed` Falha no Reagendamento de Pagamento de Tributo.\n* `payment.tax.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Tributo.\n* `payment.tax.cancel.requested` Cancelamento de Pagamento de Tributo solicitado.\n* `payment.tax.cancel.confirmed` Cancelamento de Pagamento de Tributo confirmada.\n* `payment.tax.cancel.failed` Falha no cancelamento de Pagamento de Tributo.\n* `payment.tax.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Tributo.\n* `payment.tax.get.requested` Informação do Pagamento de Tributo solicitada.\n* `payment.tax.get.confirmed` Informação do Pagamento de Tributo confirmada.\n* `payment.tax.get.failed` Falha na informação do Pagamento de Tributo.\n* `payment.tax.get.error` Ocorreu um erro na informação do Pagamento de Tributo.\n* `payment.tax.sync.requested` Sincronização do Pagamento de Tributo solicitada.\n* `payment.tax.sync.confirmed` Sincronização do Pagamento de Tributo confirmada.\n* `payment.tax.sync.failed` Falha na sincronização do Pagamento de Tributo.\n* `payment.tax.sync.error` Ocorreu um erro na sincronização do Pagamento de Tributo.\n* `payment.batch.db.created` Lote de Pagamento criado.\n* `payment.batch.db.updated` Lote de Pagamento atualizado.\n* `payment.batch.db.deleted` Lote de Pagamento excluído.\n* `payment.batch.awaiting_approval` Lote de pagamento aguardando liberação.\n* `payment.bank_billet_batch.awaiting_approval` Lote de Pagamento de Boleto aguardando liberação.\n* `payment.bank_billet_batch.get.requested` Informação do Lote de Pagamento de Boleto solicitada.\n* `payment.bank_billet_batch.get.confirmed` Informação do Lote de Pagamento de Boleto confirmada.\n* `payment.bank_billet_batch.get.failed` Falha na informação do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.sync.requested` Sincronização de Lote de Pagamento de Boleto solicitada.\n* `payment.bank_billet_batch.sync.confirmed` Sincronização de Lote de Pagamento de Boleto confirmada.\n* `payment.bank_billet_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.register.requested` Lote de Pagamento de Boleto solicitado.\n* `payment.bank_billet_batch.register.confirmed` Lote de Pagamento de Boleto confirmado.\n* `payment.bank_billet_batch.register.failed` Falha no envio do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.approve.requested` Liberação de Lote de Pagamento de Boleto solicitado.\n* `payment.bank_billet_batch.approve.confirmed` Liberação de Lote de Pagamento de Boleto confirmado.\n* `payment.bank_billet_batch.approve.failed` Falha na liberação de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.reprove.requested` Rejeição de Lote de Pagamento de Boleto solicitado.\n* `payment.bank_billet_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Boleto confirmado.\n* `payment.bank_billet_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.bank_billet_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.bank_billet_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.bank_billet_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.darf_batch.awaiting_approval` Lote de Pagamento de DARF aguardando liberação.\n* `payment.darf_batch.get.requested` Informação do Lote de Pagamento de DARF solicitada.\n* `payment.darf_batch.get.confirmed` Informação do Lote de Pagamento de DARF confirmada.\n* `payment.darf_batch.get.failed` Falha na informação do Lote de Pagamento de DARF.\n* `payment.darf_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de DARF.\n* `payment.darf_batch.sync.requested` Sincronização de Lote de Pagamento de DARF solicitada.\n* `payment.darf_batch.sync.confirmed` Sincronização de Lote de Pagamento de DARF confirmada.\n* `payment.darf_batch.sync.failed` Falha na sincronização de Lote de Pagamento de DARF.\n* `payment.darf_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de DARF.\n* `payment.darf_batch.register.requested` Lote de Pagamento de DARF solicitado.\n* `payment.darf_batch.register.confirmed` Lote de Pagamento de DARF confirmado.\n* `payment.darf_batch.register.failed` Falha no envio do Lote de Pagamento de DARF.\n* `payment.darf_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de DARF.\n* `payment.darf_batch.approve.requested` Liberação de Lote de Pagamento de DARF solicitado.\n* `payment.darf_batch.approve.confirmed` Liberação de Lote de Pagamento de DARF confirmado.\n* `payment.darf_batch.approve.failed` Falha na liberação de Lote de Pagamento de DARF.\n* `payment.darf_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de DARF.\n* `payment.darf_batch.reprove.requested` Rejeição de Lote de Pagamento de DARF solicitado.\n* `payment.darf_batch.reprove.confirmed` Rejeição de Lote de Pagamento de DARF confirmado.\n* `payment.darf_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de DARF.\n* `payment.darf_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de DARF.\n* `payment.darf_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.darf_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.darf_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.darf_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.utility_batch.awaiting_approval` Lote de Pagamento de Conta de Consumo aguardando liberação.\n* `payment.utility_batch.get.requested` Informação do Lote de Pagamento de Conta de Consumo solicitada.\n* `payment.utility_batch.get.confirmed` Informação do Lote de Pagamento de Conta de Consumo confirmada.\n* `payment.utility_batch.get.failed` Falha na informação do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.sync.requested` Sincronização de Lote de Pagamento de Conta de Consumo solicitada.\n* `payment.utility_batch.sync.confirmed` Sincronização de Lote de Pagamento de Conta de Consumo confirmada.\n* `payment.utility_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.register.requested` Lote de Pagamento de Conta de Consumo solicitado.\n* `payment.utility_batch.register.confirmed` Lote de Pagamento de Conta de Consumo confirmado.\n* `payment.utility_batch.register.failed` Falha no envio do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.approve.requested` Liberação de Lote de Pagamento de Conta de Consumo solicitado.\n* `payment.utility_batch.approve.confirmed` Liberação de Lote de Pagamento de Conta de Consumo confirmado.\n* `payment.utility_batch.approve.failed` Falha na liberação de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.reprove.requested` Rejeição de Lote de Pagamento de Conta de Consumo solicitado.\n* `payment.utility_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Conta de Consumo confirmado.\n* `payment.utility_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.utility_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.utility_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.utility_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.gru_batch.awaiting_approval` Lote de Pagamento de GRU aguardando liberação.\n* `payment.gru_batch.get.requested` Informação do Lote de Pagamento de GRU solicitada.\n* `payment.gru_batch.get.confirmed` Informação do Lote de Pagamento de GRU confirmada.\n* `payment.gru_batch.get.failed` Falha na informação do Lote de Pagamento de GRU.\n* `payment.gru_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de GRU.\n* `payment.gru_batch.sync.requested` Sincronização de Lote de Pagamento de GRU solicitada.\n* `payment.gru_batch.sync.confirmed` Sincronização de Lote de Pagamento de GRU confirmada.\n* `payment.gru_batch.sync.failed` Falha na sincronização de Lote de Pagamento de GRU.\n* `payment.gru_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de GRU.\n* `payment.gru_batch.register.requested` Lote de Pagamento de GRU solicitado.\n* `payment.gru_batch.register.confirmed` Lote de Pagamento de GRU confirmado.\n* `payment.gru_batch.register.failed` Falha no envio do Lote de Pagamento de GRU.\n* `payment.gru_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de GRU.\n* `payment.gru_batch.approve.requested` Liberação de Lote de Pagamento de GRU solicitado.\n* `payment.gru_batch.approve.confirmed` Liberação de Lote de Pagamento de GRU confirmado.\n* `payment.gru_batch.approve.failed` Falha na liberação de Lote de Pagamento de GRU.\n* `payment.gru_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de GRU.\n* `payment.gru_batch.reprove.requested` Rejeição de Lote de Pagamento de GRU solicitado.\n* `payment.gru_batch.reprove.confirmed` Rejeição de Lote de Pagamento de GRU confirmado.\n* `payment.gru_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de GRU.\n* `payment.gru_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de GRU.\n* `payment.gru_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.gru_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.gru_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.gru_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.pix_batch.awaiting_approval` Lote de Pagamento de Pix aguardando liberação.\n* `payment.pix_batch.get.requested` Informação do Lote de Pagamento de Pix solicitada.\n* `payment.pix_batch.get.confirmed` Informação do Lote de Pagamento de Pix confirmada.\n* `payment.pix_batch.get.failed` Falha na informação do Lote de Pagamento de Pix.\n* `payment.pix_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Pix.\n* `payment.pix_batch.sync.requested` Sincronização de Lote de Pagamento de Pix solicitada.\n* `payment.pix_batch.sync.confirmed` Sincronização de Lote de Pagamento de Pix confirmada.\n* `payment.pix_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Pix.\n* `payment.pix_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Pix.\n* `payment.pix_batch.register.requested` Lote de Pagamento de Pix solicitado.\n* `payment.pix_batch.register.confirmed` Lote de Pagamento de Pix confirmado.\n* `payment.pix_batch.register.failed` Falha no envio do Lote de Pagamento de Pix.\n* `payment.pix_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Pix.\n* `payment.pix_batch.approve.requested` Liberação de Lote de Pagamento de Pix solicitado.\n* `payment.pix_batch.approve.confirmed` Liberação de Lote de Pagamento de Pix confirmado.\n* `payment.pix_batch.approve.failed` Falha na liberação de Lote de Pagamento de Pix.\n* `payment.pix_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Pix.\n* `payment.pix_batch.reprove.requested` Rejeição de Lote de Pagamento de Pix solicitado.\n* `payment.pix_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Pix confirmado.\n* `payment.pix_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Pix.\n* `payment.pix_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Pix.\n* `payment.pix_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.pix_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.pix_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.pix_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.tax_batch.awaiting_approval` Lote de Pagamento de Tributo aguardando liberação.\n* `payment.tax_batch.get.requested` Informação do Lote de Pagamento de Tributo solicitada.\n* `payment.tax_batch.get.confirmed` Informação do Lote de Pagamento de Tributo confirmada.\n* `payment.tax_batch.get.failed` Falha na informação do Lote de Pagamento de Tributo.\n* `payment.tax_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Tributo.\n* `payment.tax_batch.sync.requested` Sincronização de Lote de Pagamento de Tributo solicitada.\n* `payment.tax_batch.sync.confirmed` Sincronização de Lote de Pagamento de Tributo confirmada.\n* `payment.tax_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Tributo.\n* `payment.tax_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Tributo.\n* `payment.tax_batch.register.requested` Lote de Pagamento de Tributo solicitado.\n* `payment.tax_batch.register.confirmed` Lote de Pagamento de Tributo confirmado.\n* `payment.tax_batch.register.failed` Falha no envio do Lote de Pagamento de Tributo.\n* `payment.tax_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Tributo.\n* `payment.tax_batch.approve.requested` Liberação de Lote de Pagamento de Tributo solicitado.\n* `payment.tax_batch.approve.confirmed` Liberação de Lote de Pagamento de Tributo confirmado.\n* `payment.tax_batch.approve.failed` Falha na liberação de Lote de Pagamento de Tributo.\n* `payment.tax_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Tributo.\n* `payment.tax_batch.reprove.requested` Rejeição de Lote de Pagamento de Tributo solicitado.\n* `payment.tax_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Tributo confirmado.\n* `payment.tax_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Tributo.\n* `payment.tax_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Tributo.\n* `payment.tax_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.tax_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.tax_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.tax_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.dda.account.db.created` Conta de DDA criada\n* `payment.dda.account.register.requested` Conta de DDA solicitada.\n* `payment.dda.account.register.failed` Falha na criação da conta DDA.\n* `payment.dda.account.register.error` Ocorreu um erro no registro da conta DDA.\n* `payment.dda.account.register.confirmed` Conta de DDA confirmada.\n* `payment.dda.account.bank_billets_sync.requested` Sincronização de Boletos solicitada.\n* `payment.dda.account.bank_billets_sync.failed` Falha na sincronização de Boleto.\n* `payment.dda.account.bank_billets_sync.error` Ocorreu um erro na sincronização de Boletos.\n* `payment.dda.account.bank_billets_sync.confirmed` Sincronização de Boletos confirmada.\n* `payment.dda.account.unregister.requested` Descadastramento da conta DDA solicitado.\n* `payment.dda.account.unregister.failed` Falha no descadastramento da conta DDA.\n* `payment.dda.account.unregister.error` Ocorreu um erro no descadastramento da conta DDA.\n* `payment.dda.account.unregister.confirmed` Descadastramento da conta DDA confirmado.\n* `payment.dda.bank_billet.db.created` Boleto DDA criado\n* `payment.dda.bank_billet.db.updated` Boleto DDA atualizado.\n* `payment.dda.bank_billet.external_status_changed` Status externo do Boleto DDA alterado.\n* `payment.dda.bank_billet.get.requested` Informação do Boleto solicitada.\n* `payment.dda.bank_billet.get.confirmed` Informação do Boleto confirmada.\n* `payment.dda.bank_billet.get.failed` Falha na informação do Boleto.\n* `payment.dda.bank_billet.get.error` Ocorreu um erro na informação do Boleto.\n* `payment.dda.bank_billet.sync.requested` Sincronização do Boleto solicitada.\n* `payment.dda.bank_billet.sync.confirmed` Sincronização do Boleto confirmada.\n* `payment.dda.bank_billet.sync.failed` Falha na sincronização do Boleto.\n* `payment.dda.bank_billet.sync.error` Ocorreu um erro na sincronização do Boleto.\n* `payment.dda.account.db.updated` Conta de DDA atualizada.\n* `payment.dda.account.db.deleted` Conta de DDA excluída.\n* `payment.dda.account.letter.pending` Carta DDA gerada.\n* `payment.dda.account.letter.waiting_signatures` Carta DDA aguardando assinaturas.\n* `payment.dda.account.letter.signed` Carta DDA assinada.\n* `payment.dda.account.letter.failed` Falha no processo de assinatura da carta DDA.\n* `payment.dda.account.confirmed` Assinatura da conta DDA aprovada.\n* `payment.dda.account.rejected` Assinatura da conta DDA rejeitada.\n* `payment.dda.account.failed` Falha na conta DDA.\n* `payment.dda.account.disabled` Conta DDA desabilitada.\n* `payment.dda.account.enabled` Conta DDA reabilitada.\n* `credit.restriction.add.requested` Inclusão da restrição de crédito solicitada.\n* `credit.restriction.add.failed` Falha na inclusão da restrição de crédito.\n* `credit.restriction.add.error` Ocorreu um erro na inclusão da restrição de crédito.\n* `credit.restriction.add.confirmed` Inclusão da restrição de crédito confirmada.\n* `credit.restriction.remove.requested` Remoção da restrição de crédito solicitada.\n* `credit.restriction.remove.confirmed` Remoção da restrição de crédito confirmada.\n* `credit.restriction.remove.failed` Falha na remoção da restrição de crédito.\n* `credit.restriction.remove.error` Ocorreu um erro na remoção da restrição de crédito.\n* `charge.automatic_pix.account.db.created` Conta de Pix Automático criada.\n* `charge.automatic_pix.account.db.updated` Conta de Pix Automático atualizada.\n* `charge.automatic_pix.account.db.deleted` Conta de Pix Automático excluída.\n* `charge.automatic_pix.recurrence.db.created` Recorrência de Pix Automático criada.\n* `charge.automatic_pix.recurrence.db.updated` Recorrência de Pix Automático atualizada.\n* `charge.automatic_pix.recurrence.db.deleted` Recorrência de Pix Automático excluída.\n* `charge.automatic_pix.recurrence.cancel.requested` Cancelamento da Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.recurrence.cancel.confirmed` Cancelamento da Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.recurrence.cancel.failed` Falha no cancelamento da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.cancel.error` Ocorreu um erro no cancelamento da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.register.requested` Registro da Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.recurrence.register.confirmed` Registro da Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.recurrence.register.failed` Falha no registro da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.register.error` Ocorreu um erro no registro da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.update.requested` Atualização da Recorrência de Pix Automático solicitada.\n* `charge.automatic_pix.recurrence.update.confirmed` Atualização da Recorrência de Pix Automático confirmada.\n* `charge.automatic_pix.recurrence.update.failed` Falha na atualização da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.update.error` Ocorreu um erro na atualização da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.pending` Recorrência de Pix Automático pendente.\n* `charge.automatic_pix.recurrence.created` Recorrência de Pix Automático criada no provedor financeiro.\n* `charge.automatic_pix.recurrence.approved` Recorrência de Pix Automático aprovada.\n* `charge.automatic_pix.recurrence.rejected` Recorrência de Pix Automático rejeitada.\n* `charge.automatic_pix.recurrence.expired` Recorrência de Pix Automático expirada.\n* `charge.automatic_pix.recurrence.canceled` Recorrência de Pix Automático cancelada.\n* `charge.automatic_pix.request.db.created` Solicitações de Recorrência de Pix Automático criada.\n* `charge.automatic_pix.request.db.updated` Solicitações de Recorrência de Pix Automático atualizada.\n* `charge.automatic_pix.request.db.deleted` Solicitações de Recorrência de Pix Automático excluída.\n* `charge.automatic_pix.request.cancel.requested` Cancelamento da Solicitação de Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.request.cancel.confirmed` Cancelamento da Solicitação de Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.request.cancel.failed` Falha no cancelamento da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.cancel.error` Ocorreu um erro no cancelamento da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.register.requested` Registro da Solicitação de Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.request.register.confirmed` Registro da Solicitação de Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.request.register.failed` Falha no registro da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.register.error` Ocorreu um erro no registro da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.pending` Solicitação de Recorrência de Pix Automático pendente.\n* `charge.automatic_pix.request.created` Solicitação de Recorrência de Pix Automático criada no provedor financeiro.\n* `charge.automatic_pix.request.sent` Solicitação de Recorrência de Pix Automático enviada ao pagador.\n* `charge.automatic_pix.request.received` Solicitação de Recorrência de Pix Automático recebida pelo pagador.\n* `charge.automatic_pix.request.rejected` Solicitação de Recorrência de Pix Automático rejeitada.\n* `charge.automatic_pix.request.accepted` Solicitação de Recorrência de Pix Automático aceita.\n* `charge.automatic_pix.request.expired` Solicitação de Recorrência de Pix Automático expirada.\n* `charge.automatic_pix.request.canceled` Solicitação de Recorrência de Pix Automático cancelada.\n* `charge.automatic_pix.pix.db.created` Cobrança de Pix Automático criada.\n* `charge.automatic_pix.pix.db.updated` Cobrança de Pix Automático atualizada.\n* `charge.automatic_pix.pix.db.deleted` Cobrança de Pix Automático excluída.\n* `charge.automatic_pix.pix.cancel.requested` Cancelamento da Cobrança de Pix Automático solicitado.\n* `charge.automatic_pix.pix.cancel.confirmed` Cancelamento da Cobrança de Pix Automático confirmado.\n* `charge.automatic_pix.pix.cancel.failed` Falha no cancelamento da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.cancel.error` Ocorreu um erro no cancelamento da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.register.requested` Registro da Cobrança de Pix Automático solicitado.\n* `charge.automatic_pix.pix.register.confirmed` Registro da Cobrança de Pix Automático confirmado.\n* `charge.automatic_pix.pix.register.failed` Falha no registro da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.register.error` Ocorreu um erro no registro da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.update.requested` Atualização da Cobrança de Pix Automático solicitada.\n* `charge.automatic_pix.pix.update.confirmed` Atualização da Cobrança de Pix Automático confirmada.\n* `charge.automatic_pix.pix.update.failed` Falha na atualização da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.update.error` Ocorreu um erro na atualização da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.pending` Cobrança de Pix Automático pendente.\n* `charge.automatic_pix.pix.created` Cobrança de Pix Automático criada no provedor financeiro.\n* `charge.automatic_pix.pix.active` Cobrança de Pix Automático ativa.\n* `charge.automatic_pix.pix.paid` Cobrança de Pix Automático paga.\n* `charge.automatic_pix.pix.expired` Cobrança de Pix Automático expirada.\n* `charge.automatic_pix.pix.rejected` Cobrança de Pix Automático rejeitada.\n* `charge.automatic_pix.pix.canceled` Cobrança de Pix Automático cancelada.\n* `charge.automatic_pix.location.db.created` Localização de Pix Automático criada.\n* `charge.automatic_pix.location.db.updated` Localização de Pix Automático atualizada.\n* `charge.automatic_pix.location.db.deleted` Localização de Pix Automático excluída.\n* `charge.automatic_pix.location.register.requested` Registro da Localização de Pix Automático solicitado.\n* `charge.automatic_pix.location.register.confirmed` Registro da Localização de Pix Automático confirmado.\n* `charge.automatic_pix.location.register.failed` Falha no registro da Localização de Pix Automático.\n* `charge.automatic_pix.location.register.error` Ocorreu um erro no registro da Localização de Pix Automático.\n* `charge.payment.db.created` Recebimento de cobrança criado.\n* `charge.payment.db.updated` Recebimento de cobrança atualizado.\n* `charge.payment.db.deleted` Recebimento de cobrança excluído.\n* `charge.payment.notified` Recebimento notificado.\n* `charge.payment.canceled` Recebimento cancelado.\n* `charge.payment.confirmed` Recebimento confirmado.\n* `charge.payment.duplicated` Recebimento duplicado.\n* `charge.bank_billet.payment.notified` Baixa operacional de boleto notificada.\n* `charge.bank_billet.payment.canceled` Baixa operacional de boleto cancelada.\n* `charge.bank_billet.payment.confirmed` Baixa operacional de boleto liquidada.\n* `data.bank_billet_query.success` Consulta de boleto realizada com sucesso.\n* `data.bank_billet_query.error` Consulta de boleto com erro.\n* `data.bank_billet_query.db.created` Consulta de boleto criada.\n* `data.bank_billet_query.db.updated` Consulta de boleto atualizada.\n* `data.bank_billet_query.db.deleted` Consulta de boleto excluída.\n* `data.pix_qrcode_query.success` Consulta de Pix via QR Code realizada com sucesso.\n* `data.pix_qrcode_query.error` Consulta de Pix via QR Code com erro.\n* `data.pix_qrcode_query.db.created` Consulta de Pix via QR Code criada.\n* `data.pix_qrcode_query.db.updated` Consulta de Pix via QR Code atualizada.\n* `data.pix_qrcode_query.db.deleted` Consulta de Pix via QR Code excluída.\n* `mailbox.entry.db.created` Caixa Postal criado.\n* `mailbox.entry.db.updated` Caixa Postal atualizado.\n* `mailbox.entry.db.deleted` Caixa Postal excluída.\n* `mailbox.entry.file.received` Arquivo recebido na caixa de entrada.\n* `mailbox.entry.file.sent` Arquivo enviado para a caixa de saída.\n* `mailbox.file.db.created` Arquivo criado.\n* `mailbox.file.db.updated` Arquivo atualizado.\n* `mailbox.file.db.deleted` Arquivo excluído.\n* `mailbox.channel.s3.db.created` Canal S3 criado.\n* `mailbox.channel.s3.db.updated` Canal S3 atualizado.\n* `mailbox.channel.s3.db.deleted` Canal S3 excluído.\n* `mailbox.channel.s3.fetch_all` Arquivo obtido do canal S3.\n* `mailbox.channel.email.db.created` Canal de Email criado.\n* `mailbox.channel.email.db.updated` Canal de Email atualizado.\n* `mailbox.channel.email.db.deleted` Canal de Email excluído.\n* `mailbox.channel.whatsapp.db.created` Canal WhatsApp criado.\n* `mailbox.channel.whatsapp.db.updated` Canal WhatsApp atualizado.\n* `mailbox.channel.whatsapp.db.deleted` Canal WhatsApp excluído.\n* `mailbox.channel.sftp.db.created` Canal SFTP criado.\n* `mailbox.channel.sftp.db.updated` Canal SFTP atualizado.\n* `mailbox.channel.sftp.db.deleted` Canal SFTP excluído.\n* `mailbox.channel.sftp.fetch_all` Arquivo obtido do canal SFTP.\n* `mailbox.channel.syncthing.db.created` Canal Syncthing criado.\n* `mailbox.channel.syncthing.db.updated` Canal Syncthing atualizado.\n* `mailbox.channel.syncthing.db.deleted` Canal Syncthing excluído.\n* `email_account.db.created` Conta de e-mail criada.\n* `email_account.db.updated` Conta de e-mail atualizada.\n* `email_account.db.deleted` Conta de e-mail excluída.\n* `email_account.identity.pending` Aguardando identidade\n* `email_account.identity.created` Identidade criada\n* `email_account.identity.error` Identidade já existente\n* `email_account.identity.failure` Falha da identidade\n* `email_account.dns.not_ready` DNS não pronto\n* `email_account.dns.awaiting` Aguardando validação DNS\n* `email_account.dns.validated` DNS validado\n* `email_account.dns.error` Falha na validação do DNS\n* `email_account.dns.failure` Falha na tentativa do DNS\n* `integration.connection.db.created` Conexão criada.\n* `integration.connection.db.updated` Conexão atualizada.\n* `integration.connection.db.deleted` Conexão excluída.\n* `webhook.db.created` Webhook criado.\n* `webhook.db.updated` Webhook atualizado.\n* `webhook.db.deleted` Webhook excluído.\n* `enotas.nfe.generated` Enotas: nota fiscal gerada" }, "sent_error": { "type": "string", "nullable": true, "maxLength": 255, "description": "Erro ocorrido no envio" }, "email_notification_id": { "type": "integer", "nullable": true, "description": "ID da Notificação", "example": null }, "bank_billet_account_id": { "type": "integer", "nullable": true, "description": "ID da Carteira de Cobrança", "example": null }, "resource_owner_id": { "type": "integer", "nullable": true, "description": "ID do Objeto", "example": null }, "status": { "type": "string", "readOnly": true, "description": "Situação:\n* `pending` Pendente\n* `submitted` Enviado para o Servidor de E-mail\n* `failed` Falha no Envio para o Servidor de E-mail\n* `read` Lido pelo Destinatário\n* `clicked` Link Acessado pelo Destinatário", "enum": [ "pending", "submitted", "failed", "read", "clicked" ] }, "status_occurred_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora que o status ocorreu." }, "last_clicked_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora que foi clicado pela última vez." }, "last_read_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora que foi lido pela última vez." }, "clicked_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora que foi clicado." }, "click_count": { "type": "integer", "description": "Quantidade que foi clicado." }, "read_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora que foi lido." }, "read_count": { "type": "integer", "description": "Quantidade que foi lido." }, "subject": { "type": "string", "nullable": true, "description": "Assunto do email" }, "email_account_id": { "type": "integer", "nullable": true, "description": "ID da conta de e-email" }, "email_template_id": { "type": "integer", "nullable": true, "description": "ID template de e-email" }, "bank_billet_in_pdf": { "type": "boolean", "description": "Indicativo se boleto em pdf" }, "bcc": { "type": "string", "nullable": true, "description": "Lista do destinatários das cópias ocultas" }, "cc": { "type": "string", "nullable": true, "description": "Lista do destinatários" }, "from_address": { "type": "string", "nullable": true, "description": "Endereço do remetente" }, "reply_to_address": { "type": "string", "nullable": true, "description": "Endereço de resposta" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do registro" } } }, "v1_sms_delivery_object": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do SMS enviado" }, "uid": { "type": "string", "maxLength": 36, "description": "UID usado no cabeçalho da requisição" }, "event_code": { "type": "string", "maxLength": 255, "example": "bank_billet.created", "description": "Código do evento.\n* `ping` Ping\n* `access_token.db.created` Token de Acesso criado.\n* `access_token.db.updated` Token de Acesso atualizado.\n* `access_token.db.deleted` Token de Acesso excluído.\n* `access_token.reminder` Lembrete de expiração do Token de Acesso.\n* `access_token.expired` Token de Acesso expirou.\n* `account.updated` Conta atualizada.\n* `account.blocked` Conta bloqueada.\n* `account.bank_billet_creation_blocked` Emissão de boletos bloqueada.\n* `bank_billet.created` Boleto criado.\n* `bank_billet.updated` Boleto atualizado.\n* `bank_billet.generated` PDF do Boleto Gerado ou Atualizado.\n* `bank_billet.canceled` Boleto cancelado.\n* `bank_billet.blocked` Boleto foi bloqueado.\n* `bank_billet.overdue` Boleto ficou vencido.\n* `bank_billet.paid` Boleto foi pago.\n* `bank_billet.due_date` Notifica boleto com 15, 7, 3 e 1 dias antes do vencimento.\n* `bank_billet.rejected` Boleto rejeitado.\n* `bank_billet.cancel.requested` Cancelamento do Boleto solicitado.\n* `bank_billet.cancel.confirmed` Cancelamento do Boleto confirmado.\n* `bank_billet.cancel.failed` Falha no cancelamento do Boleto.\n* `bank_billet.cancel.error` Ocorreu um erro no cancelamento do Boleto.\n* `bank_billet.register.requested` Registro do Boleto solicitado.\n* `bank_billet.register.confirmed` Registro do Boleto confirmado.\n* `bank_billet.register.failed` Falha no registro do Boleto.\n* `bank_billet.register.error` Ocorreu um erro no registro do Boleto.\n* `bank_billet.update.requested` Atualização do Boleto solicitada.\n* `bank_billet.update.confirmed` Atualização do Boleto confirmada.\n* `bank_billet.update.failed` Falha na atualização do Boleto.\n* `bank_billet.update.error` Ocorreu um erro na atualização do Boleto.\n* `bank_billet.registered` Boleto registrado.\n* `bank_billet.deleted` Boleto excluído.\n* `bank_billet.sync.requested` Sincronização do Boleto solicitada.\n* `bank_billet.sync.confirmed` Sincronização do Boleto confirmada.\n* `bank_billet.sync.failed` Falha na sincronização do Boleto.\n* `bank_billet.sync.error` Ocorreu um erro na sincronização do Boleto.\n* `bank_billet.get.requested` Informação do Boleto solicitada.\n* `bank_billet.get.confirmed` Informação do Boleto confirmada.\n* `bank_billet.get.failed` Falha na informação do Boleto.\n* `bank_billet.get.error` Ocorreu um erro na informação do Boleto.\n* `bank_billet.get_child.requested` Informação do Boleto filho solicitada.\n* `bank_billet.get_child.confirmed` Informação do Boleto filho confirmada.\n* `bank_billet.get_child.failed` Falha na informação do Boleto filho.\n* `bank_billet.get_child.error` Ocorreu um erro na informação do Boleto filho.\n* `bank_billet.find.requested` Busca de Boleto solicitada.\n* `bank_billet.find.confirmed` Busca de Boleto confirmada.\n* `bank_billet.find.failed` Falha na busca de Boleto.\n* `bank_billet.find.error` Ocorreu um erro na busca de Boleto.\n* `bank_billet.add_pix.requested` Adição do Pix ao Boleto solicitada.\n* `bank_billet.add_pix.confirmed` Adição do Pix ao Boleto confirmada.\n* `bank_billet.add_pix.failed` Falha na adição do Pix ao Boleto.\n* `bank_billet.add_pix.error` Ocorreu um erro na adição do Pix ao Boleto.\n* `bank_billet.get_pix.requested` Consulta do Pix do Boleto solicitada.\n* `bank_billet.get_pix.confirmed` Consulta do Pix do Boleto confirmada.\n* `bank_billet.get_pix.failed` Falha na consulta do Pix do Boleto.\n* `bank_billet.get_pix.error` Ocorreu um erro na consulta do Pix do Boleto.\n* `bank_billet.protest.requested` Protesto do Boleto solicitado.\n* `bank_billet.protest.confirmed` Protesto do Boleto confirmado.\n* `bank_billet.protest.failed` Falha no protesto do Boleto.\n* `bank_billet.protest.error` Ocorreu um erro no protesto do Boleto.\n* `bank_billet_discharge.created` Registro de retorno criado.\n* `bank_billet_discharge.updated` Registro de retorno atualizado.\n* `bank_billet_discharge.deleted` Registro de retorno excluído.\n* `bank_billet_remittance.created` Registro de remessa criado.\n* `bank_billet_remittance.updated` Registro de remessa atualizado.\n* `bank_billet_remittance.deleted` Registro de remessa excluído.\n* `bank_billet_registration.created` Registro de Boleto criado.\n* `bank_billet_registration.updated` Registro de Boleto atualizado.\n* `bank_billet_registration.deleted` Registro de Boleto excluído.\n* `bank_billet_payment.created` Recebimento criado.\n* `bank_billet_payment.updated` Recebimento atualizado.\n* `bank_billet_payment.deleted` Recebimento excluído.\n* `customer.created` Cliente criado.\n* `customer.updated` Cliente atualizado.\n* `customer.portal_password_updated` Senha do portal do cliente atualizada.\n* `customer.deleted` Cliente excluído.\n* `transaction.created` Transação criada.\n* `transaction.updated` Transação atualizada.\n* `transaction.processed` Transação processada.\n* `withdrawal.transferred` Saque transferido.\n* `withdrawal.requested` Saque solicitado.\n* `addon.activated` Addon ativado.\n* `addon.removed` Addon removido.\n* `plan_subscription.activated` Plano ativado.\n* `plan_subscription.removed` Plano removido.\n* `plan_subscription.fee` Cobrança do plano.\n* `plan_subscription.updated` Plano atualizado.\n* `user.created` Usuário criado.\n* `user.updated` Usuário atualizado.\n* `user.deleted` Usuário excluído.\n* `remittance.created` Remessa criada.\n* `remittance.processed` Remessa processada.\n* `remittance.downloaded` Download de Remessa realizado.\n* `remittance.sent` Remessa enviada.\n* `remittance.deleted` Remessa excluída.\n* `remittance.line.db.created` Linha de Remessa criada.\n* `remittance.line.db.updated` Linha de Remessa atualizada.\n* `remittance.line.db.deleted` Linha de Remessa excluída.\n* `discharge.created` Retorno criado.\n* `discharge.processed` Retorno processado.\n* `discharge.deleted` Retorno excluído.\n* `bank_billet_account.created` Conta de Cobrança criada.\n* `bank_billet_account.homologated` Conta de Cobrança enviada para homologação.\n* `bank_billet_account.homologation_failed` Falha na homologação da Conta de Cobrança.\n* `bank_billet_account.homologation_started` Conta de Cobrança enviada para homologação.\n* `bank_billet_account.validated` Conta de Cobrança homologada.\n* `bank_billet_account.validation_released` Conta de Cobrança homologada.\n* `bank_billet_account.activated` Conta de Cobrança ativada.\n* `bank_billet_account.updated` Conta de Cobrança atualizada.\n* `bank_billet_account.deleted` Conta de Cobrança excluída.\n* `edi.remittance_line.created` Linha de Remessa criada.\n* `edi.remittance_line.updated` Linha de Remessa atualizada.\n* `edi.remittance_line.deleted` Linha de Remessa excluída.\n* `edi.edi_box.activated` EDI ativado.\n* `edi.edi_box.db.created` EDI criado.\n* `edi.edi_box.db.deleted` EDI excluído.\n* `edi.edi_box.db.updated` EDI atualizado.\n* `edi.edi_box.generated` Carta Gerada\n* `edi.edi_box.demand_received` Demanda recepcionada\n* `edi.edi_box.confirming_at_bank` Aguardando confirmação do banco\n* `edi.edi_box.testing_by_customer` Aguardando teste do cliente\n* `edi.edi_box.waiting_for_validations` Aguardando validações\n* `customer_subscription.created` Assinatura criada.\n* `customer_subscription.updated` Assinatura atualizada.\n* `customer_subscription.deleted` Assinatura excluída.\n* `installment.created` Carnê criado.\n* `installment.processed` Carnê processado.\n* `installment.generated` Carnê gerado.\n* `installment.deleted` Carnê excluído.\n* `import.created` Importação criada.\n* `import.processed` Importação processada.\n* `import.deleted` Importação excluída.\n* `export.db.created` Exportação criada.\n* `export.db.updated` Exportação atualizada.\n* `export.db.deleted` Exportação excluída.\n* `pix.db.created` Pix criado.\n* `pix.db.updated` Pix atualizado.\n* `pix.db.deleted` Pix excluído.\n* `pix.register.requested` Registro do Pix solicitado.\n* `pix.register.confirmed` Registro do Pix confirmado.\n* `pix.register.failed` Falha no registro do Pix.\n* `pix.register.error` Ocorreu um erro no registro do Pix.\n* `pix.update.requested` Atualização do Pix solicitada.\n* `pix.update.confirmed` Atualização do Pix confirmada.\n* `pix.update.failed` Falha na atualização do Pix.\n* `pix.update.error` Ocorreu um erro na atualização do Pix.\n* `pix.paid` Pix pago.\n* `pix.overdue` Pix vencido (somente Pix Cobrança).\n* `pix.cancel.requested` Cancelamento do Pix solicitado.\n* `pix.cancel.confirmed` Cancelamento do Pix confirmado.\n* `pix.cancel.failed` Falha no cancelamento do Pix.\n* `pix.cancel.error` Ocorreu um erro no cancelamento do Pix.\n* `pix.sync.requested` Sincronização do Pix solicitada.\n* `pix.sync.confirmed` Sincronização do Pix confirmada.\n* `pix.sync.failed` Falha na sincronização do Pix.\n* `pix.sync.error` Ocorreu um erro na sincronização do Pix.\n* `pix.get.requested` Informação do Pix solicitada.\n* `pix.get.confirmed` Informação do Pix confirmada.\n* `pix.get.failed` Falha na informação do Pix.\n* `pix.get.error` Ocorreu um erro na informação do Pix.\n* `financial.account.balance_sync.requested` Sincronização do Saldo solicitada.\n* `financial.account.balance_sync.confirmed` Sincronização do Saldo confirmada.\n* `financial.account.balance_sync.failed` Falha na sincronização do Saldo.\n* `financial.account.balance_sync.error` Ocorreu um erro na sincronização do Saldo.\n* `financial.account.statement_sync.requested` Sincronização do Extrato solicitada.\n* `financial.account.statement_sync.confirmed` Sincronização do Extrato confirmada.\n* `financial.account.statement_sync.failed` Falha na sincronização do Extrato.\n* `financial.account.statement_sync.error` Ocorreu um erro na sincronização do Extrato.\n* `financial.account.db.created` Conta Financeira criada.\n* `financial.account.db.updated` Conta Financeira atualizada.\n* `financial.account.db.deleted` Conta Financeira excluída.\n* `financial.account.statement.updated` Extrato atualizado.\n* `financial.account.balance.updated` Saldo da conta financeira atualizado.\n* `financial.account_balance.db.created` Saldo criado.\n* `transfer.batch.db.created` Lote de transferência criado.\n* `transfer.batch.db.updated` Lote de transferência atualizado.\n* `transfer.batch.db.deleted` Lote de transferência excluído.\n* `transfer.batch.awaiting_approval` Lote de transferência aguardando liberação.\n* `transfer.pix_batch.awaiting_approval` Lote de Transferência Pix aguardando liberação.\n* `transfer.pix_batch.get.requested` Informação do Lote de Transferência Pix solicitada.\n* `transfer.pix_batch.get.confirmed` Informação do Lote de Transferência Pix confirmada.\n* `transfer.pix_batch.get.failed` Falha na informação do Lote de Transferência Pix.\n* `transfer.pix_batch.get.error` Ocorreu um erro na informação do Lote de Transferência Pix.\n* `transfer.pix_batch.sync.requested` Sincronização de Lote de transferência Pix solicitada.\n* `transfer.pix_batch.sync.confirmed` Sincronização de Lote de transferência Pix confirmada.\n* `transfer.pix_batch.sync.failed` Falha na sincronização de Lote de transferência Pix.\n* `transfer.pix_batch.sync.error` Ocorreu um erro na sincronização de Lote de transferência Pix.\n* `transfer.pix_batch.register.requested` Lote de Transferência Pix solicitado.\n* `transfer.pix_batch.register.confirmed` Lote de Transferência Pix confirmado.\n* `transfer.pix_batch.register.failed` Falha no envio de Lote de Transferência Pix.\n* `transfer.pix_batch.register.error` Ocorreu um erro no envio de Lote de Transferência Pix.\n* `transfer.pix_batch.approve.requested` Liberação de Lote de Transferência Pix solicitada.\n* `transfer.pix_batch.approve.confirmed` Liberação de Lote de Transferência Pix confirmada.\n* `transfer.pix_batch.approve.failed` Falha na liberação de Lote de Transferência Pix.\n* `transfer.pix_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência Pix.\n* `transfer.pix_batch.reprove.requested` Rejeição de Lote de Transferência Pix solicitada.\n* `transfer.pix_batch.reprove.confirmed` Rejeição de Lote de transferência Pix confirmada.\n* `transfer.pix_batch.reprove.failed` Falha na rejeição de Lote de Transferência Pix.\n* `transfer.pix_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência Pix.\n* `transfer.pix_batch.cancel.requested` Cancelamento de Lote de Transferência Pix solicitado.\n* `transfer.pix_batch.cancel.confirmed` Cancelamento de Lote de Transferência Pix confirmado.\n* `transfer.pix_batch.cancel.failed` Falha no cancelamento de Lote de Transferência Pix.\n* `transfer.pix_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Transferência Pix.\n* `transfer.ted_batch.awaiting_approval` Lote de Transferência TED aguardando liberação.\n* `transfer.ted_batch.get.requested` Informação do Lote de Transferência TED solicitada.\n* `transfer.ted_batch.get.confirmed` Informação do Lote de Transferência TED confirmada.\n* `transfer.ted_batch.get.failed` Falha na informação do Lote de Transferência TED.\n* `transfer.ted_batch.get.error` Ocorreu um erro na informação do Lote de Transferência TED.\n* `transfer.ted_batch.sync.requested` Sincronização de Lote de transferência TED solicitada.\n* `transfer.ted_batch.sync.confirmed` Sincronização de Lote de transferência TED confirmada.\n* `transfer.ted_batch.sync.failed` Falha na sincronização de Lote de transferência TED.\n* `transfer.ted_batch.sync.error` Ocorreu um erro na sincronização de Lote de transferência TED.\n* `transfer.ted_batch.register.requested` Lote de Transferência TED solicitado.\n* `transfer.ted_batch.register.confirmed` Lote de Transferência TED confirmado.\n* `transfer.ted_batch.register.failed` Falha no envio de Lote de Transferência TED.\n* `transfer.ted_batch.register.error` Ocorreu um erro no envio de Lote de Transferência TED.\n* `transfer.ted_batch.approve.requested` Liberação de Lote de Transferência TED solicitada.\n* `transfer.ted_batch.approve.confirmed` Liberação de Lote de Transferência TED confirmada.\n* `transfer.ted_batch.approve.failed` Falha na liberação de Lote de Transferência TED.\n* `transfer.ted_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência TED.\n* `transfer.ted_batch.reprove.requested` Rejeição de Lote de Transferência TED solicitada.\n* `transfer.ted_batch.reprove.confirmed` Rejeição de Lote de transferência TED confirmada.\n* `transfer.ted_batch.reprove.failed` Falha na rejeição de Lote de Transferência TED.\n* `transfer.ted_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência TED.\n* `transfer.ted_batch.cancel.requested` Cancelamento de Lote de Transferência TED solicitado.\n* `transfer.ted_batch.cancel.confirmed` Cancelamento de Lote de Transferência TED confirmado.\n* `transfer.ted_batch.cancel.failed` Falha no cancelamento de Lote de Transferência TED.\n* `transfer.ted_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Transferência TED.\n* `transfer.internal_batch.awaiting_approval` Lote de Transferência Entre Contas do Mesmo Banco aguardando liberação.\n* `transfer.internal_batch.get.requested` Informação do Lote de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.get.confirmed` Informação do Lote de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.get.failed` Falha na informação do Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.get.error` Ocorreu um erro na informação do Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.sync.requested` Sincronização de Lote de transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.sync.confirmed` Sincronização de Lote de transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.sync.failed` Falha na sincronização de Lote de transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.sync.error` Ocorreu um erro na sincronização de Lote de transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.register.requested` Lote de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal_batch.register.confirmed` Lote de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal_batch.register.failed` Falha no envio de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.register.error` Ocorreu um erro no envio de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.approve.requested` Liberação de Lote de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.approve.confirmed` Liberação de Lote de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.approve.failed` Falha na liberação de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.reprove.requested` Rejeição de Lote de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.reprove.confirmed` Rejeição de Lote de transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.reprove.failed` Falha na rejeição de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.cancel.requested` Cancelamento de Lote de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal_batch.cancel.confirmed` Cancelamento de Lote de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal_batch.cancel.failed` Falha no cancelamento de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.db.created` Transferência criada.\n* `transfer.db.updated` Transferência atualizada.\n* `transfer.db.deleted` Transferência excluída.\n* `transfer.pix.register.requested` Transferência Pix solicitada.\n* `transfer.pix.register.confirmed` Transferência Pix confirmada.\n* `transfer.pix.register.failed` Falha no envio da Transferência Pix.\n* `transfer.pix.register.error` Ocorreu um erro no envio da Transferência Pix.\n* `transfer.pix.reschedule.requested` Reagendamento de Transferência Pix solicitado.\n* `transfer.pix.reschedule.confirmed` Reagendamento de Transferência Pix confirmado.\n* `transfer.pix.reschedule.failed` Falha no reagendamento da Transferência Pix.\n* `transfer.pix.reschedule.error` Ocorreu um erro no reagendamento da Transferência Pix.\n* `transfer.pix.approve.requested` Liberação de Transferência Pix solicitada.\n* `transfer.pix.approve.confirmed` Liberação de Transferência Pix confirmada.\n* `transfer.pix.approve.failed` Falha na liberação da transferência Pix.\n* `transfer.pix.approve.error` Ocorreu um erro na liberação da Transferência Pix.\n* `transfer.pix.reprove.requested` Rejeição de Transferência Pix solicitada.\n* `transfer.pix.reprove.confirmed` Rejeição de Transferência Pix confirmada.\n* `transfer.pix.reprove.failed` Falha na rejeição da transferência Pix.\n* `transfer.pix.reprove.error` Ocorreu um erro na rejeição da Transferência Pix.\n* `transfer.pix.cancel.requested` Cancelamento de Transferência Pix solicitado.\n* `transfer.pix.cancel.confirmed` Cancelamento de Transferência Pix confirmado.\n* `transfer.pix.cancel.failed` Falha no cancelamento da Transferência Pix.\n* `transfer.pix.cancel.error` Ocorreu um erro no cancelamento da Transferência Pix.\n* `transfer.pix.get.requested` Informação da Transferência Pix solicitada.\n* `transfer.pix.get.confirmed` Informação da Transferência Pix confirmada.\n* `transfer.pix.get.failed` Falha na informação da Transferência Pix.\n* `transfer.pix.get.error` Ocorreu um erro na informação da Transferência Pix.\n* `transfer.pix.sync.requested` Sincronização da Transferência Pix solicitada.\n* `transfer.pix.sync.confirmed` Sincronização da Transferência Pix confirmada.\n* `transfer.pix.sync.failed` Falha na sincronização da Transferência Pix.\n* `transfer.pix.sync.error` Ocorreu um erro na sincronização da Transferência Pix.\n* `transfer.ted.register.requested` Transferência TED solicitada.\n* `transfer.ted.register.confirmed` Transferência TED confirmada.\n* `transfer.ted.register.failed` Falha no envio da Transferência TED.\n* `transfer.ted.register.error` Ocorreu um erro no envio da Transferência TED.\n* `transfer.ted.reschedule.requested` Reagendamento de Transferência TED solicitado.\n* `transfer.ted.reschedule.confirmed` Reagendamento de Transferência TED confirmado.\n* `transfer.ted.reschedule.failed` Falha no Reagendamento de Transferência TED.\n* `transfer.ted.reschedule.error` Ocorreu um erro no Reagendamento de Transferência TED.\n* `transfer.ted.approve.requested` Liberação de Transferência TED solicitada.\n* `transfer.ted.approve.confirmed` Liberação de Transferência TED confirmada.\n* `transfer.ted.approve.failed` Falha na liberação da transferência TED.\n* `transfer.ted.approve.error` Ocorreu um erro na liberação da Transferência TED.\n* `transfer.ted.reprove.requested` Rejeição de Transferência TED solicitada.\n* `transfer.ted.reprove.confirmed` Rejeição de Transferência TED confirmada.\n* `transfer.ted.reprove.failed` Falha na rejeição da transferência TED.\n* `transfer.ted.reprove.error` Ocorreu um erro na rejeição da Transferência TED.\n* `transfer.ted.cancel.requested` Cancelamento de Transferência TED solicitado.\n* `transfer.ted.cancel.confirmed` Cancelamento de Transferência TED confirmado.\n* `transfer.ted.cancel.failed` Falha no cancelamento de Transferência TED.\n* `transfer.ted.cancel.error` Ocorreu um erro no cancelamento de Transferência TED.\n* `transfer.ted.get.requested` Informação da Transferência TED solicitada.\n* `transfer.ted.get.confirmed` Informação da Transferência TED confirmada.\n* `transfer.ted.get.failed` Falha na informação da Transferência TED.\n* `transfer.ted.get.error` Ocorreu um erro na informação da Transferência TED.\n* `transfer.ted.sync.requested` Sincronização da Transferência TED solicitada.\n* `transfer.ted.sync.confirmed` Sincronização da Transferência TED confirmada.\n* `transfer.ted.sync.failed` Falha na sincronização da Transferência TED.\n* `transfer.ted.sync.error` Ocorreu um erro na sincronização da Transferência TED.\n* `transfer.internal.register.requested` Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.register.confirmed` Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.register.failed` Falha no envio da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.register.error` Ocorreu um erro no envio da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reschedule.requested` Reagendamento de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal.reschedule.confirmed` Reagendamento de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal.reschedule.failed` Falha no Reagendamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reschedule.error` Ocorreu um erro no Reagendamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.approve.requested` Liberação de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.approve.confirmed` Liberação de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.approve.failed` Falha na liberação da transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.approve.error` Ocorreu um erro na liberação da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reprove.requested` Rejeição de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.reprove.confirmed` Rejeição de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.reprove.failed` Falha na rejeição da transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reprove.error` Ocorreu um erro na rejeição da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.cancel.requested` Cancelamento de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal.cancel.confirmed` Cancelamento de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal.cancel.failed` Falha no cancelamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.cancel.error` Ocorreu um erro no cancelamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.get.requested` Informação da Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.get.confirmed` Informação da Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.get.failed` Falha na informação da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.get.error` Ocorreu um erro na informação da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.sync.requested` Sincronização da Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.sync.confirmed` Sincronização da Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.sync.failed` Falha na sincronização da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.sync.error` Ocorreu um erro na sincronização da Transferência Entre Contas do Mesmo Banco.\n* `payment.db.created` Pagamento criado.\n* `payment.db.updated` Pagamento atualizado.\n* `payment.db.deleted` Pagamento excluído.\n* `payment.bank_billet.register.requested` Pagamento de Boleto solicitado.\n* `payment.bank_billet.register.confirmed` Pagamento de Boleto confirmado.\n* `payment.bank_billet.register.failed` Falha no envio do Pagamento de Boleto.\n* `payment.bank_billet.register.error` Ocorreu um erro no envio de Pagamento de Boleto.\n* `payment.bank_billet.approve.requested` Liberação de Pagamento de Boleto solicitada.\n* `payment.bank_billet.approve.confirmed` Liberação de Pagamento de Boleto confirmada.\n* `payment.bank_billet.approve.failed` Falha na liberação de Pagamento de Boleto.\n* `payment.bank_billet.approve.error` Ocorreu um erro na liberação de Pagamento de Boleto.\n* `payment.bank_billet.reprove.requested` Rejeição de Pagamento de Boleto solicitada.\n* `payment.bank_billet.reprove.confirmed` Rejeição de Pagamento de Boleto confirmada.\n* `payment.bank_billet.reprove.failed` Falha na rejeição de Pagamento de Boleto.\n* `payment.bank_billet.reprove.error` Ocorreu um erro na rejeição de Pagamento de Boleto.\n* `payment.bank_billet.reschedule.requested` Reagendamento de Pagamento de Boleto solicitado.\n* `payment.bank_billet.reschedule.confirmed` Reagendamento de Pagamento de Boleto confirmado.\n* `payment.bank_billet.reschedule.failed` Falha no Reagendamento de Pagamento de Boleto.\n* `payment.bank_billet.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Boleto.\n* `payment.bank_billet.cancel.requested` Cancelamento de Pagamento de Boleto solicitado.\n* `payment.bank_billet.cancel.confirmed` Cancelamento de Pagamento de Boleto confirmada.\n* `payment.bank_billet.cancel.failed` Falha no cancelamento de Pagamento de Boleto.\n* `payment.bank_billet.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Boleto.\n* `payment.bank_billet.get.requested` Informação do Pagamento de Boleto solicitada.\n* `payment.bank_billet.get.confirmed` Informação do Pagamento de Boleto confirmada.\n* `payment.bank_billet.get.failed` Falha na informação do Pagamento de Boleto.\n* `payment.bank_billet.get.error` Ocorreu um erro na informação do Pagamento de Boleto.\n* `payment.bank_billet.sync.requested` Sincronização do Pagamento de Boleto solicitada.\n* `payment.bank_billet.sync.confirmed` Sincronização do Pagamento de Boleto confirmada.\n* `payment.bank_billet.sync.failed` Falha na sincronização do Pagamento de Boleto.\n* `payment.bank_billet.sync.error` Ocorreu um erro na sincronização do Pagamento de Boleto.\n* `payment.darf.register.requested` Pagamento de DARF solicitado.\n* `payment.darf.register.confirmed` Pagamento de DARF confirmado.\n* `payment.darf.register.failed` Falha no envio do Pagamento de DARF.\n* `payment.darf.register.error` Ocorreu um erro no envio de Pagamento de DARF.\n* `payment.darf.approve.requested` Liberação de Pagamento de DARF solicitada.\n* `payment.darf.approve.confirmed` Liberação de Pagamento de DARF confirmada.\n* `payment.darf.approve.failed` Falha na liberação de Pagamento de DARF.\n* `payment.darf.approve.error` Ocorreu um erro na liberação de Pagamento de DARF.\n* `payment.darf.reprove.requested` Rejeição de Pagamento de DARF solicitada.\n* `payment.darf.reprove.confirmed` Rejeição de Pagamento de DARF confirmada.\n* `payment.darf.reprove.failed` Falha na rejeição de Pagamento de DARF.\n* `payment.darf.reprove.error` Ocorreu um erro na rejeição de Pagamento de DARF.\n* `payment.darf.reschedule.requested` Reagendamento de Pagamento de DARF solicitado.\n* `payment.darf.reschedule.confirmed` Reagendamento de Pagamento de DARF confirmado.\n* `payment.darf.reschedule.failed` Falha no Reagendamento de Pagamento de DARF.\n* `payment.darf.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de DARF.\n* `payment.darf.cancel.requested` Cancelamento de Pagamento de DARF solicitado.\n* `payment.darf.cancel.confirmed` Cancelamento de Pagamento de DARF confirmada.\n* `payment.darf.cancel.failed` Falha no cancelamento de Pagamento de DARF.\n* `payment.darf.cancel.error` Ocorreu um erro no cancelamento de Pagamento de DARF.\n* `payment.darf.get.requested` Informação do Pagamento de DARF solicitada.\n* `payment.darf.get.confirmed` Informação do Pagamento de DARF confirmada.\n* `payment.darf.get.failed` Falha na informação do Pagamento de DARF.\n* `payment.darf.get.error` Ocorreu um erro na informação do Pagamento de DARF.\n* `payment.darf.sync.requested` Sincronização do Pagamento de DARF solicitada.\n* `payment.darf.sync.confirmed` Sincronização do Pagamento de DARF confirmada.\n* `payment.darf.sync.failed` Falha na sincronização do Pagamento de DARF.\n* `payment.darf.sync.error` Ocorreu um erro na sincronização do Pagamento de DARF.\n* `payment.utility.register.requested` Pagamento de Conta de Consumo solicitado.\n* `payment.utility.register.confirmed` Pagamento de Conta de Consumo confirmado.\n* `payment.utility.register.failed` Falha no envio do Pagamento de Conta de Consumo.\n* `payment.utility.register.error` Ocorreu um erro no envio de Pagamento de Conta de Consumo.\n* `payment.utility.approve.requested` Liberação de Pagamento de Conta de Consumo solicitada.\n* `payment.utility.approve.confirmed` Liberação de Pagamento de Conta de Consumo confirmada.\n* `payment.utility.approve.failed` Falha na liberação de Pagamento de Conta de Consumo.\n* `payment.utility.approve.error` Ocorreu um erro na liberação de Pagamento de Conta de Consumo.\n* `payment.utility.reprove.requested` Rejeição de Pagamento de Conta de Consumo solicitada.\n* `payment.utility.reprove.confirmed` Rejeição de Pagamento de Conta de Consumo confirmada.\n* `payment.utility.reprove.failed` Falha na rejeição de Pagamento de Conta de Consumo.\n* `payment.utility.reprove.error` Ocorreu um erro na rejeição de Pagamento de Conta de Consumo.\n* `payment.utility.reschedule.requested` Reagendamento de Pagamento de Conta de Consumo solicitado.\n* `payment.utility.reschedule.confirmed` Reagendamento de Pagamento de Conta de Consumo confirmado.\n* `payment.utility.reschedule.failed` Falha no Reagendamento de Pagamento de Conta de Consumo.\n* `payment.utility.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Conta de Consumo.\n* `payment.utility.cancel.requested` Cancelamento de Pagamento de Conta de Consumo solicitado.\n* `payment.utility.cancel.confirmed` Cancelamento de Pagamento de Conta de Consumo confirmada.\n* `payment.utility.cancel.failed` Falha no cancelamento de Pagamento de Conta de Consumo.\n* `payment.utility.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Conta de Consumo.\n* `payment.utility.get.requested` Informação do Pagamento de Conta de Consumo solicitada.\n* `payment.utility.get.confirmed` Informação do Pagamento de Conta de Consumo confirmada.\n* `payment.utility.get.failed` Falha na informação do Pagamento de Conta de Consumo.\n* `payment.utility.get.error` Ocorreu um erro na informação do Pagamento de Conta de Consumo.\n* `payment.utility.sync.requested` Sincronização do Pagamento de Conta de Consumo solicitada.\n* `payment.utility.sync.confirmed` Sincronização do Pagamento de Conta de Consumo confirmada.\n* `payment.utility.sync.failed` Falha na sincronização do Pagamento de Conta de Consumo.\n* `payment.utility.sync.error` Ocorreu um erro na sincronização do Pagamento de Conta de Consumo.\n* `payment.gru.register.requested` Pagamento de GRU solicitado.\n* `payment.gru.register.confirmed` Pagamento de GRU confirmado.\n* `payment.gru.register.failed` Falha no envio do Pagamento de GRU.\n* `payment.gru.register.error` Ocorreu um erro no envio de Pagamento de GRU.\n* `payment.gru.approve.requested` Liberação de Pagamento de GRU solicitada.\n* `payment.gru.approve.confirmed` Liberação de Pagamento de GRU confirmada.\n* `payment.gru.approve.failed` Falha na liberação de Pagamento de GRU.\n* `payment.gru.approve.error` Ocorreu um erro na liberação de Pagamento de GRU.\n* `payment.gru.reprove.requested` Rejeição de Pagamento de GRU solicitada.\n* `payment.gru.reprove.confirmed` Rejeição de Pagamento de GRU confirmada.\n* `payment.gru.reprove.failed` Falha na rejeição de Pagamento de GRU.\n* `payment.gru.reprove.error` Ocorreu um erro na rejeição de Pagamento de GRU.\n* `payment.gru.reschedule.requested` Reagendamento de Pagamento de GRU solicitado.\n* `payment.gru.reschedule.confirmed` Reagendamento de Pagamento de GRU confirmado.\n* `payment.gru.reschedule.failed` Falha no Reagendamento de Pagamento de GRU.\n* `payment.gru.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de GRU.\n* `payment.gru.cancel.requested` Cancelamento de Pagamento de GRU solicitado.\n* `payment.gru.cancel.confirmed` Cancelamento de Pagamento de GRU confirmada.\n* `payment.gru.cancel.failed` Falha no cancelamento de Pagamento de GRU.\n* `payment.gru.cancel.error` Ocorreu um erro no cancelamento de Pagamento de GRU.\n* `payment.gru.get.requested` Informação do Pagamento de GRU solicitada.\n* `payment.gru.get.confirmed` Informação do Pagamento de GRU confirmada.\n* `payment.gru.get.failed` Falha na informação do Pagamento de GRU.\n* `payment.gru.get.error` Ocorreu um erro na informação do Pagamento de GRU.\n* `payment.gru.sync.requested` Sincronização do Pagamento de GRU solicitada.\n* `payment.gru.sync.confirmed` Sincronização do Pagamento de GRU confirmada.\n* `payment.gru.sync.failed` Falha na sincronização do Pagamento de GRU.\n* `payment.gru.sync.error` Ocorreu um erro na sincronização do Pagamento de GRU.\n* `payment.pix.register.requested` Pagamento de Pix solicitado.\n* `payment.pix.register.confirmed` Pagamento de Pix confirmado.\n* `payment.pix.register.failed` Falha no envio do Pagamento de Pix.\n* `payment.pix.register.error` Ocorreu um erro no envio de Pagamento de Pix.\n* `payment.pix.approve.requested` Liberação de Pagamento de Pix solicitada.\n* `payment.pix.approve.confirmed` Liberação de Pagamento de Pix confirmada.\n* `payment.pix.approve.failed` Falha na liberação de Pagamento de Pix.\n* `payment.pix.approve.error` Ocorreu um erro na liberação de Pagamento de Pix.\n* `payment.pix.reprove.requested` Rejeição de Pagamento de Pix solicitada.\n* `payment.pix.reprove.confirmed` Rejeição de Pagamento de Pix confirmada.\n* `payment.pix.reprove.failed` Falha na rejeição de Pagamento de Pix.\n* `payment.pix.reprove.error` Ocorreu um erro na rejeição de Pagamento de Pix.\n* `payment.pix.reschedule.requested` Reagendamento de Pagamento de Pix solicitado.\n* `payment.pix.reschedule.confirmed` Reagendamento de Pagamento de Pix confirmado.\n* `payment.pix.reschedule.failed` Falha no Reagendamento de Pagamento de Pix.\n* `payment.pix.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Pix.\n* `payment.pix.cancel.requested` Cancelamento de Pagamento de Pix solicitado.\n* `payment.pix.cancel.confirmed` Cancelamento de Pagamento de Pix confirmada.\n* `payment.pix.cancel.failed` Falha no cancelamento de Pagamento de Pix.\n* `payment.pix.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Pix.\n* `payment.pix.get.requested` Informação do Pagamento de Pix solicitada.\n* `payment.pix.get.confirmed` Informação do Pagamento de Pix confirmada.\n* `payment.pix.get.failed` Falha na informação do Pagamento de Pix.\n* `payment.pix.get.error` Ocorreu um erro na informação do Pagamento de Pix.\n* `payment.pix.sync.requested` Sincronização do Pagamento de Pix solicitada.\n* `payment.pix.sync.confirmed` Sincronização do Pagamento de Pix confirmada.\n* `payment.pix.sync.failed` Falha na sincronização do Pagamento de Pix.\n* `payment.pix.sync.error` Ocorreu um erro na sincronização do Pagamento de Pix.\n* `payment.tax.register.requested` Pagamento de Tributo solicitado.\n* `payment.tax.register.confirmed` Pagamento de Tributo confirmado.\n* `payment.tax.register.failed` Falha no envio do Pagamento de Tributo.\n* `payment.tax.register.error` Ocorreu um erro no envio de Pagamento de Tributo.\n* `payment.tax.approve.requested` Liberação de Pagamento de Tributo solicitada.\n* `payment.tax.approve.confirmed` Liberação de Pagamento de Tributo confirmada.\n* `payment.tax.approve.failed` Falha na liberação de Pagamento de Tributo.\n* `payment.tax.approve.error` Ocorreu um erro na liberação de Pagamento de Tributo.\n* `payment.tax.reprove.requested` Rejeição de Pagamento de Tributo solicitada.\n* `payment.tax.reprove.confirmed` Rejeição de Pagamento de Tributo confirmada.\n* `payment.tax.reprove.failed` Falha na rejeição de Pagamento de Tributo.\n* `payment.tax.reprove.error` Ocorreu um erro na rejeição de Pagamento de Tributo.\n* `payment.tax.reschedule.requested` Reagendamento de Pagamento de Tributo solicitado.\n* `payment.tax.reschedule.confirmed` Reagendamento de Pagamento de Tributo confirmado.\n* `payment.tax.reschedule.failed` Falha no Reagendamento de Pagamento de Tributo.\n* `payment.tax.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Tributo.\n* `payment.tax.cancel.requested` Cancelamento de Pagamento de Tributo solicitado.\n* `payment.tax.cancel.confirmed` Cancelamento de Pagamento de Tributo confirmada.\n* `payment.tax.cancel.failed` Falha no cancelamento de Pagamento de Tributo.\n* `payment.tax.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Tributo.\n* `payment.tax.get.requested` Informação do Pagamento de Tributo solicitada.\n* `payment.tax.get.confirmed` Informação do Pagamento de Tributo confirmada.\n* `payment.tax.get.failed` Falha na informação do Pagamento de Tributo.\n* `payment.tax.get.error` Ocorreu um erro na informação do Pagamento de Tributo.\n* `payment.tax.sync.requested` Sincronização do Pagamento de Tributo solicitada.\n* `payment.tax.sync.confirmed` Sincronização do Pagamento de Tributo confirmada.\n* `payment.tax.sync.failed` Falha na sincronização do Pagamento de Tributo.\n* `payment.tax.sync.error` Ocorreu um erro na sincronização do Pagamento de Tributo.\n* `payment.batch.db.created` Lote de Pagamento criado.\n* `payment.batch.db.updated` Lote de Pagamento atualizado.\n* `payment.batch.db.deleted` Lote de Pagamento excluído.\n* `payment.batch.awaiting_approval` Lote de pagamento aguardando liberação.\n* `payment.bank_billet_batch.awaiting_approval` Lote de Pagamento de Boleto aguardando liberação.\n* `payment.bank_billet_batch.get.requested` Informação do Lote de Pagamento de Boleto solicitada.\n* `payment.bank_billet_batch.get.confirmed` Informação do Lote de Pagamento de Boleto confirmada.\n* `payment.bank_billet_batch.get.failed` Falha na informação do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.sync.requested` Sincronização de Lote de Pagamento de Boleto solicitada.\n* `payment.bank_billet_batch.sync.confirmed` Sincronização de Lote de Pagamento de Boleto confirmada.\n* `payment.bank_billet_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.register.requested` Lote de Pagamento de Boleto solicitado.\n* `payment.bank_billet_batch.register.confirmed` Lote de Pagamento de Boleto confirmado.\n* `payment.bank_billet_batch.register.failed` Falha no envio do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.approve.requested` Liberação de Lote de Pagamento de Boleto solicitado.\n* `payment.bank_billet_batch.approve.confirmed` Liberação de Lote de Pagamento de Boleto confirmado.\n* `payment.bank_billet_batch.approve.failed` Falha na liberação de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.reprove.requested` Rejeição de Lote de Pagamento de Boleto solicitado.\n* `payment.bank_billet_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Boleto confirmado.\n* `payment.bank_billet_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.bank_billet_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.bank_billet_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.bank_billet_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.darf_batch.awaiting_approval` Lote de Pagamento de DARF aguardando liberação.\n* `payment.darf_batch.get.requested` Informação do Lote de Pagamento de DARF solicitada.\n* `payment.darf_batch.get.confirmed` Informação do Lote de Pagamento de DARF confirmada.\n* `payment.darf_batch.get.failed` Falha na informação do Lote de Pagamento de DARF.\n* `payment.darf_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de DARF.\n* `payment.darf_batch.sync.requested` Sincronização de Lote de Pagamento de DARF solicitada.\n* `payment.darf_batch.sync.confirmed` Sincronização de Lote de Pagamento de DARF confirmada.\n* `payment.darf_batch.sync.failed` Falha na sincronização de Lote de Pagamento de DARF.\n* `payment.darf_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de DARF.\n* `payment.darf_batch.register.requested` Lote de Pagamento de DARF solicitado.\n* `payment.darf_batch.register.confirmed` Lote de Pagamento de DARF confirmado.\n* `payment.darf_batch.register.failed` Falha no envio do Lote de Pagamento de DARF.\n* `payment.darf_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de DARF.\n* `payment.darf_batch.approve.requested` Liberação de Lote de Pagamento de DARF solicitado.\n* `payment.darf_batch.approve.confirmed` Liberação de Lote de Pagamento de DARF confirmado.\n* `payment.darf_batch.approve.failed` Falha na liberação de Lote de Pagamento de DARF.\n* `payment.darf_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de DARF.\n* `payment.darf_batch.reprove.requested` Rejeição de Lote de Pagamento de DARF solicitado.\n* `payment.darf_batch.reprove.confirmed` Rejeição de Lote de Pagamento de DARF confirmado.\n* `payment.darf_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de DARF.\n* `payment.darf_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de DARF.\n* `payment.darf_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.darf_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.darf_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.darf_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.utility_batch.awaiting_approval` Lote de Pagamento de Conta de Consumo aguardando liberação.\n* `payment.utility_batch.get.requested` Informação do Lote de Pagamento de Conta de Consumo solicitada.\n* `payment.utility_batch.get.confirmed` Informação do Lote de Pagamento de Conta de Consumo confirmada.\n* `payment.utility_batch.get.failed` Falha na informação do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.sync.requested` Sincronização de Lote de Pagamento de Conta de Consumo solicitada.\n* `payment.utility_batch.sync.confirmed` Sincronização de Lote de Pagamento de Conta de Consumo confirmada.\n* `payment.utility_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.register.requested` Lote de Pagamento de Conta de Consumo solicitado.\n* `payment.utility_batch.register.confirmed` Lote de Pagamento de Conta de Consumo confirmado.\n* `payment.utility_batch.register.failed` Falha no envio do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.approve.requested` Liberação de Lote de Pagamento de Conta de Consumo solicitado.\n* `payment.utility_batch.approve.confirmed` Liberação de Lote de Pagamento de Conta de Consumo confirmado.\n* `payment.utility_batch.approve.failed` Falha na liberação de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.reprove.requested` Rejeição de Lote de Pagamento de Conta de Consumo solicitado.\n* `payment.utility_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Conta de Consumo confirmado.\n* `payment.utility_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.utility_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.utility_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.utility_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.gru_batch.awaiting_approval` Lote de Pagamento de GRU aguardando liberação.\n* `payment.gru_batch.get.requested` Informação do Lote de Pagamento de GRU solicitada.\n* `payment.gru_batch.get.confirmed` Informação do Lote de Pagamento de GRU confirmada.\n* `payment.gru_batch.get.failed` Falha na informação do Lote de Pagamento de GRU.\n* `payment.gru_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de GRU.\n* `payment.gru_batch.sync.requested` Sincronização de Lote de Pagamento de GRU solicitada.\n* `payment.gru_batch.sync.confirmed` Sincronização de Lote de Pagamento de GRU confirmada.\n* `payment.gru_batch.sync.failed` Falha na sincronização de Lote de Pagamento de GRU.\n* `payment.gru_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de GRU.\n* `payment.gru_batch.register.requested` Lote de Pagamento de GRU solicitado.\n* `payment.gru_batch.register.confirmed` Lote de Pagamento de GRU confirmado.\n* `payment.gru_batch.register.failed` Falha no envio do Lote de Pagamento de GRU.\n* `payment.gru_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de GRU.\n* `payment.gru_batch.approve.requested` Liberação de Lote de Pagamento de GRU solicitado.\n* `payment.gru_batch.approve.confirmed` Liberação de Lote de Pagamento de GRU confirmado.\n* `payment.gru_batch.approve.failed` Falha na liberação de Lote de Pagamento de GRU.\n* `payment.gru_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de GRU.\n* `payment.gru_batch.reprove.requested` Rejeição de Lote de Pagamento de GRU solicitado.\n* `payment.gru_batch.reprove.confirmed` Rejeição de Lote de Pagamento de GRU confirmado.\n* `payment.gru_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de GRU.\n* `payment.gru_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de GRU.\n* `payment.gru_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.gru_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.gru_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.gru_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.pix_batch.awaiting_approval` Lote de Pagamento de Pix aguardando liberação.\n* `payment.pix_batch.get.requested` Informação do Lote de Pagamento de Pix solicitada.\n* `payment.pix_batch.get.confirmed` Informação do Lote de Pagamento de Pix confirmada.\n* `payment.pix_batch.get.failed` Falha na informação do Lote de Pagamento de Pix.\n* `payment.pix_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Pix.\n* `payment.pix_batch.sync.requested` Sincronização de Lote de Pagamento de Pix solicitada.\n* `payment.pix_batch.sync.confirmed` Sincronização de Lote de Pagamento de Pix confirmada.\n* `payment.pix_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Pix.\n* `payment.pix_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Pix.\n* `payment.pix_batch.register.requested` Lote de Pagamento de Pix solicitado.\n* `payment.pix_batch.register.confirmed` Lote de Pagamento de Pix confirmado.\n* `payment.pix_batch.register.failed` Falha no envio do Lote de Pagamento de Pix.\n* `payment.pix_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Pix.\n* `payment.pix_batch.approve.requested` Liberação de Lote de Pagamento de Pix solicitado.\n* `payment.pix_batch.approve.confirmed` Liberação de Lote de Pagamento de Pix confirmado.\n* `payment.pix_batch.approve.failed` Falha na liberação de Lote de Pagamento de Pix.\n* `payment.pix_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Pix.\n* `payment.pix_batch.reprove.requested` Rejeição de Lote de Pagamento de Pix solicitado.\n* `payment.pix_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Pix confirmado.\n* `payment.pix_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Pix.\n* `payment.pix_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Pix.\n* `payment.pix_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.pix_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.pix_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.pix_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.tax_batch.awaiting_approval` Lote de Pagamento de Tributo aguardando liberação.\n* `payment.tax_batch.get.requested` Informação do Lote de Pagamento de Tributo solicitada.\n* `payment.tax_batch.get.confirmed` Informação do Lote de Pagamento de Tributo confirmada.\n* `payment.tax_batch.get.failed` Falha na informação do Lote de Pagamento de Tributo.\n* `payment.tax_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Tributo.\n* `payment.tax_batch.sync.requested` Sincronização de Lote de Pagamento de Tributo solicitada.\n* `payment.tax_batch.sync.confirmed` Sincronização de Lote de Pagamento de Tributo confirmada.\n* `payment.tax_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Tributo.\n* `payment.tax_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Tributo.\n* `payment.tax_batch.register.requested` Lote de Pagamento de Tributo solicitado.\n* `payment.tax_batch.register.confirmed` Lote de Pagamento de Tributo confirmado.\n* `payment.tax_batch.register.failed` Falha no envio do Lote de Pagamento de Tributo.\n* `payment.tax_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Tributo.\n* `payment.tax_batch.approve.requested` Liberação de Lote de Pagamento de Tributo solicitado.\n* `payment.tax_batch.approve.confirmed` Liberação de Lote de Pagamento de Tributo confirmado.\n* `payment.tax_batch.approve.failed` Falha na liberação de Lote de Pagamento de Tributo.\n* `payment.tax_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Tributo.\n* `payment.tax_batch.reprove.requested` Rejeição de Lote de Pagamento de Tributo solicitado.\n* `payment.tax_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Tributo confirmado.\n* `payment.tax_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Tributo.\n* `payment.tax_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Tributo.\n* `payment.tax_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.tax_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.tax_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.tax_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.dda.account.db.created` Conta de DDA criada\n* `payment.dda.account.register.requested` Conta de DDA solicitada.\n* `payment.dda.account.register.failed` Falha na criação da conta DDA.\n* `payment.dda.account.register.error` Ocorreu um erro no registro da conta DDA.\n* `payment.dda.account.register.confirmed` Conta de DDA confirmada.\n* `payment.dda.account.bank_billets_sync.requested` Sincronização de Boletos solicitada.\n* `payment.dda.account.bank_billets_sync.failed` Falha na sincronização de Boleto.\n* `payment.dda.account.bank_billets_sync.error` Ocorreu um erro na sincronização de Boletos.\n* `payment.dda.account.bank_billets_sync.confirmed` Sincronização de Boletos confirmada.\n* `payment.dda.account.unregister.requested` Descadastramento da conta DDA solicitado.\n* `payment.dda.account.unregister.failed` Falha no descadastramento da conta DDA.\n* `payment.dda.account.unregister.error` Ocorreu um erro no descadastramento da conta DDA.\n* `payment.dda.account.unregister.confirmed` Descadastramento da conta DDA confirmado.\n* `payment.dda.bank_billet.db.created` Boleto DDA criado\n* `payment.dda.bank_billet.db.updated` Boleto DDA atualizado.\n* `payment.dda.bank_billet.external_status_changed` Status externo do Boleto DDA alterado.\n* `payment.dda.bank_billet.get.requested` Informação do Boleto solicitada.\n* `payment.dda.bank_billet.get.confirmed` Informação do Boleto confirmada.\n* `payment.dda.bank_billet.get.failed` Falha na informação do Boleto.\n* `payment.dda.bank_billet.get.error` Ocorreu um erro na informação do Boleto.\n* `payment.dda.bank_billet.sync.requested` Sincronização do Boleto solicitada.\n* `payment.dda.bank_billet.sync.confirmed` Sincronização do Boleto confirmada.\n* `payment.dda.bank_billet.sync.failed` Falha na sincronização do Boleto.\n* `payment.dda.bank_billet.sync.error` Ocorreu um erro na sincronização do Boleto.\n* `payment.dda.account.db.updated` Conta de DDA atualizada.\n* `payment.dda.account.db.deleted` Conta de DDA excluída.\n* `payment.dda.account.letter.pending` Carta DDA gerada.\n* `payment.dda.account.letter.waiting_signatures` Carta DDA aguardando assinaturas.\n* `payment.dda.account.letter.signed` Carta DDA assinada.\n* `payment.dda.account.letter.failed` Falha no processo de assinatura da carta DDA.\n* `payment.dda.account.confirmed` Assinatura da conta DDA aprovada.\n* `payment.dda.account.rejected` Assinatura da conta DDA rejeitada.\n* `payment.dda.account.failed` Falha na conta DDA.\n* `payment.dda.account.disabled` Conta DDA desabilitada.\n* `payment.dda.account.enabled` Conta DDA reabilitada.\n* `credit.restriction.add.requested` Inclusão da restrição de crédito solicitada.\n* `credit.restriction.add.failed` Falha na inclusão da restrição de crédito.\n* `credit.restriction.add.error` Ocorreu um erro na inclusão da restrição de crédito.\n* `credit.restriction.add.confirmed` Inclusão da restrição de crédito confirmada.\n* `credit.restriction.remove.requested` Remoção da restrição de crédito solicitada.\n* `credit.restriction.remove.confirmed` Remoção da restrição de crédito confirmada.\n* `credit.restriction.remove.failed` Falha na remoção da restrição de crédito.\n* `credit.restriction.remove.error` Ocorreu um erro na remoção da restrição de crédito.\n* `charge.automatic_pix.account.db.created` Conta de Pix Automático criada.\n* `charge.automatic_pix.account.db.updated` Conta de Pix Automático atualizada.\n* `charge.automatic_pix.account.db.deleted` Conta de Pix Automático excluída.\n* `charge.automatic_pix.recurrence.db.created` Recorrência de Pix Automático criada.\n* `charge.automatic_pix.recurrence.db.updated` Recorrência de Pix Automático atualizada.\n* `charge.automatic_pix.recurrence.db.deleted` Recorrência de Pix Automático excluída.\n* `charge.automatic_pix.recurrence.cancel.requested` Cancelamento da Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.recurrence.cancel.confirmed` Cancelamento da Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.recurrence.cancel.failed` Falha no cancelamento da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.cancel.error` Ocorreu um erro no cancelamento da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.register.requested` Registro da Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.recurrence.register.confirmed` Registro da Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.recurrence.register.failed` Falha no registro da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.register.error` Ocorreu um erro no registro da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.update.requested` Atualização da Recorrência de Pix Automático solicitada.\n* `charge.automatic_pix.recurrence.update.confirmed` Atualização da Recorrência de Pix Automático confirmada.\n* `charge.automatic_pix.recurrence.update.failed` Falha na atualização da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.update.error` Ocorreu um erro na atualização da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.pending` Recorrência de Pix Automático pendente.\n* `charge.automatic_pix.recurrence.created` Recorrência de Pix Automático criada no provedor financeiro.\n* `charge.automatic_pix.recurrence.approved` Recorrência de Pix Automático aprovada.\n* `charge.automatic_pix.recurrence.rejected` Recorrência de Pix Automático rejeitada.\n* `charge.automatic_pix.recurrence.expired` Recorrência de Pix Automático expirada.\n* `charge.automatic_pix.recurrence.canceled` Recorrência de Pix Automático cancelada.\n* `charge.automatic_pix.request.db.created` Solicitações de Recorrência de Pix Automático criada.\n* `charge.automatic_pix.request.db.updated` Solicitações de Recorrência de Pix Automático atualizada.\n* `charge.automatic_pix.request.db.deleted` Solicitações de Recorrência de Pix Automático excluída.\n* `charge.automatic_pix.request.cancel.requested` Cancelamento da Solicitação de Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.request.cancel.confirmed` Cancelamento da Solicitação de Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.request.cancel.failed` Falha no cancelamento da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.cancel.error` Ocorreu um erro no cancelamento da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.register.requested` Registro da Solicitação de Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.request.register.confirmed` Registro da Solicitação de Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.request.register.failed` Falha no registro da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.register.error` Ocorreu um erro no registro da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.pending` Solicitação de Recorrência de Pix Automático pendente.\n* `charge.automatic_pix.request.created` Solicitação de Recorrência de Pix Automático criada no provedor financeiro.\n* `charge.automatic_pix.request.sent` Solicitação de Recorrência de Pix Automático enviada ao pagador.\n* `charge.automatic_pix.request.received` Solicitação de Recorrência de Pix Automático recebida pelo pagador.\n* `charge.automatic_pix.request.rejected` Solicitação de Recorrência de Pix Automático rejeitada.\n* `charge.automatic_pix.request.accepted` Solicitação de Recorrência de Pix Automático aceita.\n* `charge.automatic_pix.request.expired` Solicitação de Recorrência de Pix Automático expirada.\n* `charge.automatic_pix.request.canceled` Solicitação de Recorrência de Pix Automático cancelada.\n* `charge.automatic_pix.pix.db.created` Cobrança de Pix Automático criada.\n* `charge.automatic_pix.pix.db.updated` Cobrança de Pix Automático atualizada.\n* `charge.automatic_pix.pix.db.deleted` Cobrança de Pix Automático excluída.\n* `charge.automatic_pix.pix.cancel.requested` Cancelamento da Cobrança de Pix Automático solicitado.\n* `charge.automatic_pix.pix.cancel.confirmed` Cancelamento da Cobrança de Pix Automático confirmado.\n* `charge.automatic_pix.pix.cancel.failed` Falha no cancelamento da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.cancel.error` Ocorreu um erro no cancelamento da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.register.requested` Registro da Cobrança de Pix Automático solicitado.\n* `charge.automatic_pix.pix.register.confirmed` Registro da Cobrança de Pix Automático confirmado.\n* `charge.automatic_pix.pix.register.failed` Falha no registro da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.register.error` Ocorreu um erro no registro da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.update.requested` Atualização da Cobrança de Pix Automático solicitada.\n* `charge.automatic_pix.pix.update.confirmed` Atualização da Cobrança de Pix Automático confirmada.\n* `charge.automatic_pix.pix.update.failed` Falha na atualização da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.update.error` Ocorreu um erro na atualização da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.pending` Cobrança de Pix Automático pendente.\n* `charge.automatic_pix.pix.created` Cobrança de Pix Automático criada no provedor financeiro.\n* `charge.automatic_pix.pix.active` Cobrança de Pix Automático ativa.\n* `charge.automatic_pix.pix.paid` Cobrança de Pix Automático paga.\n* `charge.automatic_pix.pix.expired` Cobrança de Pix Automático expirada.\n* `charge.automatic_pix.pix.rejected` Cobrança de Pix Automático rejeitada.\n* `charge.automatic_pix.pix.canceled` Cobrança de Pix Automático cancelada.\n* `charge.automatic_pix.location.db.created` Localização de Pix Automático criada.\n* `charge.automatic_pix.location.db.updated` Localização de Pix Automático atualizada.\n* `charge.automatic_pix.location.db.deleted` Localização de Pix Automático excluída.\n* `charge.automatic_pix.location.register.requested` Registro da Localização de Pix Automático solicitado.\n* `charge.automatic_pix.location.register.confirmed` Registro da Localização de Pix Automático confirmado.\n* `charge.automatic_pix.location.register.failed` Falha no registro da Localização de Pix Automático.\n* `charge.automatic_pix.location.register.error` Ocorreu um erro no registro da Localização de Pix Automático.\n* `charge.payment.db.created` Recebimento de cobrança criado.\n* `charge.payment.db.updated` Recebimento de cobrança atualizado.\n* `charge.payment.db.deleted` Recebimento de cobrança excluído.\n* `charge.payment.notified` Recebimento notificado.\n* `charge.payment.canceled` Recebimento cancelado.\n* `charge.payment.confirmed` Recebimento confirmado.\n* `charge.payment.duplicated` Recebimento duplicado.\n* `charge.bank_billet.payment.notified` Baixa operacional de boleto notificada.\n* `charge.bank_billet.payment.canceled` Baixa operacional de boleto cancelada.\n* `charge.bank_billet.payment.confirmed` Baixa operacional de boleto liquidada.\n* `data.bank_billet_query.success` Consulta de boleto realizada com sucesso.\n* `data.bank_billet_query.error` Consulta de boleto com erro.\n* `data.bank_billet_query.db.created` Consulta de boleto criada.\n* `data.bank_billet_query.db.updated` Consulta de boleto atualizada.\n* `data.bank_billet_query.db.deleted` Consulta de boleto excluída.\n* `data.pix_qrcode_query.success` Consulta de Pix via QR Code realizada com sucesso.\n* `data.pix_qrcode_query.error` Consulta de Pix via QR Code com erro.\n* `data.pix_qrcode_query.db.created` Consulta de Pix via QR Code criada.\n* `data.pix_qrcode_query.db.updated` Consulta de Pix via QR Code atualizada.\n* `data.pix_qrcode_query.db.deleted` Consulta de Pix via QR Code excluída.\n* `mailbox.entry.db.created` Caixa Postal criado.\n* `mailbox.entry.db.updated` Caixa Postal atualizado.\n* `mailbox.entry.db.deleted` Caixa Postal excluída.\n* `mailbox.entry.file.received` Arquivo recebido na caixa de entrada.\n* `mailbox.entry.file.sent` Arquivo enviado para a caixa de saída.\n* `mailbox.file.db.created` Arquivo criado.\n* `mailbox.file.db.updated` Arquivo atualizado.\n* `mailbox.file.db.deleted` Arquivo excluído.\n* `mailbox.channel.s3.db.created` Canal S3 criado.\n* `mailbox.channel.s3.db.updated` Canal S3 atualizado.\n* `mailbox.channel.s3.db.deleted` Canal S3 excluído.\n* `mailbox.channel.s3.fetch_all` Arquivo obtido do canal S3.\n* `mailbox.channel.email.db.created` Canal de Email criado.\n* `mailbox.channel.email.db.updated` Canal de Email atualizado.\n* `mailbox.channel.email.db.deleted` Canal de Email excluído.\n* `mailbox.channel.whatsapp.db.created` Canal WhatsApp criado.\n* `mailbox.channel.whatsapp.db.updated` Canal WhatsApp atualizado.\n* `mailbox.channel.whatsapp.db.deleted` Canal WhatsApp excluído.\n* `mailbox.channel.sftp.db.created` Canal SFTP criado.\n* `mailbox.channel.sftp.db.updated` Canal SFTP atualizado.\n* `mailbox.channel.sftp.db.deleted` Canal SFTP excluído.\n* `mailbox.channel.sftp.fetch_all` Arquivo obtido do canal SFTP.\n* `mailbox.channel.syncthing.db.created` Canal Syncthing criado.\n* `mailbox.channel.syncthing.db.updated` Canal Syncthing atualizado.\n* `mailbox.channel.syncthing.db.deleted` Canal Syncthing excluído.\n* `email_account.db.created` Conta de e-mail criada.\n* `email_account.db.updated` Conta de e-mail atualizada.\n* `email_account.db.deleted` Conta de e-mail excluída.\n* `email_account.identity.pending` Aguardando identidade\n* `email_account.identity.created` Identidade criada\n* `email_account.identity.error` Identidade já existente\n* `email_account.identity.failure` Falha da identidade\n* `email_account.dns.not_ready` DNS não pronto\n* `email_account.dns.awaiting` Aguardando validação DNS\n* `email_account.dns.validated` DNS validado\n* `email_account.dns.error` Falha na validação do DNS\n* `email_account.dns.failure` Falha na tentativa do DNS\n* `integration.connection.db.created` Conexão criada.\n* `integration.connection.db.updated` Conexão atualizada.\n* `integration.connection.db.deleted` Conexão excluída.\n* `webhook.db.created` Webhook criado.\n* `webhook.db.updated` Webhook atualizado.\n* `webhook.db.deleted` Webhook excluído.\n* `enotas.nfe.generated` Enotas: nota fiscal gerada" }, "message": { "type": "string", "description": "Mensagem de sms", "example": null }, "phone_to": { "type": "string", "maxLength": 14, "description": "Telefone (com DDI e DDD) do pagador", "example": null }, "sent_error": { "type": "string", "nullable": true, "maxLength": 255, "description": "Erro ocorrido no envio" }, "delivered_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora que a entrega foi realizada" }, "failed_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora que a entrega falhou" }, "resource_owner_id": { "type": "integer", "nullable": true, "description": "ID do Objeto", "example": null }, "status": { "type": "string", "readOnly": true, "description": "Situação:\n* `pending` Pendente\n* `submitted` Submetido para o Gateway\n* `failed` Falha ao Enviar para o Gateway\n* `rejected` Rejeitado pelo Gateway\n* `auditing` Sendo Auditado para Liberação\n* `sent` Enviado pelo Gateway\n* `delivered` Recebido pelo Destinatário\n* `n_delivered` Não Recebido pelo Destinatário\n* `read` Lido pelo Destinatário\n* `clicked` Link Acessado pelo Destinatário", "enum": [ "pending", "submitted", "failed", "rejected", "sent", "delivered", "n_delivered", "read", "auditing", "clicked" ] }, "bank_billet_account_id": { "type": "integer", "nullable": true, "description": "ID da Carteira de Cobrança", "example": null }, "sms_notification_id": { "type": "integer", "description": "ID da notificação", "example": null }, "email_notification_id": { "type": "integer", "nullable": true, "description": "ID da Notificação", "example": null }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do registro" } } }, "v1_webhook_delivery_object": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do webhook enviado" }, "uid": { "type": "string", "maxLength": 255, "description": "UID usado no cabeçalho da requisição" }, "url": { "type": "string", "maxLength": 255, "nullable": true, "description": "Endereço onde a entrega foi realizada, herdado do webhook" }, "request_payload": { "type": "object", "nullable": true, "description": "Payload que será enviado no corpo da mensagem. Ver possíveis valores em [Payloads](/reference/payloads)" }, "request_error": { "type": "string", "maxLength": 255, "nullable": true, "description": "Mensagem de erro retornada na requisição" }, "response_headers": { "type": "string", "nullable": true, "description": "Cabeçalhos da resposta" }, "response_body": { "type": "string", "nullable": true, "deprecated": true, "description": "Conteúdo do corpo da resposta" }, "response_code": { "type": "integer", "nullable": true, "description": "Código HTTP da resposta. [Leia mais](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes)" }, "response_message": { "type": "string", "maxLength": 255, "nullable": true, "description": "Mensagem relativa ao Código HTTP da resposta. [Leia mais](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes)" }, "content_type": { "type": "string", "maxLength": 255, "nullable": true, "description": "Content-type da requisição que será realizada. Valores válidos `application/json` (valor padrão) ou `application/x-www-form-urlencoded`." }, "delivered_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora que a entrega foi realizada" }, "first_try": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da primeira tentativa" }, "failed_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora que a falha ocorreu." }, "duration": { "type": "integer", "nullable": true, "description": "Duração em milesegundos do round trip entre requisição e resposta" }, "event_code": { "type": "string", "maxLength": 255, "example": "bank_billet.created", "description": "Código do evento.\n* `ping` Ping\n* `access_token.db.created` Token de Acesso criado.\n* `access_token.db.updated` Token de Acesso atualizado.\n* `access_token.db.deleted` Token de Acesso excluído.\n* `access_token.reminder` Lembrete de expiração do Token de Acesso.\n* `access_token.expired` Token de Acesso expirou.\n* `account.updated` Conta atualizada.\n* `account.blocked` Conta bloqueada.\n* `account.bank_billet_creation_blocked` Emissão de boletos bloqueada.\n* `bank_billet.created` Boleto criado.\n* `bank_billet.updated` Boleto atualizado.\n* `bank_billet.generated` PDF do Boleto Gerado ou Atualizado.\n* `bank_billet.canceled` Boleto cancelado.\n* `bank_billet.blocked` Boleto foi bloqueado.\n* `bank_billet.overdue` Boleto ficou vencido.\n* `bank_billet.paid` Boleto foi pago.\n* `bank_billet.due_date` Notifica boleto com 15, 7, 3 e 1 dias antes do vencimento.\n* `bank_billet.rejected` Boleto rejeitado.\n* `bank_billet.cancel.requested` Cancelamento do Boleto solicitado.\n* `bank_billet.cancel.confirmed` Cancelamento do Boleto confirmado.\n* `bank_billet.cancel.failed` Falha no cancelamento do Boleto.\n* `bank_billet.cancel.error` Ocorreu um erro no cancelamento do Boleto.\n* `bank_billet.register.requested` Registro do Boleto solicitado.\n* `bank_billet.register.confirmed` Registro do Boleto confirmado.\n* `bank_billet.register.failed` Falha no registro do Boleto.\n* `bank_billet.register.error` Ocorreu um erro no registro do Boleto.\n* `bank_billet.update.requested` Atualização do Boleto solicitada.\n* `bank_billet.update.confirmed` Atualização do Boleto confirmada.\n* `bank_billet.update.failed` Falha na atualização do Boleto.\n* `bank_billet.update.error` Ocorreu um erro na atualização do Boleto.\n* `bank_billet.registered` Boleto registrado.\n* `bank_billet.deleted` Boleto excluído.\n* `bank_billet.sync.requested` Sincronização do Boleto solicitada.\n* `bank_billet.sync.confirmed` Sincronização do Boleto confirmada.\n* `bank_billet.sync.failed` Falha na sincronização do Boleto.\n* `bank_billet.sync.error` Ocorreu um erro na sincronização do Boleto.\n* `bank_billet.get.requested` Informação do Boleto solicitada.\n* `bank_billet.get.confirmed` Informação do Boleto confirmada.\n* `bank_billet.get.failed` Falha na informação do Boleto.\n* `bank_billet.get.error` Ocorreu um erro na informação do Boleto.\n* `bank_billet.get_child.requested` Informação do Boleto filho solicitada.\n* `bank_billet.get_child.confirmed` Informação do Boleto filho confirmada.\n* `bank_billet.get_child.failed` Falha na informação do Boleto filho.\n* `bank_billet.get_child.error` Ocorreu um erro na informação do Boleto filho.\n* `bank_billet.find.requested` Busca de Boleto solicitada.\n* `bank_billet.find.confirmed` Busca de Boleto confirmada.\n* `bank_billet.find.failed` Falha na busca de Boleto.\n* `bank_billet.find.error` Ocorreu um erro na busca de Boleto.\n* `bank_billet.add_pix.requested` Adição do Pix ao Boleto solicitada.\n* `bank_billet.add_pix.confirmed` Adição do Pix ao Boleto confirmada.\n* `bank_billet.add_pix.failed` Falha na adição do Pix ao Boleto.\n* `bank_billet.add_pix.error` Ocorreu um erro na adição do Pix ao Boleto.\n* `bank_billet.get_pix.requested` Consulta do Pix do Boleto solicitada.\n* `bank_billet.get_pix.confirmed` Consulta do Pix do Boleto confirmada.\n* `bank_billet.get_pix.failed` Falha na consulta do Pix do Boleto.\n* `bank_billet.get_pix.error` Ocorreu um erro na consulta do Pix do Boleto.\n* `bank_billet.protest.requested` Protesto do Boleto solicitado.\n* `bank_billet.protest.confirmed` Protesto do Boleto confirmado.\n* `bank_billet.protest.failed` Falha no protesto do Boleto.\n* `bank_billet.protest.error` Ocorreu um erro no protesto do Boleto.\n* `bank_billet_discharge.created` Registro de retorno criado.\n* `bank_billet_discharge.updated` Registro de retorno atualizado.\n* `bank_billet_discharge.deleted` Registro de retorno excluído.\n* `bank_billet_remittance.created` Registro de remessa criado.\n* `bank_billet_remittance.updated` Registro de remessa atualizado.\n* `bank_billet_remittance.deleted` Registro de remessa excluído.\n* `bank_billet_registration.created` Registro de Boleto criado.\n* `bank_billet_registration.updated` Registro de Boleto atualizado.\n* `bank_billet_registration.deleted` Registro de Boleto excluído.\n* `bank_billet_payment.created` Recebimento criado.\n* `bank_billet_payment.updated` Recebimento atualizado.\n* `bank_billet_payment.deleted` Recebimento excluído.\n* `customer.created` Cliente criado.\n* `customer.updated` Cliente atualizado.\n* `customer.portal_password_updated` Senha do portal do cliente atualizada.\n* `customer.deleted` Cliente excluído.\n* `transaction.created` Transação criada.\n* `transaction.updated` Transação atualizada.\n* `transaction.processed` Transação processada.\n* `withdrawal.transferred` Saque transferido.\n* `withdrawal.requested` Saque solicitado.\n* `addon.activated` Addon ativado.\n* `addon.removed` Addon removido.\n* `plan_subscription.activated` Plano ativado.\n* `plan_subscription.removed` Plano removido.\n* `plan_subscription.fee` Cobrança do plano.\n* `plan_subscription.updated` Plano atualizado.\n* `user.created` Usuário criado.\n* `user.updated` Usuário atualizado.\n* `user.deleted` Usuário excluído.\n* `remittance.created` Remessa criada.\n* `remittance.processed` Remessa processada.\n* `remittance.downloaded` Download de Remessa realizado.\n* `remittance.sent` Remessa enviada.\n* `remittance.deleted` Remessa excluída.\n* `remittance.line.db.created` Linha de Remessa criada.\n* `remittance.line.db.updated` Linha de Remessa atualizada.\n* `remittance.line.db.deleted` Linha de Remessa excluída.\n* `discharge.created` Retorno criado.\n* `discharge.processed` Retorno processado.\n* `discharge.deleted` Retorno excluído.\n* `bank_billet_account.created` Conta de Cobrança criada.\n* `bank_billet_account.homologated` Conta de Cobrança enviada para homologação.\n* `bank_billet_account.homologation_failed` Falha na homologação da Conta de Cobrança.\n* `bank_billet_account.homologation_started` Conta de Cobrança enviada para homologação.\n* `bank_billet_account.validated` Conta de Cobrança homologada.\n* `bank_billet_account.validation_released` Conta de Cobrança homologada.\n* `bank_billet_account.activated` Conta de Cobrança ativada.\n* `bank_billet_account.updated` Conta de Cobrança atualizada.\n* `bank_billet_account.deleted` Conta de Cobrança excluída.\n* `edi.remittance_line.created` Linha de Remessa criada.\n* `edi.remittance_line.updated` Linha de Remessa atualizada.\n* `edi.remittance_line.deleted` Linha de Remessa excluída.\n* `edi.edi_box.activated` EDI ativado.\n* `edi.edi_box.db.created` EDI criado.\n* `edi.edi_box.db.deleted` EDI excluído.\n* `edi.edi_box.db.updated` EDI atualizado.\n* `edi.edi_box.generated` Carta Gerada\n* `edi.edi_box.demand_received` Demanda recepcionada\n* `edi.edi_box.confirming_at_bank` Aguardando confirmação do banco\n* `edi.edi_box.testing_by_customer` Aguardando teste do cliente\n* `edi.edi_box.waiting_for_validations` Aguardando validações\n* `customer_subscription.created` Assinatura criada.\n* `customer_subscription.updated` Assinatura atualizada.\n* `customer_subscription.deleted` Assinatura excluída.\n* `installment.created` Carnê criado.\n* `installment.processed` Carnê processado.\n* `installment.generated` Carnê gerado.\n* `installment.deleted` Carnê excluído.\n* `import.created` Importação criada.\n* `import.processed` Importação processada.\n* `import.deleted` Importação excluída.\n* `export.db.created` Exportação criada.\n* `export.db.updated` Exportação atualizada.\n* `export.db.deleted` Exportação excluída.\n* `pix.db.created` Pix criado.\n* `pix.db.updated` Pix atualizado.\n* `pix.db.deleted` Pix excluído.\n* `pix.register.requested` Registro do Pix solicitado.\n* `pix.register.confirmed` Registro do Pix confirmado.\n* `pix.register.failed` Falha no registro do Pix.\n* `pix.register.error` Ocorreu um erro no registro do Pix.\n* `pix.update.requested` Atualização do Pix solicitada.\n* `pix.update.confirmed` Atualização do Pix confirmada.\n* `pix.update.failed` Falha na atualização do Pix.\n* `pix.update.error` Ocorreu um erro na atualização do Pix.\n* `pix.paid` Pix pago.\n* `pix.overdue` Pix vencido (somente Pix Cobrança).\n* `pix.cancel.requested` Cancelamento do Pix solicitado.\n* `pix.cancel.confirmed` Cancelamento do Pix confirmado.\n* `pix.cancel.failed` Falha no cancelamento do Pix.\n* `pix.cancel.error` Ocorreu um erro no cancelamento do Pix.\n* `pix.sync.requested` Sincronização do Pix solicitada.\n* `pix.sync.confirmed` Sincronização do Pix confirmada.\n* `pix.sync.failed` Falha na sincronização do Pix.\n* `pix.sync.error` Ocorreu um erro na sincronização do Pix.\n* `pix.get.requested` Informação do Pix solicitada.\n* `pix.get.confirmed` Informação do Pix confirmada.\n* `pix.get.failed` Falha na informação do Pix.\n* `pix.get.error` Ocorreu um erro na informação do Pix.\n* `financial.account.balance_sync.requested` Sincronização do Saldo solicitada.\n* `financial.account.balance_sync.confirmed` Sincronização do Saldo confirmada.\n* `financial.account.balance_sync.failed` Falha na sincronização do Saldo.\n* `financial.account.balance_sync.error` Ocorreu um erro na sincronização do Saldo.\n* `financial.account.statement_sync.requested` Sincronização do Extrato solicitada.\n* `financial.account.statement_sync.confirmed` Sincronização do Extrato confirmada.\n* `financial.account.statement_sync.failed` Falha na sincronização do Extrato.\n* `financial.account.statement_sync.error` Ocorreu um erro na sincronização do Extrato.\n* `financial.account.db.created` Conta Financeira criada.\n* `financial.account.db.updated` Conta Financeira atualizada.\n* `financial.account.db.deleted` Conta Financeira excluída.\n* `financial.account.statement.updated` Extrato atualizado.\n* `financial.account.balance.updated` Saldo da conta financeira atualizado.\n* `financial.account_balance.db.created` Saldo criado.\n* `transfer.batch.db.created` Lote de transferência criado.\n* `transfer.batch.db.updated` Lote de transferência atualizado.\n* `transfer.batch.db.deleted` Lote de transferência excluído.\n* `transfer.batch.awaiting_approval` Lote de transferência aguardando liberação.\n* `transfer.pix_batch.awaiting_approval` Lote de Transferência Pix aguardando liberação.\n* `transfer.pix_batch.get.requested` Informação do Lote de Transferência Pix solicitada.\n* `transfer.pix_batch.get.confirmed` Informação do Lote de Transferência Pix confirmada.\n* `transfer.pix_batch.get.failed` Falha na informação do Lote de Transferência Pix.\n* `transfer.pix_batch.get.error` Ocorreu um erro na informação do Lote de Transferência Pix.\n* `transfer.pix_batch.sync.requested` Sincronização de Lote de transferência Pix solicitada.\n* `transfer.pix_batch.sync.confirmed` Sincronização de Lote de transferência Pix confirmada.\n* `transfer.pix_batch.sync.failed` Falha na sincronização de Lote de transferência Pix.\n* `transfer.pix_batch.sync.error` Ocorreu um erro na sincronização de Lote de transferência Pix.\n* `transfer.pix_batch.register.requested` Lote de Transferência Pix solicitado.\n* `transfer.pix_batch.register.confirmed` Lote de Transferência Pix confirmado.\n* `transfer.pix_batch.register.failed` Falha no envio de Lote de Transferência Pix.\n* `transfer.pix_batch.register.error` Ocorreu um erro no envio de Lote de Transferência Pix.\n* `transfer.pix_batch.approve.requested` Liberação de Lote de Transferência Pix solicitada.\n* `transfer.pix_batch.approve.confirmed` Liberação de Lote de Transferência Pix confirmada.\n* `transfer.pix_batch.approve.failed` Falha na liberação de Lote de Transferência Pix.\n* `transfer.pix_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência Pix.\n* `transfer.pix_batch.reprove.requested` Rejeição de Lote de Transferência Pix solicitada.\n* `transfer.pix_batch.reprove.confirmed` Rejeição de Lote de transferência Pix confirmada.\n* `transfer.pix_batch.reprove.failed` Falha na rejeição de Lote de Transferência Pix.\n* `transfer.pix_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência Pix.\n* `transfer.pix_batch.cancel.requested` Cancelamento de Lote de Transferência Pix solicitado.\n* `transfer.pix_batch.cancel.confirmed` Cancelamento de Lote de Transferência Pix confirmado.\n* `transfer.pix_batch.cancel.failed` Falha no cancelamento de Lote de Transferência Pix.\n* `transfer.pix_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Transferência Pix.\n* `transfer.ted_batch.awaiting_approval` Lote de Transferência TED aguardando liberação.\n* `transfer.ted_batch.get.requested` Informação do Lote de Transferência TED solicitada.\n* `transfer.ted_batch.get.confirmed` Informação do Lote de Transferência TED confirmada.\n* `transfer.ted_batch.get.failed` Falha na informação do Lote de Transferência TED.\n* `transfer.ted_batch.get.error` Ocorreu um erro na informação do Lote de Transferência TED.\n* `transfer.ted_batch.sync.requested` Sincronização de Lote de transferência TED solicitada.\n* `transfer.ted_batch.sync.confirmed` Sincronização de Lote de transferência TED confirmada.\n* `transfer.ted_batch.sync.failed` Falha na sincronização de Lote de transferência TED.\n* `transfer.ted_batch.sync.error` Ocorreu um erro na sincronização de Lote de transferência TED.\n* `transfer.ted_batch.register.requested` Lote de Transferência TED solicitado.\n* `transfer.ted_batch.register.confirmed` Lote de Transferência TED confirmado.\n* `transfer.ted_batch.register.failed` Falha no envio de Lote de Transferência TED.\n* `transfer.ted_batch.register.error` Ocorreu um erro no envio de Lote de Transferência TED.\n* `transfer.ted_batch.approve.requested` Liberação de Lote de Transferência TED solicitada.\n* `transfer.ted_batch.approve.confirmed` Liberação de Lote de Transferência TED confirmada.\n* `transfer.ted_batch.approve.failed` Falha na liberação de Lote de Transferência TED.\n* `transfer.ted_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência TED.\n* `transfer.ted_batch.reprove.requested` Rejeição de Lote de Transferência TED solicitada.\n* `transfer.ted_batch.reprove.confirmed` Rejeição de Lote de transferência TED confirmada.\n* `transfer.ted_batch.reprove.failed` Falha na rejeição de Lote de Transferência TED.\n* `transfer.ted_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência TED.\n* `transfer.ted_batch.cancel.requested` Cancelamento de Lote de Transferência TED solicitado.\n* `transfer.ted_batch.cancel.confirmed` Cancelamento de Lote de Transferência TED confirmado.\n* `transfer.ted_batch.cancel.failed` Falha no cancelamento de Lote de Transferência TED.\n* `transfer.ted_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Transferência TED.\n* `transfer.internal_batch.awaiting_approval` Lote de Transferência Entre Contas do Mesmo Banco aguardando liberação.\n* `transfer.internal_batch.get.requested` Informação do Lote de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.get.confirmed` Informação do Lote de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.get.failed` Falha na informação do Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.get.error` Ocorreu um erro na informação do Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.sync.requested` Sincronização de Lote de transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.sync.confirmed` Sincronização de Lote de transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.sync.failed` Falha na sincronização de Lote de transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.sync.error` Ocorreu um erro na sincronização de Lote de transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.register.requested` Lote de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal_batch.register.confirmed` Lote de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal_batch.register.failed` Falha no envio de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.register.error` Ocorreu um erro no envio de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.approve.requested` Liberação de Lote de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.approve.confirmed` Liberação de Lote de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.approve.failed` Falha na liberação de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.reprove.requested` Rejeição de Lote de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.reprove.confirmed` Rejeição de Lote de transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.reprove.failed` Falha na rejeição de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.cancel.requested` Cancelamento de Lote de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal_batch.cancel.confirmed` Cancelamento de Lote de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal_batch.cancel.failed` Falha no cancelamento de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.db.created` Transferência criada.\n* `transfer.db.updated` Transferência atualizada.\n* `transfer.db.deleted` Transferência excluída.\n* `transfer.pix.register.requested` Transferência Pix solicitada.\n* `transfer.pix.register.confirmed` Transferência Pix confirmada.\n* `transfer.pix.register.failed` Falha no envio da Transferência Pix.\n* `transfer.pix.register.error` Ocorreu um erro no envio da Transferência Pix.\n* `transfer.pix.reschedule.requested` Reagendamento de Transferência Pix solicitado.\n* `transfer.pix.reschedule.confirmed` Reagendamento de Transferência Pix confirmado.\n* `transfer.pix.reschedule.failed` Falha no reagendamento da Transferência Pix.\n* `transfer.pix.reschedule.error` Ocorreu um erro no reagendamento da Transferência Pix.\n* `transfer.pix.approve.requested` Liberação de Transferência Pix solicitada.\n* `transfer.pix.approve.confirmed` Liberação de Transferência Pix confirmada.\n* `transfer.pix.approve.failed` Falha na liberação da transferência Pix.\n* `transfer.pix.approve.error` Ocorreu um erro na liberação da Transferência Pix.\n* `transfer.pix.reprove.requested` Rejeição de Transferência Pix solicitada.\n* `transfer.pix.reprove.confirmed` Rejeição de Transferência Pix confirmada.\n* `transfer.pix.reprove.failed` Falha na rejeição da transferência Pix.\n* `transfer.pix.reprove.error` Ocorreu um erro na rejeição da Transferência Pix.\n* `transfer.pix.cancel.requested` Cancelamento de Transferência Pix solicitado.\n* `transfer.pix.cancel.confirmed` Cancelamento de Transferência Pix confirmado.\n* `transfer.pix.cancel.failed` Falha no cancelamento da Transferência Pix.\n* `transfer.pix.cancel.error` Ocorreu um erro no cancelamento da Transferência Pix.\n* `transfer.pix.get.requested` Informação da Transferência Pix solicitada.\n* `transfer.pix.get.confirmed` Informação da Transferência Pix confirmada.\n* `transfer.pix.get.failed` Falha na informação da Transferência Pix.\n* `transfer.pix.get.error` Ocorreu um erro na informação da Transferência Pix.\n* `transfer.pix.sync.requested` Sincronização da Transferência Pix solicitada.\n* `transfer.pix.sync.confirmed` Sincronização da Transferência Pix confirmada.\n* `transfer.pix.sync.failed` Falha na sincronização da Transferência Pix.\n* `transfer.pix.sync.error` Ocorreu um erro na sincronização da Transferência Pix.\n* `transfer.ted.register.requested` Transferência TED solicitada.\n* `transfer.ted.register.confirmed` Transferência TED confirmada.\n* `transfer.ted.register.failed` Falha no envio da Transferência TED.\n* `transfer.ted.register.error` Ocorreu um erro no envio da Transferência TED.\n* `transfer.ted.reschedule.requested` Reagendamento de Transferência TED solicitado.\n* `transfer.ted.reschedule.confirmed` Reagendamento de Transferência TED confirmado.\n* `transfer.ted.reschedule.failed` Falha no Reagendamento de Transferência TED.\n* `transfer.ted.reschedule.error` Ocorreu um erro no Reagendamento de Transferência TED.\n* `transfer.ted.approve.requested` Liberação de Transferência TED solicitada.\n* `transfer.ted.approve.confirmed` Liberação de Transferência TED confirmada.\n* `transfer.ted.approve.failed` Falha na liberação da transferência TED.\n* `transfer.ted.approve.error` Ocorreu um erro na liberação da Transferência TED.\n* `transfer.ted.reprove.requested` Rejeição de Transferência TED solicitada.\n* `transfer.ted.reprove.confirmed` Rejeição de Transferência TED confirmada.\n* `transfer.ted.reprove.failed` Falha na rejeição da transferência TED.\n* `transfer.ted.reprove.error` Ocorreu um erro na rejeição da Transferência TED.\n* `transfer.ted.cancel.requested` Cancelamento de Transferência TED solicitado.\n* `transfer.ted.cancel.confirmed` Cancelamento de Transferência TED confirmado.\n* `transfer.ted.cancel.failed` Falha no cancelamento de Transferência TED.\n* `transfer.ted.cancel.error` Ocorreu um erro no cancelamento de Transferência TED.\n* `transfer.ted.get.requested` Informação da Transferência TED solicitada.\n* `transfer.ted.get.confirmed` Informação da Transferência TED confirmada.\n* `transfer.ted.get.failed` Falha na informação da Transferência TED.\n* `transfer.ted.get.error` Ocorreu um erro na informação da Transferência TED.\n* `transfer.ted.sync.requested` Sincronização da Transferência TED solicitada.\n* `transfer.ted.sync.confirmed` Sincronização da Transferência TED confirmada.\n* `transfer.ted.sync.failed` Falha na sincronização da Transferência TED.\n* `transfer.ted.sync.error` Ocorreu um erro na sincronização da Transferência TED.\n* `transfer.internal.register.requested` Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.register.confirmed` Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.register.failed` Falha no envio da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.register.error` Ocorreu um erro no envio da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reschedule.requested` Reagendamento de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal.reschedule.confirmed` Reagendamento de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal.reschedule.failed` Falha no Reagendamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reschedule.error` Ocorreu um erro no Reagendamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.approve.requested` Liberação de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.approve.confirmed` Liberação de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.approve.failed` Falha na liberação da transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.approve.error` Ocorreu um erro na liberação da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reprove.requested` Rejeição de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.reprove.confirmed` Rejeição de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.reprove.failed` Falha na rejeição da transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reprove.error` Ocorreu um erro na rejeição da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.cancel.requested` Cancelamento de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal.cancel.confirmed` Cancelamento de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal.cancel.failed` Falha no cancelamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.cancel.error` Ocorreu um erro no cancelamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.get.requested` Informação da Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.get.confirmed` Informação da Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.get.failed` Falha na informação da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.get.error` Ocorreu um erro na informação da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.sync.requested` Sincronização da Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.sync.confirmed` Sincronização da Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.sync.failed` Falha na sincronização da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.sync.error` Ocorreu um erro na sincronização da Transferência Entre Contas do Mesmo Banco.\n* `payment.db.created` Pagamento criado.\n* `payment.db.updated` Pagamento atualizado.\n* `payment.db.deleted` Pagamento excluído.\n* `payment.bank_billet.register.requested` Pagamento de Boleto solicitado.\n* `payment.bank_billet.register.confirmed` Pagamento de Boleto confirmado.\n* `payment.bank_billet.register.failed` Falha no envio do Pagamento de Boleto.\n* `payment.bank_billet.register.error` Ocorreu um erro no envio de Pagamento de Boleto.\n* `payment.bank_billet.approve.requested` Liberação de Pagamento de Boleto solicitada.\n* `payment.bank_billet.approve.confirmed` Liberação de Pagamento de Boleto confirmada.\n* `payment.bank_billet.approve.failed` Falha na liberação de Pagamento de Boleto.\n* `payment.bank_billet.approve.error` Ocorreu um erro na liberação de Pagamento de Boleto.\n* `payment.bank_billet.reprove.requested` Rejeição de Pagamento de Boleto solicitada.\n* `payment.bank_billet.reprove.confirmed` Rejeição de Pagamento de Boleto confirmada.\n* `payment.bank_billet.reprove.failed` Falha na rejeição de Pagamento de Boleto.\n* `payment.bank_billet.reprove.error` Ocorreu um erro na rejeição de Pagamento de Boleto.\n* `payment.bank_billet.reschedule.requested` Reagendamento de Pagamento de Boleto solicitado.\n* `payment.bank_billet.reschedule.confirmed` Reagendamento de Pagamento de Boleto confirmado.\n* `payment.bank_billet.reschedule.failed` Falha no Reagendamento de Pagamento de Boleto.\n* `payment.bank_billet.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Boleto.\n* `payment.bank_billet.cancel.requested` Cancelamento de Pagamento de Boleto solicitado.\n* `payment.bank_billet.cancel.confirmed` Cancelamento de Pagamento de Boleto confirmada.\n* `payment.bank_billet.cancel.failed` Falha no cancelamento de Pagamento de Boleto.\n* `payment.bank_billet.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Boleto.\n* `payment.bank_billet.get.requested` Informação do Pagamento de Boleto solicitada.\n* `payment.bank_billet.get.confirmed` Informação do Pagamento de Boleto confirmada.\n* `payment.bank_billet.get.failed` Falha na informação do Pagamento de Boleto.\n* `payment.bank_billet.get.error` Ocorreu um erro na informação do Pagamento de Boleto.\n* `payment.bank_billet.sync.requested` Sincronização do Pagamento de Boleto solicitada.\n* `payment.bank_billet.sync.confirmed` Sincronização do Pagamento de Boleto confirmada.\n* `payment.bank_billet.sync.failed` Falha na sincronização do Pagamento de Boleto.\n* `payment.bank_billet.sync.error` Ocorreu um erro na sincronização do Pagamento de Boleto.\n* `payment.darf.register.requested` Pagamento de DARF solicitado.\n* `payment.darf.register.confirmed` Pagamento de DARF confirmado.\n* `payment.darf.register.failed` Falha no envio do Pagamento de DARF.\n* `payment.darf.register.error` Ocorreu um erro no envio de Pagamento de DARF.\n* `payment.darf.approve.requested` Liberação de Pagamento de DARF solicitada.\n* `payment.darf.approve.confirmed` Liberação de Pagamento de DARF confirmada.\n* `payment.darf.approve.failed` Falha na liberação de Pagamento de DARF.\n* `payment.darf.approve.error` Ocorreu um erro na liberação de Pagamento de DARF.\n* `payment.darf.reprove.requested` Rejeição de Pagamento de DARF solicitada.\n* `payment.darf.reprove.confirmed` Rejeição de Pagamento de DARF confirmada.\n* `payment.darf.reprove.failed` Falha na rejeição de Pagamento de DARF.\n* `payment.darf.reprove.error` Ocorreu um erro na rejeição de Pagamento de DARF.\n* `payment.darf.reschedule.requested` Reagendamento de Pagamento de DARF solicitado.\n* `payment.darf.reschedule.confirmed` Reagendamento de Pagamento de DARF confirmado.\n* `payment.darf.reschedule.failed` Falha no Reagendamento de Pagamento de DARF.\n* `payment.darf.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de DARF.\n* `payment.darf.cancel.requested` Cancelamento de Pagamento de DARF solicitado.\n* `payment.darf.cancel.confirmed` Cancelamento de Pagamento de DARF confirmada.\n* `payment.darf.cancel.failed` Falha no cancelamento de Pagamento de DARF.\n* `payment.darf.cancel.error` Ocorreu um erro no cancelamento de Pagamento de DARF.\n* `payment.darf.get.requested` Informação do Pagamento de DARF solicitada.\n* `payment.darf.get.confirmed` Informação do Pagamento de DARF confirmada.\n* `payment.darf.get.failed` Falha na informação do Pagamento de DARF.\n* `payment.darf.get.error` Ocorreu um erro na informação do Pagamento de DARF.\n* `payment.darf.sync.requested` Sincronização do Pagamento de DARF solicitada.\n* `payment.darf.sync.confirmed` Sincronização do Pagamento de DARF confirmada.\n* `payment.darf.sync.failed` Falha na sincronização do Pagamento de DARF.\n* `payment.darf.sync.error` Ocorreu um erro na sincronização do Pagamento de DARF.\n* `payment.utility.register.requested` Pagamento de Conta de Consumo solicitado.\n* `payment.utility.register.confirmed` Pagamento de Conta de Consumo confirmado.\n* `payment.utility.register.failed` Falha no envio do Pagamento de Conta de Consumo.\n* `payment.utility.register.error` Ocorreu um erro no envio de Pagamento de Conta de Consumo.\n* `payment.utility.approve.requested` Liberação de Pagamento de Conta de Consumo solicitada.\n* `payment.utility.approve.confirmed` Liberação de Pagamento de Conta de Consumo confirmada.\n* `payment.utility.approve.failed` Falha na liberação de Pagamento de Conta de Consumo.\n* `payment.utility.approve.error` Ocorreu um erro na liberação de Pagamento de Conta de Consumo.\n* `payment.utility.reprove.requested` Rejeição de Pagamento de Conta de Consumo solicitada.\n* `payment.utility.reprove.confirmed` Rejeição de Pagamento de Conta de Consumo confirmada.\n* `payment.utility.reprove.failed` Falha na rejeição de Pagamento de Conta de Consumo.\n* `payment.utility.reprove.error` Ocorreu um erro na rejeição de Pagamento de Conta de Consumo.\n* `payment.utility.reschedule.requested` Reagendamento de Pagamento de Conta de Consumo solicitado.\n* `payment.utility.reschedule.confirmed` Reagendamento de Pagamento de Conta de Consumo confirmado.\n* `payment.utility.reschedule.failed` Falha no Reagendamento de Pagamento de Conta de Consumo.\n* `payment.utility.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Conta de Consumo.\n* `payment.utility.cancel.requested` Cancelamento de Pagamento de Conta de Consumo solicitado.\n* `payment.utility.cancel.confirmed` Cancelamento de Pagamento de Conta de Consumo confirmada.\n* `payment.utility.cancel.failed` Falha no cancelamento de Pagamento de Conta de Consumo.\n* `payment.utility.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Conta de Consumo.\n* `payment.utility.get.requested` Informação do Pagamento de Conta de Consumo solicitada.\n* `payment.utility.get.confirmed` Informação do Pagamento de Conta de Consumo confirmada.\n* `payment.utility.get.failed` Falha na informação do Pagamento de Conta de Consumo.\n* `payment.utility.get.error` Ocorreu um erro na informação do Pagamento de Conta de Consumo.\n* `payment.utility.sync.requested` Sincronização do Pagamento de Conta de Consumo solicitada.\n* `payment.utility.sync.confirmed` Sincronização do Pagamento de Conta de Consumo confirmada.\n* `payment.utility.sync.failed` Falha na sincronização do Pagamento de Conta de Consumo.\n* `payment.utility.sync.error` Ocorreu um erro na sincronização do Pagamento de Conta de Consumo.\n* `payment.gru.register.requested` Pagamento de GRU solicitado.\n* `payment.gru.register.confirmed` Pagamento de GRU confirmado.\n* `payment.gru.register.failed` Falha no envio do Pagamento de GRU.\n* `payment.gru.register.error` Ocorreu um erro no envio de Pagamento de GRU.\n* `payment.gru.approve.requested` Liberação de Pagamento de GRU solicitada.\n* `payment.gru.approve.confirmed` Liberação de Pagamento de GRU confirmada.\n* `payment.gru.approve.failed` Falha na liberação de Pagamento de GRU.\n* `payment.gru.approve.error` Ocorreu um erro na liberação de Pagamento de GRU.\n* `payment.gru.reprove.requested` Rejeição de Pagamento de GRU solicitada.\n* `payment.gru.reprove.confirmed` Rejeição de Pagamento de GRU confirmada.\n* `payment.gru.reprove.failed` Falha na rejeição de Pagamento de GRU.\n* `payment.gru.reprove.error` Ocorreu um erro na rejeição de Pagamento de GRU.\n* `payment.gru.reschedule.requested` Reagendamento de Pagamento de GRU solicitado.\n* `payment.gru.reschedule.confirmed` Reagendamento de Pagamento de GRU confirmado.\n* `payment.gru.reschedule.failed` Falha no Reagendamento de Pagamento de GRU.\n* `payment.gru.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de GRU.\n* `payment.gru.cancel.requested` Cancelamento de Pagamento de GRU solicitado.\n* `payment.gru.cancel.confirmed` Cancelamento de Pagamento de GRU confirmada.\n* `payment.gru.cancel.failed` Falha no cancelamento de Pagamento de GRU.\n* `payment.gru.cancel.error` Ocorreu um erro no cancelamento de Pagamento de GRU.\n* `payment.gru.get.requested` Informação do Pagamento de GRU solicitada.\n* `payment.gru.get.confirmed` Informação do Pagamento de GRU confirmada.\n* `payment.gru.get.failed` Falha na informação do Pagamento de GRU.\n* `payment.gru.get.error` Ocorreu um erro na informação do Pagamento de GRU.\n* `payment.gru.sync.requested` Sincronização do Pagamento de GRU solicitada.\n* `payment.gru.sync.confirmed` Sincronização do Pagamento de GRU confirmada.\n* `payment.gru.sync.failed` Falha na sincronização do Pagamento de GRU.\n* `payment.gru.sync.error` Ocorreu um erro na sincronização do Pagamento de GRU.\n* `payment.pix.register.requested` Pagamento de Pix solicitado.\n* `payment.pix.register.confirmed` Pagamento de Pix confirmado.\n* `payment.pix.register.failed` Falha no envio do Pagamento de Pix.\n* `payment.pix.register.error` Ocorreu um erro no envio de Pagamento de Pix.\n* `payment.pix.approve.requested` Liberação de Pagamento de Pix solicitada.\n* `payment.pix.approve.confirmed` Liberação de Pagamento de Pix confirmada.\n* `payment.pix.approve.failed` Falha na liberação de Pagamento de Pix.\n* `payment.pix.approve.error` Ocorreu um erro na liberação de Pagamento de Pix.\n* `payment.pix.reprove.requested` Rejeição de Pagamento de Pix solicitada.\n* `payment.pix.reprove.confirmed` Rejeição de Pagamento de Pix confirmada.\n* `payment.pix.reprove.failed` Falha na rejeição de Pagamento de Pix.\n* `payment.pix.reprove.error` Ocorreu um erro na rejeição de Pagamento de Pix.\n* `payment.pix.reschedule.requested` Reagendamento de Pagamento de Pix solicitado.\n* `payment.pix.reschedule.confirmed` Reagendamento de Pagamento de Pix confirmado.\n* `payment.pix.reschedule.failed` Falha no Reagendamento de Pagamento de Pix.\n* `payment.pix.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Pix.\n* `payment.pix.cancel.requested` Cancelamento de Pagamento de Pix solicitado.\n* `payment.pix.cancel.confirmed` Cancelamento de Pagamento de Pix confirmada.\n* `payment.pix.cancel.failed` Falha no cancelamento de Pagamento de Pix.\n* `payment.pix.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Pix.\n* `payment.pix.get.requested` Informação do Pagamento de Pix solicitada.\n* `payment.pix.get.confirmed` Informação do Pagamento de Pix confirmada.\n* `payment.pix.get.failed` Falha na informação do Pagamento de Pix.\n* `payment.pix.get.error` Ocorreu um erro na informação do Pagamento de Pix.\n* `payment.pix.sync.requested` Sincronização do Pagamento de Pix solicitada.\n* `payment.pix.sync.confirmed` Sincronização do Pagamento de Pix confirmada.\n* `payment.pix.sync.failed` Falha na sincronização do Pagamento de Pix.\n* `payment.pix.sync.error` Ocorreu um erro na sincronização do Pagamento de Pix.\n* `payment.tax.register.requested` Pagamento de Tributo solicitado.\n* `payment.tax.register.confirmed` Pagamento de Tributo confirmado.\n* `payment.tax.register.failed` Falha no envio do Pagamento de Tributo.\n* `payment.tax.register.error` Ocorreu um erro no envio de Pagamento de Tributo.\n* `payment.tax.approve.requested` Liberação de Pagamento de Tributo solicitada.\n* `payment.tax.approve.confirmed` Liberação de Pagamento de Tributo confirmada.\n* `payment.tax.approve.failed` Falha na liberação de Pagamento de Tributo.\n* `payment.tax.approve.error` Ocorreu um erro na liberação de Pagamento de Tributo.\n* `payment.tax.reprove.requested` Rejeição de Pagamento de Tributo solicitada.\n* `payment.tax.reprove.confirmed` Rejeição de Pagamento de Tributo confirmada.\n* `payment.tax.reprove.failed` Falha na rejeição de Pagamento de Tributo.\n* `payment.tax.reprove.error` Ocorreu um erro na rejeição de Pagamento de Tributo.\n* `payment.tax.reschedule.requested` Reagendamento de Pagamento de Tributo solicitado.\n* `payment.tax.reschedule.confirmed` Reagendamento de Pagamento de Tributo confirmado.\n* `payment.tax.reschedule.failed` Falha no Reagendamento de Pagamento de Tributo.\n* `payment.tax.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Tributo.\n* `payment.tax.cancel.requested` Cancelamento de Pagamento de Tributo solicitado.\n* `payment.tax.cancel.confirmed` Cancelamento de Pagamento de Tributo confirmada.\n* `payment.tax.cancel.failed` Falha no cancelamento de Pagamento de Tributo.\n* `payment.tax.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Tributo.\n* `payment.tax.get.requested` Informação do Pagamento de Tributo solicitada.\n* `payment.tax.get.confirmed` Informação do Pagamento de Tributo confirmada.\n* `payment.tax.get.failed` Falha na informação do Pagamento de Tributo.\n* `payment.tax.get.error` Ocorreu um erro na informação do Pagamento de Tributo.\n* `payment.tax.sync.requested` Sincronização do Pagamento de Tributo solicitada.\n* `payment.tax.sync.confirmed` Sincronização do Pagamento de Tributo confirmada.\n* `payment.tax.sync.failed` Falha na sincronização do Pagamento de Tributo.\n* `payment.tax.sync.error` Ocorreu um erro na sincronização do Pagamento de Tributo.\n* `payment.batch.db.created` Lote de Pagamento criado.\n* `payment.batch.db.updated` Lote de Pagamento atualizado.\n* `payment.batch.db.deleted` Lote de Pagamento excluído.\n* `payment.batch.awaiting_approval` Lote de pagamento aguardando liberação.\n* `payment.bank_billet_batch.awaiting_approval` Lote de Pagamento de Boleto aguardando liberação.\n* `payment.bank_billet_batch.get.requested` Informação do Lote de Pagamento de Boleto solicitada.\n* `payment.bank_billet_batch.get.confirmed` Informação do Lote de Pagamento de Boleto confirmada.\n* `payment.bank_billet_batch.get.failed` Falha na informação do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.sync.requested` Sincronização de Lote de Pagamento de Boleto solicitada.\n* `payment.bank_billet_batch.sync.confirmed` Sincronização de Lote de Pagamento de Boleto confirmada.\n* `payment.bank_billet_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.register.requested` Lote de Pagamento de Boleto solicitado.\n* `payment.bank_billet_batch.register.confirmed` Lote de Pagamento de Boleto confirmado.\n* `payment.bank_billet_batch.register.failed` Falha no envio do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.approve.requested` Liberação de Lote de Pagamento de Boleto solicitado.\n* `payment.bank_billet_batch.approve.confirmed` Liberação de Lote de Pagamento de Boleto confirmado.\n* `payment.bank_billet_batch.approve.failed` Falha na liberação de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.reprove.requested` Rejeição de Lote de Pagamento de Boleto solicitado.\n* `payment.bank_billet_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Boleto confirmado.\n* `payment.bank_billet_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.bank_billet_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.bank_billet_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.bank_billet_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.darf_batch.awaiting_approval` Lote de Pagamento de DARF aguardando liberação.\n* `payment.darf_batch.get.requested` Informação do Lote de Pagamento de DARF solicitada.\n* `payment.darf_batch.get.confirmed` Informação do Lote de Pagamento de DARF confirmada.\n* `payment.darf_batch.get.failed` Falha na informação do Lote de Pagamento de DARF.\n* `payment.darf_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de DARF.\n* `payment.darf_batch.sync.requested` Sincronização de Lote de Pagamento de DARF solicitada.\n* `payment.darf_batch.sync.confirmed` Sincronização de Lote de Pagamento de DARF confirmada.\n* `payment.darf_batch.sync.failed` Falha na sincronização de Lote de Pagamento de DARF.\n* `payment.darf_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de DARF.\n* `payment.darf_batch.register.requested` Lote de Pagamento de DARF solicitado.\n* `payment.darf_batch.register.confirmed` Lote de Pagamento de DARF confirmado.\n* `payment.darf_batch.register.failed` Falha no envio do Lote de Pagamento de DARF.\n* `payment.darf_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de DARF.\n* `payment.darf_batch.approve.requested` Liberação de Lote de Pagamento de DARF solicitado.\n* `payment.darf_batch.approve.confirmed` Liberação de Lote de Pagamento de DARF confirmado.\n* `payment.darf_batch.approve.failed` Falha na liberação de Lote de Pagamento de DARF.\n* `payment.darf_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de DARF.\n* `payment.darf_batch.reprove.requested` Rejeição de Lote de Pagamento de DARF solicitado.\n* `payment.darf_batch.reprove.confirmed` Rejeição de Lote de Pagamento de DARF confirmado.\n* `payment.darf_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de DARF.\n* `payment.darf_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de DARF.\n* `payment.darf_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.darf_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.darf_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.darf_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.utility_batch.awaiting_approval` Lote de Pagamento de Conta de Consumo aguardando liberação.\n* `payment.utility_batch.get.requested` Informação do Lote de Pagamento de Conta de Consumo solicitada.\n* `payment.utility_batch.get.confirmed` Informação do Lote de Pagamento de Conta de Consumo confirmada.\n* `payment.utility_batch.get.failed` Falha na informação do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.sync.requested` Sincronização de Lote de Pagamento de Conta de Consumo solicitada.\n* `payment.utility_batch.sync.confirmed` Sincronização de Lote de Pagamento de Conta de Consumo confirmada.\n* `payment.utility_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.register.requested` Lote de Pagamento de Conta de Consumo solicitado.\n* `payment.utility_batch.register.confirmed` Lote de Pagamento de Conta de Consumo confirmado.\n* `payment.utility_batch.register.failed` Falha no envio do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.approve.requested` Liberação de Lote de Pagamento de Conta de Consumo solicitado.\n* `payment.utility_batch.approve.confirmed` Liberação de Lote de Pagamento de Conta de Consumo confirmado.\n* `payment.utility_batch.approve.failed` Falha na liberação de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.reprove.requested` Rejeição de Lote de Pagamento de Conta de Consumo solicitado.\n* `payment.utility_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Conta de Consumo confirmado.\n* `payment.utility_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.utility_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.utility_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.utility_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.gru_batch.awaiting_approval` Lote de Pagamento de GRU aguardando liberação.\n* `payment.gru_batch.get.requested` Informação do Lote de Pagamento de GRU solicitada.\n* `payment.gru_batch.get.confirmed` Informação do Lote de Pagamento de GRU confirmada.\n* `payment.gru_batch.get.failed` Falha na informação do Lote de Pagamento de GRU.\n* `payment.gru_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de GRU.\n* `payment.gru_batch.sync.requested` Sincronização de Lote de Pagamento de GRU solicitada.\n* `payment.gru_batch.sync.confirmed` Sincronização de Lote de Pagamento de GRU confirmada.\n* `payment.gru_batch.sync.failed` Falha na sincronização de Lote de Pagamento de GRU.\n* `payment.gru_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de GRU.\n* `payment.gru_batch.register.requested` Lote de Pagamento de GRU solicitado.\n* `payment.gru_batch.register.confirmed` Lote de Pagamento de GRU confirmado.\n* `payment.gru_batch.register.failed` Falha no envio do Lote de Pagamento de GRU.\n* `payment.gru_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de GRU.\n* `payment.gru_batch.approve.requested` Liberação de Lote de Pagamento de GRU solicitado.\n* `payment.gru_batch.approve.confirmed` Liberação de Lote de Pagamento de GRU confirmado.\n* `payment.gru_batch.approve.failed` Falha na liberação de Lote de Pagamento de GRU.\n* `payment.gru_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de GRU.\n* `payment.gru_batch.reprove.requested` Rejeição de Lote de Pagamento de GRU solicitado.\n* `payment.gru_batch.reprove.confirmed` Rejeição de Lote de Pagamento de GRU confirmado.\n* `payment.gru_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de GRU.\n* `payment.gru_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de GRU.\n* `payment.gru_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.gru_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.gru_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.gru_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.pix_batch.awaiting_approval` Lote de Pagamento de Pix aguardando liberação.\n* `payment.pix_batch.get.requested` Informação do Lote de Pagamento de Pix solicitada.\n* `payment.pix_batch.get.confirmed` Informação do Lote de Pagamento de Pix confirmada.\n* `payment.pix_batch.get.failed` Falha na informação do Lote de Pagamento de Pix.\n* `payment.pix_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Pix.\n* `payment.pix_batch.sync.requested` Sincronização de Lote de Pagamento de Pix solicitada.\n* `payment.pix_batch.sync.confirmed` Sincronização de Lote de Pagamento de Pix confirmada.\n* `payment.pix_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Pix.\n* `payment.pix_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Pix.\n* `payment.pix_batch.register.requested` Lote de Pagamento de Pix solicitado.\n* `payment.pix_batch.register.confirmed` Lote de Pagamento de Pix confirmado.\n* `payment.pix_batch.register.failed` Falha no envio do Lote de Pagamento de Pix.\n* `payment.pix_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Pix.\n* `payment.pix_batch.approve.requested` Liberação de Lote de Pagamento de Pix solicitado.\n* `payment.pix_batch.approve.confirmed` Liberação de Lote de Pagamento de Pix confirmado.\n* `payment.pix_batch.approve.failed` Falha na liberação de Lote de Pagamento de Pix.\n* `payment.pix_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Pix.\n* `payment.pix_batch.reprove.requested` Rejeição de Lote de Pagamento de Pix solicitado.\n* `payment.pix_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Pix confirmado.\n* `payment.pix_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Pix.\n* `payment.pix_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Pix.\n* `payment.pix_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.pix_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.pix_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.pix_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.tax_batch.awaiting_approval` Lote de Pagamento de Tributo aguardando liberação.\n* `payment.tax_batch.get.requested` Informação do Lote de Pagamento de Tributo solicitada.\n* `payment.tax_batch.get.confirmed` Informação do Lote de Pagamento de Tributo confirmada.\n* `payment.tax_batch.get.failed` Falha na informação do Lote de Pagamento de Tributo.\n* `payment.tax_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Tributo.\n* `payment.tax_batch.sync.requested` Sincronização de Lote de Pagamento de Tributo solicitada.\n* `payment.tax_batch.sync.confirmed` Sincronização de Lote de Pagamento de Tributo confirmada.\n* `payment.tax_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Tributo.\n* `payment.tax_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Tributo.\n* `payment.tax_batch.register.requested` Lote de Pagamento de Tributo solicitado.\n* `payment.tax_batch.register.confirmed` Lote de Pagamento de Tributo confirmado.\n* `payment.tax_batch.register.failed` Falha no envio do Lote de Pagamento de Tributo.\n* `payment.tax_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Tributo.\n* `payment.tax_batch.approve.requested` Liberação de Lote de Pagamento de Tributo solicitado.\n* `payment.tax_batch.approve.confirmed` Liberação de Lote de Pagamento de Tributo confirmado.\n* `payment.tax_batch.approve.failed` Falha na liberação de Lote de Pagamento de Tributo.\n* `payment.tax_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Tributo.\n* `payment.tax_batch.reprove.requested` Rejeição de Lote de Pagamento de Tributo solicitado.\n* `payment.tax_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Tributo confirmado.\n* `payment.tax_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Tributo.\n* `payment.tax_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Tributo.\n* `payment.tax_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.tax_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.tax_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.tax_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.dda.account.db.created` Conta de DDA criada\n* `payment.dda.account.register.requested` Conta de DDA solicitada.\n* `payment.dda.account.register.failed` Falha na criação da conta DDA.\n* `payment.dda.account.register.error` Ocorreu um erro no registro da conta DDA.\n* `payment.dda.account.register.confirmed` Conta de DDA confirmada.\n* `payment.dda.account.bank_billets_sync.requested` Sincronização de Boletos solicitada.\n* `payment.dda.account.bank_billets_sync.failed` Falha na sincronização de Boleto.\n* `payment.dda.account.bank_billets_sync.error` Ocorreu um erro na sincronização de Boletos.\n* `payment.dda.account.bank_billets_sync.confirmed` Sincronização de Boletos confirmada.\n* `payment.dda.account.unregister.requested` Descadastramento da conta DDA solicitado.\n* `payment.dda.account.unregister.failed` Falha no descadastramento da conta DDA.\n* `payment.dda.account.unregister.error` Ocorreu um erro no descadastramento da conta DDA.\n* `payment.dda.account.unregister.confirmed` Descadastramento da conta DDA confirmado.\n* `payment.dda.bank_billet.db.created` Boleto DDA criado\n* `payment.dda.bank_billet.db.updated` Boleto DDA atualizado.\n* `payment.dda.bank_billet.external_status_changed` Status externo do Boleto DDA alterado.\n* `payment.dda.bank_billet.get.requested` Informação do Boleto solicitada.\n* `payment.dda.bank_billet.get.confirmed` Informação do Boleto confirmada.\n* `payment.dda.bank_billet.get.failed` Falha na informação do Boleto.\n* `payment.dda.bank_billet.get.error` Ocorreu um erro na informação do Boleto.\n* `payment.dda.bank_billet.sync.requested` Sincronização do Boleto solicitada.\n* `payment.dda.bank_billet.sync.confirmed` Sincronização do Boleto confirmada.\n* `payment.dda.bank_billet.sync.failed` Falha na sincronização do Boleto.\n* `payment.dda.bank_billet.sync.error` Ocorreu um erro na sincronização do Boleto.\n* `payment.dda.account.db.updated` Conta de DDA atualizada.\n* `payment.dda.account.db.deleted` Conta de DDA excluída.\n* `payment.dda.account.letter.pending` Carta DDA gerada.\n* `payment.dda.account.letter.waiting_signatures` Carta DDA aguardando assinaturas.\n* `payment.dda.account.letter.signed` Carta DDA assinada.\n* `payment.dda.account.letter.failed` Falha no processo de assinatura da carta DDA.\n* `payment.dda.account.confirmed` Assinatura da conta DDA aprovada.\n* `payment.dda.account.rejected` Assinatura da conta DDA rejeitada.\n* `payment.dda.account.failed` Falha na conta DDA.\n* `payment.dda.account.disabled` Conta DDA desabilitada.\n* `payment.dda.account.enabled` Conta DDA reabilitada.\n* `credit.restriction.add.requested` Inclusão da restrição de crédito solicitada.\n* `credit.restriction.add.failed` Falha na inclusão da restrição de crédito.\n* `credit.restriction.add.error` Ocorreu um erro na inclusão da restrição de crédito.\n* `credit.restriction.add.confirmed` Inclusão da restrição de crédito confirmada.\n* `credit.restriction.remove.requested` Remoção da restrição de crédito solicitada.\n* `credit.restriction.remove.confirmed` Remoção da restrição de crédito confirmada.\n* `credit.restriction.remove.failed` Falha na remoção da restrição de crédito.\n* `credit.restriction.remove.error` Ocorreu um erro na remoção da restrição de crédito.\n* `charge.automatic_pix.account.db.created` Conta de Pix Automático criada.\n* `charge.automatic_pix.account.db.updated` Conta de Pix Automático atualizada.\n* `charge.automatic_pix.account.db.deleted` Conta de Pix Automático excluída.\n* `charge.automatic_pix.recurrence.db.created` Recorrência de Pix Automático criada.\n* `charge.automatic_pix.recurrence.db.updated` Recorrência de Pix Automático atualizada.\n* `charge.automatic_pix.recurrence.db.deleted` Recorrência de Pix Automático excluída.\n* `charge.automatic_pix.recurrence.cancel.requested` Cancelamento da Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.recurrence.cancel.confirmed` Cancelamento da Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.recurrence.cancel.failed` Falha no cancelamento da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.cancel.error` Ocorreu um erro no cancelamento da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.register.requested` Registro da Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.recurrence.register.confirmed` Registro da Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.recurrence.register.failed` Falha no registro da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.register.error` Ocorreu um erro no registro da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.update.requested` Atualização da Recorrência de Pix Automático solicitada.\n* `charge.automatic_pix.recurrence.update.confirmed` Atualização da Recorrência de Pix Automático confirmada.\n* `charge.automatic_pix.recurrence.update.failed` Falha na atualização da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.update.error` Ocorreu um erro na atualização da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.pending` Recorrência de Pix Automático pendente.\n* `charge.automatic_pix.recurrence.created` Recorrência de Pix Automático criada no provedor financeiro.\n* `charge.automatic_pix.recurrence.approved` Recorrência de Pix Automático aprovada.\n* `charge.automatic_pix.recurrence.rejected` Recorrência de Pix Automático rejeitada.\n* `charge.automatic_pix.recurrence.expired` Recorrência de Pix Automático expirada.\n* `charge.automatic_pix.recurrence.canceled` Recorrência de Pix Automático cancelada.\n* `charge.automatic_pix.request.db.created` Solicitações de Recorrência de Pix Automático criada.\n* `charge.automatic_pix.request.db.updated` Solicitações de Recorrência de Pix Automático atualizada.\n* `charge.automatic_pix.request.db.deleted` Solicitações de Recorrência de Pix Automático excluída.\n* `charge.automatic_pix.request.cancel.requested` Cancelamento da Solicitação de Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.request.cancel.confirmed` Cancelamento da Solicitação de Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.request.cancel.failed` Falha no cancelamento da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.cancel.error` Ocorreu um erro no cancelamento da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.register.requested` Registro da Solicitação de Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.request.register.confirmed` Registro da Solicitação de Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.request.register.failed` Falha no registro da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.register.error` Ocorreu um erro no registro da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.pending` Solicitação de Recorrência de Pix Automático pendente.\n* `charge.automatic_pix.request.created` Solicitação de Recorrência de Pix Automático criada no provedor financeiro.\n* `charge.automatic_pix.request.sent` Solicitação de Recorrência de Pix Automático enviada ao pagador.\n* `charge.automatic_pix.request.received` Solicitação de Recorrência de Pix Automático recebida pelo pagador.\n* `charge.automatic_pix.request.rejected` Solicitação de Recorrência de Pix Automático rejeitada.\n* `charge.automatic_pix.request.accepted` Solicitação de Recorrência de Pix Automático aceita.\n* `charge.automatic_pix.request.expired` Solicitação de Recorrência de Pix Automático expirada.\n* `charge.automatic_pix.request.canceled` Solicitação de Recorrência de Pix Automático cancelada.\n* `charge.automatic_pix.pix.db.created` Cobrança de Pix Automático criada.\n* `charge.automatic_pix.pix.db.updated` Cobrança de Pix Automático atualizada.\n* `charge.automatic_pix.pix.db.deleted` Cobrança de Pix Automático excluída.\n* `charge.automatic_pix.pix.cancel.requested` Cancelamento da Cobrança de Pix Automático solicitado.\n* `charge.automatic_pix.pix.cancel.confirmed` Cancelamento da Cobrança de Pix Automático confirmado.\n* `charge.automatic_pix.pix.cancel.failed` Falha no cancelamento da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.cancel.error` Ocorreu um erro no cancelamento da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.register.requested` Registro da Cobrança de Pix Automático solicitado.\n* `charge.automatic_pix.pix.register.confirmed` Registro da Cobrança de Pix Automático confirmado.\n* `charge.automatic_pix.pix.register.failed` Falha no registro da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.register.error` Ocorreu um erro no registro da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.update.requested` Atualização da Cobrança de Pix Automático solicitada.\n* `charge.automatic_pix.pix.update.confirmed` Atualização da Cobrança de Pix Automático confirmada.\n* `charge.automatic_pix.pix.update.failed` Falha na atualização da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.update.error` Ocorreu um erro na atualização da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.pending` Cobrança de Pix Automático pendente.\n* `charge.automatic_pix.pix.created` Cobrança de Pix Automático criada no provedor financeiro.\n* `charge.automatic_pix.pix.active` Cobrança de Pix Automático ativa.\n* `charge.automatic_pix.pix.paid` Cobrança de Pix Automático paga.\n* `charge.automatic_pix.pix.expired` Cobrança de Pix Automático expirada.\n* `charge.automatic_pix.pix.rejected` Cobrança de Pix Automático rejeitada.\n* `charge.automatic_pix.pix.canceled` Cobrança de Pix Automático cancelada.\n* `charge.automatic_pix.location.db.created` Localização de Pix Automático criada.\n* `charge.automatic_pix.location.db.updated` Localização de Pix Automático atualizada.\n* `charge.automatic_pix.location.db.deleted` Localização de Pix Automático excluída.\n* `charge.automatic_pix.location.register.requested` Registro da Localização de Pix Automático solicitado.\n* `charge.automatic_pix.location.register.confirmed` Registro da Localização de Pix Automático confirmado.\n* `charge.automatic_pix.location.register.failed` Falha no registro da Localização de Pix Automático.\n* `charge.automatic_pix.location.register.error` Ocorreu um erro no registro da Localização de Pix Automático.\n* `charge.payment.db.created` Recebimento de cobrança criado.\n* `charge.payment.db.updated` Recebimento de cobrança atualizado.\n* `charge.payment.db.deleted` Recebimento de cobrança excluído.\n* `charge.payment.notified` Recebimento notificado.\n* `charge.payment.canceled` Recebimento cancelado.\n* `charge.payment.confirmed` Recebimento confirmado.\n* `charge.payment.duplicated` Recebimento duplicado.\n* `charge.bank_billet.payment.notified` Baixa operacional de boleto notificada.\n* `charge.bank_billet.payment.canceled` Baixa operacional de boleto cancelada.\n* `charge.bank_billet.payment.confirmed` Baixa operacional de boleto liquidada.\n* `data.bank_billet_query.success` Consulta de boleto realizada com sucesso.\n* `data.bank_billet_query.error` Consulta de boleto com erro.\n* `data.bank_billet_query.db.created` Consulta de boleto criada.\n* `data.bank_billet_query.db.updated` Consulta de boleto atualizada.\n* `data.bank_billet_query.db.deleted` Consulta de boleto excluída.\n* `data.pix_qrcode_query.success` Consulta de Pix via QR Code realizada com sucesso.\n* `data.pix_qrcode_query.error` Consulta de Pix via QR Code com erro.\n* `data.pix_qrcode_query.db.created` Consulta de Pix via QR Code criada.\n* `data.pix_qrcode_query.db.updated` Consulta de Pix via QR Code atualizada.\n* `data.pix_qrcode_query.db.deleted` Consulta de Pix via QR Code excluída.\n* `mailbox.entry.db.created` Caixa Postal criado.\n* `mailbox.entry.db.updated` Caixa Postal atualizado.\n* `mailbox.entry.db.deleted` Caixa Postal excluída.\n* `mailbox.entry.file.received` Arquivo recebido na caixa de entrada.\n* `mailbox.entry.file.sent` Arquivo enviado para a caixa de saída.\n* `mailbox.file.db.created` Arquivo criado.\n* `mailbox.file.db.updated` Arquivo atualizado.\n* `mailbox.file.db.deleted` Arquivo excluído.\n* `mailbox.channel.s3.db.created` Canal S3 criado.\n* `mailbox.channel.s3.db.updated` Canal S3 atualizado.\n* `mailbox.channel.s3.db.deleted` Canal S3 excluído.\n* `mailbox.channel.s3.fetch_all` Arquivo obtido do canal S3.\n* `mailbox.channel.email.db.created` Canal de Email criado.\n* `mailbox.channel.email.db.updated` Canal de Email atualizado.\n* `mailbox.channel.email.db.deleted` Canal de Email excluído.\n* `mailbox.channel.whatsapp.db.created` Canal WhatsApp criado.\n* `mailbox.channel.whatsapp.db.updated` Canal WhatsApp atualizado.\n* `mailbox.channel.whatsapp.db.deleted` Canal WhatsApp excluído.\n* `mailbox.channel.sftp.db.created` Canal SFTP criado.\n* `mailbox.channel.sftp.db.updated` Canal SFTP atualizado.\n* `mailbox.channel.sftp.db.deleted` Canal SFTP excluído.\n* `mailbox.channel.sftp.fetch_all` Arquivo obtido do canal SFTP.\n* `mailbox.channel.syncthing.db.created` Canal Syncthing criado.\n* `mailbox.channel.syncthing.db.updated` Canal Syncthing atualizado.\n* `mailbox.channel.syncthing.db.deleted` Canal Syncthing excluído.\n* `email_account.db.created` Conta de e-mail criada.\n* `email_account.db.updated` Conta de e-mail atualizada.\n* `email_account.db.deleted` Conta de e-mail excluída.\n* `email_account.identity.pending` Aguardando identidade\n* `email_account.identity.created` Identidade criada\n* `email_account.identity.error` Identidade já existente\n* `email_account.identity.failure` Falha da identidade\n* `email_account.dns.not_ready` DNS não pronto\n* `email_account.dns.awaiting` Aguardando validação DNS\n* `email_account.dns.validated` DNS validado\n* `email_account.dns.error` Falha na validação do DNS\n* `email_account.dns.failure` Falha na tentativa do DNS\n* `integration.connection.db.created` Conexão criada.\n* `integration.connection.db.updated` Conexão atualizada.\n* `integration.connection.db.deleted` Conexão excluída.\n* `webhook.db.created` Webhook criado.\n* `webhook.db.updated` Webhook atualizado.\n* `webhook.db.deleted` Webhook excluído.\n* `enotas.nfe.generated` Enotas: nota fiscal gerada" }, "webhook_id": { "type": "integer", "description": "ID do Webhook", "example": null }, "fails_count": { "type": "integer", "description": "Quantidade de falhas" }, "resource_owner_id": { "type": "integer", "nullable": true, "description": "ID do Objeto", "example": null }, "bank_billet_account_id": { "type": "integer", "nullable": true, "description": "ID da Carteira de Cobrança.", "example": null }, "status": { "type": "string", "readOnly": true, "description": "Situação:\n* `pending` Pendente\n* `delivered` Entregue\n* `failed` Falhou", "enum": [ "pending", "delivered", "failed" ] }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do registro" } } }, "v1_webhook_delivery_resend_object": { "type": "object", "properties": { "resource_owner_id": { "type": "integer", "nullable": true, "description": "ID do Objeto", "example": null }, "webhook_id": { "type": "integer", "nullable": true, "description": "ID do Webhook", "example": null }, "uid": { "type": "string", "maxLength": 255, "nullable": true, "description": "UID usado no cabeçalho da requisição" }, "response_code": { "type": "integer", "nullable": true, "description": "Código HTTP da resposta. [Leia mais](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes)" }, "event_code": { "type": "string", "maxLength": 255, "nullable": true, "example": "bank_billet.created", "description": "Código do evento.\n* `ping` Ping\n* `access_token.db.created` Token de Acesso criado.\n* `access_token.db.updated` Token de Acesso atualizado.\n* `access_token.db.deleted` Token de Acesso excluído.\n* `access_token.reminder` Lembrete de expiração do Token de Acesso.\n* `access_token.expired` Token de Acesso expirou.\n* `account.updated` Conta atualizada.\n* `account.blocked` Conta bloqueada.\n* `account.bank_billet_creation_blocked` Emissão de boletos bloqueada.\n* `bank_billet.created` Boleto criado.\n* `bank_billet.updated` Boleto atualizado.\n* `bank_billet.generated` PDF do Boleto Gerado ou Atualizado.\n* `bank_billet.canceled` Boleto cancelado.\n* `bank_billet.blocked` Boleto foi bloqueado.\n* `bank_billet.overdue` Boleto ficou vencido.\n* `bank_billet.paid` Boleto foi pago.\n* `bank_billet.due_date` Notifica boleto com 15, 7, 3 e 1 dias antes do vencimento.\n* `bank_billet.rejected` Boleto rejeitado.\n* `bank_billet.cancel.requested` Cancelamento do Boleto solicitado.\n* `bank_billet.cancel.confirmed` Cancelamento do Boleto confirmado.\n* `bank_billet.cancel.failed` Falha no cancelamento do Boleto.\n* `bank_billet.cancel.error` Ocorreu um erro no cancelamento do Boleto.\n* `bank_billet.register.requested` Registro do Boleto solicitado.\n* `bank_billet.register.confirmed` Registro do Boleto confirmado.\n* `bank_billet.register.failed` Falha no registro do Boleto.\n* `bank_billet.register.error` Ocorreu um erro no registro do Boleto.\n* `bank_billet.update.requested` Atualização do Boleto solicitada.\n* `bank_billet.update.confirmed` Atualização do Boleto confirmada.\n* `bank_billet.update.failed` Falha na atualização do Boleto.\n* `bank_billet.update.error` Ocorreu um erro na atualização do Boleto.\n* `bank_billet.registered` Boleto registrado.\n* `bank_billet.deleted` Boleto excluído.\n* `bank_billet.sync.requested` Sincronização do Boleto solicitada.\n* `bank_billet.sync.confirmed` Sincronização do Boleto confirmada.\n* `bank_billet.sync.failed` Falha na sincronização do Boleto.\n* `bank_billet.sync.error` Ocorreu um erro na sincronização do Boleto.\n* `bank_billet.get.requested` Informação do Boleto solicitada.\n* `bank_billet.get.confirmed` Informação do Boleto confirmada.\n* `bank_billet.get.failed` Falha na informação do Boleto.\n* `bank_billet.get.error` Ocorreu um erro na informação do Boleto.\n* `bank_billet.get_child.requested` Informação do Boleto filho solicitada.\n* `bank_billet.get_child.confirmed` Informação do Boleto filho confirmada.\n* `bank_billet.get_child.failed` Falha na informação do Boleto filho.\n* `bank_billet.get_child.error` Ocorreu um erro na informação do Boleto filho.\n* `bank_billet.find.requested` Busca de Boleto solicitada.\n* `bank_billet.find.confirmed` Busca de Boleto confirmada.\n* `bank_billet.find.failed` Falha na busca de Boleto.\n* `bank_billet.find.error` Ocorreu um erro na busca de Boleto.\n* `bank_billet.add_pix.requested` Adição do Pix ao Boleto solicitada.\n* `bank_billet.add_pix.confirmed` Adição do Pix ao Boleto confirmada.\n* `bank_billet.add_pix.failed` Falha na adição do Pix ao Boleto.\n* `bank_billet.add_pix.error` Ocorreu um erro na adição do Pix ao Boleto.\n* `bank_billet.get_pix.requested` Consulta do Pix do Boleto solicitada.\n* `bank_billet.get_pix.confirmed` Consulta do Pix do Boleto confirmada.\n* `bank_billet.get_pix.failed` Falha na consulta do Pix do Boleto.\n* `bank_billet.get_pix.error` Ocorreu um erro na consulta do Pix do Boleto.\n* `bank_billet.protest.requested` Protesto do Boleto solicitado.\n* `bank_billet.protest.confirmed` Protesto do Boleto confirmado.\n* `bank_billet.protest.failed` Falha no protesto do Boleto.\n* `bank_billet.protest.error` Ocorreu um erro no protesto do Boleto.\n* `bank_billet_discharge.created` Registro de retorno criado.\n* `bank_billet_discharge.updated` Registro de retorno atualizado.\n* `bank_billet_discharge.deleted` Registro de retorno excluído.\n* `bank_billet_remittance.created` Registro de remessa criado.\n* `bank_billet_remittance.updated` Registro de remessa atualizado.\n* `bank_billet_remittance.deleted` Registro de remessa excluído.\n* `bank_billet_registration.created` Registro de Boleto criado.\n* `bank_billet_registration.updated` Registro de Boleto atualizado.\n* `bank_billet_registration.deleted` Registro de Boleto excluído.\n* `bank_billet_payment.created` Recebimento criado.\n* `bank_billet_payment.updated` Recebimento atualizado.\n* `bank_billet_payment.deleted` Recebimento excluído.\n* `customer.created` Cliente criado.\n* `customer.updated` Cliente atualizado.\n* `customer.portal_password_updated` Senha do portal do cliente atualizada.\n* `customer.deleted` Cliente excluído.\n* `transaction.created` Transação criada.\n* `transaction.updated` Transação atualizada.\n* `transaction.processed` Transação processada.\n* `withdrawal.transferred` Saque transferido.\n* `withdrawal.requested` Saque solicitado.\n* `addon.activated` Addon ativado.\n* `addon.removed` Addon removido.\n* `plan_subscription.activated` Plano ativado.\n* `plan_subscription.removed` Plano removido.\n* `plan_subscription.fee` Cobrança do plano.\n* `plan_subscription.updated` Plano atualizado.\n* `user.created` Usuário criado.\n* `user.updated` Usuário atualizado.\n* `user.deleted` Usuário excluído.\n* `remittance.created` Remessa criada.\n* `remittance.processed` Remessa processada.\n* `remittance.downloaded` Download de Remessa realizado.\n* `remittance.sent` Remessa enviada.\n* `remittance.deleted` Remessa excluída.\n* `remittance.line.db.created` Linha de Remessa criada.\n* `remittance.line.db.updated` Linha de Remessa atualizada.\n* `remittance.line.db.deleted` Linha de Remessa excluída.\n* `discharge.created` Retorno criado.\n* `discharge.processed` Retorno processado.\n* `discharge.deleted` Retorno excluído.\n* `bank_billet_account.created` Conta de Cobrança criada.\n* `bank_billet_account.homologated` Conta de Cobrança enviada para homologação.\n* `bank_billet_account.homologation_failed` Falha na homologação da Conta de Cobrança.\n* `bank_billet_account.homologation_started` Conta de Cobrança enviada para homologação.\n* `bank_billet_account.validated` Conta de Cobrança homologada.\n* `bank_billet_account.validation_released` Conta de Cobrança homologada.\n* `bank_billet_account.activated` Conta de Cobrança ativada.\n* `bank_billet_account.updated` Conta de Cobrança atualizada.\n* `bank_billet_account.deleted` Conta de Cobrança excluída.\n* `edi.remittance_line.created` Linha de Remessa criada.\n* `edi.remittance_line.updated` Linha de Remessa atualizada.\n* `edi.remittance_line.deleted` Linha de Remessa excluída.\n* `edi.edi_box.activated` EDI ativado.\n* `edi.edi_box.db.created` EDI criado.\n* `edi.edi_box.db.deleted` EDI excluído.\n* `edi.edi_box.db.updated` EDI atualizado.\n* `edi.edi_box.generated` Carta Gerada\n* `edi.edi_box.demand_received` Demanda recepcionada\n* `edi.edi_box.confirming_at_bank` Aguardando confirmação do banco\n* `edi.edi_box.testing_by_customer` Aguardando teste do cliente\n* `edi.edi_box.waiting_for_validations` Aguardando validações\n* `customer_subscription.created` Assinatura criada.\n* `customer_subscription.updated` Assinatura atualizada.\n* `customer_subscription.deleted` Assinatura excluída.\n* `installment.created` Carnê criado.\n* `installment.processed` Carnê processado.\n* `installment.generated` Carnê gerado.\n* `installment.deleted` Carnê excluído.\n* `import.created` Importação criada.\n* `import.processed` Importação processada.\n* `import.deleted` Importação excluída.\n* `export.db.created` Exportação criada.\n* `export.db.updated` Exportação atualizada.\n* `export.db.deleted` Exportação excluída.\n* `pix.db.created` Pix criado.\n* `pix.db.updated` Pix atualizado.\n* `pix.db.deleted` Pix excluído.\n* `pix.register.requested` Registro do Pix solicitado.\n* `pix.register.confirmed` Registro do Pix confirmado.\n* `pix.register.failed` Falha no registro do Pix.\n* `pix.register.error` Ocorreu um erro no registro do Pix.\n* `pix.update.requested` Atualização do Pix solicitada.\n* `pix.update.confirmed` Atualização do Pix confirmada.\n* `pix.update.failed` Falha na atualização do Pix.\n* `pix.update.error` Ocorreu um erro na atualização do Pix.\n* `pix.paid` Pix pago.\n* `pix.overdue` Pix vencido (somente Pix Cobrança).\n* `pix.cancel.requested` Cancelamento do Pix solicitado.\n* `pix.cancel.confirmed` Cancelamento do Pix confirmado.\n* `pix.cancel.failed` Falha no cancelamento do Pix.\n* `pix.cancel.error` Ocorreu um erro no cancelamento do Pix.\n* `pix.sync.requested` Sincronização do Pix solicitada.\n* `pix.sync.confirmed` Sincronização do Pix confirmada.\n* `pix.sync.failed` Falha na sincronização do Pix.\n* `pix.sync.error` Ocorreu um erro na sincronização do Pix.\n* `pix.get.requested` Informação do Pix solicitada.\n* `pix.get.confirmed` Informação do Pix confirmada.\n* `pix.get.failed` Falha na informação do Pix.\n* `pix.get.error` Ocorreu um erro na informação do Pix.\n* `financial.account.balance_sync.requested` Sincronização do Saldo solicitada.\n* `financial.account.balance_sync.confirmed` Sincronização do Saldo confirmada.\n* `financial.account.balance_sync.failed` Falha na sincronização do Saldo.\n* `financial.account.balance_sync.error` Ocorreu um erro na sincronização do Saldo.\n* `financial.account.statement_sync.requested` Sincronização do Extrato solicitada.\n* `financial.account.statement_sync.confirmed` Sincronização do Extrato confirmada.\n* `financial.account.statement_sync.failed` Falha na sincronização do Extrato.\n* `financial.account.statement_sync.error` Ocorreu um erro na sincronização do Extrato.\n* `financial.account.db.created` Conta Financeira criada.\n* `financial.account.db.updated` Conta Financeira atualizada.\n* `financial.account.db.deleted` Conta Financeira excluída.\n* `financial.account.statement.updated` Extrato atualizado.\n* `financial.account.balance.updated` Saldo da conta financeira atualizado.\n* `financial.account_balance.db.created` Saldo criado.\n* `transfer.batch.db.created` Lote de transferência criado.\n* `transfer.batch.db.updated` Lote de transferência atualizado.\n* `transfer.batch.db.deleted` Lote de transferência excluído.\n* `transfer.batch.awaiting_approval` Lote de transferência aguardando liberação.\n* `transfer.pix_batch.awaiting_approval` Lote de Transferência Pix aguardando liberação.\n* `transfer.pix_batch.get.requested` Informação do Lote de Transferência Pix solicitada.\n* `transfer.pix_batch.get.confirmed` Informação do Lote de Transferência Pix confirmada.\n* `transfer.pix_batch.get.failed` Falha na informação do Lote de Transferência Pix.\n* `transfer.pix_batch.get.error` Ocorreu um erro na informação do Lote de Transferência Pix.\n* `transfer.pix_batch.sync.requested` Sincronização de Lote de transferência Pix solicitada.\n* `transfer.pix_batch.sync.confirmed` Sincronização de Lote de transferência Pix confirmada.\n* `transfer.pix_batch.sync.failed` Falha na sincronização de Lote de transferência Pix.\n* `transfer.pix_batch.sync.error` Ocorreu um erro na sincronização de Lote de transferência Pix.\n* `transfer.pix_batch.register.requested` Lote de Transferência Pix solicitado.\n* `transfer.pix_batch.register.confirmed` Lote de Transferência Pix confirmado.\n* `transfer.pix_batch.register.failed` Falha no envio de Lote de Transferência Pix.\n* `transfer.pix_batch.register.error` Ocorreu um erro no envio de Lote de Transferência Pix.\n* `transfer.pix_batch.approve.requested` Liberação de Lote de Transferência Pix solicitada.\n* `transfer.pix_batch.approve.confirmed` Liberação de Lote de Transferência Pix confirmada.\n* `transfer.pix_batch.approve.failed` Falha na liberação de Lote de Transferência Pix.\n* `transfer.pix_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência Pix.\n* `transfer.pix_batch.reprove.requested` Rejeição de Lote de Transferência Pix solicitada.\n* `transfer.pix_batch.reprove.confirmed` Rejeição de Lote de transferência Pix confirmada.\n* `transfer.pix_batch.reprove.failed` Falha na rejeição de Lote de Transferência Pix.\n* `transfer.pix_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência Pix.\n* `transfer.pix_batch.cancel.requested` Cancelamento de Lote de Transferência Pix solicitado.\n* `transfer.pix_batch.cancel.confirmed` Cancelamento de Lote de Transferência Pix confirmado.\n* `transfer.pix_batch.cancel.failed` Falha no cancelamento de Lote de Transferência Pix.\n* `transfer.pix_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Transferência Pix.\n* `transfer.ted_batch.awaiting_approval` Lote de Transferência TED aguardando liberação.\n* `transfer.ted_batch.get.requested` Informação do Lote de Transferência TED solicitada.\n* `transfer.ted_batch.get.confirmed` Informação do Lote de Transferência TED confirmada.\n* `transfer.ted_batch.get.failed` Falha na informação do Lote de Transferência TED.\n* `transfer.ted_batch.get.error` Ocorreu um erro na informação do Lote de Transferência TED.\n* `transfer.ted_batch.sync.requested` Sincronização de Lote de transferência TED solicitada.\n* `transfer.ted_batch.sync.confirmed` Sincronização de Lote de transferência TED confirmada.\n* `transfer.ted_batch.sync.failed` Falha na sincronização de Lote de transferência TED.\n* `transfer.ted_batch.sync.error` Ocorreu um erro na sincronização de Lote de transferência TED.\n* `transfer.ted_batch.register.requested` Lote de Transferência TED solicitado.\n* `transfer.ted_batch.register.confirmed` Lote de Transferência TED confirmado.\n* `transfer.ted_batch.register.failed` Falha no envio de Lote de Transferência TED.\n* `transfer.ted_batch.register.error` Ocorreu um erro no envio de Lote de Transferência TED.\n* `transfer.ted_batch.approve.requested` Liberação de Lote de Transferência TED solicitada.\n* `transfer.ted_batch.approve.confirmed` Liberação de Lote de Transferência TED confirmada.\n* `transfer.ted_batch.approve.failed` Falha na liberação de Lote de Transferência TED.\n* `transfer.ted_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência TED.\n* `transfer.ted_batch.reprove.requested` Rejeição de Lote de Transferência TED solicitada.\n* `transfer.ted_batch.reprove.confirmed` Rejeição de Lote de transferência TED confirmada.\n* `transfer.ted_batch.reprove.failed` Falha na rejeição de Lote de Transferência TED.\n* `transfer.ted_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência TED.\n* `transfer.ted_batch.cancel.requested` Cancelamento de Lote de Transferência TED solicitado.\n* `transfer.ted_batch.cancel.confirmed` Cancelamento de Lote de Transferência TED confirmado.\n* `transfer.ted_batch.cancel.failed` Falha no cancelamento de Lote de Transferência TED.\n* `transfer.ted_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Transferência TED.\n* `transfer.internal_batch.awaiting_approval` Lote de Transferência Entre Contas do Mesmo Banco aguardando liberação.\n* `transfer.internal_batch.get.requested` Informação do Lote de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.get.confirmed` Informação do Lote de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.get.failed` Falha na informação do Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.get.error` Ocorreu um erro na informação do Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.sync.requested` Sincronização de Lote de transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.sync.confirmed` Sincronização de Lote de transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.sync.failed` Falha na sincronização de Lote de transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.sync.error` Ocorreu um erro na sincronização de Lote de transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.register.requested` Lote de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal_batch.register.confirmed` Lote de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal_batch.register.failed` Falha no envio de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.register.error` Ocorreu um erro no envio de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.approve.requested` Liberação de Lote de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.approve.confirmed` Liberação de Lote de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.approve.failed` Falha na liberação de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.reprove.requested` Rejeição de Lote de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.reprove.confirmed` Rejeição de Lote de transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.reprove.failed` Falha na rejeição de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.cancel.requested` Cancelamento de Lote de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal_batch.cancel.confirmed` Cancelamento de Lote de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal_batch.cancel.failed` Falha no cancelamento de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.db.created` Transferência criada.\n* `transfer.db.updated` Transferência atualizada.\n* `transfer.db.deleted` Transferência excluída.\n* `transfer.pix.register.requested` Transferência Pix solicitada.\n* `transfer.pix.register.confirmed` Transferência Pix confirmada.\n* `transfer.pix.register.failed` Falha no envio da Transferência Pix.\n* `transfer.pix.register.error` Ocorreu um erro no envio da Transferência Pix.\n* `transfer.pix.reschedule.requested` Reagendamento de Transferência Pix solicitado.\n* `transfer.pix.reschedule.confirmed` Reagendamento de Transferência Pix confirmado.\n* `transfer.pix.reschedule.failed` Falha no reagendamento da Transferência Pix.\n* `transfer.pix.reschedule.error` Ocorreu um erro no reagendamento da Transferência Pix.\n* `transfer.pix.approve.requested` Liberação de Transferência Pix solicitada.\n* `transfer.pix.approve.confirmed` Liberação de Transferência Pix confirmada.\n* `transfer.pix.approve.failed` Falha na liberação da transferência Pix.\n* `transfer.pix.approve.error` Ocorreu um erro na liberação da Transferência Pix.\n* `transfer.pix.reprove.requested` Rejeição de Transferência Pix solicitada.\n* `transfer.pix.reprove.confirmed` Rejeição de Transferência Pix confirmada.\n* `transfer.pix.reprove.failed` Falha na rejeição da transferência Pix.\n* `transfer.pix.reprove.error` Ocorreu um erro na rejeição da Transferência Pix.\n* `transfer.pix.cancel.requested` Cancelamento de Transferência Pix solicitado.\n* `transfer.pix.cancel.confirmed` Cancelamento de Transferência Pix confirmado.\n* `transfer.pix.cancel.failed` Falha no cancelamento da Transferência Pix.\n* `transfer.pix.cancel.error` Ocorreu um erro no cancelamento da Transferência Pix.\n* `transfer.pix.get.requested` Informação da Transferência Pix solicitada.\n* `transfer.pix.get.confirmed` Informação da Transferência Pix confirmada.\n* `transfer.pix.get.failed` Falha na informação da Transferência Pix.\n* `transfer.pix.get.error` Ocorreu um erro na informação da Transferência Pix.\n* `transfer.pix.sync.requested` Sincronização da Transferência Pix solicitada.\n* `transfer.pix.sync.confirmed` Sincronização da Transferência Pix confirmada.\n* `transfer.pix.sync.failed` Falha na sincronização da Transferência Pix.\n* `transfer.pix.sync.error` Ocorreu um erro na sincronização da Transferência Pix.\n* `transfer.ted.register.requested` Transferência TED solicitada.\n* `transfer.ted.register.confirmed` Transferência TED confirmada.\n* `transfer.ted.register.failed` Falha no envio da Transferência TED.\n* `transfer.ted.register.error` Ocorreu um erro no envio da Transferência TED.\n* `transfer.ted.reschedule.requested` Reagendamento de Transferência TED solicitado.\n* `transfer.ted.reschedule.confirmed` Reagendamento de Transferência TED confirmado.\n* `transfer.ted.reschedule.failed` Falha no Reagendamento de Transferência TED.\n* `transfer.ted.reschedule.error` Ocorreu um erro no Reagendamento de Transferência TED.\n* `transfer.ted.approve.requested` Liberação de Transferência TED solicitada.\n* `transfer.ted.approve.confirmed` Liberação de Transferência TED confirmada.\n* `transfer.ted.approve.failed` Falha na liberação da transferência TED.\n* `transfer.ted.approve.error` Ocorreu um erro na liberação da Transferência TED.\n* `transfer.ted.reprove.requested` Rejeição de Transferência TED solicitada.\n* `transfer.ted.reprove.confirmed` Rejeição de Transferência TED confirmada.\n* `transfer.ted.reprove.failed` Falha na rejeição da transferência TED.\n* `transfer.ted.reprove.error` Ocorreu um erro na rejeição da Transferência TED.\n* `transfer.ted.cancel.requested` Cancelamento de Transferência TED solicitado.\n* `transfer.ted.cancel.confirmed` Cancelamento de Transferência TED confirmado.\n* `transfer.ted.cancel.failed` Falha no cancelamento de Transferência TED.\n* `transfer.ted.cancel.error` Ocorreu um erro no cancelamento de Transferência TED.\n* `transfer.ted.get.requested` Informação da Transferência TED solicitada.\n* `transfer.ted.get.confirmed` Informação da Transferência TED confirmada.\n* `transfer.ted.get.failed` Falha na informação da Transferência TED.\n* `transfer.ted.get.error` Ocorreu um erro na informação da Transferência TED.\n* `transfer.ted.sync.requested` Sincronização da Transferência TED solicitada.\n* `transfer.ted.sync.confirmed` Sincronização da Transferência TED confirmada.\n* `transfer.ted.sync.failed` Falha na sincronização da Transferência TED.\n* `transfer.ted.sync.error` Ocorreu um erro na sincronização da Transferência TED.\n* `transfer.internal.register.requested` Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.register.confirmed` Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.register.failed` Falha no envio da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.register.error` Ocorreu um erro no envio da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reschedule.requested` Reagendamento de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal.reschedule.confirmed` Reagendamento de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal.reschedule.failed` Falha no Reagendamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reschedule.error` Ocorreu um erro no Reagendamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.approve.requested` Liberação de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.approve.confirmed` Liberação de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.approve.failed` Falha na liberação da transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.approve.error` Ocorreu um erro na liberação da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reprove.requested` Rejeição de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.reprove.confirmed` Rejeição de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.reprove.failed` Falha na rejeição da transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reprove.error` Ocorreu um erro na rejeição da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.cancel.requested` Cancelamento de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal.cancel.confirmed` Cancelamento de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal.cancel.failed` Falha no cancelamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.cancel.error` Ocorreu um erro no cancelamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.get.requested` Informação da Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.get.confirmed` Informação da Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.get.failed` Falha na informação da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.get.error` Ocorreu um erro na informação da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.sync.requested` Sincronização da Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.sync.confirmed` Sincronização da Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.sync.failed` Falha na sincronização da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.sync.error` Ocorreu um erro na sincronização da Transferência Entre Contas do Mesmo Banco.\n* `payment.db.created` Pagamento criado.\n* `payment.db.updated` Pagamento atualizado.\n* `payment.db.deleted` Pagamento excluído.\n* `payment.bank_billet.register.requested` Pagamento de Boleto solicitado.\n* `payment.bank_billet.register.confirmed` Pagamento de Boleto confirmado.\n* `payment.bank_billet.register.failed` Falha no envio do Pagamento de Boleto.\n* `payment.bank_billet.register.error` Ocorreu um erro no envio de Pagamento de Boleto.\n* `payment.bank_billet.approve.requested` Liberação de Pagamento de Boleto solicitada.\n* `payment.bank_billet.approve.confirmed` Liberação de Pagamento de Boleto confirmada.\n* `payment.bank_billet.approve.failed` Falha na liberação de Pagamento de Boleto.\n* `payment.bank_billet.approve.error` Ocorreu um erro na liberação de Pagamento de Boleto.\n* `payment.bank_billet.reprove.requested` Rejeição de Pagamento de Boleto solicitada.\n* `payment.bank_billet.reprove.confirmed` Rejeição de Pagamento de Boleto confirmada.\n* `payment.bank_billet.reprove.failed` Falha na rejeição de Pagamento de Boleto.\n* `payment.bank_billet.reprove.error` Ocorreu um erro na rejeição de Pagamento de Boleto.\n* `payment.bank_billet.reschedule.requested` Reagendamento de Pagamento de Boleto solicitado.\n* `payment.bank_billet.reschedule.confirmed` Reagendamento de Pagamento de Boleto confirmado.\n* `payment.bank_billet.reschedule.failed` Falha no Reagendamento de Pagamento de Boleto.\n* `payment.bank_billet.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Boleto.\n* `payment.bank_billet.cancel.requested` Cancelamento de Pagamento de Boleto solicitado.\n* `payment.bank_billet.cancel.confirmed` Cancelamento de Pagamento de Boleto confirmada.\n* `payment.bank_billet.cancel.failed` Falha no cancelamento de Pagamento de Boleto.\n* `payment.bank_billet.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Boleto.\n* `payment.bank_billet.get.requested` Informação do Pagamento de Boleto solicitada.\n* `payment.bank_billet.get.confirmed` Informação do Pagamento de Boleto confirmada.\n* `payment.bank_billet.get.failed` Falha na informação do Pagamento de Boleto.\n* `payment.bank_billet.get.error` Ocorreu um erro na informação do Pagamento de Boleto.\n* `payment.bank_billet.sync.requested` Sincronização do Pagamento de Boleto solicitada.\n* `payment.bank_billet.sync.confirmed` Sincronização do Pagamento de Boleto confirmada.\n* `payment.bank_billet.sync.failed` Falha na sincronização do Pagamento de Boleto.\n* `payment.bank_billet.sync.error` Ocorreu um erro na sincronização do Pagamento de Boleto.\n* `payment.darf.register.requested` Pagamento de DARF solicitado.\n* `payment.darf.register.confirmed` Pagamento de DARF confirmado.\n* `payment.darf.register.failed` Falha no envio do Pagamento de DARF.\n* `payment.darf.register.error` Ocorreu um erro no envio de Pagamento de DARF.\n* `payment.darf.approve.requested` Liberação de Pagamento de DARF solicitada.\n* `payment.darf.approve.confirmed` Liberação de Pagamento de DARF confirmada.\n* `payment.darf.approve.failed` Falha na liberação de Pagamento de DARF.\n* `payment.darf.approve.error` Ocorreu um erro na liberação de Pagamento de DARF.\n* `payment.darf.reprove.requested` Rejeição de Pagamento de DARF solicitada.\n* `payment.darf.reprove.confirmed` Rejeição de Pagamento de DARF confirmada.\n* `payment.darf.reprove.failed` Falha na rejeição de Pagamento de DARF.\n* `payment.darf.reprove.error` Ocorreu um erro na rejeição de Pagamento de DARF.\n* `payment.darf.reschedule.requested` Reagendamento de Pagamento de DARF solicitado.\n* `payment.darf.reschedule.confirmed` Reagendamento de Pagamento de DARF confirmado.\n* `payment.darf.reschedule.failed` Falha no Reagendamento de Pagamento de DARF.\n* `payment.darf.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de DARF.\n* `payment.darf.cancel.requested` Cancelamento de Pagamento de DARF solicitado.\n* `payment.darf.cancel.confirmed` Cancelamento de Pagamento de DARF confirmada.\n* `payment.darf.cancel.failed` Falha no cancelamento de Pagamento de DARF.\n* `payment.darf.cancel.error` Ocorreu um erro no cancelamento de Pagamento de DARF.\n* `payment.darf.get.requested` Informação do Pagamento de DARF solicitada.\n* `payment.darf.get.confirmed` Informação do Pagamento de DARF confirmada.\n* `payment.darf.get.failed` Falha na informação do Pagamento de DARF.\n* `payment.darf.get.error` Ocorreu um erro na informação do Pagamento de DARF.\n* `payment.darf.sync.requested` Sincronização do Pagamento de DARF solicitada.\n* `payment.darf.sync.confirmed` Sincronização do Pagamento de DARF confirmada.\n* `payment.darf.sync.failed` Falha na sincronização do Pagamento de DARF.\n* `payment.darf.sync.error` Ocorreu um erro na sincronização do Pagamento de DARF.\n* `payment.utility.register.requested` Pagamento de Conta de Consumo solicitado.\n* `payment.utility.register.confirmed` Pagamento de Conta de Consumo confirmado.\n* `payment.utility.register.failed` Falha no envio do Pagamento de Conta de Consumo.\n* `payment.utility.register.error` Ocorreu um erro no envio de Pagamento de Conta de Consumo.\n* `payment.utility.approve.requested` Liberação de Pagamento de Conta de Consumo solicitada.\n* `payment.utility.approve.confirmed` Liberação de Pagamento de Conta de Consumo confirmada.\n* `payment.utility.approve.failed` Falha na liberação de Pagamento de Conta de Consumo.\n* `payment.utility.approve.error` Ocorreu um erro na liberação de Pagamento de Conta de Consumo.\n* `payment.utility.reprove.requested` Rejeição de Pagamento de Conta de Consumo solicitada.\n* `payment.utility.reprove.confirmed` Rejeição de Pagamento de Conta de Consumo confirmada.\n* `payment.utility.reprove.failed` Falha na rejeição de Pagamento de Conta de Consumo.\n* `payment.utility.reprove.error` Ocorreu um erro na rejeição de Pagamento de Conta de Consumo.\n* `payment.utility.reschedule.requested` Reagendamento de Pagamento de Conta de Consumo solicitado.\n* `payment.utility.reschedule.confirmed` Reagendamento de Pagamento de Conta de Consumo confirmado.\n* `payment.utility.reschedule.failed` Falha no Reagendamento de Pagamento de Conta de Consumo.\n* `payment.utility.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Conta de Consumo.\n* `payment.utility.cancel.requested` Cancelamento de Pagamento de Conta de Consumo solicitado.\n* `payment.utility.cancel.confirmed` Cancelamento de Pagamento de Conta de Consumo confirmada.\n* `payment.utility.cancel.failed` Falha no cancelamento de Pagamento de Conta de Consumo.\n* `payment.utility.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Conta de Consumo.\n* `payment.utility.get.requested` Informação do Pagamento de Conta de Consumo solicitada.\n* `payment.utility.get.confirmed` Informação do Pagamento de Conta de Consumo confirmada.\n* `payment.utility.get.failed` Falha na informação do Pagamento de Conta de Consumo.\n* `payment.utility.get.error` Ocorreu um erro na informação do Pagamento de Conta de Consumo.\n* `payment.utility.sync.requested` Sincronização do Pagamento de Conta de Consumo solicitada.\n* `payment.utility.sync.confirmed` Sincronização do Pagamento de Conta de Consumo confirmada.\n* `payment.utility.sync.failed` Falha na sincronização do Pagamento de Conta de Consumo.\n* `payment.utility.sync.error` Ocorreu um erro na sincronização do Pagamento de Conta de Consumo.\n* `payment.gru.register.requested` Pagamento de GRU solicitado.\n* `payment.gru.register.confirmed` Pagamento de GRU confirmado.\n* `payment.gru.register.failed` Falha no envio do Pagamento de GRU.\n* `payment.gru.register.error` Ocorreu um erro no envio de Pagamento de GRU.\n* `payment.gru.approve.requested` Liberação de Pagamento de GRU solicitada.\n* `payment.gru.approve.confirmed` Liberação de Pagamento de GRU confirmada.\n* `payment.gru.approve.failed` Falha na liberação de Pagamento de GRU.\n* `payment.gru.approve.error` Ocorreu um erro na liberação de Pagamento de GRU.\n* `payment.gru.reprove.requested` Rejeição de Pagamento de GRU solicitada.\n* `payment.gru.reprove.confirmed` Rejeição de Pagamento de GRU confirmada.\n* `payment.gru.reprove.failed` Falha na rejeição de Pagamento de GRU.\n* `payment.gru.reprove.error` Ocorreu um erro na rejeição de Pagamento de GRU.\n* `payment.gru.reschedule.requested` Reagendamento de Pagamento de GRU solicitado.\n* `payment.gru.reschedule.confirmed` Reagendamento de Pagamento de GRU confirmado.\n* `payment.gru.reschedule.failed` Falha no Reagendamento de Pagamento de GRU.\n* `payment.gru.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de GRU.\n* `payment.gru.cancel.requested` Cancelamento de Pagamento de GRU solicitado.\n* `payment.gru.cancel.confirmed` Cancelamento de Pagamento de GRU confirmada.\n* `payment.gru.cancel.failed` Falha no cancelamento de Pagamento de GRU.\n* `payment.gru.cancel.error` Ocorreu um erro no cancelamento de Pagamento de GRU.\n* `payment.gru.get.requested` Informação do Pagamento de GRU solicitada.\n* `payment.gru.get.confirmed` Informação do Pagamento de GRU confirmada.\n* `payment.gru.get.failed` Falha na informação do Pagamento de GRU.\n* `payment.gru.get.error` Ocorreu um erro na informação do Pagamento de GRU.\n* `payment.gru.sync.requested` Sincronização do Pagamento de GRU solicitada.\n* `payment.gru.sync.confirmed` Sincronização do Pagamento de GRU confirmada.\n* `payment.gru.sync.failed` Falha na sincronização do Pagamento de GRU.\n* `payment.gru.sync.error` Ocorreu um erro na sincronização do Pagamento de GRU.\n* `payment.pix.register.requested` Pagamento de Pix solicitado.\n* `payment.pix.register.confirmed` Pagamento de Pix confirmado.\n* `payment.pix.register.failed` Falha no envio do Pagamento de Pix.\n* `payment.pix.register.error` Ocorreu um erro no envio de Pagamento de Pix.\n* `payment.pix.approve.requested` Liberação de Pagamento de Pix solicitada.\n* `payment.pix.approve.confirmed` Liberação de Pagamento de Pix confirmada.\n* `payment.pix.approve.failed` Falha na liberação de Pagamento de Pix.\n* `payment.pix.approve.error` Ocorreu um erro na liberação de Pagamento de Pix.\n* `payment.pix.reprove.requested` Rejeição de Pagamento de Pix solicitada.\n* `payment.pix.reprove.confirmed` Rejeição de Pagamento de Pix confirmada.\n* `payment.pix.reprove.failed` Falha na rejeição de Pagamento de Pix.\n* `payment.pix.reprove.error` Ocorreu um erro na rejeição de Pagamento de Pix.\n* `payment.pix.reschedule.requested` Reagendamento de Pagamento de Pix solicitado.\n* `payment.pix.reschedule.confirmed` Reagendamento de Pagamento de Pix confirmado.\n* `payment.pix.reschedule.failed` Falha no Reagendamento de Pagamento de Pix.\n* `payment.pix.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Pix.\n* `payment.pix.cancel.requested` Cancelamento de Pagamento de Pix solicitado.\n* `payment.pix.cancel.confirmed` Cancelamento de Pagamento de Pix confirmada.\n* `payment.pix.cancel.failed` Falha no cancelamento de Pagamento de Pix.\n* `payment.pix.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Pix.\n* `payment.pix.get.requested` Informação do Pagamento de Pix solicitada.\n* `payment.pix.get.confirmed` Informação do Pagamento de Pix confirmada.\n* `payment.pix.get.failed` Falha na informação do Pagamento de Pix.\n* `payment.pix.get.error` Ocorreu um erro na informação do Pagamento de Pix.\n* `payment.pix.sync.requested` Sincronização do Pagamento de Pix solicitada.\n* `payment.pix.sync.confirmed` Sincronização do Pagamento de Pix confirmada.\n* `payment.pix.sync.failed` Falha na sincronização do Pagamento de Pix.\n* `payment.pix.sync.error` Ocorreu um erro na sincronização do Pagamento de Pix.\n* `payment.tax.register.requested` Pagamento de Tributo solicitado.\n* `payment.tax.register.confirmed` Pagamento de Tributo confirmado.\n* `payment.tax.register.failed` Falha no envio do Pagamento de Tributo.\n* `payment.tax.register.error` Ocorreu um erro no envio de Pagamento de Tributo.\n* `payment.tax.approve.requested` Liberação de Pagamento de Tributo solicitada.\n* `payment.tax.approve.confirmed` Liberação de Pagamento de Tributo confirmada.\n* `payment.tax.approve.failed` Falha na liberação de Pagamento de Tributo.\n* `payment.tax.approve.error` Ocorreu um erro na liberação de Pagamento de Tributo.\n* `payment.tax.reprove.requested` Rejeição de Pagamento de Tributo solicitada.\n* `payment.tax.reprove.confirmed` Rejeição de Pagamento de Tributo confirmada.\n* `payment.tax.reprove.failed` Falha na rejeição de Pagamento de Tributo.\n* `payment.tax.reprove.error` Ocorreu um erro na rejeição de Pagamento de Tributo.\n* `payment.tax.reschedule.requested` Reagendamento de Pagamento de Tributo solicitado.\n* `payment.tax.reschedule.confirmed` Reagendamento de Pagamento de Tributo confirmado.\n* `payment.tax.reschedule.failed` Falha no Reagendamento de Pagamento de Tributo.\n* `payment.tax.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Tributo.\n* `payment.tax.cancel.requested` Cancelamento de Pagamento de Tributo solicitado.\n* `payment.tax.cancel.confirmed` Cancelamento de Pagamento de Tributo confirmada.\n* `payment.tax.cancel.failed` Falha no cancelamento de Pagamento de Tributo.\n* `payment.tax.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Tributo.\n* `payment.tax.get.requested` Informação do Pagamento de Tributo solicitada.\n* `payment.tax.get.confirmed` Informação do Pagamento de Tributo confirmada.\n* `payment.tax.get.failed` Falha na informação do Pagamento de Tributo.\n* `payment.tax.get.error` Ocorreu um erro na informação do Pagamento de Tributo.\n* `payment.tax.sync.requested` Sincronização do Pagamento de Tributo solicitada.\n* `payment.tax.sync.confirmed` Sincronização do Pagamento de Tributo confirmada.\n* `payment.tax.sync.failed` Falha na sincronização do Pagamento de Tributo.\n* `payment.tax.sync.error` Ocorreu um erro na sincronização do Pagamento de Tributo.\n* `payment.batch.db.created` Lote de Pagamento criado.\n* `payment.batch.db.updated` Lote de Pagamento atualizado.\n* `payment.batch.db.deleted` Lote de Pagamento excluído.\n* `payment.batch.awaiting_approval` Lote de pagamento aguardando liberação.\n* `payment.bank_billet_batch.awaiting_approval` Lote de Pagamento de Boleto aguardando liberação.\n* `payment.bank_billet_batch.get.requested` Informação do Lote de Pagamento de Boleto solicitada.\n* `payment.bank_billet_batch.get.confirmed` Informação do Lote de Pagamento de Boleto confirmada.\n* `payment.bank_billet_batch.get.failed` Falha na informação do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.sync.requested` Sincronização de Lote de Pagamento de Boleto solicitada.\n* `payment.bank_billet_batch.sync.confirmed` Sincronização de Lote de Pagamento de Boleto confirmada.\n* `payment.bank_billet_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.register.requested` Lote de Pagamento de Boleto solicitado.\n* `payment.bank_billet_batch.register.confirmed` Lote de Pagamento de Boleto confirmado.\n* `payment.bank_billet_batch.register.failed` Falha no envio do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.approve.requested` Liberação de Lote de Pagamento de Boleto solicitado.\n* `payment.bank_billet_batch.approve.confirmed` Liberação de Lote de Pagamento de Boleto confirmado.\n* `payment.bank_billet_batch.approve.failed` Falha na liberação de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.reprove.requested` Rejeição de Lote de Pagamento de Boleto solicitado.\n* `payment.bank_billet_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Boleto confirmado.\n* `payment.bank_billet_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.bank_billet_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.bank_billet_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.bank_billet_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.darf_batch.awaiting_approval` Lote de Pagamento de DARF aguardando liberação.\n* `payment.darf_batch.get.requested` Informação do Lote de Pagamento de DARF solicitada.\n* `payment.darf_batch.get.confirmed` Informação do Lote de Pagamento de DARF confirmada.\n* `payment.darf_batch.get.failed` Falha na informação do Lote de Pagamento de DARF.\n* `payment.darf_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de DARF.\n* `payment.darf_batch.sync.requested` Sincronização de Lote de Pagamento de DARF solicitada.\n* `payment.darf_batch.sync.confirmed` Sincronização de Lote de Pagamento de DARF confirmada.\n* `payment.darf_batch.sync.failed` Falha na sincronização de Lote de Pagamento de DARF.\n* `payment.darf_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de DARF.\n* `payment.darf_batch.register.requested` Lote de Pagamento de DARF solicitado.\n* `payment.darf_batch.register.confirmed` Lote de Pagamento de DARF confirmado.\n* `payment.darf_batch.register.failed` Falha no envio do Lote de Pagamento de DARF.\n* `payment.darf_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de DARF.\n* `payment.darf_batch.approve.requested` Liberação de Lote de Pagamento de DARF solicitado.\n* `payment.darf_batch.approve.confirmed` Liberação de Lote de Pagamento de DARF confirmado.\n* `payment.darf_batch.approve.failed` Falha na liberação de Lote de Pagamento de DARF.\n* `payment.darf_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de DARF.\n* `payment.darf_batch.reprove.requested` Rejeição de Lote de Pagamento de DARF solicitado.\n* `payment.darf_batch.reprove.confirmed` Rejeição de Lote de Pagamento de DARF confirmado.\n* `payment.darf_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de DARF.\n* `payment.darf_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de DARF.\n* `payment.darf_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.darf_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.darf_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.darf_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.utility_batch.awaiting_approval` Lote de Pagamento de Conta de Consumo aguardando liberação.\n* `payment.utility_batch.get.requested` Informação do Lote de Pagamento de Conta de Consumo solicitada.\n* `payment.utility_batch.get.confirmed` Informação do Lote de Pagamento de Conta de Consumo confirmada.\n* `payment.utility_batch.get.failed` Falha na informação do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.sync.requested` Sincronização de Lote de Pagamento de Conta de Consumo solicitada.\n* `payment.utility_batch.sync.confirmed` Sincronização de Lote de Pagamento de Conta de Consumo confirmada.\n* `payment.utility_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.register.requested` Lote de Pagamento de Conta de Consumo solicitado.\n* `payment.utility_batch.register.confirmed` Lote de Pagamento de Conta de Consumo confirmado.\n* `payment.utility_batch.register.failed` Falha no envio do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.approve.requested` Liberação de Lote de Pagamento de Conta de Consumo solicitado.\n* `payment.utility_batch.approve.confirmed` Liberação de Lote de Pagamento de Conta de Consumo confirmado.\n* `payment.utility_batch.approve.failed` Falha na liberação de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.reprove.requested` Rejeição de Lote de Pagamento de Conta de Consumo solicitado.\n* `payment.utility_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Conta de Consumo confirmado.\n* `payment.utility_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.utility_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.utility_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.utility_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.gru_batch.awaiting_approval` Lote de Pagamento de GRU aguardando liberação.\n* `payment.gru_batch.get.requested` Informação do Lote de Pagamento de GRU solicitada.\n* `payment.gru_batch.get.confirmed` Informação do Lote de Pagamento de GRU confirmada.\n* `payment.gru_batch.get.failed` Falha na informação do Lote de Pagamento de GRU.\n* `payment.gru_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de GRU.\n* `payment.gru_batch.sync.requested` Sincronização de Lote de Pagamento de GRU solicitada.\n* `payment.gru_batch.sync.confirmed` Sincronização de Lote de Pagamento de GRU confirmada.\n* `payment.gru_batch.sync.failed` Falha na sincronização de Lote de Pagamento de GRU.\n* `payment.gru_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de GRU.\n* `payment.gru_batch.register.requested` Lote de Pagamento de GRU solicitado.\n* `payment.gru_batch.register.confirmed` Lote de Pagamento de GRU confirmado.\n* `payment.gru_batch.register.failed` Falha no envio do Lote de Pagamento de GRU.\n* `payment.gru_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de GRU.\n* `payment.gru_batch.approve.requested` Liberação de Lote de Pagamento de GRU solicitado.\n* `payment.gru_batch.approve.confirmed` Liberação de Lote de Pagamento de GRU confirmado.\n* `payment.gru_batch.approve.failed` Falha na liberação de Lote de Pagamento de GRU.\n* `payment.gru_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de GRU.\n* `payment.gru_batch.reprove.requested` Rejeição de Lote de Pagamento de GRU solicitado.\n* `payment.gru_batch.reprove.confirmed` Rejeição de Lote de Pagamento de GRU confirmado.\n* `payment.gru_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de GRU.\n* `payment.gru_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de GRU.\n* `payment.gru_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.gru_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.gru_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.gru_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.pix_batch.awaiting_approval` Lote de Pagamento de Pix aguardando liberação.\n* `payment.pix_batch.get.requested` Informação do Lote de Pagamento de Pix solicitada.\n* `payment.pix_batch.get.confirmed` Informação do Lote de Pagamento de Pix confirmada.\n* `payment.pix_batch.get.failed` Falha na informação do Lote de Pagamento de Pix.\n* `payment.pix_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Pix.\n* `payment.pix_batch.sync.requested` Sincronização de Lote de Pagamento de Pix solicitada.\n* `payment.pix_batch.sync.confirmed` Sincronização de Lote de Pagamento de Pix confirmada.\n* `payment.pix_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Pix.\n* `payment.pix_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Pix.\n* `payment.pix_batch.register.requested` Lote de Pagamento de Pix solicitado.\n* `payment.pix_batch.register.confirmed` Lote de Pagamento de Pix confirmado.\n* `payment.pix_batch.register.failed` Falha no envio do Lote de Pagamento de Pix.\n* `payment.pix_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Pix.\n* `payment.pix_batch.approve.requested` Liberação de Lote de Pagamento de Pix solicitado.\n* `payment.pix_batch.approve.confirmed` Liberação de Lote de Pagamento de Pix confirmado.\n* `payment.pix_batch.approve.failed` Falha na liberação de Lote de Pagamento de Pix.\n* `payment.pix_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Pix.\n* `payment.pix_batch.reprove.requested` Rejeição de Lote de Pagamento de Pix solicitado.\n* `payment.pix_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Pix confirmado.\n* `payment.pix_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Pix.\n* `payment.pix_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Pix.\n* `payment.pix_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.pix_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.pix_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.pix_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.tax_batch.awaiting_approval` Lote de Pagamento de Tributo aguardando liberação.\n* `payment.tax_batch.get.requested` Informação do Lote de Pagamento de Tributo solicitada.\n* `payment.tax_batch.get.confirmed` Informação do Lote de Pagamento de Tributo confirmada.\n* `payment.tax_batch.get.failed` Falha na informação do Lote de Pagamento de Tributo.\n* `payment.tax_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Tributo.\n* `payment.tax_batch.sync.requested` Sincronização de Lote de Pagamento de Tributo solicitada.\n* `payment.tax_batch.sync.confirmed` Sincronização de Lote de Pagamento de Tributo confirmada.\n* `payment.tax_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Tributo.\n* `payment.tax_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Tributo.\n* `payment.tax_batch.register.requested` Lote de Pagamento de Tributo solicitado.\n* `payment.tax_batch.register.confirmed` Lote de Pagamento de Tributo confirmado.\n* `payment.tax_batch.register.failed` Falha no envio do Lote de Pagamento de Tributo.\n* `payment.tax_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Tributo.\n* `payment.tax_batch.approve.requested` Liberação de Lote de Pagamento de Tributo solicitado.\n* `payment.tax_batch.approve.confirmed` Liberação de Lote de Pagamento de Tributo confirmado.\n* `payment.tax_batch.approve.failed` Falha na liberação de Lote de Pagamento de Tributo.\n* `payment.tax_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Tributo.\n* `payment.tax_batch.reprove.requested` Rejeição de Lote de Pagamento de Tributo solicitado.\n* `payment.tax_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Tributo confirmado.\n* `payment.tax_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Tributo.\n* `payment.tax_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Tributo.\n* `payment.tax_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.tax_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.tax_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.tax_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.dda.account.db.created` Conta de DDA criada\n* `payment.dda.account.register.requested` Conta de DDA solicitada.\n* `payment.dda.account.register.failed` Falha na criação da conta DDA.\n* `payment.dda.account.register.error` Ocorreu um erro no registro da conta DDA.\n* `payment.dda.account.register.confirmed` Conta de DDA confirmada.\n* `payment.dda.account.bank_billets_sync.requested` Sincronização de Boletos solicitada.\n* `payment.dda.account.bank_billets_sync.failed` Falha na sincronização de Boleto.\n* `payment.dda.account.bank_billets_sync.error` Ocorreu um erro na sincronização de Boletos.\n* `payment.dda.account.bank_billets_sync.confirmed` Sincronização de Boletos confirmada.\n* `payment.dda.account.unregister.requested` Descadastramento da conta DDA solicitado.\n* `payment.dda.account.unregister.failed` Falha no descadastramento da conta DDA.\n* `payment.dda.account.unregister.error` Ocorreu um erro no descadastramento da conta DDA.\n* `payment.dda.account.unregister.confirmed` Descadastramento da conta DDA confirmado.\n* `payment.dda.bank_billet.db.created` Boleto DDA criado\n* `payment.dda.bank_billet.db.updated` Boleto DDA atualizado.\n* `payment.dda.bank_billet.external_status_changed` Status externo do Boleto DDA alterado.\n* `payment.dda.bank_billet.get.requested` Informação do Boleto solicitada.\n* `payment.dda.bank_billet.get.confirmed` Informação do Boleto confirmada.\n* `payment.dda.bank_billet.get.failed` Falha na informação do Boleto.\n* `payment.dda.bank_billet.get.error` Ocorreu um erro na informação do Boleto.\n* `payment.dda.bank_billet.sync.requested` Sincronização do Boleto solicitada.\n* `payment.dda.bank_billet.sync.confirmed` Sincronização do Boleto confirmada.\n* `payment.dda.bank_billet.sync.failed` Falha na sincronização do Boleto.\n* `payment.dda.bank_billet.sync.error` Ocorreu um erro na sincronização do Boleto.\n* `payment.dda.account.db.updated` Conta de DDA atualizada.\n* `payment.dda.account.db.deleted` Conta de DDA excluída.\n* `payment.dda.account.letter.pending` Carta DDA gerada.\n* `payment.dda.account.letter.waiting_signatures` Carta DDA aguardando assinaturas.\n* `payment.dda.account.letter.signed` Carta DDA assinada.\n* `payment.dda.account.letter.failed` Falha no processo de assinatura da carta DDA.\n* `payment.dda.account.confirmed` Assinatura da conta DDA aprovada.\n* `payment.dda.account.rejected` Assinatura da conta DDA rejeitada.\n* `payment.dda.account.failed` Falha na conta DDA.\n* `payment.dda.account.disabled` Conta DDA desabilitada.\n* `payment.dda.account.enabled` Conta DDA reabilitada.\n* `credit.restriction.add.requested` Inclusão da restrição de crédito solicitada.\n* `credit.restriction.add.failed` Falha na inclusão da restrição de crédito.\n* `credit.restriction.add.error` Ocorreu um erro na inclusão da restrição de crédito.\n* `credit.restriction.add.confirmed` Inclusão da restrição de crédito confirmada.\n* `credit.restriction.remove.requested` Remoção da restrição de crédito solicitada.\n* `credit.restriction.remove.confirmed` Remoção da restrição de crédito confirmada.\n* `credit.restriction.remove.failed` Falha na remoção da restrição de crédito.\n* `credit.restriction.remove.error` Ocorreu um erro na remoção da restrição de crédito.\n* `charge.automatic_pix.account.db.created` Conta de Pix Automático criada.\n* `charge.automatic_pix.account.db.updated` Conta de Pix Automático atualizada.\n* `charge.automatic_pix.account.db.deleted` Conta de Pix Automático excluída.\n* `charge.automatic_pix.recurrence.db.created` Recorrência de Pix Automático criada.\n* `charge.automatic_pix.recurrence.db.updated` Recorrência de Pix Automático atualizada.\n* `charge.automatic_pix.recurrence.db.deleted` Recorrência de Pix Automático excluída.\n* `charge.automatic_pix.recurrence.cancel.requested` Cancelamento da Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.recurrence.cancel.confirmed` Cancelamento da Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.recurrence.cancel.failed` Falha no cancelamento da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.cancel.error` Ocorreu um erro no cancelamento da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.register.requested` Registro da Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.recurrence.register.confirmed` Registro da Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.recurrence.register.failed` Falha no registro da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.register.error` Ocorreu um erro no registro da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.update.requested` Atualização da Recorrência de Pix Automático solicitada.\n* `charge.automatic_pix.recurrence.update.confirmed` Atualização da Recorrência de Pix Automático confirmada.\n* `charge.automatic_pix.recurrence.update.failed` Falha na atualização da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.update.error` Ocorreu um erro na atualização da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.pending` Recorrência de Pix Automático pendente.\n* `charge.automatic_pix.recurrence.created` Recorrência de Pix Automático criada no provedor financeiro.\n* `charge.automatic_pix.recurrence.approved` Recorrência de Pix Automático aprovada.\n* `charge.automatic_pix.recurrence.rejected` Recorrência de Pix Automático rejeitada.\n* `charge.automatic_pix.recurrence.expired` Recorrência de Pix Automático expirada.\n* `charge.automatic_pix.recurrence.canceled` Recorrência de Pix Automático cancelada.\n* `charge.automatic_pix.request.db.created` Solicitações de Recorrência de Pix Automático criada.\n* `charge.automatic_pix.request.db.updated` Solicitações de Recorrência de Pix Automático atualizada.\n* `charge.automatic_pix.request.db.deleted` Solicitações de Recorrência de Pix Automático excluída.\n* `charge.automatic_pix.request.cancel.requested` Cancelamento da Solicitação de Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.request.cancel.confirmed` Cancelamento da Solicitação de Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.request.cancel.failed` Falha no cancelamento da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.cancel.error` Ocorreu um erro no cancelamento da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.register.requested` Registro da Solicitação de Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.request.register.confirmed` Registro da Solicitação de Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.request.register.failed` Falha no registro da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.register.error` Ocorreu um erro no registro da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.pending` Solicitação de Recorrência de Pix Automático pendente.\n* `charge.automatic_pix.request.created` Solicitação de Recorrência de Pix Automático criada no provedor financeiro.\n* `charge.automatic_pix.request.sent` Solicitação de Recorrência de Pix Automático enviada ao pagador.\n* `charge.automatic_pix.request.received` Solicitação de Recorrência de Pix Automático recebida pelo pagador.\n* `charge.automatic_pix.request.rejected` Solicitação de Recorrência de Pix Automático rejeitada.\n* `charge.automatic_pix.request.accepted` Solicitação de Recorrência de Pix Automático aceita.\n* `charge.automatic_pix.request.expired` Solicitação de Recorrência de Pix Automático expirada.\n* `charge.automatic_pix.request.canceled` Solicitação de Recorrência de Pix Automático cancelada.\n* `charge.automatic_pix.pix.db.created` Cobrança de Pix Automático criada.\n* `charge.automatic_pix.pix.db.updated` Cobrança de Pix Automático atualizada.\n* `charge.automatic_pix.pix.db.deleted` Cobrança de Pix Automático excluída.\n* `charge.automatic_pix.pix.cancel.requested` Cancelamento da Cobrança de Pix Automático solicitado.\n* `charge.automatic_pix.pix.cancel.confirmed` Cancelamento da Cobrança de Pix Automático confirmado.\n* `charge.automatic_pix.pix.cancel.failed` Falha no cancelamento da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.cancel.error` Ocorreu um erro no cancelamento da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.register.requested` Registro da Cobrança de Pix Automático solicitado.\n* `charge.automatic_pix.pix.register.confirmed` Registro da Cobrança de Pix Automático confirmado.\n* `charge.automatic_pix.pix.register.failed` Falha no registro da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.register.error` Ocorreu um erro no registro da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.update.requested` Atualização da Cobrança de Pix Automático solicitada.\n* `charge.automatic_pix.pix.update.confirmed` Atualização da Cobrança de Pix Automático confirmada.\n* `charge.automatic_pix.pix.update.failed` Falha na atualização da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.update.error` Ocorreu um erro na atualização da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.pending` Cobrança de Pix Automático pendente.\n* `charge.automatic_pix.pix.created` Cobrança de Pix Automático criada no provedor financeiro.\n* `charge.automatic_pix.pix.active` Cobrança de Pix Automático ativa.\n* `charge.automatic_pix.pix.paid` Cobrança de Pix Automático paga.\n* `charge.automatic_pix.pix.expired` Cobrança de Pix Automático expirada.\n* `charge.automatic_pix.pix.rejected` Cobrança de Pix Automático rejeitada.\n* `charge.automatic_pix.pix.canceled` Cobrança de Pix Automático cancelada.\n* `charge.automatic_pix.location.db.created` Localização de Pix Automático criada.\n* `charge.automatic_pix.location.db.updated` Localização de Pix Automático atualizada.\n* `charge.automatic_pix.location.db.deleted` Localização de Pix Automático excluída.\n* `charge.automatic_pix.location.register.requested` Registro da Localização de Pix Automático solicitado.\n* `charge.automatic_pix.location.register.confirmed` Registro da Localização de Pix Automático confirmado.\n* `charge.automatic_pix.location.register.failed` Falha no registro da Localização de Pix Automático.\n* `charge.automatic_pix.location.register.error` Ocorreu um erro no registro da Localização de Pix Automático.\n* `charge.payment.db.created` Recebimento de cobrança criado.\n* `charge.payment.db.updated` Recebimento de cobrança atualizado.\n* `charge.payment.db.deleted` Recebimento de cobrança excluído.\n* `charge.payment.notified` Recebimento notificado.\n* `charge.payment.canceled` Recebimento cancelado.\n* `charge.payment.confirmed` Recebimento confirmado.\n* `charge.payment.duplicated` Recebimento duplicado.\n* `charge.bank_billet.payment.notified` Baixa operacional de boleto notificada.\n* `charge.bank_billet.payment.canceled` Baixa operacional de boleto cancelada.\n* `charge.bank_billet.payment.confirmed` Baixa operacional de boleto liquidada.\n* `data.bank_billet_query.success` Consulta de boleto realizada com sucesso.\n* `data.bank_billet_query.error` Consulta de boleto com erro.\n* `data.bank_billet_query.db.created` Consulta de boleto criada.\n* `data.bank_billet_query.db.updated` Consulta de boleto atualizada.\n* `data.bank_billet_query.db.deleted` Consulta de boleto excluída.\n* `data.pix_qrcode_query.success` Consulta de Pix via QR Code realizada com sucesso.\n* `data.pix_qrcode_query.error` Consulta de Pix via QR Code com erro.\n* `data.pix_qrcode_query.db.created` Consulta de Pix via QR Code criada.\n* `data.pix_qrcode_query.db.updated` Consulta de Pix via QR Code atualizada.\n* `data.pix_qrcode_query.db.deleted` Consulta de Pix via QR Code excluída.\n* `mailbox.entry.db.created` Caixa Postal criado.\n* `mailbox.entry.db.updated` Caixa Postal atualizado.\n* `mailbox.entry.db.deleted` Caixa Postal excluída.\n* `mailbox.entry.file.received` Arquivo recebido na caixa de entrada.\n* `mailbox.entry.file.sent` Arquivo enviado para a caixa de saída.\n* `mailbox.file.db.created` Arquivo criado.\n* `mailbox.file.db.updated` Arquivo atualizado.\n* `mailbox.file.db.deleted` Arquivo excluído.\n* `mailbox.channel.s3.db.created` Canal S3 criado.\n* `mailbox.channel.s3.db.updated` Canal S3 atualizado.\n* `mailbox.channel.s3.db.deleted` Canal S3 excluído.\n* `mailbox.channel.s3.fetch_all` Arquivo obtido do canal S3.\n* `mailbox.channel.email.db.created` Canal de Email criado.\n* `mailbox.channel.email.db.updated` Canal de Email atualizado.\n* `mailbox.channel.email.db.deleted` Canal de Email excluído.\n* `mailbox.channel.whatsapp.db.created` Canal WhatsApp criado.\n* `mailbox.channel.whatsapp.db.updated` Canal WhatsApp atualizado.\n* `mailbox.channel.whatsapp.db.deleted` Canal WhatsApp excluído.\n* `mailbox.channel.sftp.db.created` Canal SFTP criado.\n* `mailbox.channel.sftp.db.updated` Canal SFTP atualizado.\n* `mailbox.channel.sftp.db.deleted` Canal SFTP excluído.\n* `mailbox.channel.sftp.fetch_all` Arquivo obtido do canal SFTP.\n* `mailbox.channel.syncthing.db.created` Canal Syncthing criado.\n* `mailbox.channel.syncthing.db.updated` Canal Syncthing atualizado.\n* `mailbox.channel.syncthing.db.deleted` Canal Syncthing excluído.\n* `email_account.db.created` Conta de e-mail criada.\n* `email_account.db.updated` Conta de e-mail atualizada.\n* `email_account.db.deleted` Conta de e-mail excluída.\n* `email_account.identity.pending` Aguardando identidade\n* `email_account.identity.created` Identidade criada\n* `email_account.identity.error` Identidade já existente\n* `email_account.identity.failure` Falha da identidade\n* `email_account.dns.not_ready` DNS não pronto\n* `email_account.dns.awaiting` Aguardando validação DNS\n* `email_account.dns.validated` DNS validado\n* `email_account.dns.error` Falha na validação do DNS\n* `email_account.dns.failure` Falha na tentativa do DNS\n* `integration.connection.db.created` Conexão criada.\n* `integration.connection.db.updated` Conexão atualizada.\n* `integration.connection.db.deleted` Conexão excluída.\n* `webhook.db.created` Webhook criado.\n* `webhook.db.updated` Webhook atualizado.\n* `webhook.db.deleted` Webhook excluído.\n* `enotas.nfe.generated` Enotas: nota fiscal gerada" }, "status": { "type": "integer", "nullable": true, "description": "Situação:\n* `0` Pendente\n* `1` Entregue\n* `2` Falhou", "enum": [ "0", "1", "2" ] }, "created_from": { "type": "string", "format": "date", "nullable": true, "description": "A partir da Data de criação (DD/MM/YYYY) ou (YYYY-MM-DD)", "example": "2020-01-01" }, "created_to": { "type": "string", "format": "date", "nullable": true, "description": "Até a Data de criação (DD/MM/YYYY) ou (YYYY-MM-DD)", "example": "2020-01-01" } } }, "v1_webhook_object": { "type": "object", "required": [ "url", "events" ], "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do webhook" }, "name": { "type": "string", "maxLength": 255, "nullable": true, "description": "Nome de identificação do webhook" }, "url": { "type": "string", "maxLength": 255, "description": "Endereço onde as requisições serão realizadas" }, "content_type": { "type": "string", "maxLength": 255, "nullable": true, "description": "Content-type da requisição que será realizada. Valores válidos `application/json` (valor padrão) ou `application/x-www-form-urlencoded`." }, "events": { "type": "array", "description": "Eventos que devem gerar notificações para o webhook. Escolha um ou mais eventos.", "items": { "type": "string", "enum": [ "ping", "access_token.db.created", "access_token.db.updated", "access_token.db.deleted", "access_token.reminder", "access_token.expired", "account.updated", "account.blocked", "account.bank_billet_creation_blocked", "bank_billet.created", "bank_billet.updated", "bank_billet.generated", "bank_billet.canceled", "bank_billet.blocked", "bank_billet.overdue", "bank_billet.paid", "bank_billet.due_date", "bank_billet.rejected", "bank_billet.cancel.requested", "bank_billet.cancel.confirmed", "bank_billet.cancel.failed", "bank_billet.cancel.error", "bank_billet.register.requested", "bank_billet.register.confirmed", "bank_billet.register.failed", "bank_billet.register.error", "bank_billet.update.requested", "bank_billet.update.confirmed", "bank_billet.update.failed", "bank_billet.update.error", "bank_billet.registered", "bank_billet.deleted", "bank_billet.sync.requested", "bank_billet.sync.confirmed", "bank_billet.sync.failed", "bank_billet.sync.error", "bank_billet.get.requested", "bank_billet.get.confirmed", "bank_billet.get.failed", "bank_billet.get.error", "bank_billet.get_child.requested", "bank_billet.get_child.confirmed", "bank_billet.get_child.failed", "bank_billet.get_child.error", "bank_billet.find.requested", "bank_billet.find.confirmed", "bank_billet.find.failed", "bank_billet.find.error", "bank_billet.add_pix.requested", "bank_billet.add_pix.confirmed", "bank_billet.add_pix.failed", "bank_billet.add_pix.error", "bank_billet.get_pix.requested", "bank_billet.get_pix.confirmed", "bank_billet.get_pix.failed", "bank_billet.get_pix.error", "bank_billet.protest.requested", "bank_billet.protest.confirmed", "bank_billet.protest.failed", "bank_billet.protest.error", "bank_billet_discharge.created", "bank_billet_discharge.updated", "bank_billet_discharge.deleted", "bank_billet_remittance.created", "bank_billet_remittance.updated", "bank_billet_remittance.deleted", "bank_billet_registration.created", "bank_billet_registration.updated", "bank_billet_registration.deleted", "bank_billet_payment.created", "bank_billet_payment.updated", "bank_billet_payment.deleted", "customer.created", "customer.updated", "customer.portal_password_updated", "customer.deleted", "transaction.created", "transaction.updated", "transaction.processed", "withdrawal.transferred", "withdrawal.requested", "addon.activated", "addon.removed", "plan_subscription.activated", "plan_subscription.removed", "plan_subscription.fee", "plan_subscription.updated", "user.created", "user.updated", "user.deleted", "remittance.created", "remittance.processed", "remittance.downloaded", "remittance.sent", "remittance.deleted", "remittance.line.db.created", "remittance.line.db.updated", "remittance.line.db.deleted", "discharge.created", "discharge.processed", "discharge.deleted", "bank_billet_account.created", "bank_billet_account.homologated", "bank_billet_account.homologation_failed", "bank_billet_account.homologation_started", "bank_billet_account.validated", "bank_billet_account.validation_released", "bank_billet_account.activated", "bank_billet_account.updated", "bank_billet_account.deleted", "edi.remittance_line.created", "edi.remittance_line.updated", "edi.remittance_line.deleted", "edi.edi_box.activated", "edi.edi_box.db.created", "edi.edi_box.db.deleted", "edi.edi_box.db.updated", "edi.edi_box.generated", "edi.edi_box.demand_received", "edi.edi_box.confirming_at_bank", "edi.edi_box.testing_by_customer", "edi.edi_box.waiting_for_validations", "customer_subscription.created", "customer_subscription.updated", "customer_subscription.deleted", "installment.created", "installment.processed", "installment.generated", "installment.deleted", "import.created", "import.processed", "import.deleted", "export.db.created", "export.db.updated", "export.db.deleted", "pix.db.created", "pix.db.updated", "pix.db.deleted", "pix.register.requested", "pix.register.confirmed", "pix.register.failed", "pix.register.error", "pix.update.requested", "pix.update.confirmed", "pix.update.failed", "pix.update.error", "pix.paid", "pix.overdue", "pix.cancel.requested", "pix.cancel.confirmed", "pix.cancel.failed", "pix.cancel.error", "pix.sync.requested", "pix.sync.confirmed", "pix.sync.failed", "pix.sync.error", "pix.get.requested", "pix.get.confirmed", "pix.get.failed", "pix.get.error", "financial.account.balance_sync.requested", "financial.account.balance_sync.confirmed", "financial.account.balance_sync.failed", "financial.account.balance_sync.error", "financial.account.statement_sync.requested", "financial.account.statement_sync.confirmed", "financial.account.statement_sync.failed", "financial.account.statement_sync.error", "financial.account.db.created", "financial.account.db.updated", "financial.account.db.deleted", "financial.account.statement.updated", "financial.account.balance.updated", "financial.account_balance.db.created", "transfer.batch.db.created", "transfer.batch.db.updated", "transfer.batch.db.deleted", "transfer.batch.awaiting_approval", "transfer.pix_batch.awaiting_approval", "transfer.pix_batch.get.requested", "transfer.pix_batch.get.confirmed", "transfer.pix_batch.get.failed", "transfer.pix_batch.get.error", "transfer.pix_batch.sync.requested", "transfer.pix_batch.sync.confirmed", "transfer.pix_batch.sync.failed", "transfer.pix_batch.sync.error", "transfer.pix_batch.register.requested", "transfer.pix_batch.register.confirmed", "transfer.pix_batch.register.failed", "transfer.pix_batch.register.error", "transfer.pix_batch.approve.requested", "transfer.pix_batch.approve.confirmed", "transfer.pix_batch.approve.failed", "transfer.pix_batch.approve.error", "transfer.pix_batch.reprove.requested", "transfer.pix_batch.reprove.confirmed", "transfer.pix_batch.reprove.failed", "transfer.pix_batch.reprove.error", "transfer.pix_batch.cancel.requested", "transfer.pix_batch.cancel.confirmed", "transfer.pix_batch.cancel.failed", "transfer.pix_batch.cancel.error", "transfer.ted_batch.awaiting_approval", "transfer.ted_batch.get.requested", "transfer.ted_batch.get.confirmed", "transfer.ted_batch.get.failed", "transfer.ted_batch.get.error", "transfer.ted_batch.sync.requested", "transfer.ted_batch.sync.confirmed", "transfer.ted_batch.sync.failed", "transfer.ted_batch.sync.error", "transfer.ted_batch.register.requested", "transfer.ted_batch.register.confirmed", "transfer.ted_batch.register.failed", "transfer.ted_batch.register.error", "transfer.ted_batch.approve.requested", "transfer.ted_batch.approve.confirmed", "transfer.ted_batch.approve.failed", "transfer.ted_batch.approve.error", "transfer.ted_batch.reprove.requested", "transfer.ted_batch.reprove.confirmed", "transfer.ted_batch.reprove.failed", "transfer.ted_batch.reprove.error", "transfer.ted_batch.cancel.requested", "transfer.ted_batch.cancel.confirmed", "transfer.ted_batch.cancel.failed", "transfer.ted_batch.cancel.error", "transfer.internal_batch.awaiting_approval", "transfer.internal_batch.get.requested", "transfer.internal_batch.get.confirmed", "transfer.internal_batch.get.failed", "transfer.internal_batch.get.error", "transfer.internal_batch.sync.requested", "transfer.internal_batch.sync.confirmed", "transfer.internal_batch.sync.failed", "transfer.internal_batch.sync.error", "transfer.internal_batch.register.requested", "transfer.internal_batch.register.confirmed", "transfer.internal_batch.register.failed", "transfer.internal_batch.register.error", "transfer.internal_batch.approve.requested", "transfer.internal_batch.approve.confirmed", "transfer.internal_batch.approve.failed", "transfer.internal_batch.approve.error", "transfer.internal_batch.reprove.requested", "transfer.internal_batch.reprove.confirmed", "transfer.internal_batch.reprove.failed", "transfer.internal_batch.reprove.error", "transfer.internal_batch.cancel.requested", "transfer.internal_batch.cancel.confirmed", "transfer.internal_batch.cancel.failed", "transfer.internal_batch.cancel.error", "transfer.db.created", "transfer.db.updated", "transfer.db.deleted", "transfer.pix.register.requested", "transfer.pix.register.confirmed", "transfer.pix.register.failed", "transfer.pix.register.error", "transfer.pix.reschedule.requested", "transfer.pix.reschedule.confirmed", "transfer.pix.reschedule.failed", "transfer.pix.reschedule.error", "transfer.pix.approve.requested", "transfer.pix.approve.confirmed", "transfer.pix.approve.failed", "transfer.pix.approve.error", "transfer.pix.reprove.requested", "transfer.pix.reprove.confirmed", "transfer.pix.reprove.failed", "transfer.pix.reprove.error", "transfer.pix.cancel.requested", "transfer.pix.cancel.confirmed", "transfer.pix.cancel.failed", "transfer.pix.cancel.error", "transfer.pix.get.requested", "transfer.pix.get.confirmed", "transfer.pix.get.failed", "transfer.pix.get.error", "transfer.pix.sync.requested", "transfer.pix.sync.confirmed", "transfer.pix.sync.failed", "transfer.pix.sync.error", "transfer.ted.register.requested", "transfer.ted.register.confirmed", "transfer.ted.register.failed", "transfer.ted.register.error", "transfer.ted.reschedule.requested", "transfer.ted.reschedule.confirmed", "transfer.ted.reschedule.failed", "transfer.ted.reschedule.error", "transfer.ted.approve.requested", "transfer.ted.approve.confirmed", "transfer.ted.approve.failed", "transfer.ted.approve.error", "transfer.ted.reprove.requested", "transfer.ted.reprove.confirmed", "transfer.ted.reprove.failed", "transfer.ted.reprove.error", "transfer.ted.cancel.requested", "transfer.ted.cancel.confirmed", "transfer.ted.cancel.failed", "transfer.ted.cancel.error", "transfer.ted.get.requested", "transfer.ted.get.confirmed", "transfer.ted.get.failed", "transfer.ted.get.error", "transfer.ted.sync.requested", "transfer.ted.sync.confirmed", "transfer.ted.sync.failed", "transfer.ted.sync.error", "transfer.internal.register.requested", "transfer.internal.register.confirmed", "transfer.internal.register.failed", "transfer.internal.register.error", "transfer.internal.reschedule.requested", "transfer.internal.reschedule.confirmed", "transfer.internal.reschedule.failed", "transfer.internal.reschedule.error", "transfer.internal.approve.requested", "transfer.internal.approve.confirmed", "transfer.internal.approve.failed", "transfer.internal.approve.error", "transfer.internal.reprove.requested", "transfer.internal.reprove.confirmed", "transfer.internal.reprove.failed", "transfer.internal.reprove.error", "transfer.internal.cancel.requested", "transfer.internal.cancel.confirmed", "transfer.internal.cancel.failed", "transfer.internal.cancel.error", "transfer.internal.get.requested", "transfer.internal.get.confirmed", "transfer.internal.get.failed", "transfer.internal.get.error", "transfer.internal.sync.requested", "transfer.internal.sync.confirmed", "transfer.internal.sync.failed", "transfer.internal.sync.error", "payment.db.created", "payment.db.updated", "payment.db.deleted", "payment.bank_billet.register.requested", "payment.bank_billet.register.confirmed", "payment.bank_billet.register.failed", "payment.bank_billet.register.error", "payment.bank_billet.approve.requested", "payment.bank_billet.approve.confirmed", "payment.bank_billet.approve.failed", "payment.bank_billet.approve.error", "payment.bank_billet.reprove.requested", "payment.bank_billet.reprove.confirmed", "payment.bank_billet.reprove.failed", "payment.bank_billet.reprove.error", "payment.bank_billet.reschedule.requested", "payment.bank_billet.reschedule.confirmed", "payment.bank_billet.reschedule.failed", "payment.bank_billet.reschedule.error", "payment.bank_billet.cancel.requested", "payment.bank_billet.cancel.confirmed", "payment.bank_billet.cancel.failed", "payment.bank_billet.cancel.error", "payment.bank_billet.get.requested", "payment.bank_billet.get.confirmed", "payment.bank_billet.get.failed", "payment.bank_billet.get.error", "payment.bank_billet.sync.requested", "payment.bank_billet.sync.confirmed", "payment.bank_billet.sync.failed", "payment.bank_billet.sync.error", "payment.darf.register.requested", "payment.darf.register.confirmed", "payment.darf.register.failed", "payment.darf.register.error", "payment.darf.approve.requested", "payment.darf.approve.confirmed", "payment.darf.approve.failed", "payment.darf.approve.error", "payment.darf.reprove.requested", "payment.darf.reprove.confirmed", "payment.darf.reprove.failed", "payment.darf.reprove.error", "payment.darf.reschedule.requested", "payment.darf.reschedule.confirmed", "payment.darf.reschedule.failed", "payment.darf.reschedule.error", "payment.darf.cancel.requested", "payment.darf.cancel.confirmed", "payment.darf.cancel.failed", "payment.darf.cancel.error", "payment.darf.get.requested", "payment.darf.get.confirmed", "payment.darf.get.failed", "payment.darf.get.error", "payment.darf.sync.requested", "payment.darf.sync.confirmed", "payment.darf.sync.failed", "payment.darf.sync.error", "payment.utility.register.requested", "payment.utility.register.confirmed", "payment.utility.register.failed", "payment.utility.register.error", "payment.utility.approve.requested", "payment.utility.approve.confirmed", "payment.utility.approve.failed", "payment.utility.approve.error", "payment.utility.reprove.requested", "payment.utility.reprove.confirmed", "payment.utility.reprove.failed", "payment.utility.reprove.error", "payment.utility.reschedule.requested", "payment.utility.reschedule.confirmed", "payment.utility.reschedule.failed", "payment.utility.reschedule.error", "payment.utility.cancel.requested", "payment.utility.cancel.confirmed", "payment.utility.cancel.failed", "payment.utility.cancel.error", "payment.utility.get.requested", "payment.utility.get.confirmed", "payment.utility.get.failed", "payment.utility.get.error", "payment.utility.sync.requested", "payment.utility.sync.confirmed", "payment.utility.sync.failed", "payment.utility.sync.error", "payment.gru.register.requested", "payment.gru.register.confirmed", "payment.gru.register.failed", "payment.gru.register.error", "payment.gru.approve.requested", "payment.gru.approve.confirmed", "payment.gru.approve.failed", "payment.gru.approve.error", "payment.gru.reprove.requested", "payment.gru.reprove.confirmed", "payment.gru.reprove.failed", "payment.gru.reprove.error", "payment.gru.reschedule.requested", "payment.gru.reschedule.confirmed", "payment.gru.reschedule.failed", "payment.gru.reschedule.error", "payment.gru.cancel.requested", "payment.gru.cancel.confirmed", "payment.gru.cancel.failed", "payment.gru.cancel.error", "payment.gru.get.requested", "payment.gru.get.confirmed", "payment.gru.get.failed", "payment.gru.get.error", "payment.gru.sync.requested", "payment.gru.sync.confirmed", "payment.gru.sync.failed", "payment.gru.sync.error", "payment.pix.register.requested", "payment.pix.register.confirmed", "payment.pix.register.failed", "payment.pix.register.error", "payment.pix.approve.requested", "payment.pix.approve.confirmed", "payment.pix.approve.failed", "payment.pix.approve.error", "payment.pix.reprove.requested", "payment.pix.reprove.confirmed", "payment.pix.reprove.failed", "payment.pix.reprove.error", "payment.pix.reschedule.requested", "payment.pix.reschedule.confirmed", "payment.pix.reschedule.failed", "payment.pix.reschedule.error", "payment.pix.cancel.requested", "payment.pix.cancel.confirmed", "payment.pix.cancel.failed", "payment.pix.cancel.error", "payment.pix.get.requested", "payment.pix.get.confirmed", "payment.pix.get.failed", "payment.pix.get.error", "payment.pix.sync.requested", "payment.pix.sync.confirmed", "payment.pix.sync.failed", "payment.pix.sync.error", "payment.tax.register.requested", "payment.tax.register.confirmed", "payment.tax.register.failed", "payment.tax.register.error", "payment.tax.approve.requested", "payment.tax.approve.confirmed", "payment.tax.approve.failed", "payment.tax.approve.error", "payment.tax.reprove.requested", "payment.tax.reprove.confirmed", "payment.tax.reprove.failed", "payment.tax.reprove.error", "payment.tax.reschedule.requested", "payment.tax.reschedule.confirmed", "payment.tax.reschedule.failed", "payment.tax.reschedule.error", "payment.tax.cancel.requested", "payment.tax.cancel.confirmed", "payment.tax.cancel.failed", "payment.tax.cancel.error", "payment.tax.get.requested", "payment.tax.get.confirmed", "payment.tax.get.failed", "payment.tax.get.error", "payment.tax.sync.requested", "payment.tax.sync.confirmed", "payment.tax.sync.failed", "payment.tax.sync.error", "payment.batch.db.created", "payment.batch.db.updated", "payment.batch.db.deleted", "payment.batch.awaiting_approval", "payment.bank_billet_batch.awaiting_approval", "payment.bank_billet_batch.get.requested", "payment.bank_billet_batch.get.confirmed", "payment.bank_billet_batch.get.failed", "payment.bank_billet_batch.get.error", "payment.bank_billet_batch.sync.requested", "payment.bank_billet_batch.sync.confirmed", "payment.bank_billet_batch.sync.failed", "payment.bank_billet_batch.sync.error", "payment.bank_billet_batch.register.requested", "payment.bank_billet_batch.register.confirmed", "payment.bank_billet_batch.register.failed", "payment.bank_billet_batch.register.error", "payment.bank_billet_batch.approve.requested", "payment.bank_billet_batch.approve.confirmed", "payment.bank_billet_batch.approve.failed", "payment.bank_billet_batch.approve.error", "payment.bank_billet_batch.reprove.requested", "payment.bank_billet_batch.reprove.confirmed", "payment.bank_billet_batch.reprove.failed", "payment.bank_billet_batch.reprove.error", "payment.bank_billet_batch.cancel.requested", "payment.bank_billet_batch.cancel.confirmed", "payment.bank_billet_batch.cancel.failed", "payment.bank_billet_batch.cancel.error", "payment.darf_batch.awaiting_approval", "payment.darf_batch.get.requested", "payment.darf_batch.get.confirmed", "payment.darf_batch.get.failed", "payment.darf_batch.get.error", "payment.darf_batch.sync.requested", "payment.darf_batch.sync.confirmed", "payment.darf_batch.sync.failed", "payment.darf_batch.sync.error", "payment.darf_batch.register.requested", "payment.darf_batch.register.confirmed", "payment.darf_batch.register.failed", "payment.darf_batch.register.error", "payment.darf_batch.approve.requested", "payment.darf_batch.approve.confirmed", "payment.darf_batch.approve.failed", "payment.darf_batch.approve.error", "payment.darf_batch.reprove.requested", "payment.darf_batch.reprove.confirmed", "payment.darf_batch.reprove.failed", "payment.darf_batch.reprove.error", "payment.darf_batch.cancel.requested", "payment.darf_batch.cancel.confirmed", "payment.darf_batch.cancel.failed", "payment.darf_batch.cancel.error", "payment.utility_batch.awaiting_approval", "payment.utility_batch.get.requested", "payment.utility_batch.get.confirmed", "payment.utility_batch.get.failed", "payment.utility_batch.get.error", "payment.utility_batch.sync.requested", "payment.utility_batch.sync.confirmed", "payment.utility_batch.sync.failed", "payment.utility_batch.sync.error", "payment.utility_batch.register.requested", "payment.utility_batch.register.confirmed", "payment.utility_batch.register.failed", "payment.utility_batch.register.error", "payment.utility_batch.approve.requested", "payment.utility_batch.approve.confirmed", "payment.utility_batch.approve.failed", "payment.utility_batch.approve.error", "payment.utility_batch.reprove.requested", "payment.utility_batch.reprove.confirmed", "payment.utility_batch.reprove.failed", "payment.utility_batch.reprove.error", "payment.utility_batch.cancel.requested", "payment.utility_batch.cancel.confirmed", "payment.utility_batch.cancel.failed", "payment.utility_batch.cancel.error", "payment.gru_batch.awaiting_approval", "payment.gru_batch.get.requested", "payment.gru_batch.get.confirmed", "payment.gru_batch.get.failed", "payment.gru_batch.get.error", "payment.gru_batch.sync.requested", "payment.gru_batch.sync.confirmed", "payment.gru_batch.sync.failed", "payment.gru_batch.sync.error", "payment.gru_batch.register.requested", "payment.gru_batch.register.confirmed", "payment.gru_batch.register.failed", "payment.gru_batch.register.error", "payment.gru_batch.approve.requested", "payment.gru_batch.approve.confirmed", "payment.gru_batch.approve.failed", "payment.gru_batch.approve.error", "payment.gru_batch.reprove.requested", "payment.gru_batch.reprove.confirmed", "payment.gru_batch.reprove.failed", "payment.gru_batch.reprove.error", "payment.gru_batch.cancel.requested", "payment.gru_batch.cancel.confirmed", "payment.gru_batch.cancel.failed", "payment.gru_batch.cancel.error", "payment.pix_batch.awaiting_approval", "payment.pix_batch.get.requested", "payment.pix_batch.get.confirmed", "payment.pix_batch.get.failed", "payment.pix_batch.get.error", "payment.pix_batch.sync.requested", "payment.pix_batch.sync.confirmed", "payment.pix_batch.sync.failed", "payment.pix_batch.sync.error", "payment.pix_batch.register.requested", "payment.pix_batch.register.confirmed", "payment.pix_batch.register.failed", "payment.pix_batch.register.error", "payment.pix_batch.approve.requested", "payment.pix_batch.approve.confirmed", "payment.pix_batch.approve.failed", "payment.pix_batch.approve.error", "payment.pix_batch.reprove.requested", "payment.pix_batch.reprove.confirmed", "payment.pix_batch.reprove.failed", "payment.pix_batch.reprove.error", "payment.pix_batch.cancel.requested", "payment.pix_batch.cancel.confirmed", "payment.pix_batch.cancel.failed", "payment.pix_batch.cancel.error", "payment.tax_batch.awaiting_approval", "payment.tax_batch.get.requested", "payment.tax_batch.get.confirmed", "payment.tax_batch.get.failed", "payment.tax_batch.get.error", "payment.tax_batch.sync.requested", "payment.tax_batch.sync.confirmed", "payment.tax_batch.sync.failed", "payment.tax_batch.sync.error", "payment.tax_batch.register.requested", "payment.tax_batch.register.confirmed", "payment.tax_batch.register.failed", "payment.tax_batch.register.error", "payment.tax_batch.approve.requested", "payment.tax_batch.approve.confirmed", "payment.tax_batch.approve.failed", "payment.tax_batch.approve.error", "payment.tax_batch.reprove.requested", "payment.tax_batch.reprove.confirmed", "payment.tax_batch.reprove.failed", "payment.tax_batch.reprove.error", "payment.tax_batch.cancel.requested", "payment.tax_batch.cancel.confirmed", "payment.tax_batch.cancel.failed", "payment.tax_batch.cancel.error", "payment.dda.account.db.created", "payment.dda.account.register.requested", "payment.dda.account.register.failed", "payment.dda.account.register.error", "payment.dda.account.register.confirmed", "payment.dda.account.bank_billets_sync.requested", "payment.dda.account.bank_billets_sync.failed", "payment.dda.account.bank_billets_sync.error", "payment.dda.account.bank_billets_sync.confirmed", "payment.dda.account.unregister.requested", "payment.dda.account.unregister.failed", "payment.dda.account.unregister.error", "payment.dda.account.unregister.confirmed", "payment.dda.bank_billet.db.created", "payment.dda.bank_billet.db.updated", "payment.dda.bank_billet.external_status_changed", "payment.dda.bank_billet.get.requested", "payment.dda.bank_billet.get.confirmed", "payment.dda.bank_billet.get.failed", "payment.dda.bank_billet.get.error", "payment.dda.bank_billet.sync.requested", "payment.dda.bank_billet.sync.confirmed", "payment.dda.bank_billet.sync.failed", "payment.dda.bank_billet.sync.error", "payment.dda.account.db.updated", "payment.dda.account.db.deleted", "payment.dda.account.letter.pending", "payment.dda.account.letter.waiting_signatures", "payment.dda.account.letter.signed", "payment.dda.account.letter.failed", "payment.dda.account.confirmed", "payment.dda.account.rejected", "payment.dda.account.failed", "payment.dda.account.disabled", "payment.dda.account.enabled", "credit.restriction.add.requested", "credit.restriction.add.failed", "credit.restriction.add.error", "credit.restriction.add.confirmed", "credit.restriction.remove.requested", "credit.restriction.remove.confirmed", "credit.restriction.remove.failed", "credit.restriction.remove.error", "charge.automatic_pix.account.db.created", "charge.automatic_pix.account.db.updated", "charge.automatic_pix.account.db.deleted", "charge.automatic_pix.recurrence.db.created", "charge.automatic_pix.recurrence.db.updated", "charge.automatic_pix.recurrence.db.deleted", "charge.automatic_pix.recurrence.cancel.requested", "charge.automatic_pix.recurrence.cancel.confirmed", "charge.automatic_pix.recurrence.cancel.failed", "charge.automatic_pix.recurrence.cancel.error", "charge.automatic_pix.recurrence.register.requested", "charge.automatic_pix.recurrence.register.confirmed", "charge.automatic_pix.recurrence.register.failed", "charge.automatic_pix.recurrence.register.error", "charge.automatic_pix.recurrence.update.requested", "charge.automatic_pix.recurrence.update.confirmed", "charge.automatic_pix.recurrence.update.failed", "charge.automatic_pix.recurrence.update.error", "charge.automatic_pix.recurrence.pending", "charge.automatic_pix.recurrence.created", "charge.automatic_pix.recurrence.approved", "charge.automatic_pix.recurrence.rejected", "charge.automatic_pix.recurrence.expired", "charge.automatic_pix.recurrence.canceled", "charge.automatic_pix.request.db.created", "charge.automatic_pix.request.db.updated", "charge.automatic_pix.request.db.deleted", "charge.automatic_pix.request.cancel.requested", "charge.automatic_pix.request.cancel.confirmed", "charge.automatic_pix.request.cancel.failed", "charge.automatic_pix.request.cancel.error", "charge.automatic_pix.request.register.requested", "charge.automatic_pix.request.register.confirmed", "charge.automatic_pix.request.register.failed", "charge.automatic_pix.request.register.error", "charge.automatic_pix.request.pending", "charge.automatic_pix.request.created", "charge.automatic_pix.request.sent", "charge.automatic_pix.request.received", "charge.automatic_pix.request.rejected", "charge.automatic_pix.request.accepted", "charge.automatic_pix.request.expired", "charge.automatic_pix.request.canceled", "charge.automatic_pix.pix.db.created", "charge.automatic_pix.pix.db.updated", "charge.automatic_pix.pix.db.deleted", "charge.automatic_pix.pix.cancel.requested", "charge.automatic_pix.pix.cancel.confirmed", "charge.automatic_pix.pix.cancel.failed", "charge.automatic_pix.pix.cancel.error", "charge.automatic_pix.pix.register.requested", "charge.automatic_pix.pix.register.confirmed", "charge.automatic_pix.pix.register.failed", "charge.automatic_pix.pix.register.error", "charge.automatic_pix.pix.update.requested", "charge.automatic_pix.pix.update.confirmed", "charge.automatic_pix.pix.update.failed", "charge.automatic_pix.pix.update.error", "charge.automatic_pix.pix.pending", "charge.automatic_pix.pix.created", "charge.automatic_pix.pix.active", "charge.automatic_pix.pix.paid", "charge.automatic_pix.pix.expired", "charge.automatic_pix.pix.rejected", "charge.automatic_pix.pix.canceled", "charge.automatic_pix.location.db.created", "charge.automatic_pix.location.db.updated", "charge.automatic_pix.location.db.deleted", "charge.automatic_pix.location.register.requested", "charge.automatic_pix.location.register.confirmed", "charge.automatic_pix.location.register.failed", "charge.automatic_pix.location.register.error", "charge.payment.db.created", "charge.payment.db.updated", "charge.payment.db.deleted", "charge.payment.notified", "charge.payment.canceled", "charge.payment.confirmed", "charge.payment.duplicated", "charge.bank_billet.payment.notified", "charge.bank_billet.payment.canceled", "charge.bank_billet.payment.confirmed", "data.bank_billet_query.success", "data.bank_billet_query.error", "data.bank_billet_query.db.created", "data.bank_billet_query.db.updated", "data.bank_billet_query.db.deleted", "data.pix_qrcode_query.success", "data.pix_qrcode_query.error", "data.pix_qrcode_query.db.created", "data.pix_qrcode_query.db.updated", "data.pix_qrcode_query.db.deleted", "mailbox.entry.db.created", "mailbox.entry.db.updated", "mailbox.entry.db.deleted", "mailbox.entry.file.received", "mailbox.entry.file.sent", "mailbox.file.db.created", "mailbox.file.db.updated", "mailbox.file.db.deleted", "mailbox.channel.s3.db.created", "mailbox.channel.s3.db.updated", "mailbox.channel.s3.db.deleted", "mailbox.channel.s3.fetch_all", "mailbox.channel.email.db.created", "mailbox.channel.email.db.updated", "mailbox.channel.email.db.deleted", "mailbox.channel.whatsapp.db.created", "mailbox.channel.whatsapp.db.updated", "mailbox.channel.whatsapp.db.deleted", "mailbox.channel.sftp.db.created", "mailbox.channel.sftp.db.updated", "mailbox.channel.sftp.db.deleted", "mailbox.channel.sftp.fetch_all", "mailbox.channel.syncthing.db.created", "mailbox.channel.syncthing.db.updated", "mailbox.channel.syncthing.db.deleted", "email_account.db.created", "email_account.db.updated", "email_account.db.deleted", "email_account.identity.pending", "email_account.identity.created", "email_account.identity.error", "email_account.identity.failure", "email_account.dns.not_ready", "email_account.dns.awaiting", "email_account.dns.validated", "email_account.dns.error", "email_account.dns.failure", "integration.connection.db.created", "integration.connection.db.updated", "integration.connection.db.deleted", "webhook.db.created", "webhook.db.updated", "webhook.db.deleted", "enotas.nfe.generated" ] } }, "active": { "type": "boolean", "nullable": true, "description": "Define se o webhook estará ativo, recebendo notificações. O valor padrão é `true`.", "example": null }, "ssl_verification_enabled": { "type": "boolean", "nullable": true, "description": "Define se a verificação SSL está habilitada no webhook.", "example": null }, "subaccounts": { "type": "boolean", "nullable": false, "description": "Define se o webhook estará ativo para os eventos das subcontas.", "example": null }, "bank_billet_account_id": { "type": "integer", "nullable": true, "description": "ID da [Carteira de Cobrança](/reference/post_v1-bank-billet-accounts). Se informado, o webhook apenas receberá notificações de eventos relacionados à carteira indicada.", "example": null, "deprecated": true }, "auth_kind": { "type": "string", "nullable": true, "enum": [ "none", "basic_auth", "bearer", "api_key" ], "readOnly": true, "description": "Tipo de autenticação configurado. Retornado nas respostas. Para configurar, envie o objeto `auth` no body." }, "auth": { "type": "object", "nullable": true, "writeOnly": true, "description": "Configuração de autenticação do endpoint receptor. Apenas para criação/atualização — não retornado nas respostas.", "properties": { "kind": { "type": "string", "enum": [ "none", "basic_auth", "bearer", "api_key" ], "description": "Tipo de autenticação: `none`, `basic_auth`, `bearer` ou `api_key`." }, "username": { "type": "string", "nullable": true, "description": "Usuário (somente `basic_auth`)." }, "password": { "type": "string", "nullable": true, "description": "Senha (somente `basic_auth`). Deixe em branco para manter a senha atual." }, "token": { "type": "string", "nullable": true, "description": "Token (somente `bearer`). Deixe em branco para manter o token atual." }, "header_name": { "type": "string", "nullable": true, "description": "Nome do header (somente `api_key`). Ex: `X-API-Key`." }, "header_value": { "type": "string", "nullable": true, "description": "Valor do header (somente `api_key`). Deixe em branco para manter o valor atual." } } }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do registro" } } }, "v1_user_object": { "type": "object", "required": [ "email" ], "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do usuário" }, "uid": { "type": "string", "readOnly": true, "description": "UID do Evento" }, "email": { "type": "string", "format": "email", "description": "E-mail", "example": "cliente@example.com" }, "first_name": { "type": "string", "nullable": true, "description": "Primeiro Nome", "example": null }, "middle_name": { "type": "string", "nullable": true, "description": "Nome do Meio", "example": null }, "last_name": { "type": "string", "nullable": true, "description": "Último Nome", "example": null }, "full_name": { "type": "string", "nullable": true, "description": "Nome completo", "example": null }, "created_via_api": { "type": "boolean", "nullable": true, "description": "Enviado pela API", "example": null }, "permissions": { "type": "array", "nullable": true, "items": { "type": "string" }, "example": "bank_billet.*", "description": "Permissões" }, "enabled_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação de ativação do usuário" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do evento" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de atualização do evento" } } }, "v1_message_object": { "type": "object", "properties": { "message": { "type": "string", "description": "Mensagem de retorno." } } }, "v1_error_controller": { "type": "object", "properties": { "errors": { "type": "string", "description": "Mensagem de erro." } } }, "v1_discharge_object": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do CNAB" }, "filename": { "type": "string", "maxLength": 255, "nullable": true, "description": "Nome do arquivo" }, "status": { "type": "string", "readOnly": true, "description": "Situação do arquivo:\n* `unprocessed` Pendente\n* `processed` Processado", "enum": [ "unprocessed", "processed" ] }, "processed_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data de Processamento." }, "created_via_api": { "type": "boolean", "nullable": true, "description": "Enviado pela API", "example": null }, "bank_billet_account_id": { "type": "integer", "nullable": true, "description": "ID da [Carteira de Cobrança](/reference/post_v1-bank-billet-accounts).", "example": null }, "created_via_integration": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data de recebimento automático do banco." }, "bank_billet_discharges": { "type": "array", "nullable": true, "example": null, "description": "Retornos bancários.", "items": { "$ref": "#/components/schemas/v1_bank_billet_discharge_object" } }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do registro" }, "external_id": { "type": "string", "nullable": true, "description": "ID externo." }, "custom_data": { "type": "object", "nullable": true, "description": "Dados customizados." }, "tags": { "type": "array", "nullable": true, "description": "Etiquetas.", "items": { "type": "string" } }, "tag_list": { "type": "string", "nullable": true, "readOnly": true, "description": "Lista de etiquetas separadas por vírgula." } } }, "v1_discharge_send_cnab_object": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "Arquivo" }, "filename": { "type": "string", "maxLength": 255, "nullable": true, "description": "Nome do arquivo" }, "bank_billet_account_id": { "type": "integer", "nullable": true, "description": "ID da [Carteira de Cobrança](/reference/post_v1-bank-billet-accounts).", "example": null }, "external_id": { "type": "string", "nullable": true, "description": "ID externo." }, "custom_data": { "type": "object", "nullable": true, "description": "Dados customizados." }, "tags": { "type": "array", "nullable": true, "description": "Etiquetas.", "items": { "type": "string" } } } }, "v1_bank_billet_discharge_object": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Registro de Retorno" }, "our_occurrence": { "type": "string", "maxLength": 4, "nullable": true, "description": "Código único de operação dentro da Kobana.\n\n| Código | Descrição |\n|---|---|\n| 2001 | Entrada Confirmada |\n| 2002 | Entrada Rejeitada |\n| 2003 | Liquidação |\n| 2004 | Baixa de Título Confirmada |\n| 2005 | Baixa de Título Rejeitada |\n| 2006 | Alteração do Vencimento Confirmada |\n| 2007 | Alteração do Vencimento Rejeitada |\n| 2008 | Baixa Solicitada |\n| 2009 | Títulos em Carteira (em ser) |\n| 2010 | Confirmação de Recebimento de Instrução de Abatimento |\n| 2011 | Confirmação de Recebimento de Instrução de Cancelamento Abatimento |\n| 2012 | Confirmação de Recebimento de Instrução de Alteração de Vencimento |\n| 2013 | Franco de Pagamento |\n| 2014 | Liquidação Após Baixa ou Liquidação Título Não Registrado |\n| 2015 | Confirmação Recebimento Instrução de Protesto |\n| 2016 | Confirmação Recebimento Instrução de Sustação/Cancelamento de Protesto |\n| 2017 | Remessa a Cartório (Aponte em Cartório) |\n| 2018 | Retirada de Cartório e Manutenção em Carteira |\n| 2019 | Protestado e Baixado (Baixa por ter sido Protestado) |\n| 2020 | Instrução Rejeitada |\n| 2021 | Confirmação do Pedido de Alteração de Outros Dados |\n| 2022 | Débito de Tarifas/Custas |\n| 2023 | Ocorrências do Sacado |\n| 2024 | Alteração de Dados Rejeitada |\n| 2025 | Título pago com cheque devolvido |\n| 2026 | Título pago com cheque pendente de compensação |\n| 2027 | Liquidado sem registro |\n| 2028 | Liquidação Normal |\n| 2029 | Liquidação por Conta/Parcial |\n| 2030 | Liquidação por Saldo |\n| 2031 | Transferência de Carteira/Entrada |\n| 2032 | Transferência de Carteira/Baixa |\n| 2033 | Abatimento Concedido |\n| 2034 | Abatimento Cancelado |\n| 2035 | Liquidação em Cartório |\n| 2036 | Confirmação de alteração de juros de mora |\n| 2037 | Débito em Conta |\n| 2038 | Alteração do Nome do Sacado |\n| 2039 | Alteração do Endereço do Sacado |\n| 2040 | Indicação de encaminhamento a cartório |\n| 2041 | Sustar Protesto |\n| 2042 | Dispensar Juros de mora |\n| 2043 | Alteração do número do título dado pelo Cedente (Seu número) – 10 e 15 posições |\n| 2044 | Manutenção de título vencido |\n| 2045 | Conceder desconto |\n| 2046 | Não conceder desconto |\n| 2047 | Retificar desconto |\n| 2048 | Alterar data para desconto |\n| 2049 | Cobrar Multa |\n| 2050 | Dispensar Multa |\n| 2051 | Dispensar Indexador |\n| 2052 | Dispensar prazo limite para recebimento |\n| 2053 | Alterar prazo limite para recebimento |\n| 2054 | Alteração do número do controle do participante (25 posições) |\n| 2055 | Alteração do número do documento do sacado (CNPJ/CPF) |\n| 2056 | Alteração de tipo de cobrança (específico para títulos das carteiras 11 e 17) |\n| 2057 | Confirmação de Instrução de Parâmetro de Pagamento Parcial |\n| 2058 | Despesas de Protesto |\n| 2059 | Despesas de Sustação de Protesto |\n| 2060 | Débito de Custas Antecipadas |\n| 2061 | Confirmação do recebimento da instrução de desconto |\n| 2062 | Confirmação do recebimento do cancelamento do desconto |\n| 2063 | Solicitação de 2a via de instrumento de protesto |\n| 2064 | 2a via de instrumento de protesto emitida pelo cartório |\n| 2065 | Confirmação da alteração dos dados do sacado |\n| 2066 | Confirmação da alteração dos dados do sacador avalista |\n| 2067 | Título DDA reconhecido pelo sacado |\n| 2068 | Título DDA não reconhecido pelo sacado |\n| 2069 | Título DDA recusado pela CIP |\n| 2070 | Instrução de protesto processada |\n| 2071 | Remessa rejeitada |\n| 2072 | Baixa de título liquidado por edital |\n| 2073 | Devolução automática |\n| 2074 | Baixado conforme instruções |\n| 2075 | Arquivo levantamento |\n| 2076 | Pagamento em cartório |\n| 2077 | Alteração de dados |\n| 2078 | Alteração de instruções |\n| 2079 | Aguardando autorização para protesto por edital |\n| 2080 | Protesto sustado por alteração de vencimento e prazo de cartório |\n| 2081 | Confirmação da entrada em cartório |\n| 2082 | cobrança a creditar (liquidação em trânsito) |\n| 2083 | Título em trânsito pago em cartório |\n| 2084 | Reembolso e transferência Desconto e Vendor ou carteira em garantia |\n| 2085 | Reembolso e devolução Desconto e Vendor |\n| 2086 | Reembolso não efetuado por falta de saldo |\n| 2087 | Despesa de aponte |\n| 2088 | Alteração de título |\n| 2089 | Relação de títulos |\n| 2090 | Manutenção mensal |\n| 2091 | Sustação de cartório e envio de título a cartório |\n| 2092 | Fornecimento de formulário pré-impresso |\n| 2093 | Confirmação de entrada – Pagador DDA |\n| 2094 | Acerto dos dados do rateio de crédito |\n| 2095 | Cancelamento dos dados do rateio |\n| 2096 | Pagamento por Conta |\n| 2097 | Baixa Simples |\n| 2098 | Devolvido - Protestado |\n| 2099 | Baixa automática |\n| 2100 | Alteração Depositária |\n| 2101 | Confirmação de Protesto |\n| 2102 | Título Pago em Cheque – Vinculado |\n| 2103 | Acerto de Depositária |\n| 2104 | Acerto do Controle do Participante |\n| 2105 | Título Com Pagamento Cancelado |\n| 2106 | Entrada rejeitada por CEP Irregular |\n| 2107 | Confirmação Receb.Inst.de Protesto Falimentar |\n| 2108 | Ocorrências do Pagador |\n| 2109 | Retirado de Cartório e Manutenção Carteira |\n| 2110 | Desagendamento do débito automático |\n| 2111 | Estorno de pagamento |\n| 2112 | Sustado judicial |\n| 2113 | Solicitação de Impressão de Títulos Confirmada |\n| 2114 | Confirmação de Inclusão Banco de Pagador |\n| 2115 | Confirmação de Alteração Banco de Pagador |\n| 2116 | Confirmação de Exclusão Banco de Pagador |\n| 2117 | Emissão de Boletos de Banco de Pagador |\n| 2118 | Manutenção de Pagador Rejeitada |\n| 2119 | Entrada de Título via Banco de Pagador Rejeitada |\n| 2120 | Manutenção de Banco de Pagador Rejeitada |\n| 2121 | Estorno de Baixa / Liquidação |\n| 2122 | Liquidação On-line |\n| 2123 | Estorno de Liquidação On-line |\n| 2124 | Confirmação de alteração do valor nominal do título |\n| 2125 | Confirmação de alteração do valor/percentual mínimo/máximo |\n| 2126 | Baixa Manual Confirmada |\n| 2127 | Uso da Empresa Alterado |\n| 2128 | Prazo de Protesto Alterado |\n| 2129 | Prazo de Devolução Alterado |\n| 2130 | Alteração com reemissão de Bloqueto Confirmada |\n| 2131 | Alteração da opção de Protesto para Devolução Confirmada |\n| 2132 | Alteração da opção de Devolução para Protesto Confirmada |\n| 2133 | Baixa por Devolução |\n| 2134 | Título enviado para Cartório |\n| 2135 | Estorno de Protesto |\n| 2136 | Estorno de Sustação de Protesto |\n| 2137 | Tarifa sobre Título Vencido |\n| 2138 | Outras Tarifas de Alteração |\n| 2139 | Tarifas Diversas |\n| 2140 | Rejeição do Título |\n| 2141 | Confirmação de Envio de SMS |\n| 2142 | Envio de SMS rejeitado |\n| 2143 | Cancelamento de SMS |\n| 2144 | Liquidação de boleto cooperativa emite e expede |\n| 2145 | Liquidação de boleto após baixa ou não registrado cooperativa emite e expede |\n| 2146 | Título em aberto não enviado ao pagador |\n| 2147 | Inconsistência Negativação Serasa |\n| 2148 | Inclusão Negativação via Serasa |\n| 2149 | Exclusão Negativação Serasa |\n| 2150 | Devolução por Decurso de Prazo |\n| 2151 | Confirmação de Pedido de Exclusão da Serasa |\n| 2152 | Título enviado para negativação |\n| 2153 | Alegação do Sacado |\n| 2154 | Título retirado de cartório |\n| 2155 | Custa de distribuição |\n| 2156 | Custa de sustação |\n| 2157 | Custa de protesto |\n| 2158 | Movimentação CIP |\n| 2159 | Alteração De Dados – Nova Entrada ou Alteração/Exclusão de Dados Acatada |\n| 2160 | Alteração de Dados – Baixa |\n| 2161 | Baixa Por Ter Sido Liquidado |\n| 2162 | Cobrança Contratual – Instruções/Alterações Rejeitadas/Pendentes |\n| 2163 | Confirmação Recebimento de Instrução de Não Protestar |\n| 2164 | Protesto Enviado a Cartório/Tarifa |\n| 2165 | Tarifa de Aviso de Cobrança |\n| 2166 | Tarifa de Extrato Posição |\n| 2167 | Tarifa de Relação das Liquidações |\n| 2168 | Tarifa de Manutenção de Títulos Vencidos |\n| 2169 | Débito Mensal de Tarifas (para entradas e baixas) |\n| 2170 | Custas de Edital |\n| 2171 | Tarifa de Emissão de Boleto/Tarifa de Envio de Duplicata |\n| 2172 | Tarifa de Instrução |\n| 2173 | Tarifa de Ocorrências |\n| 2174 | Tarifa Mensal de Emissão de Boleto/Tarifa Mensal de Envio de Duplicata |\n| 2175 | Débito Mensal de Tarifas – Extrato de Posição (b4ep/b4ox) |\n| 2176 | Débito Mensal de Tarifas – Outras Instruções |\n| 2177 | Débito Mensal de Tarifas – Manutenção de Títulos Vencidos |\n| 2178 | Débito Mensal de Tarifas – Outras Ocorrências |\n| 2179 | Débito Mensal de Tarifas – Protesto |\n| 2180 | Débito Mensal de Tarifas – Sustação de Protesto |\n| 2181 | Baixa Com Transferência Para Desconto |\n| 2182 | Custas de Sustação Judicial |\n| 2183 | Tarifa Mensal Referente A Entradas Bancos Correspondentes Na Carteira |\n| 2184 | Tarifa Mensal Baixas Na Carteira |\n| 2185 | Tarifa Mensal Baixas Em Bancos Correspondentes Na Carteira |\n| 2186 | Tarifa Mensal de Liquidações Na Carteira |\n| 2187 | Tarifa Mensal de Liquidações Em Bancos Correspondentes Na Carteira |\n| 2188 | Custas de Irregularidade |\n| 2189 | Instrução Cancelada |\n| 2190 | Comando Recusado |\n| 2191 | Código de IOF inválido |\n| 2192 | Título não existe |\n| 2193 | Prorrogação de Vencimento |\n| 2194 | Título Já Baixado/Protestado |\n| 2195 | Custas de Cartório |\n| 2196 | Confirmação de envio de e-mail/SMS |\n| 2197 | Envio de e-mail/SMS rejeitado |\n| 2198 | Título pago com cheque compensado |\n| 2199 | Instrução para protesto para fins falimentares confirmada |\n| 2200 | Alteração de contrato de cobrança |\n| 2201 | Confirmação da Instrução de Baixa de Título Negativado sem Protesto |\n| 2202 | Confirmação de Pedido de Dispensa de Multa |\n| 2203 | Confirmação do Pedido de Cobrança de Multa |\n| 2204 | Confirmação do Pedido de Alteração de Cobrança de Juros |\n| 2205 | Confirmação do Pedido de Alteração do Valor/Data de Desconto |\n| 2206 | Confirmação do Pedido de Alteração do Beneficiário do Título |\n| 2207 | Confirmação do Pedido de Dispensa de Juros de Mora |\n| 2208 | Confirmação de instrução de transferência de carteira/modalidade de cobrança |\n| 2209 | Confirmação de Desistência de Protesto |\n| 2210 | Encaminhado a Protesto |\n| 2211 | Baixado automaticamente via arquivo |\n| 2212 | Baixa rejeitada |\n| 2213 | Tarifa |\n| 2214 | Rejeição do pagador |\n| 2215 | Alteração rejeitada |\n| 2216 | Aceite do Pagador |\n| 2217 | Baixa por Crédito em Conta Corrente |\n| 2218 | Entrada Rejeitada Carnê |\n| 2219 | Tarifa Emissão Aviso de Movimentação de Títulos |\n| 2220 | Débito Mensal de Tarifas - Aviso de Movimentação de Títulos |\n| 2221 | Entrada Confirmada com Rateio de Crédito |\n| 2222 | Baixa por Crédito em Conta Corrente sem Título Correspondente |\n| 2223 | Confirmação de Entrada na Cobrança |\n| 2224 | Instrução de Negativação Expressa Rejeitada |\n| 2225 | Confirma o Recebimento de Instrução de Entrada Em Negativação Expressa |\n| 2226 | Confirma o Recebimento de Instrução de Exclusão de Entrada Em Negativação Expressa |\n| 2227 | Confirma o Recebimento de Instrução de Cancelamento de Negativação Expressa |\n| 2228 | Negativação Expressa Informacional |\n| 2229 | Confirma de Entrada Em Negativação Expressa / Tarifa |\n| 2230 | Confirma o Cancelamento Em Negativação Expressa / Tarifa |\n| 2231 | Confirma Exclusão de Entrada Em Negativação Expressa Por Liquidação / Tarifa |\n| 2232 | Tarifa Pacote Cobrança Ativa Eletrônica |\n| 2233 | Tarifa E-mail Cobrança Ativa Eletrônica |\n| 2234 | Tarifa Sms Cobrança Ativa Eletrônica |\n| 2235 | Tarifa Mensal Pacote Cobrança Ativa Eletrônica |\n| 2236 | Tarifa Mensal E-mail Cobrança Ativa Eletrônica |\n| 2237 | Tarifa Mensal Sms Cobrança Ativa Eletrônica |\n| 2238 | Tarifa Mensal de Exclusão de Entrada Em Negativação Expressa |\n| 2239 | Tarifa Mensal de Cancelamento de Negativação Expressa |\n| 2240 | Tarifa Mensal de Exclusão de Negativação Expressa Por Liquidação |\n| 2241 | Confirma Recebimento de Instrução de Não Negativar |\n| 2242 | Transferência de Beneficiário |\n| 2243 | Baixa de Título Protestado |\n| 2244 | Despesa de Cartório |\n| 2245 | Acerto de Data de Emissão |\n| 2246 | Acerto de Código de Espécie Documento |\n| 2247 | Instrução Negativação Aceita |\n| 2248 | Instrução Baixa de Negativação Aceita |\n| 2249 | Instrução Não Negativar Aceita |", "enum": [ "2001", "2002", "2003", "2004", "2005", "2006", "2007", "2008", "2009", "2010", "2011", "2012", "2013", "2014", "2015", "2016", "2017", "2018", "2019", "2020", "2021", "2022", "2023", "2024", "2025", "2026", "2027", "2028", "2029", "2030", "2031", "2032", "2033", "2034", "2035", "2036", "2037", "2038", "2039", "2040", "2041", "2042", "2043", "2044", "2045", "2046", "2047", "2048", "2049", "2050", "2051", "2052", "2053", "2054", "2055", "2056", "2057", "2058", "2059", "2060", "2061", "2062", "2063", "2064", "2065", "2066", "2067", "2068", "2069", "2070", "2071", "2072", "2073", "2074", "2075", "2076", "2077", "2078", "2079", "2080", "2081", "2082", "2083", "2084", "2085", "2086", "2087", "2088", "2089", "2090", "2091", "2092", "2093", "2094", "2095", "2096", "2097", "2098", "2099", "2100", "2101", "2102", "2103", "2104", "2105", "2106", "2107", "2108", "2109", "2110", "2111", "2112", "2113", "2114", "2115", "2116", "2117", "2118", "2119", "2120", "2121", "2122", "2123", "2124", "2125", "2126", "2127", "2128", "2129", "2130", "2131", "2132", "2133", "2134", "2135", "2136", "2137", "2138", "2139", "2140", "2141", "2142", "2143", "2144", "2145", "2146", "2147", "2148", "2149", "2150", "2151", "2152", "2153", "2154", "2155", "2156", "2157", "2158", "2159", "2160", "2161", "2162", "2163", "2164", "2165", "2166", "2167", "2168", "2169", "2170", "2171", "2172", "2173", "2174", "2175", "2176", "2177", "2178", "2179", "2180", "2181", "2182", "2183", "2184", "2185", "2186", "2187", "2188", "2189", "2190", "2191", "2192", "2193", "2194", "2195", "2196", "2197", "2198", "2199", "2200", "2201", "2202", "2203", "2204", "2205", "2206", "2207", "2208", "2209", "2210", "2211", "2212", "2213", "2214", "2215", "2216", "2217", "2218", "2219", "2220", "2221", "2222", "2223", "2224", "2225", "2226", "2227", "2228", "2229", "2230", "2231", "2232", "2233", "2234", "2235", "2236", "2237", "2238", "2239", "2240", "2241", "2242", "2243", "2244", "2245", "2246", "2247", "2248", "2249" ] }, "discharge_id": { "type": "integer", "nullable": true, "description": "ID do Retorno.", "example": null }, "bank_billet_id": { "type": "integer", "nullable": true, "description": "ID do Boleto.", "example": null }, "processed_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data de Processamento." }, "date_of_occurrence": { "type": "string", "format": "date", "nullable": true, "readOnly": true, "description": "Data da ocorrência." }, "occurrence": { "type": "string", "maxLength": 2, "nullable": true, "description": "Código da operação no banco." }, "occurrence_detail": { "type": "string", "nullable": true, "description": "Descrição do evento no Retorno." }, "occurrence_error": { "type": "string", "nullable": true, "description": "Erro no retorno." }, "occurrence_error_detail": { "type": "string", "nullable": true, "description": "Descrição do erro no retorno." }, "line_raw": { "type": "string", "format": "json", "nullable": true, "description": "Linha plana com informações vindas do banco.", "example": null }, "line_parsed": { "type": "string", "format": "json", "nullable": true, "description": "Linha parseada com informações vindas do banco:\n\nConteúdo do retorno bancário. Pode mudar de acordo com o banco e o formato 240 ou 400. Se algum dos campos estiver em branco é porque o seu banco não disponibiliza essa informação.\n\n| Valor | Descrição |\n|---|---|\n| paid_at | Data de pagamento |\n| paid_amount | Valor pago |\n| bank_rate | Taxa do boleto paga ao banco |\n| credit_at | Data de crédito |\n| credit_amount | Valor do Crédito |\n| our_number | Nosso número |\n| processed_our_number_raw | Nosso número formatado |\n| discount | Desconto |\n| billet_fine | Acréscimos(Multa/Juros cobrados) |\n| other_fines | Outras cobranças adicionais |\n| other_credit | Outros valores pagos |\n| value_rebate | Outras taxas |\n| error_code | Código de erro |\n| event_type | Ocorrência bancária |\n| agency_number | Agência |\n| account_number | Conta |\n| banco_recebedor | Banco recebedor |\n| agencia_recebedora | Agência recebedora |\n| control_number | Número de Controle |\n| document_number | Número do Documento |" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do registro" } } }, "v1_remittance_object": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do CNAB" }, "content": { "type": "string", "nullable": true, "description": "Conteúdo da remessa" }, "filename": { "type": "string", "maxLength": 255, "nullable": true, "description": "Nome do arquivo" }, "status": { "type": "string", "readOnly": true, "description": "Situação do arquivo:\n* `unprocessed` Pendente\n* `processed` Processado\n* `send` Enviada para o banco (Somente quando contratado envio automático)", "enum": [ "unprocessed", "processed", "send" ] }, "processed_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data de Processamento." }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação." }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização." }, "url": { "type": "string", "nullable": true, "description": "URL do arquivo de remessa." }, "created_via_api": { "type": "boolean", "nullable": true, "description": "Enviado pela API", "example": null }, "bank_billet_account_id": { "type": "integer", "nullable": true, "description": "ID da [Carteira de Cobrança](/reference/post_v1-bank-billet-accounts).", "example": null }, "remittance_number": { "type": "integer", "nullable": true, "description": "Número da remessa", "example": null }, "sent_via_integration": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de envio automático para o banco." }, "bank_billet_ids": { "type": "array", "nullable": true, "example": null, "readOnly": true, "description": "IDs de boletos.", "items": { "type": "integer" } }, "bank_billet_remittances": { "type": "array", "nullable": true, "example": null, "description": "Registros de Remessa.", "items": { "$ref": "#/components/schemas/v1_bank_billet_remittance_object" } }, "external_id": { "type": "string", "nullable": true, "description": "ID externo." }, "custom_data": { "type": "object", "nullable": true, "description": "Dados customizados." }, "tags": { "type": "array", "nullable": true, "description": "Etiquetas.", "items": { "type": "string" } }, "tag_list": { "type": "string", "nullable": true, "readOnly": true, "description": "Lista de etiquetas separadas por vírgula." } } }, "v1_remittance_create_cnab_object": { "type": "object", "properties": { "bank_billet_account_id": { "type": "integer", "nullable": true, "description": "ID da [Carteira de Cobrança](/reference/post_v1-bank-billet-accounts).", "example": null }, "bank_billet_remittance_ids": { "type": "array", "nullable": true, "example": null, "description": "IDs de [Registros de Remessa](/reference/get_v1-bank-billet-remittances).", "items": { "type": "integer" } }, "external_id": { "type": "string", "nullable": true, "description": "ID externo." }, "custom_data": { "type": "object", "nullable": true, "description": "Dados customizados." }, "tags": { "type": "array", "nullable": true, "description": "Etiquetas.", "items": { "type": "string" } } } }, "v1_bank_billet_remittance_object": { "type": "object", "required": [ "our_code", "remittance_id", "bank_billet_id", "bank_billet_account_id" ], "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Registro de Remessa" }, "our_code": { "type": "string", "maxLength": 6, "nullable": true, "description": "Código de operação de registro. Consulte os possíveis valores [para cada banco](/reference/bancos-suportados)." }, "occurrence": { "type": "string", "maxLength": 3, "nullable": true, "description": "Ocorrência." }, "remittance_id": { "type": "integer", "nullable": true, "description": "ID da Remessa.", "example": null }, "bank_billet_id": { "type": "integer", "nullable": true, "description": "ID do Boleto.", "example": null }, "bank_billet_account_id": { "type": "integer", "nullable": true, "description": "ID da Carteira.", "example": null }, "processed_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data de Processamento." }, "occurrence_detail": { "type": "string", "nullable": true, "description": "Descrição do evento na Remessa." }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do registro" } } }, "v1_bank_billet_registration_object": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Registro de Boleto" }, "bank_billet_id": { "type": "integer", "nullable": true, "description": "ID do Boleto.", "example": null }, "bank_billet_account_id": { "type": "integer", "nullable": true, "description": "ID da Carteira.", "example": null }, "status": { "type": "string", "readOnly": true, "description": "Situação do registro:\n* `0` Erro\n* `1` Sucesso\n* `2` Serviço indisponível", "enum": [ "0", "1", "2" ] }, "registered_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora do registro." }, "error_message": { "type": "string", "nullable": true, "description": "Mensagem de erro do registro." }, "failed_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da falha." }, "fails_count": { "type": "integer", "nullable": true, "description": "Quantidade de falhas em tentativas de registrar o boleto." }, "retry_blocked": { "type": "boolean", "nullable": true, "description": "Retentativa bloqueada." }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do registro" } } }, "v1_bank_billet_report_object": { "type": "object", "properties": { "bank_billet_account_id": { "type": "integer", "nullable": true, "description": "ID da Carteira de Cobrança.", "example": null }, "bank_billet_count": { "type": "integer", "nullable": true, "description": "Quantidade de boletos." }, "bank_billet_amount": { "type": "number", "nullable": true, "description": "Valor total dos boletos." } } }, "v1_bank_billet_payment_object": { "type": "object", "required": [ "paid_at", "bank_billet_id", "bank_billet_account_id", "paid_amount", "kind" ], "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Recebimento de Boleto" }, "bank_billet_id": { "type": "integer", "nullable": true, "description": "ID do Boleto.", "example": null }, "bank_billet_account_id": { "type": "integer", "nullable": true, "description": "ID da Carteira.", "example": null }, "discharge_id": { "type": "integer", "nullable": true, "description": "ID do Retorno.", "example": null }, "amount": { "type": "number", "format": "float", "description": "Valor do Boleto", "example": 10.99 }, "paid_amount": { "type": "number", "format": "float", "description": "Valor Pago", "example": 10.99 }, "paid_at": { "type": "string", "format": "date", "nullable": true, "readOnly": true, "description": "Data do Recebimento." }, "paid_bank": { "type": "string", "maxLength": 3, "nullable": true, "description": "Banco de Recebimento." }, "paid_agency": { "type": "string", "maxLength": 5, "nullable": true, "description": "Agência de Recebimento (com dígito quando disponível)." }, "paid_agency_number": { "type": "string", "maxLength": 4, "nullable": true, "description": "Número da Agência de Recebimento (sem dígito)." }, "paid_agency_digit": { "type": "string", "maxLength": 1, "nullable": true, "description": "Dígito da Agência de Recebimento." }, "bank_rate": { "type": "number", "format": "float", "nullable": true, "description": "Taxa bancária", "example": 10.99 }, "credit_at": { "type": "string", "format": "date", "nullable": true, "readOnly": true, "description": "Data de crédito." }, "direct": { "type": "boolean", "deprecated": true, "nullable": true, "description": "Recebimento direto ao beneficíario", "example": null }, "expire_at": { "type": "string", "format": "date", "nullable": true, "readOnly": true, "description": "Data de vencimento." }, "kind": { "type": "integer", "description": "Tipo de Recebimento:\n* `0` Direto ao beneficíario/Em mãos\n* `1` Boleto (Confirmado pelo banco via arquivo de retorno ou API)\n* `2` Pix (Confirmado pelo banco via Pix)", "enum": [ 0, 1, 2 ] }, "document_number": { "type": "string", "nullable": true, "readOnly": true, "description": "Número do Documento." }, "our_number": { "type": "string", "nullable": true, "description": "Nosso Número.", "example": null }, "created_via_api": { "type": "boolean", "nullable": true, "description": "Enviado pela API", "example": null }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação." }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização." }, "customer_person_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "Nome do cliente" }, "paid_by_pix": { "type": "boolean", "deprecated": true, "nullable": true, "description": "\tRecebimento via Pix", "example": null }, "financial_provider_external_id": { "type": "string", "nullable": true, "description": "ID do recebimento na instituição financeira", "example": null }, "line_parsed": { "type": "string", "format": "json", "nullable": true, "description": "Linha parseada com informações vindas do banco:\n\nConteúdo do retorno bancário. Pode mudar de acordo com o banco e o formato 240 ou 400. Se algum dos campos estiver em branco é porque o seu banco não disponibiliza essa informação.\n\n| Valor | Descrição |\n|---|---|\n| paid_at | Data de recebimento |\n| paid_amount | Valor pago |\n| bank_rate | Taxa do boleto paga ao banco |\n| credit_at | Data de crédito |\n| credit_amount | Valor do Crédito |\n| our_number | Nosso número |\n| processed_our_number_raw | Nosso número formatado |\n| discount | Desconto |\n| billet_fine | Acréscimos(Multa/Juros cobrados) |\n| other_fines | Outras cobranças adicionais |\n| other_credit | Outros valores pagos |\n| value_rebate | Outras taxas |\n| error_code | Código de erro |\n| event_type | Ocorrência bancária |\n| agency_number | Agência |\n| account_number | Conta |\n| banco_recebedor | Banco recebedor |\n| agencia_recebedora | Agência recebedora |\n| control_number | Número de Controle |\n| document_number | Número do Documento |" } } }, "v1_bank_billet_batch_create_object": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "nullable": true, "description": "Nome do lote." }, "bank_billet_ids": { "type": "string", "nullable": true, "description": "IDs dos [Boletos](/reference/post_v1-bank-billets-1) separados por vírgula.", "example": null } } }, "v1_bank_billet_batch_object": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do lote" }, "name": { "type": "string", "nullable": true, "description": "Nome do lote." }, "bank_billet_ids": { "type": "array", "nullable": true, "example": null, "description": "IDs dos [Boletos](/reference/post_v1-bank-billets-1).", "items": { "type": "integer" } }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação." }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização." } } }, "v1_bank_billet_batch_export_object": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID arquivo de exportação do lote" }, "account_id": { "type": "integer", "readOnly": true, "description": "ID da conta" }, "bank_billet_batch_id": { "type": "integer", "readOnly": true, "description": "ID do lote" }, "status": { "type": "string", "readOnly": true, "description": "Situação da exportação do lote:\n* `pending` Pendente\n* `enqueued` Na Fila\n* `processed` Processado\n* `failed` Falhou", "enum": [ "pending", "enqueued", "processed", "failed" ] }, "file_format": { "type": "string", "readOnly": true, "description": "Formato do Arquivo:\n* `zip` Pendente\n* `pdf` Na Fila", "enum": [ "zip", "pdf" ] }, "output_url": { "type": "string", "nullable": true, "description": "Url do arquivo." }, "processed_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora do processamento." }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação." }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização." } } }, "v1_import": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID da Importação." }, "status": { "type": "string", "readOnly": true, "description": "Status da importação.\n\n`enqueued`: Aguardando processamento. [Estado inicial]\n`failed`: Processamento não realizado devido a erro.\n`processed`: Processamento concluído.\n" }, "started_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data/hora de início do processamento da Importação", "nullable": true }, "finished_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data/hora de fim do processamento da Importação", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data/hora da criação da Importação" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data/hora da atualização da Importação" }, "created_rows": { "type": "integer", "readOnly": true }, "enqueued_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "processed_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "failed_to_create_rows": { "type": "integer", "readOnly": true }, "failed_to_update_rows": { "type": "integer", "readOnly": true }, "import_errors": { "type": "object", "readOnly": true, "nullable": true }, "processed_rows": { "type": "integer", "readOnly": true }, "total_rows": { "type": "integer", "readOnly": true, "nullable": true }, "updated_rows": { "type": "integer", "readOnly": true } } }, "v1_import_send": { "type": "object", "required": [ "source" ], "properties": { "source": { "type": "string", "format": "binary", "description": "Arquivo para importação." } } }, "v2_error": { "type": "object", "required": [ "status", "errors" ], "properties": { "status": { "type": "integer", "minimum": 100, "maximum": 599, "description": "Status HTTP do erro. Ex: `400`.", "examples": [ 400, 401, 422, 500 ] }, "errors": { "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Descrição breve do erro. Ex: `Token de API inválido`.", "examples": [ "Token de API inválido", "Parâmetro obrigatório" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Código do erro. Ex: `validation_error`.", "examples": [ "validation_error", "authentication_error", "not_found" ] }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Nome do parâmetro que falhou a validação. Ex: `amount`.", "examples": [ "amount", "customer_email", "expire_at" ] }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "object" } ], "description": "Detalhe da validação que gerou o erro. Ex: `não pode ficar em branco`.", "examples": [ "não pode ficar em branco", "deve ser um email válido" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "object" } ] } }, "additionalProperties": false }, "description": "Erros aninhados" } }, "additionalProperties": false } } }, "additionalProperties": false }, "v2_pagination": { "type": "object", "required": [ "page" ], "properties": { "prev_url": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ], "description": "URL da página anterior.", "examples": [ "https://api.kobana.com.br/v2/bank_billets?page=1", null ] }, "next_url": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ], "description": "URL da próxima página.", "examples": [ "https://api.kobana.com.br/v2/bank_billets?page=3", null ] }, "page": { "type": "integer", "minimum": 1, "description": "Número da página atual.", "examples": [ 1, 2, 10 ] } }, "additionalProperties": false }, "v2_pix_command": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Comando." }, "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "Identificador público (UUID) do Comando. Utilizado como parâmetro na consulta individual (`GET /commands/{uid}`)." }, "status": { "type": "string", "readOnly": true, "description": "Status do comando.\n\n`pending`: Comando ainda não executado. [Estado inicial]\n`confirmed`: Comando executado e confirmado.\n`failed`: Execução do comando falhou.\n" }, "operation": { "type": "string", "readOnly": true, "description": "Tipo da operação.\n\n`update`: Alteração de dados.\n`cancel`: Cancelamento.\n`destroy`: Exclusão do registro.\n" }, "resource_type": { "type": "string", "readOnly": true, "nullable": true, "description": "Tipo do recurso ao qual o Comando pertence (ex.: `BankBillet`, `Pix`, `Financial::Account`)." }, "resource_uid": { "type": "string", "format": "uuid", "readOnly": true, "nullable": true, "description": "Identificador público (UUID) do recurso ao qual o Comando pertence." }, "financial_provider_slug": { "type": "string", "readOnly": true, "nullable": true, "description": "Slug do provedor financeiro (banco) responsável pela execução do Comando." }, "params": { "type": "object", "readOnly": true, "nullable": true, "description": "Parâmetros para a execução do Comando." }, "payload": { "type": "object", "readOnly": true, "nullable": true, "description": "Resposta do servidor com o resultado da operação." }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da criação do registro do Comando" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da atualização do registro do Comando." }, "confirmation_via": { "type": "string", "enum": [ "api", "edi" ], "readOnly": true, "nullable": true, "description": "Origem da confirmação do Comando.\n\n`api`: confirmado via resposta da API do banco (inclui webhooks, Recuperator e sync).\n`edi`: confirmado via retorno CNAB (arquivo de baixa).\n`null`: Sem origem registrada.\n" }, "pix": { "$ref": "#/components/schemas/v2_pix" } } }, "v2_pix": { "type": "object", "required": [ "amount", "pix_account_uid", "expire_at" ], "properties": { "id": { "type": "integer", "readOnly": true, "deprecated": true, "description": "ID do Pix (DEPRECATED: use uid)", "example": 123 }, "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID do Pix", "examples": [ "018df180-7208-727b-a10a-ea545e4a75a8" ] }, "amount": { "type": "number", "minimum": 0.01, "multipleOf": 0.01, "description": "Quantia em reais", "examples": [ 120.99, 50.0, 1000.5 ] }, "payer": { "type": "object", "description": "Dados do Pagador", "properties": { "document_number": { "type": "string", "nullable": false, "description": "Número do Documento (CPF ou CNPJ)", "example": "111.321.322-09" }, "name": { "type": "string", "nullable": false, "description": "Nome Completo ou Razão Social", "example": "João da Silva" }, "email": { "type": "string", "nullable": true, "description": "Email do Pagador", "example": "joao@example.com" }, "address": { "type": "object", "description": "Endereço do Pagador. Obrigatório para Pix com tipo de registro Cobrança para o banco Sicoob", "properties": { "street": { "type": "string", "nullable": false, "description": "Rua", "example": "Rua das Flores" }, "zip_code": { "type": "string", "nullable": false, "description": "CEP", "example": "12345-678" }, "complement": { "type": "string", "nullable": true, "description": "Complemento", "example": "Casa 2" }, "number": { "type": "string", "nullable": false, "description": "Número", "example": "123" }, "neighborhood": { "type": "string", "nullable": false, "description": "Bairro", "example": "Centro" }, "city_name": { "type": "string", "nullable": false, "description": "Nome da Cidade", "example": "São Paulo" }, "state": { "type": "string", "nullable": false, "description": "Sigla do Estado", "example": "SP" } } } }, "required": [ "document_number", "name" ], "example": { "document_number": "111.321.322-09", "name": "João da Silva", "email": "joao@example.com", "address": { "street": "Rua das Flores", "zip_code": "12345-678", "complement": "Casa 2", "number": "123", "neighborhood": "Centro", "city_name": "São Paulo", "state": "SP" } } }, "status": { "readOnly": true, "type": "string", "enum": [ "opened", "paid", "overdue", "canceled", "generation_failed" ], "description": "Status do Pix.\n\n* `opened`: Cobrança Pix em aberto (não pago). [Estado Inicial]\n* `paid`: Cobrança Pix paga.\n* `overdue`: Cobrança Pix em atraso.\n* `canceled`: Cobrança Pix cancelada.\n* `generation_failed`: Cobrança Pix criada, mas não foi registrada no banco.\n", "examples": [ "opened", "paid", "canceled" ] }, "pix_account_id": { "type": "integer", "readOnly": true, "deprecated": true, "description": "ID da Conta Pix (DEPRECATED: use pix_account_uid)", "example": 456 }, "pix_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Pix", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "txid": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 35 }, { "type": "null" } ], "description": "TXID do Pix - Identificador único da transação", "examples": [ "E12345678202201011200123456789AB", null ] }, "expire_at": { "type": "string", "format": "date-time", "description": "Data e hora de vencimento. Formato iso8601", "example": "2023-12-02T10:03:56-03:00" }, "canceled_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de cancelamento do Pix", "example": "2023-12-02T10:03:56-03:00" }, "registered_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de registro no provedor", "example": "2023-12-02T10:03:56-03:00" }, "paid_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora do pagamento", "example": "2023-12-02T10:03:56-03:00" }, "paid_amount": { "type": "number", "format": "float", "nullable": true, "readOnly": true, "description": "Valor efetivamente pago", "example": 120.99 }, "registration_status": { "type": "string", "readOnly": true, "nullable": true, "description": "Status do registro no provedor", "enum": [ "pending", "skipped", "requested", "confirmed", "rejected", "failed" ], "example": "confirmed" }, "revoke_days": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ], "description": "Número de dias ativo após o vencimento. OBRIGATÓRIO e deve ser maior que zero quando o Pix possui juros (interest) ou multa (fine) configurados.", "examples": [ 1, 7, 30, null ] }, "message": { "anyOf": [ { "type": "string", "maxLength": 140 }, { "type": "null" } ], "description": "Mensagem de solicitação ao pagador", "examples": [ "Pagamento da fatura 123", "Cobrança mensal", null ] }, "message_payer": { "anyOf": [ { "type": "string", "maxLength": 140 }, { "type": "null" } ], "readOnly": true, "description": "Mensagem para o pagador (campo readOnly)", "examples": [ "Pagamento da fatura 123", null ] }, "beneficiary": { "type": "object", "readOnly": true, "nullable": true, "description": "Dados do beneficiário do Pix", "properties": { "document_number": { "type": "string", "description": "CPF/CNPJ do beneficiário", "example": "12345678900" }, "name": { "type": "string", "description": "Nome do beneficiário", "example": "João Silva" } } }, "url": { "type": "string", "readOnly": true, "nullable": true, "description": "URL para visualização do Pix", "example": "https://kobana.com.br/p/abc123" }, "formats": { "type": "object", "readOnly": true, "nullable": true, "description": "URLs com formatos disponíveis para o Pix", "properties": { "default": { "type": "object", "properties": { "html": { "type": "string", "description": "URL HTML padrão", "example": "https://kobana.com.br/p/abc123" }, "png": { "type": "string", "description": "URL PNG padrão", "example": "https://kobana.com.br/p/abc123.png" }, "pdf": { "type": "string", "description": "URL PDF padrão", "example": "https://kobana.com.br/p/abc123.pdf" } } }, "qrcode": { "type": "object", "properties": { "html": { "type": "string", "description": "URL HTML QRCode", "example": "https://kobana.com.br/p/abc123/qrcode" }, "png": { "type": "string", "description": "URL PNG QRCode", "example": "https://kobana.com.br/p/abc123/qrcode.png" }, "pdf": { "type": "string", "description": "URL PDF QRCode", "example": "https://kobana.com.br/p/abc123/qrcode.pdf" } } } } }, "additional_info": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string", "maxLength": 200 }, "maxProperties": 10 }, { "type": "null" } ], "description": "Informações adicionais para o pagador (máximo 10 pares chave-valor)", "examples": [ { "Pedido": "12345", "Cliente": "João Silva" }, { "Referência": "FATURA-001" }, null ] }, "qrcode": { "type": "object", "description": "QR Code do Pix", "readOnly": true, "properties": { "emv": { "anyOf": [ { "type": "string", "pattern": "^[0-9A-Za-z\\+\\/\\=\\.\\:\\-\\*]+$" }, { "type": "null" } ], "description": "QR Code no formato EMV.", "readOnly": true, "examples": [ "00020126...", null ] }, "png": { "anyOf": [ { "type": "string", "contentEncoding": "base64", "contentMediaType": "image/png" }, { "type": "null" } ], "description": "QR Code no formato PNG em base64.", "readOnly": true, "examples": [ "iVBORw0KGgoAAAANSUhEUgAA...", null ] } } }, "registration_kind": { "type": "string", "enum": [ "instant", "billing" ], "default": "instant", "writeOnly": true, "description": "Tipo do Pix.\n\n* `instant`: Imediato (padrão)\n* `billing`: Cobrança\n", "examples": [ "instant", "billing" ] }, "kind": { "type": "string", "enum": [ "instant", "billing" ], "readOnly": true, "description": "Tipo do Pix.\n\n* `instant`: Imediato (padrão)\n* `billing`: Cobrança\n", "examples": [ "instant", "billing" ] }, "command_ids": { "type": "array", "readOnly": true, "items": { "type": "integer", "description": "IDs dos registros de Comandos do Pix" } }, "payments": { "type": "array", "readOnly": true, "items": { "type": "string", "format": "uuid", "description": "UID do Recebimento" }, "description": "Lista de UIDs dos Recebimentos vinculados ao Pix", "examples": [ [ "018df180-7208-727b-a10a-ea545e4a75a8" ], [], [ "018df180-7208-727b-a10a-ea545e4a75a8", "018df180-8319-8a9c-b21b-fa656f5b86b9" ] ] }, "end_to_end_id": { "anyOf": [ { "type": "string", "pattern": "^[A-Z]{1}[0-9]{8}[0-9]{4}[0-9]{2}[0-9]{2}[0-9]{4}[0-9a-zA-Z]{11}$" }, { "type": "null" } ], "readOnly": true, "description": "End To End Id do Pix - Identificador único da transferência", "examples": [ "E12345678202301011200123456789AB", null ] }, "custom_data": { "anyOf": [ { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] } }, { "type": "null" } ], "examples": [ { "codigo": "123", "vip": true }, { "referencia": "PEDIDO-001", "prioridade": "alta" }, null ], "description": "Hash com chave e valor no formato JSON." }, "external_id": { "type": "string", "nullable": true, "description": "Identificador externo para o Pix", "example": "pix_123" }, "virtual_pix_uid": { "type": "string", "readOnly": true, "nullable": true, "description": "UID do Pix gerado por membro BackOffice. (BackOffice precisa estar habilitado).", "example": null }, "fine_type": { "type": "integer", "writeOnly": true, "enum": [ 0, 1, 2 ], "description": "Tipo da multa:\n * `0` Sem multa (`none`)\n * `1` Por valor (`amount`)\n * `2` Por percentual (`percentage`)\n No retorno os dados vêm no objeto `fine`.", "example": 1 }, "fine_amount": { "type": "number", "format": "float", "writeOnly": true, "description": "Valor da multa em reais. Obrigatório quando `fine_type` = `amount`.", "example": 50.0 }, "fine_percentage": { "type": "number", "format": "float", "writeOnly": true, "description": "Percentual da multa (0.0 a 100.0). Obrigatório quando `fine_type` = `percentage`.", "example": 5.0 }, "interest_type": { "type": "integer", "writeOnly": true, "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ], "description": "Tipo de juros:\n * `0` Não se aplica / isento (`none`)\n * `1` Valor diário — dias corridos (`daily_amount_calendar`)\n * `2` Percentual diário — dias corridos (`daily_percentage_calendar`)\n * `3` Percentual mensal — dias corridos (`monthly_percentage_calendar`)\n * `4` Percentual anual — dias corridos (`yearly_percentage_calendar`)\n * `5` Valor diário — dias úteis (`daily_amount_business`)\n * `6` Percentual diário — dias úteis (`daily_percentage_business`)\n * `7` Percentual mensal — dias úteis (`monthly_percentage_business`)\n * `8` Percentual anual — dias úteis (`yearly_percentage_business`)\n No retorno os dados vêm no objeto `interest`.", "example": 2 }, "interest_amount": { "type": "number", "format": "float", "writeOnly": true, "description": "Valor diário de juros em reais. Obrigatório quando `interest_type` for por valor (`daily_amount_*`).", "example": 2.0 }, "interest_percentage": { "type": "number", "format": "float", "writeOnly": true, "description": "Percentual de juros. Obrigatório quando `interest_type` for por percentual.", "example": 2.5 }, "reduction_type": { "type": "integer", "writeOnly": true, "enum": [ 1, 2, 3 ], "description": "Tipo de abatimento:\n * `1` Por valor (`amount`)\n * `2` Por percentual (`percentage`)\n * `3` Não se aplica — remove o abatimento (`none`)\n No retorno os dados vêm no objeto `reduction`.", "example": 1 }, "reduction_amount": { "type": "number", "format": "float", "writeOnly": true, "description": "Valor do abatimento em reais. Obrigatório quando `reduction_type` = `amount`.", "example": 25.0 }, "reduction_percentage": { "type": "number", "format": "float", "writeOnly": true, "description": "Percentual do abatimento. Obrigatório quando `reduction_type` = `percentage`.", "example": 2.5 }, "discount_type": { "type": "integer", "writeOnly": true, "enum": [ 1, 2, 3, 4, 5, 6 ], "description": "Tipo de desconto aplicado aos campos `discount_*` (nulo/ausente = sem desconto):\n * `1` Valor fixo (`fixed_amount`)\n * `2` Percentual fixo (`fixed_percentage`)\n * `3` Antecipação por valor — dias corridos (`advance_amount_calendar`)\n * `4` Antecipação por valor — dias úteis (`advance_amount_business`)\n * `5` Antecipação por percentual — dias corridos (`advance_percentage_calendar`)\n * `6` Antecipação por percentual — dias úteis (`advance_percentage_business`)\n As modalidades de antecipação (`3`–`6`) aceitam apenas uma faixa. No retorno o tipo vem em `discounts.type`.", "example": 1 }, "discount_amount": { "type": "number", "format": "float", "writeOnly": true, "description": "Valor do 1º desconto em reais. Obrigatório quando `discount_type` for por valor.", "example": 5.0 }, "discount_percentage": { "type": "number", "format": "float", "writeOnly": true, "description": "Percentual do 1º desconto. Obrigatório quando `discount_type` for por percentual.", "example": 5.0 }, "discount_days": { "type": "integer", "writeOnly": true, "description": "Dias antes do vencimento em que o 1º desconto é válido.", "example": 7 }, "discount_second_amount": { "type": "number", "format": "float", "writeOnly": true, "description": "Valor do 2º desconto em reais.", "example": 10.0 }, "discount_second_percentage": { "type": "number", "format": "float", "writeOnly": true, "description": "Percentual do 2º desconto.", "example": 2.5 }, "discount_second_days": { "type": "integer", "writeOnly": true, "description": "Dias antes do vencimento em que o 2º desconto é válido.", "example": 9 }, "discount_third_amount": { "type": "number", "format": "float", "writeOnly": true, "description": "Valor do 3º desconto em reais.", "example": 15.0 }, "discount_third_percentage": { "type": "number", "format": "float", "writeOnly": true, "description": "Percentual do 3º desconto.", "example": 1.0 }, "discount_third_days": { "type": "integer", "writeOnly": true, "description": "Dias antes do vencimento em que o 3º desconto é válido.", "example": 10 }, "fine": { "type": "object", "nullable": true, "readOnly": true, "description": "Configuração de multa (RETORNO/response como objeto nested). No ENVIO/request use os campos flat `fine_type`, `fine_amount` e `fine_percentage`.", "properties": { "type": { "type": "string", "nullable": true, "description": "Tipo do Multa: none=Sem multa, amount=Por valor, percentage=Por porcentagem", "enum": [ "none", "amount", "percentage" ], "example": "amount" }, "amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor da Multa", "example": 50.0 }, "percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual da Multa", "example": 5.0 } } }, "reduction": { "type": "object", "nullable": true, "readOnly": true, "description": "Configuração de abatimento (RETORNO/response como objeto nested). No ENVIO/request use os campos flat `reduction_type`, `reduction_amount` e `reduction_percentage`.", "properties": { "type": { "type": "string", "nullable": true, "description": "Tipo de Abatimento: none=Não se aplica, amount=Por valor, percentage=Por porcentagem", "enum": [ "none", "amount", "percentage" ], "example": "amount" }, "amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor do Abatimento", "example": 25.0 }, "percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do Abatimento", "example": 2.5 } } }, "interest": { "type": "object", "nullable": true, "readOnly": true, "description": "Configuração de juros (RETORNO/response como objeto nested). No ENVIO/request use os campos flat `interest_type`, `interest_amount` e `interest_percentage`.", "properties": { "type": { "type": "string", "nullable": true, "description": "Tipo de Juros: none, daily_amount_calendar, daily_percentage_calendar, monthly_percentage_calendar, yearly_percentage_calendar, daily_amount_business, daily_percentage_business, monthly_percentage_business, yearly_percentage_business", "enum": [ "none", "daily_amount_calendar", "daily_percentage_calendar", "monthly_percentage_calendar", "yearly_percentage_calendar", "daily_amount_business", "daily_percentage_business", "monthly_percentage_business", "yearly_percentage_business" ], "example": "daily_percentage_calendar" }, "amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor do Juros", "example": 20.0 }, "percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do Juros", "example": 2.5 } } }, "discounts": { "type": "object", "nullable": true, "readOnly": true, "description": "Configuração de descontos (RETORNO/response como objeto nested com até 3 descontos). No ENVIO/request use os campos flat `discount_*`, `discount_second_*` e `discount_third_*`.", "properties": { "type": { "type": "string", "nullable": true, "description": "Tipo de desconto: fixed_amount, fixed_percentage, advance_amount_calendar, advance_amount_business, advance_percentage_calendar, advance_percentage_business", "enum": [ "fixed_amount", "fixed_percentage", "advance_amount_calendar", "advance_amount_business", "advance_percentage_calendar", "advance_percentage_business" ], "example": "fixed_amount" }, "discount_first": { "type": "object", "nullable": true, "description": "Primeiro desconto", "properties": { "amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor do primeiro desconto", "example": 10.0 }, "percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do primeiro desconto", "example": 5.0 }, "days": { "type": "integer", "nullable": true, "description": "Dias para o primeiro desconto", "example": 5 } } }, "discount_second": { "type": "object", "nullable": true, "description": "Segundo desconto", "properties": { "amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor do segundo desconto", "example": 5.0 }, "percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do segundo desconto", "example": 2.5 }, "days": { "type": "integer", "nullable": true, "description": "Dias para o segundo desconto", "example": 10 } } }, "discount_third": { "type": "object", "nullable": true, "description": "Terceiro desconto", "properties": { "amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor do terceiro desconto", "example": 2.5 }, "percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do terceiro desconto", "example": 1.0 }, "days": { "type": "integer", "nullable": true, "description": "Dias para o terceiro desconto", "example": 15 } } } } }, "ignore_whatsapp": { "type": "boolean", "nullable": true, "default": false, "description": "Nunca enviar este Pix por WhatsApp", "example": false }, "password_protected_mode": { "type": "integer", "nullable": true, "enum": [ 0, 1, 2 ], "description": "Modo de proteção por senha: 0=desabilitado, 1=últimos 4 dígitos, 2=primeiros 5 dígitos" }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas ao pix", "example": null, "items": { "type": "string" } }, "tag_list": { "type": "string", "nullable": true, "readOnly": true, "description": "Tags associadas ao pix" }, "created_via_api": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se o Pix foi criado por API" }, "financial_provider_external_id": { "type": "string", "nullable": true, "readOnly": true, "description": "ID na instituição financeira" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do registro" } } }, "v2_pix_update": { "type": "object", "properties": { "amount": { "type": "number", "format": "float", "description": "Quantia", "example": 120.99 }, "pix_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "UID da Conta Pix para alterar a chave Pix do recebedor.\n\nEste campo é útil quando você deseja alterar a chave Pix no provedor financeiro.\n\n**Importante**: Somente são aceitas contas Pix que estejam ativas (status `active`).\n", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payer": { "type": "object", "description": "Dados do Pagador", "properties": { "document_number": { "type": "string", "nullable": false, "description": "Número do Documento (CPF ou CNPJ)", "example": "111.321.322-09" }, "name": { "type": "string", "nullable": false, "description": "Nome Completo ou Razão Social", "example": "João da Silva" }, "email": { "type": "string", "nullable": true, "description": "Email do Pagador", "example": "joao@example.com" }, "address": { "type": "object", "description": "Endereço do Pagador. Obrigatório para Pix com tipo de registro Cobrança para o banco Sicoob", "properties": { "street": { "type": "string", "nullable": false, "description": "Rua", "example": "Rua das Flores" }, "zip_code": { "type": "string", "nullable": false, "description": "CEP", "example": "12345-678" }, "complement": { "type": "string", "nullable": true, "description": "Complemento", "example": "Casa 2" }, "number": { "type": "string", "nullable": false, "description": "Número", "example": "123" }, "neighborhood": { "type": "string", "nullable": false, "description": "Bairro", "example": "Centro" }, "city_name": { "type": "string", "nullable": false, "description": "Nome da Cidade", "example": "São Paulo" }, "state": { "type": "string", "nullable": false, "description": "Sigla do Estado", "example": "SP" } } } }, "required": [ "document_number", "name" ], "example": { "document_number": "111.321.322-09", "name": "João da Silva", "email": "joao@example.com", "address": { "street": "Rua das Flores", "zip_code": "12345-678", "complement": "Casa 2", "number": "123", "neighborhood": "Centro", "city_name": "São Paulo", "state": "SP" } } }, "status": { "readOnly": true, "type": "string", "description": "Status do Pix.\n\n`opened`: Cobrança Pix em aberto (não pago). [Estado Inicial]\n`paid`: Cobrança Pix paga.\n`overdue`: Cobrança Pix em atraso.\n`canceled`: Cobrança Pix cancelada.\n`generation_failed`: Cobrança Pix criada, mas não foi registrada no banco.\n" }, "expire_at": { "type": "string", "format": "date-time", "description": "Data e hora de vencimento. Formato iso8601", "example": "2023-12-02T10:03:56-03:00" }, "revoke_days": { "type": "integer", "nullable": true, "description": "Número de dias ativo após o vencimento", "example": 1 }, "message": { "type": "string", "nullable": true, "description": "Mensagem de solicitação ao pagador" }, "additional_info": { "type": "object", "nullable": true, "description": "Informações adicionais para o pagador", "example": { "Chave": "Valor" } }, "fine_type": { "type": "integer", "nullable": true, "enum": [ 0, 1, 2 ], "description": "Tipo da multa:\n * `0` Sem multa (`none`)\n * `1` Por valor (`amount`)\n * `2` Por percentual (`percentage`)\n No retorno os dados vêm no objeto `fine`.", "example": 1 }, "fine_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor da multa em reais. Obrigatório quando `fine_type` = `amount`.", "example": 50.0 }, "fine_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual da multa (0.0 a 100.0). Obrigatório quando `fine_type` = `percentage`.", "example": 5.0 }, "interest_type": { "type": "integer", "nullable": true, "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ], "description": "Tipo de juros:\n * `0` Não se aplica / isento (`none`)\n * `1` Valor diário — dias corridos (`daily_amount_calendar`)\n * `2` Percentual diário — dias corridos (`daily_percentage_calendar`)\n * `3` Percentual mensal — dias corridos (`monthly_percentage_calendar`)\n * `4` Percentual anual — dias corridos (`yearly_percentage_calendar`)\n * `5` Valor diário — dias úteis (`daily_amount_business`)\n * `6` Percentual diário — dias úteis (`daily_percentage_business`)\n * `7` Percentual mensal — dias úteis (`monthly_percentage_business`)\n * `8` Percentual anual — dias úteis (`yearly_percentage_business`)\n No retorno os dados vêm no objeto `interest`.", "example": 2 }, "interest_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor diário de juros em reais. Obrigatório quando `interest_type` for por valor (`daily_amount_*`).", "example": 2.0 }, "interest_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual de juros. Obrigatório quando `interest_type` for por percentual.", "example": 2.5 }, "reduction_type": { "type": "integer", "nullable": true, "enum": [ 1, 2, 3 ], "description": "Tipo de abatimento:\n * `1` Por valor (`amount`)\n * `2` Por percentual (`percentage`)\n * `3` Não se aplica — remove o abatimento (`none`)\n No retorno os dados vêm no objeto `reduction`.", "example": 1 }, "reduction_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor do abatimento em reais. Obrigatório quando `reduction_type` = `amount`.", "example": 25.0 }, "reduction_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do abatimento. Obrigatório quando `reduction_type` = `percentage`.", "example": 2.5 }, "discount_type": { "type": "integer", "nullable": true, "enum": [ 1, 2, 3, 4, 5, 6 ], "description": "Tipo de desconto aplicado aos campos `discount_*` (nulo/ausente = sem desconto):\n * `1` Valor fixo (`fixed_amount`)\n * `2` Percentual fixo (`fixed_percentage`)\n * `3` Antecipação por valor — dias corridos (`advance_amount_calendar`)\n * `4` Antecipação por valor — dias úteis (`advance_amount_business`)\n * `5` Antecipação por percentual — dias corridos (`advance_percentage_calendar`)\n * `6` Antecipação por percentual — dias úteis (`advance_percentage_business`)\n As modalidades de antecipação (`3`–`6`) aceitam apenas uma faixa. No retorno o tipo vem em `discounts.type`.", "example": 1 }, "discount_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor do 1º desconto em reais. Obrigatório quando `discount_type` for por valor.", "example": 5.0 }, "discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do 1º desconto. Obrigatório quando `discount_type` for por percentual.", "example": 5.0 }, "discount_days": { "type": "integer", "nullable": true, "description": "Dias antes do vencimento em que o 1º desconto é válido.", "example": 7 }, "discount_second_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor do 2º desconto em reais.", "example": 10.0 }, "discount_second_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do 2º desconto.", "example": 2.5 }, "discount_second_days": { "type": "integer", "nullable": true, "description": "Dias antes do vencimento em que o 2º desconto é válido.", "example": 9 }, "discount_third_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor do 3º desconto em reais.", "example": 15.0 }, "discount_third_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do 3º desconto.", "example": 1.0 }, "discount_third_days": { "type": "integer", "nullable": true, "description": "Dias antes do vencimento em que o 3º desconto é válido.", "example": 10 }, "created_via_api": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se o Pix foi criado por API" }, "financial_provider_external_id": { "type": "string", "nullable": true, "readOnly": true, "description": "ID na instituição financeira" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do registro" } } }, "v2_pix_account": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "deprecated": true, "description": "ID da Conta Pix (deprecated, use uid)", "example": 123 }, "uid": { "type": "string", "readOnly": true, "description": "UUID público da Conta Pix", "example": "123e4567-e89b-12d3-a456-426614174000" }, "financial_account_uid": { "type": "string", "nullable": true, "description": "UID da conta financeira associada. Os dados de beneficiário são derivados automaticamente da conta financeira.", "example": "123e4567-e89b-12d3-a456-426614174000" }, "custom_name": { "type": "string", "description": "Nome customizado da conta pix" }, "financial_provider_slug": { "type": "string", "readOnly": true, "description": "Slug do provedor financeiro (derivado da conta financeira)", "example": "bradesco" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilitar Conta Pix" }, "key": { "type": "string", "description": "Chave pix", "example": "+55999999999" }, "default": { "type": "boolean", "description": "Conta default", "example": "true" }, "status": { "type": "string", "readOnly": true, "description": "Status calculado da conta Pix: active (ativa), inactive (validada mas não habilitada), pending (pendente de validação)", "enum": [ "active", "inactive", "pending" ], "example": "active" }, "beneficiary": { "type": "object", "readOnly": true, "description": "Beneficiário (sincronizado automaticamente da conta financeira)", "properties": { "document_number": { "type": "string", "nullable": true, "description": "Número do documento do beneficiário" }, "name": { "type": "string", "description": "Nome do beneficiário", "example": "Nome do Beneficiário" }, "address": { "type": "object", "description": "Endereço do beneficiário", "properties": { "zip_code": { "type": "string", "description": "CEP", "example": "01234567" }, "street": { "type": "string", "description": "Rua", "example": "Rua do Beneficiário" }, "number": { "type": "string", "description": "Número", "example": "123" }, "complement": { "type": "string", "description": "Complemento", "example": "Apto 101" }, "neighborhood": { "type": "string", "description": "Bairro", "example": "Bairro do Beneficiário" }, "city_name": { "type": "string", "description": "Cidade", "example": "São Paulo" }, "state": { "type": "string", "description": "Estado", "example": "SP" } } } } }, "configuration": { "type": "object", "nullable": true, "readOnly": true, "description": "Configurações da conta Pix" }, "validated_at": { "type": "string", "nullable": true, "format": "date_time", "readOnly": true, "description": "Data de validação da conta Pix" }, "enabled_at": { "type": "string", "nullable": true, "format": "date_time", "readOnly": true, "description": "Data de habilitação da conta Pix" }, "created_at": { "type": "string", "nullable": true, "format": "date_time", "readOnly": true, "description": "Data de criação do registro" }, "updated_at": { "type": "string", "nullable": true, "format": "date_time", "readOnly": true, "description": "Data de atualização do registro" } } }, "v2_pix_account_create": { "type": "object", "required": [ "financial_account_uid", "key" ], "properties": { "financial_account_uid": { "type": "string", "description": "UID da conta financeira. O provedor e dados de beneficiário são derivados automaticamente.", "example": "123e4567-e89b-12d3-a456-426614174000" }, "custom_name": { "type": "string", "description": "Nome customizado da conta pix" }, "key": { "type": "string", "description": "Chave pix", "example": "+55999999999" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilitar Conta Pix" }, "default": { "type": "boolean", "description": "Conta default", "example": "true" } } }, "v2_pix_account_update": { "type": "object", "properties": { "custom_name": { "type": "string", "description": "Nome customizado da conta pix" }, "key": { "type": "string", "description": "Chave pix", "example": "+55999999999" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilitar Conta Pix" }, "default": { "type": "boolean", "description": "Conta default", "example": "true" }, "financial_account_uid": { "type": "string", "description": "UID da conta financeira (para associar a uma conta existente)", "example": "123e4567-e89b-12d3-a456-426614174000" } } }, "v2_split_accounts_object": { "type": "object", "properties": { "bank_number": { "type": "string", "maxLength": 3, "description": "Número do banco" }, "agency_number": { "type": "string", "maxLength": 5, "description": "Agência (Sem dígito)" }, "agency_digit": { "type": "string", "maxLength": 1, "description": "Dígito da Agência" }, "account_number": { "type": "string", "maxLength": 12, "description": "Conta (Sem dígito)" }, "account_digit": { "type": "string", "maxLength": 1, "description": "Dígito da Conta" }, "cnpj_cpf": { "type": "string", "maxLength": 20, "description": "CNPJ/CPF do Beneficiário" }, "name": { "type": "string", "maxLength": 40, "description": "Nome do Beneficiário" }, "amount": { "type": "string", "format": "float", "description": "Quantia (R$)" }, "floating": { "type": "integer", "description": "Quantidade de Dias para Crédito. Padrão 5 dias. Máximo 30 dias." }, "financial_provider_external_id": { "type": "string", "maxLength": 2, "description": "Código de partilha do Santander (2 dígitos, pré-cadastrado no convênio). Quando informado, os dados bancários do recebedor são dispensados." } } }, "v2_bank_billet_discharge": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Registro de Retorno" }, "our_occurrence": { "type": "string", "maxLength": 4, "nullable": true, "description": "Código único de operação dentro da Kobana.\n\n| Código | Descrição |\n|---|---|\n| 2001 | Entrada Confirmada |\n| 2002 | Entrada Rejeitada |\n| 2003 | Liquidação |\n| 2004 | Baixa de Título Confirmada |\n| 2005 | Baixa de Título Rejeitada |\n| 2006 | Alteração do Vencimento Confirmada |\n| 2007 | Alteração do Vencimento Rejeitada |\n| 2008 | Baixa Solicitada |\n| 2009 | Títulos em Carteira (em ser) |\n| 2010 | Confirmação de Recebimento de Instrução de Abatimento |\n| 2011 | Confirmação de Recebimento de Instrução de Cancelamento Abatimento |\n| 2012 | Confirmação de Recebimento de Instrução de Alteração de Vencimento |\n| 2013 | Franco de Pagamento |\n| 2014 | Liquidação Após Baixa ou Liquidação Título Não Registrado |\n| 2015 | Confirmação Recebimento Instrução de Protesto |\n| 2016 | Confirmação Recebimento Instrução de Sustação/Cancelamento de Protesto |\n| 2017 | Remessa a Cartório (Aponte em Cartório) |\n| 2018 | Retirada de Cartório e Manutenção em Carteira |\n| 2019 | Protestado e Baixado (Baixa por ter sido Protestado) |\n| 2020 | Instrução Rejeitada |\n| 2021 | Confirmação do Pedido de Alteração de Outros Dados |\n| 2022 | Débito de Tarifas/Custas |\n| 2023 | Ocorrências do Sacado |\n| 2024 | Alteração de Dados Rejeitada |\n| 2025 | Título pago com cheque devolvido |\n| 2026 | Título pago com cheque pendente de compensação |\n| 2027 | Liquidado sem registro |\n| 2028 | Liquidação Normal |\n| 2029 | Liquidação por Conta/Parcial |\n| 2030 | Liquidação por Saldo |\n| 2031 | Transferência de Carteira/Entrada |\n| 2032 | Transferência de Carteira/Baixa |\n| 2033 | Abatimento Concedido |\n| 2034 | Abatimento Cancelado |\n| 2035 | Liquidação em Cartório |\n| 2036 | Confirmação de alteração de juros de mora |\n| 2037 | Débito em Conta |\n| 2038 | Alteração do Nome do Sacado |\n| 2039 | Alteração do Endereço do Sacado |\n| 2040 | Indicação de encaminhamento a cartório |\n| 2041 | Sustar Protesto |\n| 2042 | Dispensar Juros de mora |\n| 2043 | Alteração do número do título dado pelo Cedente (Seu número) – 10 e 15 posições |\n| 2044 | Manutenção de título vencido |\n| 2045 | Conceder desconto |\n| 2046 | Não conceder desconto |\n| 2047 | Retificar desconto |\n| 2048 | Alterar data para desconto |\n| 2049 | Cobrar Multa |\n| 2050 | Dispensar Multa |\n| 2051 | Dispensar Indexador |\n| 2052 | Dispensar prazo limite para recebimento |\n| 2053 | Alterar prazo limite para recebimento |\n| 2054 | Alteração do número do controle do participante (25 posições) |\n| 2055 | Alteração do número do documento do sacado (CNPJ/CPF) |\n| 2056 | Alteração de tipo de cobrança (específico para títulos das carteiras 11 e 17) |\n| 2057 | Confirmação de Instrução de Parâmetro de Pagamento Parcial |\n| 2058 | Despesas de Protesto |\n| 2059 | Despesas de Sustação de Protesto |\n| 2060 | Débito de Custas Antecipadas |\n| 2061 | Confirmação do recebimento da instrução de desconto |\n| 2062 | Confirmação do recebimento do cancelamento do desconto |\n| 2063 | Solicitação de 2a via de instrumento de protesto |\n| 2064 | 2a via de instrumento de protesto emitida pelo cartório |\n| 2065 | Confirmação da alteração dos dados do sacado |\n| 2066 | Confirmação da alteração dos dados do sacador avalista |\n| 2067 | Título DDA reconhecido pelo sacado |\n| 2068 | Título DDA não reconhecido pelo sacado |\n| 2069 | Título DDA recusado pela CIP |\n| 2070 | Instrução de protesto processada |\n| 2071 | Remessa rejeitada |\n| 2072 | Baixa de título liquidado por edital |\n| 2073 | Devolução automática |\n| 2074 | Baixado conforme instruções |\n| 2075 | Arquivo levantamento |\n| 2076 | Pagamento em cartório |\n| 2077 | Alteração de dados |\n| 2078 | Alteração de instruções |\n| 2079 | Aguardando autorização para protesto por edital |\n| 2080 | Protesto sustado por alteração de vencimento e prazo de cartório |\n| 2081 | Confirmação da entrada em cartório |\n| 2082 | cobrança a creditar (liquidação em trânsito) |\n| 2083 | Título em trânsito pago em cartório |\n| 2084 | Reembolso e transferência Desconto e Vendor ou carteira em garantia |\n| 2085 | Reembolso e devolução Desconto e Vendor |\n| 2086 | Reembolso não efetuado por falta de saldo |\n| 2087 | Despesa de aponte |\n| 2088 | Alteração de título |\n| 2089 | Relação de títulos |\n| 2090 | Manutenção mensal |\n| 2091 | Sustação de cartório e envio de título a cartório |\n| 2092 | Fornecimento de formulário pré-impresso |\n| 2093 | Confirmação de entrada – Pagador DDA |\n| 2094 | Acerto dos dados do rateio de crédito |\n| 2095 | Cancelamento dos dados do rateio |\n| 2096 | Pagamento por Conta |\n| 2097 | Baixa Simples |\n| 2098 | Devolvido - Protestado |\n| 2099 | Baixa automática |\n| 2100 | Alteração Depositária |\n| 2101 | Confirmação de Protesto |\n| 2102 | Título Pago em Cheque – Vinculado |\n| 2103 | Acerto de Depositária |\n| 2104 | Acerto do Controle do Participante |\n| 2105 | Título Com Pagamento Cancelado |\n| 2106 | Entrada rejeitada por CEP Irregular |\n| 2107 | Confirmação Receb.Inst.de Protesto Falimentar |\n| 2108 | Ocorrências do Pagador |\n| 2109 | Retirado de Cartório e Manutenção Carteira |\n| 2110 | Desagendamento do débito automático |\n| 2111 | Estorno de pagamento |\n| 2112 | Sustado judicial |\n| 2113 | Solicitação de Impressão de Títulos Confirmada |\n| 2114 | Confirmação de Inclusão Banco de Pagador |\n| 2115 | Confirmação de Alteração Banco de Pagador |\n| 2116 | Confirmação de Exclusão Banco de Pagador |\n| 2117 | Emissão de Boletos de Banco de Pagador |\n| 2118 | Manutenção de Pagador Rejeitada |\n| 2119 | Entrada de Título via Banco de Pagador Rejeitada |\n| 2120 | Manutenção de Banco de Pagador Rejeitada |\n| 2121 | Estorno de Baixa / Liquidação |\n| 2122 | Liquidação On-line |\n| 2123 | Estorno de Liquidação On-line |\n| 2124 | Confirmação de alteração do valor nominal do título |\n| 2125 | Confirmação de alteração do valor/percentual mínimo/máximo |\n| 2126 | Baixa Manual Confirmada |\n| 2127 | Uso da Empresa Alterado |\n| 2128 | Prazo de Protesto Alterado |\n| 2129 | Prazo de Devolução Alterado |\n| 2130 | Alteração com reemissão de Bloqueto Confirmada |\n| 2131 | Alteração da opção de Protesto para Devolução Confirmada |\n| 2132 | Alteração da opção de Devolução para Protesto Confirmada |\n| 2133 | Baixa por Devolução |\n| 2134 | Título enviado para Cartório |\n| 2135 | Estorno de Protesto |\n| 2136 | Estorno de Sustação de Protesto |\n| 2137 | Tarifa sobre Título Vencido |\n| 2138 | Outras Tarifas de Alteração |\n| 2139 | Tarifas Diversas |\n| 2140 | Rejeição do Título |\n| 2141 | Confirmação de Envio de SMS |\n| 2142 | Envio de SMS rejeitado |\n| 2143 | Cancelamento de SMS |\n| 2144 | Liquidação de boleto cooperativa emite e expede |\n| 2145 | Liquidação de boleto após baixa ou não registrado cooperativa emite e expede |\n| 2146 | Título em aberto não enviado ao pagador |\n| 2147 | Inconsistência Negativação Serasa |\n| 2148 | Inclusão Negativação via Serasa |\n| 2149 | Exclusão Negativação Serasa |\n| 2150 | Devolução por Decurso de Prazo |\n| 2151 | Confirmação de Pedido de Exclusão da Serasa |\n| 2152 | Título enviado para negativação |\n| 2153 | Alegação do Sacado |\n| 2154 | Título retirado de cartório |\n| 2155 | Custa de distribuição |\n| 2156 | Custa de sustação |\n| 2157 | Custa de protesto |\n| 2158 | Movimentação CIP |\n| 2159 | Alteração De Dados – Nova Entrada ou Alteração/Exclusão de Dados Acatada |\n| 2160 | Alteração de Dados – Baixa |\n| 2161 | Baixa Por Ter Sido Liquidado |\n| 2162 | Cobrança Contratual – Instruções/Alterações Rejeitadas/Pendentes |\n| 2163 | Confirmação Recebimento de Instrução de Não Protestar |\n| 2164 | Protesto Enviado a Cartório/Tarifa |\n| 2165 | Tarifa de Aviso de Cobrança |\n| 2166 | Tarifa de Extrato Posição |\n| 2167 | Tarifa de Relação das Liquidações |\n| 2168 | Tarifa de Manutenção de Títulos Vencidos |\n| 2169 | Débito Mensal de Tarifas (para entradas e baixas) |\n| 2170 | Custas de Edital |\n| 2171 | Tarifa de Emissão de Boleto/Tarifa de Envio de Duplicata |\n| 2172 | Tarifa de Instrução |\n| 2173 | Tarifa de Ocorrências |\n| 2174 | Tarifa Mensal de Emissão de Boleto/Tarifa Mensal de Envio de Duplicata |\n| 2175 | Débito Mensal de Tarifas – Extrato de Posição (b4ep/b4ox) |\n| 2176 | Débito Mensal de Tarifas – Outras Instruções |\n| 2177 | Débito Mensal de Tarifas – Manutenção de Títulos Vencidos |\n| 2178 | Débito Mensal de Tarifas – Outras Ocorrências |\n| 2179 | Débito Mensal de Tarifas – Protesto |\n| 2180 | Débito Mensal de Tarifas – Sustação de Protesto |\n| 2181 | Baixa Com Transferência Para Desconto |\n| 2182 | Custas de Sustação Judicial |\n| 2183 | Tarifa Mensal Referente A Entradas Bancos Correspondentes Na Carteira |\n| 2184 | Tarifa Mensal Baixas Na Carteira |\n| 2185 | Tarifa Mensal Baixas Em Bancos Correspondentes Na Carteira |\n| 2186 | Tarifa Mensal de Liquidações Na Carteira |\n| 2187 | Tarifa Mensal de Liquidações Em Bancos Correspondentes Na Carteira |\n| 2188 | Custas de Irregularidade |\n| 2189 | Instrução Cancelada |\n| 2190 | Comando Recusado |\n| 2191 | Código de IOF inválido |\n| 2192 | Título não existe |\n| 2193 | Prorrogação de Vencimento |\n| 2194 | Título Já Baixado/Protestado |\n| 2195 | Custas de Cartório |\n| 2196 | Confirmação de envio de e-mail/SMS |\n| 2197 | Envio de e-mail/SMS rejeitado |\n| 2198 | Título pago com cheque compensado |\n| 2199 | Instrução para protesto para fins falimentares confirmada |\n| 2200 | Alteração de contrato de cobrança |\n| 2201 | Confirmação da Instrução de Baixa de Título Negativado sem Protesto |\n| 2202 | Confirmação de Pedido de Dispensa de Multa |\n| 2203 | Confirmação do Pedido de Cobrança de Multa |\n| 2204 | Confirmação do Pedido de Alteração de Cobrança de Juros |\n| 2205 | Confirmação do Pedido de Alteração do Valor/Data de Desconto |\n| 2206 | Confirmação do Pedido de Alteração do Beneficiário do Título |\n| 2207 | Confirmação do Pedido de Dispensa de Juros de Mora |\n| 2208 | Confirmação de instrução de transferência de carteira/modalidade de cobrança |\n| 2209 | Confirmação de Desistência de Protesto |\n| 2210 | Encaminhado a Protesto |\n| 2211 | Baixado automaticamente via arquivo |\n| 2212 | Baixa rejeitada |\n| 2213 | Tarifa |\n| 2214 | Rejeição do pagador |\n| 2215 | Alteração rejeitada |\n| 2216 | Aceite do Pagador |\n| 2217 | Baixa por Crédito em Conta Corrente |\n| 2218 | Entrada Rejeitada Carnê |\n| 2219 | Tarifa Emissão Aviso de Movimentação de Títulos |\n| 2220 | Débito Mensal de Tarifas - Aviso de Movimentação de Títulos |\n| 2221 | Entrada Confirmada com Rateio de Crédito |\n| 2222 | Baixa por Crédito em Conta Corrente sem Título Correspondente |\n| 2223 | Confirmação de Entrada na Cobrança |\n| 2224 | Instrução de Negativação Expressa Rejeitada |\n| 2225 | Confirma o Recebimento de Instrução de Entrada Em Negativação Expressa |\n| 2226 | Confirma o Recebimento de Instrução de Exclusão de Entrada Em Negativação Expressa |\n| 2227 | Confirma o Recebimento de Instrução de Cancelamento de Negativação Expressa |\n| 2228 | Negativação Expressa Informacional |\n| 2229 | Confirma de Entrada Em Negativação Expressa / Tarifa |\n| 2230 | Confirma o Cancelamento Em Negativação Expressa / Tarifa |\n| 2231 | Confirma Exclusão de Entrada Em Negativação Expressa Por Liquidação / Tarifa |\n| 2232 | Tarifa Pacote Cobrança Ativa Eletrônica |\n| 2233 | Tarifa E-mail Cobrança Ativa Eletrônica |\n| 2234 | Tarifa Sms Cobrança Ativa Eletrônica |\n| 2235 | Tarifa Mensal Pacote Cobrança Ativa Eletrônica |\n| 2236 | Tarifa Mensal E-mail Cobrança Ativa Eletrônica |\n| 2237 | Tarifa Mensal Sms Cobrança Ativa Eletrônica |\n| 2238 | Tarifa Mensal de Exclusão de Entrada Em Negativação Expressa |\n| 2239 | Tarifa Mensal de Cancelamento de Negativação Expressa |\n| 2240 | Tarifa Mensal de Exclusão de Negativação Expressa Por Liquidação |\n| 2241 | Confirma Recebimento de Instrução de Não Negativar |\n| 2242 | Transferência de Beneficiário |\n| 2243 | Baixa de Título Protestado |\n| 2244 | Despesa de Cartório |\n| 2245 | Acerto de Data de Emissão |\n| 2246 | Acerto de Código de Espécie Documento |\n| 2247 | Instrução Negativação Aceita |\n| 2248 | Instrução Baixa de Negativação Aceita |\n| 2249 | Instrução Não Negativar Aceita |", "enum": [ "2001", "2002", "2003", "2004", "2005", "2006", "2007", "2008", "2009", "2010", "2011", "2012", "2013", "2014", "2015", "2016", "2017", "2018", "2019", "2020", "2021", "2022", "2023", "2024", "2025", "2026", "2027", "2028", "2029", "2030", "2031", "2032", "2033", "2034", "2035", "2036", "2037", "2038", "2039", "2040", "2041", "2042", "2043", "2044", "2045", "2046", "2047", "2048", "2049", "2050", "2051", "2052", "2053", "2054", "2055", "2056", "2057", "2058", "2059", "2060", "2061", "2062", "2063", "2064", "2065", "2066", "2067", "2068", "2069", "2070", "2071", "2072", "2073", "2074", "2075", "2076", "2077", "2078", "2079", "2080", "2081", "2082", "2083", "2084", "2085", "2086", "2087", "2088", "2089", "2090", "2091", "2092", "2093", "2094", "2095", "2096", "2097", "2098", "2099", "2100", "2101", "2102", "2103", "2104", "2105", "2106", "2107", "2108", "2109", "2110", "2111", "2112", "2113", "2114", "2115", "2116", "2117", "2118", "2119", "2120", "2121", "2122", "2123", "2124", "2125", "2126", "2127", "2128", "2129", "2130", "2131", "2132", "2133", "2134", "2135", "2136", "2137", "2138", "2139", "2140", "2141", "2142", "2143", "2144", "2145", "2146", "2147", "2148", "2149", "2150", "2151", "2152", "2153", "2154", "2155", "2156", "2157", "2158", "2159", "2160", "2161", "2162", "2163", "2164", "2165", "2166", "2167", "2168", "2169", "2170", "2171", "2172", "2173", "2174", "2175", "2176", "2177", "2178", "2179", "2180", "2181", "2182", "2183", "2184", "2185", "2186", "2187", "2188", "2189", "2190", "2191", "2192", "2193", "2194", "2195", "2196", "2197", "2198", "2199", "2200", "2201", "2202", "2203", "2204", "2205", "2206", "2207", "2208", "2209", "2210", "2211", "2212", "2213", "2214", "2215", "2216", "2217", "2218", "2219", "2220", "2221", "2222", "2223", "2224", "2225", "2226", "2227", "2228", "2229", "2230", "2231", "2232", "2233", "2234", "2235", "2236", "2237", "2238", "2239", "2240", "2241", "2242", "2243", "2244", "2245", "2246", "2247", "2248", "2249" ] }, "discharge_id": { "type": "integer", "nullable": true, "description": "ID do Retorno.", "example": null }, "bank_billet_id": { "type": "integer", "nullable": true, "description": "ID do Boleto.", "example": null }, "processed_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data de Processamento." }, "date_of_occurrence": { "type": "string", "format": "date", "nullable": true, "readOnly": true, "description": "Data da ocorrência." }, "occurrence": { "type": "string", "maxLength": 2, "nullable": true, "description": "Código da operação no banco." }, "occurrence_detail": { "type": "string", "nullable": true, "description": "Descrição do evento no Retorno." }, "occurrence_error": { "type": "string", "nullable": true, "description": "Erro no retorno." }, "occurrence_error_detail": { "type": "string", "nullable": true, "description": "Descrição do erro no retorno." }, "line_raw": { "type": "string", "format": "json", "nullable": true, "description": "Linha plana com informações vindas do banco.", "example": null }, "line_parsed": { "type": "string", "format": "json", "nullable": true, "description": "Linha parseada com informações vindas do banco:\n\nConteúdo do retorno bancário. Pode mudar de acordo com o banco e o formato 240 ou 400. Se algum dos campos estiver em branco é porque o seu banco não disponibiliza essa informação.\n\n| Valor | Descrição |\n|---|---|\n| paid_at | Data de pagamento |\n| paid_amount | Valor pago |\n| bank_rate | Taxa do boleto paga ao banco |\n| credit_at | Data de crédito |\n| credit_amount | Valor do Crédito |\n| our_number | Nosso número |\n| processed_our_number_raw | Nosso número formatado |\n| discount | Desconto |\n| billet_fine | Acréscimos(Multa/Juros cobrados) |\n| other_fines | Outras cobranças adicionais |\n| other_credit | Outros valores pagos |\n| value_rebate | Outras taxas |\n| error_code | Código de erro |\n| event_type | Ocorrência bancária |\n| agency_number | Agência |\n| account_number | Conta |\n| banco_recebedor | Banco recebedor |\n| agencia_recebedora | Agência recebedora |\n| control_number | Número de Controle |\n| document_number | Número do Documento |" } } }, "v2_bank_billet_payment": { "type": "object", "required": [ "paid_at", "paid_amount", "kind" ], "properties": { "id": { "type": "integer", "readOnly": true, "deprecated": true, "description": "ID do Recebimento (deprecated, use uid)", "example": 123 }, "uid": { "type": "string", "readOnly": true, "description": "UID do Recebimento de Boleto" }, "bank_billet_id": { "type": "integer", "nullable": true, "deprecated": true, "description": "ID do Boleto (deprecated, use bank_billet_uid)", "example": null }, "bank_billet_uid": { "type": "string", "nullable": true, "description": "UID do Boleto.", "example": null }, "pix_id": { "type": "integer", "nullable": true, "readOnly": true, "deprecated": true, "description": "ID do Pix vinculado (deprecated, use pix_uid)", "example": null }, "pix_uid": { "type": "string", "nullable": true, "readOnly": true, "description": "UID do Pix vinculado ao recebimento (quando pago via Pix)", "example": null }, "bank_billet_account_id": { "type": "integer", "nullable": true, "deprecated": true, "description": "ID da Carteira (deprecated, use bank_billet_account_uid)", "example": null }, "bank_billet_account_uid": { "type": "string", "nullable": true, "description": "UID da Carteira.", "example": null }, "discharge_id": { "type": "integer", "nullable": true, "deprecated": true, "description": "ID do Retorno (deprecated, use discharge_uid)", "example": null }, "discharge_uid": { "type": "string", "nullable": true, "description": "UID do Retorno.", "example": null }, "amount": { "type": "number", "format": "float", "description": "Valor do Boleto", "example": 10.99 }, "paid_amount": { "type": "number", "format": "float", "description": "Valor Pago", "example": 10.99 }, "paid_at": { "type": "string", "format": "date", "nullable": true, "readOnly": true, "description": "Data do Recebimento." }, "paid_bank": { "type": "string", "maxLength": 3, "nullable": true, "description": "Banco de Recebimento." }, "paid_agency": { "type": "string", "maxLength": 5, "nullable": true, "description": "Agência de Recebimento (com dígito quando disponível)." }, "paid_agency_number": { "type": "string", "maxLength": 4, "nullable": true, "description": "Número da Agência de Recebimento (sem dígito)." }, "paid_agency_digit": { "type": "string", "maxLength": 1, "nullable": true, "description": "Dígito da Agência de Recebimento." }, "bank_rate": { "type": "number", "format": "float", "nullable": true, "description": "Taxa bancária", "example": 10.99 }, "credit_at": { "type": "string", "format": "date", "nullable": true, "readOnly": true, "description": "Data de crédito." }, "direct": { "type": "boolean", "deprecated": true, "nullable": true, "description": "Recebimento direto ao beneficíario", "example": null }, "expire_at": { "type": "string", "format": "date", "nullable": true, "readOnly": true, "description": "Data de vencimento." }, "kind": { "type": "integer", "description": "Tipo de Recebimento:\n* `0` Direto ao beneficíario/Em mãos\n* `1` Boleto (Confirmado pelo banco via arquivo de retorno ou API)\n* `2` Pix (Confirmado pelo banco via Pix)", "enum": [ 0, 1, 2 ] }, "our_number": { "type": "string", "nullable": true, "description": "Nosso Número.", "example": null }, "created_via_api": { "type": "boolean", "nullable": true, "description": "Enviado pela API", "example": null }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação." }, "customer_person_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "Nome do cliente" }, "paid_by_pix": { "type": "boolean", "deprecated": true, "nullable": true, "description": "\tRecebimento via Pix", "example": null }, "financial_provider_external_id": { "type": "string", "nullable": true, "description": "ID do recebimento na instituição financeira", "example": null }, "line_parsed": { "type": "string", "format": "json", "nullable": true, "description": "Linha parseada com informações vindas do banco:\n\nConteúdo do retorno bancário. Pode mudar de acordo com o banco e o formato 240 ou 400. Se algum dos campos estiver em branco é porque o seu banco não disponibiliza essa informação.\n\n| Valor | Descrição |\n|---|---|\n| paid_at | Data de recebimento |\n| paid_amount | Valor pago |\n| bank_rate | Taxa do boleto paga ao banco |\n| credit_at | Data de crédito |\n| credit_amount | Valor do Crédito |\n| our_number | Nosso número |\n| processed_our_number_raw | Nosso número formatado |\n| discount | Desconto |\n| billet_fine | Acréscimos(Multa/Juros cobrados) |\n| other_fines | Outras cobranças adicionais |\n| other_credit | Outros valores pagos |\n| value_rebate | Outras taxas |\n| error_code | Código de erro |\n| event_type | Ocorrência bancária |\n| agency_number | Agência |\n| account_number | Conta |\n| banco_recebedor | Banco recebedor |\n| agencia_recebedora | Agência recebedora |\n| control_number | Número de Controle |\n| document_number | Número do Documento |" } } }, "v2_bank_billet_remittance": { "type": "object", "required": [ "our_code", "remittance_id", "bank_billet_id", "bank_billet_account_id" ], "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Registro de Remessa" }, "uid": { "type": "string", "readOnly": true, "description": "UID do Registro de Remessa" }, "our_code": { "type": "string", "maxLength": 6, "nullable": true, "description": "Código de operação de registro. Consulte os possíveis valores [para cada banco](/reference/bancos-suportados)." }, "occurrence": { "type": "string", "maxLength": 3, "nullable": true, "description": "Ocorrência." }, "remittance_id": { "type": "integer", "nullable": true, "description": "ID da Remessa.", "example": null }, "bank_billet_id": { "type": "integer", "nullable": true, "description": "ID do Boleto.", "example": null }, "bank_billet_account_id": { "type": "integer", "nullable": true, "description": "ID da Carteira.", "example": null }, "processed_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data de Processamento." }, "occurrence_detail": { "type": "string", "nullable": true, "description": "Descrição do evento na Remessa." } } }, "v2_bank_billet_registration": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Registro de Boleto" }, "uid": { "type": "string", "readOnly": true, "description": "UID do Registro de Boleto" }, "bank_billet_id": { "type": "integer", "nullable": true, "description": "ID do Boleto.", "example": null }, "bank_billet_account_id": { "type": "integer", "nullable": true, "description": "ID da Carteira.", "example": null }, "status": { "type": "string", "readOnly": true, "description": "Situação do registro:\n* `0` Erro\n* `1` Sucesso\n* `2` Serviço indisponível", "enum": [ "0", "1", "2" ] }, "registered_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora do registro." }, "error_message": { "type": "string", "nullable": true, "description": "Mensagem de erro do registro." }, "failed_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da falha." }, "fails_count": { "type": "integer", "nullable": true, "description": "Quantidade de falhas em tentativas de registrar o boleto." }, "retry_blocked": { "type": "boolean", "nullable": true, "description": "Retentativa bloqueada." } } }, "v2_bank_billet_account": { "type": "object", "required": [ "bank_contract_slug", "agency_number", "account_number", "account_digit", "beneficiary_cnpj_cpf" ], "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID da carteira" }, "uid": { "type": "string", "readOnly": true, "description": "UID da carteira" }, "bank_contract_slug": { "type": "string", "maxLength": 50, "description": "[Slug da Carteira](/reference/bancos-suportados)" }, "next_our_number": { "type": "integer", "maxLength": 40, "nullable": true, "description": "Próximo Nosso Número. Default: 1", "example": 1 }, "next_remittance_number": { "type": "integer", "maxLength": 40, "nullable": true, "example": 1, "description": "Último sequencial da remessa Default: 1" }, "agency_number": { "type": "string", "maxLength": 20, "description": "Agência" }, "agency_digit": { "type": "string", "maxLength": 2, "nullable": true, "description": "Dígito da Agência. Opcional: será calculado automaticamente usando Módulo 11 quando o banco exigir e não for fornecido." }, "account_number": { "type": "string", "maxLength": 20, "description": "Conta" }, "account_digit": { "type": "string", "maxLength": 2, "description": "Dígito da Conta" }, "extra1": { "type": "string", "nullable": true, "maxLength": 15, "description": "Campo extra 1. Dependendo da carteira escolhida poderá ser obrigátorio." }, "extra1_digit": { "type": "string", "nullable": true, "maxLength": 3, "description": "Digito do Campo extra 1. Dependendo da carteira escolhida poderá ser obrigátorio." }, "extra2": { "type": "string", "nullable": true, "maxLength": 15, "description": "Campo extra 2. Dependendo da carteira escolhida poderá ser obrigátorio." }, "extra2_digit": { "type": "string", "nullable": true, "maxLength": 3, "description": "Dígito do Campo extra 2. Dependendo da carteira escolhida poderá ser obrigátorio." }, "contract": { "type": "string", "maxLength": 15, "description": "Contrato" }, "contract_type": { "type": "string", "maxLength": 2, "description": "Tipo do Contrato" }, "extra3": { "type": "string", "nullable": true, "maxLength": 30, "description": "Código de Remessa" }, "beneficiary_name": { "type": "string", "maxLength": 100, "description": "Nome do Beneficiário" }, "beneficiary_cnpj_cpf": { "type": "string", "maxLength": 20, "description": "CNPJ/CPF do Beneficiário.\n Quando um CNPJ válido for enviado, os dados associados ao beneficiário desse CNPJ serão obtidos automaticamente. Portanto, não é necessário incluir os seguintes campos na requisição:\"\n * `beneficiary_address_street` Rua do Beneficiário.\n * `beneficiary_address_street_number` Numero da rua do Beneficiário.\n * `beneficiary_address_complement` Complemento do endereço do Beneficiário.\n * `beneficiary_address_neighborhood` Bairro do Beneficiário.\n * `beneficiary_address_city` Cidade do Beneficiário.\n * `beneficiary_address_state` Estado do Beneficiário.\n * `beneficiary_address_zipcode` CEP do Beneficiário.\n * `beneficiary_address` Endereço completo do Beneficiário." }, "beneficiary_address_street": { "type": "string", "maxLength": 255, "nullable": true, "description": "Rua do Beneficiário" }, "beneficiary_address_street_number": { "type": "string", "maxLength": 30, "nullable": true, "description": "Numero da rua do Beneficiário" }, "beneficiary_address_complement": { "type": "string", "maxLength": 255, "nullable": true, "description": "Complemento do endereço do Beneficiário" }, "beneficiary_address_neighborhood": { "type": "string", "maxLength": 255, "nullable": true, "description": "Bairro do Beneficiário" }, "beneficiary_address_city": { "type": "string", "maxLength": 50, "nullable": true, "description": "Cidade do Beneficiário" }, "beneficiary_address_state": { "type": "string", "maxLength": 2, "nullable": true, "description": "Estado do Beneficiário" }, "beneficiary_address_zipcode": { "type": "string", "maxLength": 8, "nullable": true, "description": "CEP do Beneficiário (formato 99999999)", "example": "01310100" }, "beneficiary_address": { "type": "string", "deprecated": true, "nullable": true, "readOnly": true, "description": "Endereço completo do Beneficiário." }, "name": { "type": "string", "maxLength": 255, "description": "Nome da Conta. Não é recebido na criação e nem na atualização, só é retornado na consulta e listagem" }, "status": { "type": "string", "readOnly": true, "description": "Situação da carteira:\nQuando a carteira acaba de ser cadastrada, ela ganha o status `pending`.\n\nNesse momento o usuário deve aceitar os termos e iniciar a homologação.\n\nAo clicar em “Prosseguir com a Homologação”, o status passa para `homologating`.\n\nSerá gerado um boleto e uma remessa de Homologação para ser enviada ao banco. Após o término, o status passa para `validating`.\n\nA partir desse momento o usuário precisa informar o valor do boleto que foi gerado ou enviar o retorno processado pelo banco.\n\nQuando o valor é informado corretamente, ou no retorno processado, o banco diz estar tudo certo, o status passa para `active`.\n\n* `pending` Homologação não iniciada\n* `homologating` Em homologação, aguardando pagamento do boleto\n* `validating` Boleto pago, aguardando validação\n* `active` Ativa e pronta para uso", "enum": [ "pending", "homologating", "validating", "active" ] }, "homologated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data de homologação da carteira" }, "default": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Padrão.\nO campo `default` determina a carteira de cobrança que será usada na criação do boleto quando nenhuma carteira for informada.\n\nNo momento que a primeira carteira é homologada (passa para o `status` = `active`), ela recebe o valor `default` = `true`" }, "configuration": { "type": "object", "nullable": true, "description": "Configuração de dados padrões para boleto" }, "bank_contract": { "type": "object", "readOnly": true, "description": "Dados da Carteira. Não é recebido na criação e nem na atualização, só é retornado na consulta e listagem." }, "custom_name": { "type": "string", "maxLength": 255, "description": "Nome da Carteira para identificação dentro da Kobana." }, "kind": { "type": "string", "description": "Tipo de CNAB:\n* `cnab400` CNAB 400\n* `cnab240` CNAB 240", "enum": [ "cnab400", "cnab240" ] }, "allow_expiration_on_weekends": { "type": "boolean", "nullable": true, "description": "Permitir vencimento em fim de semana e feriados" }, "allow_duplicate_charge_payments": { "type": "boolean", "nullable": true, "description": "Permitir pagamentos duplicados de cobrança" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação da carteira" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização da carteira" }, "created_via_api": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se a carteira foi criada por API" } } }, "v2_bank_billet_account_update": { "type": "object", "properties": { "kind": { "type": "string", "description": "Tipo de CNAB:\n* `cnab400` CNAB 400\n* `cnab240` CNAB 240", "enum": [ "cnab400", "cnab240" ] }, "payment_place": { "type": "string", "nullable": true, "maxLength": 100, "example": null, "description": "Local de Pagamento" }, "custom_name": { "type": "string", "maxLength": 255, "description": "Nome da Carteira para identificação dentro da Kobana." }, "allow_expiration_on_weekends": { "type": "boolean", "nullable": true, "description": "Permitir vencimento em fim de semana e feriados" }, "beneficiary_cnpj_cpf": { "type": "string", "maxLength": 20, "description": "CNPJ/CPF do Beneficiário" }, "beneficiary_address_street": { "type": "string", "maxLength": 255, "nullable": true, "description": "Rua do Beneficiário" }, "beneficiary_address_street_number": { "type": "string", "maxLength": 30, "nullable": true, "description": "Numero da rua do Beneficiário" }, "beneficiary_address_complement": { "type": "string", "maxLength": 255, "nullable": true, "description": "Complemento do endereço do Beneficiário" }, "beneficiary_address_neighborhood": { "type": "string", "maxLength": 255, "nullable": true, "description": "Bairro do Beneficiário" }, "beneficiary_address_city": { "type": "string", "maxLength": 50, "nullable": true, "description": "Cidade do Beneficiário" }, "beneficiary_address_state": { "type": "string", "maxLength": 2, "nullable": true, "description": "Estado do Beneficiário" }, "beneficiary_address_zipcode": { "type": "string", "maxLength": 8, "nullable": true, "description": "CEP do Beneficiário (formato 99999999)", "example": "01310100" }, "beneficiary_address": { "type": "string", "deprecated": true, "nullable": true, "readOnly": true, "description": "Endereço completo do Beneficiário." }, "pix_account_id": { "type": "integer", "format": "int32", "description": "ID da Conta Pix", "example": 1 }, "default": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Padrão.\n O campo `default` determina a carteira de cobrança que será usada na criação do boleto quando nenhuma carteira for informada.\n\n No momento que a primeira carteira é homologada (passa para o `status` = `active`), ela recebe o valor `default` = `true`" }, "next_our_number": { "type": "integer", "nullable": true, "maxLength": 100, "example": null, "description": "Último nosso número" }, "next_remittance_number": { "type": "integer", "maxLength": 40, "nullable": true, "example": 1, "description": "Último sequencial da remessa Default: 1" }, "bank_billet_account_next_our_number_attributes": { "type": "object", "required": [ "next_our_number" ], "properties": { "next_our_number": { "type": "integer", "maxLength": 40, "nullable": true, "readOnly": true, "description": "Próximo Nosso Número. Default: 1", "example": 1 } } }, "bank_billet_account_next_remittance_number_attributes": { "type": "object", "required": [ "next_remittance_number" ], "properties": { "next_remittance_number": { "type": "integer", "nullable": true, "readOnly": true, "description": "Próximo Número da Remessa. Default: 1", "example": 1 } } } } }, "v2_bank_billet_object": { "type": "object", "required": [ "expire_at", "amount", "customer_person_name", "customer_cnpj_cpf", "customer_zipcode", "customer_address", "customer_neighborhood", "customer_city_name", "customer_state" ], "properties": { "id": { "type": "integer", "readOnly": true, "deprecated": true, "description": "ID do boleto (deprecated, use uid)" }, "uid": { "type": "string", "readOnly": true, "description": "UUID público do boleto", "example": "123e4567-e89b-12d3-a456-426614174000" }, "bank_billet_account_id": { "type": "integer", "deprecated": true, "description": "ID da Carteira de Cobrança (deprecated, use bank_billet_account_uid)", "example": null }, "bank_billet_account_uid": { "type": "string", "description": "UID da Carteira de Cobrança. Se não informado, usará a carteira padrão.", "example": null }, "bank_billet_layout_id": { "type": "integer", "nullable": true, "deprecated": true, "description": "ID do Modelo de Boleto (deprecated, use bank_billet_layout_uid)", "example": null }, "bank_billet_layout_uid": { "type": "string", "nullable": true, "description": "UID do Modelo de Boleto", "example": null }, "amount": { "type": "number", "format": "float", "description": "Quantia", "example": 10.99 }, "expire_at": { "type": "string", "format": "date", "description": "Data de vencimento", "example": "2023-12-12" }, "customer_id": { "type": "integer", "nullable": true, "deprecated": true, "description": "ID do Cliente (deprecated, use customer_uid)", "example": null }, "customer_uid": { "type": "string", "nullable": true, "description": "UID do Cliente. Quando esse UID é passado, os campos `customer_person_name`, `customer_cnpj_cpf`, `customer_zipcode`, `customer_address`, `customer_city_name`, `customer_state` e `customer_neighborhood` não são obrigatórios.", "example": null }, "customer_person_name": { "type": "string", "maxLength": 120, "description": "Nome do cliente", "example": "João Silva" }, "customer_cnpj_cpf": { "type": "string", "maxLength": 20, "description": "CPF/CNPJ do cliente", "example": "16.974.923/0001-84" }, "customer_state": { "type": "string", "maxLength": 2, "description": "Estado", "example": "SP" }, "customer_city_name": { "type": "string", "maxLength": 60, "description": "Cidade(Nome deve estar correto e completo)", "example": "São Paulo" }, "customer_zipcode": { "type": "string", "maxLength": 8, "description": "CEP (formato 99999999)", "example": "01310100" }, "customer_address": { "type": "string", "maxLength": 255, "description": "Endereço", "example": "Rua F, alamenda G" }, "customer_address_complement": { "type": "string", "maxLength": 120, "description": "Complemento", "example": null }, "customer_address_number": { "type": "string", "maxLength": 10, "description": "Número", "example": null }, "customer_email": { "type": "string", "format": "email", "maxLength": 80, "description": "E-mail do Pagador", "example": null }, "customer_email_cc": { "type": "string", "format": "email", "maxLength": 80, "description": "E-mail alternativo do Pagador", "example": null }, "customer_neighborhood": { "type": "string", "maxLength": 80, "description": "Bairro", "example": "Centro" }, "customer_phone_number": { "type": "string", "maxLength": 11, "description": "Telefone (com DDD)", "example": null }, "customer_ignore_email": { "type": "boolean", "nullable": true, "description": "Nunca enviar e-mail para este cliente", "example": null }, "customer_ignore_sms": { "type": "boolean", "nullable": true, "description": "Nunca enviar SMS para este cliente", "example": null }, "customer_mobile_local_code": { "type": "string", "nullable": true, "maxLength": 2, "description": "DDD do Celular", "example": null }, "customer_mobile_number": { "type": "string", "nullable": true, "maxLength": 9, "description": "Celular", "example": null }, "customer_nickname": { "type": "string", "nullable": true, "maxLength": 255, "description": "Apelido ou Nome Fantasia do Pagador", "example": null }, "customer_notes": { "type": "string", "nullable": true, "description": "Observações do Pagador", "example": null }, "customer_contact_person": { "type": "string", "nullable": true, "maxLength": 120, "description": "Contato", "example": null }, "interest_type": { "type": "integer", "nullable": true, "description": "Tipo de juros/mora:\n* `0` Inexistente (Padrão)\n* `1` Para porcentagem diária\n* `2` Para valor diário\n* `7` Para porcentagem mensal - Bancos suportados: Bradesco, BB, BTG, Caixa, Inter, Itaú, Safra, Santander, Sicoob e Sicredi", "enum": [ 0, 1, 2, 7 ], "default": 0 }, "days_for_interest": { "type": "integer", "nullable": true, "description": "Quantidade de dias após o vencimento que a mora começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento).", "example": null }, "interest_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Porcentagem de juros. De 0.0 a 100.0 (Ex 1.5% = 1.5) Obrigatório se interest_type é igual a 1 ou 7. Até 2 casas decimais.", "example": null }, "interest_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor diário de juros (R$). Obrigatório se interest_type é igual a 2. Até 2 casas decimais.", "example": null }, "interest_days_type": { "type": "integer", "nullable": true, "description": "Tipo de Dias para juros:\n* `0` Corridos\n* `1` Úteis", "enum": [ 0, 1 ], "default": 0 }, "fine_type": { "type": "integer", "nullable": true, "description": "Tipo de multa:\n* `0` Inexistente (Padrão)\n* `1` Para percentual do valor do boleto\n* `2` Para valor fixo", "enum": [ 0, 1, 2 ], "default": 0 }, "days_for_fine": { "type": "integer", "nullable": true, "description": "Quantidade de dias após o vencimento que a multa começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento).", "example": null }, "fine_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Porcentagem de Multa por Atraso Ex: 2% x R$ 250,00 = R$ 5,00. Obrigatória se fine_type é igual a 1. Até 2 casas decimais.", "example": null }, "fine_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor da multa (R$). Obrigatório se fine_type é igual a 2. Até 2 casas decimais.", "example": null }, "discount_type": { "type": "integer", "nullable": true, "description": "Tipo de desconto:\nO tipo de desconto será o mesmo para todos os três descontos, caso existam. :\n* `0` Inexistente (Padrão)\n* `1` Para valor fixo\n* `2` Para percentual do valor do boleto", "enum": [ 0, 1, 2 ], "default": 0 }, "days_for_discount": { "type": "integer", "nullable": true, "description": "Dias para desconto. Obrigatório se discount_type é diferente de 0(zero)", "example": null }, "discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao desconto. Obrigatório se discount_type é igual a 2", "example": null }, "discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do desconto (R$). Obrigatório se discount_type é igual a 1.", "example": null }, "days_for_second_discount": { "type": "integer", "nullable": true, "description": "Dias para segundo desconto.", "example": null }, "second_discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao segundo desconto.", "example": null }, "second_discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do segundo desconto (R$).", "example": null }, "days_for_third_discount": { "type": "integer", "nullable": true, "description": "Dias para terceiro desconto.", "example": null }, "third_discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao terceiro desconto.", "example": null }, "third_discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do terceiro desconto (R$).", "example": null }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas ao boleto", "example": null, "items": { "type": "string" } }, "tag_list": { "type": "string", "nullable": true, "readOnly": true, "description": "Tags associadas ao boleto" }, "charge_type": { "type": "integer", "nullable": true, "description": "Tipo de Cobrança:\n* `1` Simples\n* `2` Vinculada\n* `3` Descontada\n* `4` Vendor", "enum": [ 1, 2, 3, 4 ], "default": 1 }, "dispatch_type": { "type": "integer", "nullable": true, "description": "Tipo de Cobrança:\nQuando o boleto precisa ser enviado pelo correio. É preciso contratar o serviço junto ao banco e pagará tarifa.\n* `1` Cliente\n* `2` Banco", "enum": [ 1, 2 ], "default": 1 }, "guarantor_name": { "type": "string", "nullable": true, "maxLength": 100, "description": "Nome do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_cnpj_cpf": { "type": "string", "nullable": true, "maxLength": 20, "description": "CNPJ/CPF do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_address_number": { "type": "string", "nullable": true, "maxLength": 10, "description": "Número do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_neighborhood": { "type": "string", "nullable": true, "maxLength": 80, "description": "Bairro do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_phone_number": { "type": "string", "nullable": true, "maxLength": 11, "description": "Telefone (com DDD) do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_city_name": { "type": "string", "nullable": true, "maxLength": 60, "description": "Cidade(Nome deve estar correto e completo) do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_state": { "type": "string", "nullable": true, "maxLength": 2, "description": "Estado do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_zipcode": { "type": "string", "nullable": true, "maxLength": 8, "description": "CEP (formato 99999999) do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_address": { "type": "string", "nullable": true, "maxLength": 255, "description": "Endereço do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_address_complement": { "type": "string", "nullable": true, "maxLength": 60, "description": "Complemento do Beneficiário final (Sacador/Avalista)", "example": null }, "description": { "type": "string", "nullable": true, "description": "Descrição do produto ou serviço", "example": null }, "instructions": { "type": "string", "nullable": true, "description": "Instruções para o Caixa", "example": null }, "document_date": { "type": "string", "format": "date", "nullable": true, "description": "Data do Documento", "example": null }, "document_type": { "type": "string", "maxLength": 2, "description": "Tipo de Documento:\n\n* `Código` | `Sigla` | Descrição\n* `01` | `CH` | Cheque\n* `02` | `DM` | Duplicata Mercantil (Padrão)\n* `03` | `DMI` | Duplicata Mercantil p/ Indicação\n* `04` | `DS` | Duplicata de Serviço\n* `05` | `DSI` | Duplicata de Serviço p/ Indicação\n* `06` | `DR` | Duplicata Rural\n* `07` | `LC` | Letra de Câmbio\n* `08` | `NCC` | Nota de Crédito Comercial\n* `09` | `NCE` | Nota de Crédito a Exportação\n* `10` | `NCI` | Nota de Crédito Industrial\n* `11` | `NCR` | Nota de Crédito Rural\n* `12` | `NP` | Nota Promissória\n* `13` | `NPR` | Nota Promissória Rural\n* `14` | `TM` | Triplicata Mercantil\n* `15` | `TS` | Triplicata de Serviço\n* `16` | `NS` | Nota de Seguro\n* `17` | `RC` | Recibo\n* `18` | `FAT` | Fatura\n* `19` | `ND` | Nota de Débito\n* `20` | `AP` | Apólice de Seguro\n* `21` | `ME` | Mensalidade Escolar\n* `22` | `PC` | Parcela de Consórcio\n* `23` | `NF` | Nota Fiscal\n* `24` | `DD` | Documento de Dívida\n* `25` | `CPR` | Cédula de Produto Rural\n* `26` | `CTR` | Contrato\n* `27` | `CSG` | Cosseguros\n* `28` | `EC` | Encargos Condominiais\n* `29` | `CPS` | Conta de Prestação de Serviços\n* `30` | `WR` | Warrant\n* `31` | `DP` | Duplicata Prestação\n* `32` | `CSR` | Cobrança Seriada\n* `33` | `CAR` | Carnê\n* `34` | `ARE` | Apólice Ramos Elementares\n* `35` | `CC` | Cartão de Crédito\n* `36` | `BDP` | Boleto de Proposta\n* `37` | `NPD` | Nota Promissória Direta\n* `38` | `DAE` | Dívida Ativa de Estado\n* `39` | `DAM` | Divida Ativa de Município\n* `40` | `DAU` | Dívida Ativa União\n* `41` | `CCB` | Célula de Crédito Bancário\n* `42` | `FI` | Financiamento\n* `43` | `RD` | Rateio de Despesas\n* `44` | `DRI` | Duplicata Rural p/ Indicação\n* `45` | `ECI` | Encargos Condominiais p/ Indicação\n* `99` | `Outros` | Outros\n ", "default": "02", "enum": [ "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "99" ] }, "document_type_label": { "type": "string", "nullable": true, "readOnly": true, "description": "Tipo de Documento (Sigla)" }, "document_number": { "type": "string", "nullable": true, "example": null, "description": "Número do Documento, Tamanho depende do banco e formato do arquivo Remessa:\n * Banco |\tFormato| Tamanho |\n * Abc |`Cnab240`|\t15\t|\n * Ailos |`Cnab240`|\t15 |\n * Arbi |`Cnab240`|\t15\t|\n * Banese |`Cnab240`|\t15\t|\n * Banestes |`Cnab400`|\t10\t|\n * Banrisul |`Cnab240`|\t15\t|\n * Banrisul |`Cnab400`|\t10\t|\n * Bb |`Cnab240`|\t15\t|\n * Bb |`Cnab400`|\t10\t|\n * Bib |`Cnab240`|\t15\t|\n * Bnb |`Cnab400`|\t10\t|\n * Bnpparibas |`Cnab400`|\t10\t|\n * Bradesco |`Cnab240`|\t15\t|\n * Bradesco |`Cnab400`|\t10\t|\n * Brb |`Cnab400`|\t10\t|\n * Caixa |`Cnab240`|\t11\t|\n * Caixa |`Cnab400`|\t10\t|\n * Caruana |`Cnab400`|\t10\t|\n * Citibank |`Cnab400`|\t10\t|\n * Credisis |`Cnab240`|\t15\t|\n * Cresol |`Cnab240`|\t10\t|\n * Cresol |`Cnab400`|\t10\t|\n * Cresol Bradesco |`Cnab240`|\t15\t|\n * Cresol Bradesco |`Cnab400`|\t10\t|\n * Daycoval |`Cnab400`|\t10\t|\n * Itau |`Cnab240`|\t10\t|\n * Itau |`Cnab400`|\t10\t|\n * Mercantil |`Cnab240`|\t10\t|\n * Moneyplus |`Cnab240`|\t10\t|\n * Rendimento |`Cnab400`|\t10\t|\n * Safra |`Cnab400`|\t102\t|\n * Santander |`Cnab240`|\t15\t|\n * Santander |`Cnab400`|\t10\t|\n * Semear |`Cnab400`|\t10\t|\n * Sicoob |`Cnab240`|\t15\t|\n * Sicoob |`Cnab400`|\t10\t|\n * Sicredi |`Cnab240`|\t15\t|\n * Sicredi |`Cnab400`|\t10\t|\n * Sofisa |`Cnab240`|\t15\t|\n * Unicred |`Cnab240`|\t15\t|\n * Uniprime |`Cnab400`|\t10\t|\n * Uniprime99 |`Cnab400`|\t10\t|\n * Santander |`Cnab400`|\t10 " }, "acceptance": { "type": "string", "enum": [ "N", "S" ], "default": "N", "description": "Aceite do documento:\n\n* `N` - Não (Padrão)\n* `S` - Sim\n", "examples": [ "N", "S" ] }, "our_number": { "type": "string", "nullable": true, "description": "Nosso Número. Se não informado, usará o Próximo Nosso Número da Carteira de Cobrança.", "example": null }, "processed_our_number": { "type": "string", "readOnly": true, "nullable": true, "description": "Nosso Número calculado com DV (formatado)" }, "processed_our_number_raw": { "type": "string", "readOnly": true, "nullable": true, "description": "Nosso Número calculado com DV (limpo)" }, "paid_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor pago", "example": null }, "paid_at": { "type": "string", "format": "date", "nullable": true, "description": "Data do pagamento", "example": null }, "days_for_revoke": { "type": "integer", "nullable": true, "description": "Dias corridos para Baixa/Devolução", "example": null }, "days_for_negativation": { "type": "integer", "nullable": true, "example": null, "description": "Dias corridos para Negativação:\n\nDisponível apenas para os seguintes bancos e formatos.\n\n* Banco |\tCNAB 240|\tCNAB 400 |Webservice\n* Bradesco |\tSim |\tSim\t| Não\n* Itaú | Não | Sim | Não\n " }, "days_for_sue": { "type": "integer", "nullable": true, "description": "Dias corridos para Protesto", "example": null }, "sue_history": { "type": "array", "readOnly": true, "description": "Histórico de eventos de protesto do boleto", "items": { "type": "object", "properties": { "status": { "type": "string", "description": "Status do evento de protesto:\n* `order_issued` - Emissão da ordem de protesto\n* `order_generated` - Geração da ordem de protesto\n* `registry_sent` - Envio para o cartório\n* `protested` - Protesto efetivado\n* `order_cancelled` - Cancelamento da ordem de protesto\n* `withdrawal_requested` - Solicitação de retirada do registro\n* `registry_withdrawn` - Retirada do registro (baixa no cartório)\n* `registry_withdrawal_dispatched` - Envio da retirada do registro\n* `suspended` - Suspensão do protesto\n* `cancellation_requested` - Solicitação de cancelamento do protesto\n* `cancellation_released` - Liberação do cancelamento\n* `cancellation_sent` - Envio do cancelamento ao cartório\n* `cancelled` - Protesto cancelado", "enum": [ "order_issued", "order_generated", "registry_sent", "protested", "order_cancelled", "withdrawal_requested", "registry_withdrawn", "registry_withdrawal_dispatched", "suspended", "cancellation_requested", "cancellation_released", "cancellation_sent", "cancelled" ] }, "occurred_at": { "type": "string", "format": "date-time", "description": "Data e hora do evento" } } } }, "days_for_sue_type": { "type": "integer", "nullable": true, "readOnly": true, "description": "Tipo de dias para protesto:\n* `0` Corridos\n* `1` Úteis", "enum": [ 0, 1 ], "example": null }, "credit_bureau": { "type": "integer", "nullable": true, "description": "Órgão de protesto/negativação:\n* `1` SERASA\n* `2` OUTRO", "enum": [ 1, 2 ], "example": null }, "sue_code": { "type": "string", "maxLength": 2, "nullable": true, "description": "Código de Protesto(CNAB 240). Consulte os possíveis valores para cada banco.", "example": null }, "revoke_code": { "type": "string", "nullable": true, "description": "Código de Baixa(CNAB 240). Consulte os possíveis valores para cada banco.", "example": null }, "first_instruction": { "type": "string", "maxLength": 2, "nullable": true, "description": "Primeira Instrução(CNAB 400). Consulte os possíveis valores para cada banco.", "example": null }, "second_instruction": { "type": "string", "maxLength": 2, "nullable": true, "description": "Segunda Instrução(CNAB 400). Consulte os possíveis valores para cada banco.", "example": null }, "watermark": { "type": "boolean", "description": "Endereço", "example": null }, "payment_count": { "type": "integer", "nullable": true, "description": "Quantidade de pagamentos parciais aceitos para este boleto." }, "divergent_payment_type": { "anyOf": [ { "type": "integer", "enum": [ 1, 2, 3, 4 ], "description": "Código do tipo de pagamento divergente" }, { "type": "null" } ], "description": "Tipo de pagamento divergente (válido apenas para Itaú e Caixa):\n\n* `1` - Aceita qualquer valor divergente\n* `2` - Aceita pagamentos dentro de uma faixa de valores ou percentuais\n* `3` - Não aceita pagamento de valores divergentes\n* `4` - Aceita pagamentos de valores superiores a um valor ou percentual mínimo\n", "examples": [ 1, 2, 3, 4, null ] }, "divergent_payment_value_type": { "type": "integer", "nullable": true, "example": null, "description": "Tipo de valor a considerar para os limites de pagamentos:\nVálido apenas para Itaú e Caixa.\n* `1` Informa pagamentos divergentes por valores\n* `2` Informa pagamentos divergentes por percentuais", "enum": [ null, 1, 2 ] }, "divergent_payment_maximum_value": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Valor máximo para a faixa de pagamentos divergentes. " }, "divergent_payment_minimum_value": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Valor mínimo para a faixa de pagamentos divergentes. " }, "divergent_payment_maximum_percentage": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Percentual máximo para a faixa de pagamentos divergentes. " }, "divergent_payment_minimum_percentage": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Percentual mínimo para a faixa de pagamentos divergentes." }, "divergent_payment_limit": { "type": "integer", "nullable": true, "example": null, "description": "Quantidade de pagamentos permitida. Obrigatório se informados dados para pagamento divergente. Usado somente pela Caixa." }, "prevent_registration": { "type": "boolean", "nullable": true, "example": null, "description": "Impedir envio de registro ao banco:\n\nCaso `true`, impede que o boleto seja registrado. Para ser usado nos casos em que o boleto já foi registrado fora da KOBANA mas deseja-se incluí-lo no sistema." }, "control_number": { "type": "string", "nullable": true, "maxLength": 25, "example": null, "description": "Número de controle:\n\nPode conter qualquer informação de interesse da Empresa. A informação contida neste campo sempre retornará com o respectivo título no arquivo-retorno." }, "ignore_email": { "type": "boolean", "default": false, "nullable": true, "example": null, "description": "Não enviar este boleto por email" }, "ignore_sms": { "type": "boolean", "default": false, "nullable": true, "description": "Nunca enviar este boleto por SMS", "example": null }, "ignore_whatsapp": { "type": "boolean", "default": false, "nullable": true, "description": "Nunca enviar este boleto por WhatsApp", "example": null }, "addons": { "type": "string", "format": "jsonb", "nullable": true, "example": null, "description": "Endereço" }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "meta": { "type": "object", "deprecated": true, "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "notes": { "type": "string", "nullable": true, "example": null, "description": "Observações" }, "custom_attachment_name": { "type": "string", "nullable": true, "example": null, "description": "Nome para ser usado nos arquivos de boleto enviados para o cliente em notificações. Aceita uso de variáveis. Caso seja deixado vazio, o padrão é a palavra “boleto” acompanhada do ID." }, "split_payment": { "type": "boolean", "nullable": true, "example": null, "description": "Split de Pagamento.\nVálido apenas para ABC Brasil (remessa CNAB 240), Itaú e Bradesco (remessa CNAB 400).\nCaso true, o rateio do boleto será registrado.\nInformar as contas para rateio em `split_accounts`" }, "split_payment_type": { "type": "integer", "nullable": true, "example": null, "description": "Tipo de Split de Pagamento:\nVálido apenas para Itau. Usado apenas com Split de Pagamento true.\n* `1` Rateio de crédito por percentual (%) – Valor nominal do título\n* `2` Rateio de crédito em valor (R$) – Valor nominal do título\n* `3` Rateio de crédito por percentual (%) – Valor líquido recebido\n* `4` Rateio de crédito em valor (R$) – Valor líquido recebido, rateado proporcionalmente", "enum": [ 1, 2, 3, 4 ] }, "split_accounts": { "type": "array", "nullable": true, "example": null, "description": "Contas para Split de pagamento.", "items": { "$ref": "#/components/schemas/v2_split_accounts_object" } }, "payment_place": { "type": "string", "nullable": true, "maxLength": 100, "example": null, "description": "Local de Pagamento" }, "installment_id": { "type": "integer", "nullable": true, "readOnly": true, "deprecated": true, "description": "ID do Carnê (deprecated, use installment_uid)" }, "installment_uid": { "type": "string", "nullable": true, "readOnly": true, "description": "UID do Carnê" }, "installment_number": { "type": "integer", "nullable": true, "readOnly": true, "description": "Número da parcela do carnê" }, "installment_total": { "type": "integer", "nullable": true, "readOnly": true, "description": "Total de parcelas do carnê" }, "customer_subscription_id": { "type": "integer", "nullable": true, "readOnly": true, "deprecated": true, "description": "ID da Assinatura (deprecated, use customer_subscription_uid)" }, "customer_subscription_uid": { "type": "string", "nullable": true, "readOnly": true, "description": "UID da Assinatura" }, "beneficiary_name": { "type": "string", "readOnly": true, "description": "Nome do Beneficiário" }, "beneficiary_cnpj_cpf": { "type": "string", "readOnly": true, "description": "CNPJ/CPF do Beneficiário" }, "beneficiary_address": { "type": "string", "readOnly": true, "description": "Endereço do Beneficiário" }, "beneficiary_assignor_code": { "type": "string", "nullable": true, "readOnly": true, "description": "Agência/Código do Beneficiário" }, "bank_contract_slug": { "type": "string", "nullable": true, "readOnly": true, "description": "Slug da Carteira" }, "agency_number": { "type": "string", "readOnly": true, "description": "Agência" }, "agency_digit": { "type": "string", "readOnly": true, "description": "Dígito da Agência" }, "account_number": { "type": "string", "readOnly": true, "description": "Conta" }, "account_digit": { "type": "string", "readOnly": true, "description": "Dígito da Conta" }, "extra1": { "type": "string", "readOnly": true, "description": "Campo extra 1" }, "extra1_digit": { "type": "string", "nullable": true, "readOnly": true, "description": "Digito do Campo extra 1" }, "extra2": { "type": "string", "nullable": true, "readOnly": true, "description": "Campo extra 2" }, "extra2_digit": { "type": "string", "nullable": true, "readOnly": true, "description": "Dígito do Campo extra 2" }, "created_via_api": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se o boleto foi criado por API" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do boleto" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do boleto" }, "registration_status": { "type": "string", "readOnly": true, "description": "Situação do registro no banco:\n* `pending` Pendente\n* `skipped` Ignorado\n* `requested` Requisitado\n* `confirmed` Confirmado\n* `rejected` Rejeitado (ainda será tentado novamente)\n* `failed` Falha (não será tentado novamente)", "enum": [ "pending", "skipped", "requested", "confirmed", "rejected", "failed" ] }, "registered_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora do registro (quando confirmado)" }, "issued_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Data de emissão do boleto. Pode ser informado na criação quando `prevent_registration: true`. Nos demais casos, é preenchido automaticamente." }, "revoked_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data de baixa/cancelamento do boleto" }, "register_type": { "type": "integer", "readOnly": true, "description": "Tipo de Registro:\n* `1` API\n* `2` Banco", "enum": [ 1, 2 ] }, "cancel_type": { "type": "integer", "readOnly": true, "nullable": true, "description": "Tipo de Cancelamento:\n * `1` Cliente\n * `2` Banco", "enum": [ null, 1, 2 ] }, "cancellation_reason": { "type": "integer", "readOnly": false, "nullable": true, "description": "Motivo de Cancelamento:\n* `1` Outro\n* `2` Fraude\n* `3` Óbito\n* `4` Erro operacional\n* `5` Quitação paga", "enum": [ null, 1, 2, 3, 4, 5 ] }, "line": { "type": "string", "nullable": true, "readOnly": true, "description": "Linha Digitável" }, "barcode": { "type": "string", "nullable": true, "readOnly": true, "description": "Endereço" }, "shorten_url": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true, "description": "URL para visualização do boleto" }, "url": { "type": "string", "nullable": true, "readOnly": true, "description": "URL para visualização do boleto" }, "url_hash": { "type": "string", "nullable": true, "readOnly": true, "description": "Hash único da URL do boleto para acesso público" }, "password_protected_mode": { "type": "string", "nullable": true, "description": "Modo de proteção por senha ao visualizar o boleto. Valores possíveis: none, email, cpf_cnpj", "enum": [ "none", "email", "cpf_cnpj" ], "default": "none" }, "carne_url": { "type": "string", "nullable": true, "readOnly": true, "description": "URL para visualização do carnê(Quando for parcela)" }, "formats": { "type": "object", "nullable": true, "readOnly": true, "description": "URLs com formatos disponíveis. Ex.: PDF, Imagem, Pix e etc" }, "pix_enabled": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se o boleto é híbrido e tem QRcode Pix" }, "pix_qrcode": { "type": "string", "nullable": true, "readOnly": true, "description": "QRcode Pix do boleto híbrido" }, "pix_txid": { "type": "string", "nullable": true, "description": "Campo txid do Pix. Gerado automaticamente por default caso não fornecido." }, "prevent_pix": { "type": "boolean", "nullable": true, "default": false, "description": "Caso verdadeiro, impede a criação do Pix para carteiras com Pix habilitado. Não é considerado se a carteira não tem Pix habilitado." }, "status": { "type": "string", "readOnly": true, "description": "Situação do boleto:\n* `generating` Gerando\n* `draft` Rascunho\n* `generation_failed` Falha ao gerar\n* `opened` Aberto\n* `canceled` Cancelado\n* `paid` Pago\n* `overdue` Vencido\n* `validation_failed` Inválido\n* `chargeback` Estornado", "enum": [ "generating", "draft", "generation_failed", "validation_failed", "opened", "canceled", "paid", "overdue", "blocked", "chargeback" ] }, "recipient_account": { "type": "string", "nullable": true, "maxLength": 10, "description": "Conta Destinatária + Dígito" }, "reduction_amount": { "type": "number", "nullable": true, "format": "float", "description": "Valor do abatimento", "example": 30.25 }, "instructions_mode": { "type": "integer", "nullable": true, "readOnly": false, "description": "Cálculo de datas na Instrução para o Caixa:\n* `0` Não preencher as instruções para o caixa\n* `1` Calcular data pela via de registro (API/CNAB)\n* `2` Usar a data configurada no boleto", "enum": [ 0, 1, 2 ], "default": 1 }, "import_id": { "type": "integer", "nullable": true, "readOnly": true, "deprecated": true, "description": "ID da Importação (deprecated, use import_uid)" }, "import_uid": { "type": "string", "nullable": true, "readOnly": true, "description": "UID da Importação" }, "virtual_bank_billet_id": { "type": "integer", "nullable": true, "deprecated": true, "description": "ID do Boleto gerado por membro de contrato BackOffice (deprecated, use virtual_bank_billet_uid)", "example": null }, "virtual_bank_billet_uid": { "type": "string", "nullable": true, "description": "UID do Boleto gerado por membro de contrato BackOffice. (BackOffice precisa estar habilitado).", "example": null }, "external_id": { "type": "string", "nullable": true, "description": "ID do boleto no sistema do cliente. Opcional para controle e busca interna." }, "financial_provider_external_id": { "type": "string", "nullable": true, "description": "ID na instituição financeira" }, "payments": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/v2_charge_payment" }, "description": "Lista de Recebimentos vinculados ao Boleto. Retorna objetos completos com todas as informações de cada recebimento." }, "bank_billet_discharges": { "type": "array", "readOnly": true, "nullable": true, "items": { "$ref": "#/components/schemas/v2_bank_billet_discharge" }, "description": "Lista de Baixas vinculadas ao Boleto" }, "bank_billet_remittances": { "type": "array", "readOnly": true, "nullable": true, "items": { "$ref": "#/components/schemas/v2_bank_billet_remittance" }, "description": "Lista de Remessas vinculadas ao Boleto" }, "bank_billet_payments": { "type": "array", "readOnly": true, "nullable": true, "items": { "$ref": "#/components/schemas/v2_bank_billet_payment" }, "description": "Lista de Pagamentos de Boleto vinculados" }, "bank_billet_registrations": { "type": "array", "readOnly": true, "nullable": true, "items": { "$ref": "#/components/schemas/v2_bank_billet_registration" }, "description": "Lista de Registros de Boleto vinculados" }, "bank_billet_split_accounts": { "type": "array", "readOnly": true, "nullable": true, "items": { "$ref": "#/components/schemas/v2_split_accounts_object" }, "description": "Contas de Split vinculadas ao Boleto" }, "pix": { "type": "array", "readOnly": true, "nullable": true, "items": { "$ref": "#/components/schemas/v2_pix" }, "description": "Lista de Pix vinculados ao Boleto (quando híbrido)" }, "after_create": { "type": "array", "nullable": true, "description": "Execução automática de comandos após o boleto ser criado.\n Valores permitidos:\n * `sync`: Sincronização com o provedor financeiro.", "example": null, "items": { "type": "string" } } } }, "v2_bank_billet_duplicate_object": { "type": "object", "properties": { "expire_at_in_days": { "type": "integer", "description": "Nº de dias para vencimento a partir da data de hoje. Default: 7", "example": null }, "amount": { "type": "number", "format": "float", "description": "Valor do novo Boleto", "example": 10.99 }, "cancel": { "type": "boolean", "nullable": true, "description": "Cancelar o boleto que está sendo duplicado. Default: true", "example": null }, "with_fines": { "type": "boolean", "nullable": true, "description": "Atualizar o valor do novo boleto com juros e multa. Default: false", "example": null }, "bank_billet_account_id": { "type": "integer", "description": "ID da Carteira de Cobrança. Se não informado, usará a carteira padrão.", "example": null }, "bank_billet_layout_id": { "type": "integer", "nullable": true, "description": "ID do Modelo de Boleto", "example": null }, "customer_id": { "type": "integer", "nullable": true, "description": "ID do Cliente. Quando esse ID é passado, os campos `customer_person_name`, `customer_cnpj_cpf`, `customer_zipcode`, `customer_address`, `customer_city_name`, `customer_state` e `customer_neighborhood` não são obrigatórios.", "example": null }, "customer_person_name": { "type": "string", "maxLength": 120, "description": "Nome do cliente", "example": "João Silva" }, "customer_cnpj_cpf": { "type": "string", "maxLength": 20, "description": "CPF/CNPJ do cliente", "example": "16.974.923/0001-84" }, "customer_state": { "type": "string", "maxLength": 2, "description": "Estado", "example": "SP" }, "customer_city_name": { "type": "string", "maxLength": 60, "description": "Cidade(Nome deve estar correto e completo)", "example": "São Paulo" }, "customer_zipcode": { "type": "string", "maxLength": 8, "description": "CEP (formato 99999999)", "example": "01310100" }, "customer_address": { "type": "string", "maxLength": 255, "description": "Endereço", "example": "Rua F, alamenda G" }, "customer_address_complement": { "type": "string", "maxLength": 120, "description": "Complemento", "example": null }, "customer_address_number": { "type": "string", "maxLength": 10, "description": "Número", "example": null }, "customer_email": { "type": "string", "format": "email", "maxLength": 80, "description": "E-mail do Pagador", "example": null }, "customer_email_cc": { "type": "string", "format": "email", "maxLength": 80, "description": "E-mail alternativo do Pagador", "example": null }, "customer_neighborhood": { "type": "string", "maxLength": 80, "description": "Bairro", "example": "Centro" }, "customer_phone_number": { "type": "string", "maxLength": 15, "description": "Telefone (com DDD, DDI é opcional)", "example": null }, "customer_ignore_email": { "type": "boolean", "nullable": true, "description": "Nunca enviar e-mail para este cliente", "example": null }, "customer_ignore_sms": { "type": "boolean", "nullable": true, "description": "Nunca enviar SMS para este cliente", "example": null }, "customer_mobile_local_code": { "type": "string", "nullable": true, "maxLength": 2, "description": "DDD do Celular", "example": null }, "customer_mobile_number": { "type": "string", "nullable": true, "maxLength": 9, "description": "Celular", "example": null }, "customer_nickname": { "type": "string", "nullable": true, "maxLength": 255, "description": "Apelido ou Nome Fantasia do Pagador", "example": null }, "customer_notes": { "type": "string", "nullable": true, "description": "Observações do Pagador", "example": null }, "customer_contact_person": { "type": "string", "nullable": true, "maxLength": 120, "description": "Contato", "example": null }, "interest_type": { "type": "integer", "nullable": true, "description": "Tipo de juros/mora:\n* `0` Inexistente (Padrão)\n* `1` Para porcentagem diária\n* `2` Para valor diário", "enum": [ 0, 1, 2 ], "default": 0 }, "days_for_interest": { "type": "integer", "nullable": true, "description": "Quantidade de dias após o vencimento que a mora começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento).", "example": null }, "interest_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Porcentagem diária de juros. De 0.0 a 100.0 (Ex 1.5% = 1.5) Obrigatório se interest_type é igual a 1.", "example": null }, "interest_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor diário de juros (R$). Obrigatório se interest_type é igual a 2.", "example": null }, "interest_days_type": { "type": "integer", "nullable": true, "description": "Tipo de Dias para juros:\n* `0` Corridos\n* `1` Úteis", "enum": [ 0, 1 ], "default": 0 }, "fine_type": { "type": "integer", "nullable": true, "description": "Tipo de multa:\n* `0` Inexistente (Padrão)\n* `1` Para percentual do valor do boleto\n* `2` Para valor fixo", "enum": [ 0, 1, 2 ], "default": 0 }, "days_for_fine": { "type": "integer", "nullable": true, "description": "Quantidade de dias após o vencimento que a multa começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento).", "example": null }, "fine_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Porcentagem de Multa por Atraso Ex: 2% x R$ 250,00 = R$ 5,00. Obrigatória se fine_type é igual a 1", "example": null }, "fine_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor da multa (R$). Obrigatório se fine_type é igual a 2.", "example": null }, "discount_type": { "type": "integer", "nullable": true, "description": "Tipo de desconto:\nO tipo de desconto será o mesmo para todos os três descontos, caso existam. :\n* `0` Inexistente (Padrão)\n* `1` Para valor fixo\n* `2` Para percentual do valor do boleto", "enum": [ 0, 1, 2 ], "default": 0 }, "days_for_discount": { "type": "integer", "nullable": true, "description": "Dias para desconto. Obrigatório se discount_type é diferente de 0(zero)", "example": null }, "discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao desconto. Obrigatório se discount_type é igual a 2", "example": null }, "discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do desconto (R$). Obrigatório se discount_type é igual a 1.", "example": null }, "days_for_second_discount": { "type": "integer", "nullable": true, "description": "Dias para segundo desconto.", "example": null }, "second_discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao segundo desconto.", "example": null }, "second_discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do segundo desconto (R$).", "example": null }, "days_for_third_discount": { "type": "integer", "nullable": true, "description": "Dias para terceiro desconto.", "example": null }, "third_discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao terceiro desconto.", "example": null }, "third_discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do terceiro desconto (R$).", "example": null }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas ao boleto", "example": null, "items": { "type": "string" } }, "tag_list": { "type": "string", "nullable": true, "readOnly": true, "description": "Tags associadas ao boleto" }, "charge_type": { "type": "integer", "nullable": true, "description": "Tipo de Cobrança:\n* `1` Simples\n* `2` Vinculada\n* `3` Descontada\n* `4` Vendor", "enum": [ 1, 2, 3, 4 ], "default": 1 }, "dispatch_type": { "type": "integer", "nullable": true, "description": "Tipo de Cobrança:\nQuando o boleto precisa ser enviado pelo correio. É preciso contratar o serviço junto ao banco e pagará tarifa.\n* `1` Cliente\n* `2` Banco", "enum": [ 1, 2 ], "default": 1 }, "guarantor_name": { "type": "string", "nullable": true, "maxLength": 100, "description": "Nome do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_cnpj_cpf": { "type": "string", "nullable": true, "maxLength": 20, "description": "CNPJ/CPF do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_address_number": { "type": "string", "nullable": true, "maxLength": 10, "description": "Número do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_neighborhood": { "type": "string", "nullable": true, "maxLength": 80, "description": "Bairro do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_phone_number": { "type": "string", "nullable": true, "maxLength": 11, "description": "Telefone (com DDD) do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_city_name": { "type": "string", "nullable": true, "maxLength": 60, "description": "Cidade(Nome deve estar correto e completo) do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_state": { "type": "string", "nullable": true, "maxLength": 2, "description": "Estado do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_zipcode": { "type": "string", "nullable": true, "maxLength": 8, "description": "CEP (formato 99999999) do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_address": { "type": "string", "nullable": true, "maxLength": 255, "description": "Endereço do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_address_complement": { "type": "string", "nullable": true, "maxLength": 60, "description": "Complemento do Beneficiário final (Sacador/Avalista)", "example": null }, "description": { "type": "string", "nullable": true, "description": "Descrição do produto ou serviço", "example": null }, "instructions": { "type": "string", "nullable": true, "description": "Instruções para o Caixa", "example": null }, "document_date": { "type": "string", "format": "date", "nullable": true, "description": "Data do Documento", "example": null }, "document_type": { "type": "string", "description": "Tipo de Documento:\n\n* `Código` | `Sigla` | Descrição\n* `01` | `CH` | Cheque\n* `02` | `DM` | Duplicata Mercantil (Padrão)\n* `03` | `DMI` | Duplicata Mercantil p/ Indicação\n* `04` | `DS` | Duplicata de Serviço\n* `05` | `DSI` | Duplicata de Serviço p/ Indicação\n* `06` | `DR` | Duplicata Rural\n* `07` | `LC` | Letra de Câmbio\n* `08` | `NCC` | Nota de Crédito Comercial\n* `09` | `NCE` | Nota de Crédito a Exportação\n* `10` | `NCI` | Nota de Crédito Industrial\n* `11` | `NCR` | Nota de Crédito Rural\n* `12` | `NP` | Nota Promissória\n* `13` | `NPR` | Nota Promissória Rural\n* `14` | `TM` | Triplicata Mercantil\n* `15` | `TS` | Triplicata de Serviço\n* `16` | `NS` | Nota de Seguro\n* `17` | `RC` | Recibo\n* `18` | `FAT` | Fatura\n* `19` | `ND` | Nota de Débito\n* `20` | `AP` | Apólice de Seguro\n* `21` | `ME` | Mensalidade Escolar\n* `22` | `PC` | Parcela de Consórcio\n* `23` | `NF` | Nota Fiscal\n* `24` | `DD` | Documento de Dívida\n* `25` | `CPR` | Cédula de Produto Rural\n* `26` | `CTR` | Contrato\n* `27` | `CSG` | Cosseguros\n* `28` | `EC` | Encargos Condominiais\n* `29` | `CPS` | Conta de Prestação de Serviços\n* `30` | `WR` | Warrant\n* `31` | `DP` | Duplicata Prestação\n* `32` | `CSR` | Cobrança Seriada\n* `33` | `CAR` | Carnê\n* `34` | `ARE` | Apólice Ramos Elementares\n* `35` | `CC` | Cartão de Crédito\n* `36` | `BDP` | Boleto de Proposta\n* `37` | `NPD` | Nota Promissória Direta\n* `38` | `DAE` | Dívida Ativa de Estado\n* `39` | `DAM` | Divida Ativa de Município\n* `40` | `DAU` | Dívida Ativa União\n* `41` | `CCB` | Célula de Crédito Bancário\n* `42` | `FI` | Financiamento\n* `43` | `RD` | Rateio de Despesas\n* `44` | `DRI` | Duplicata Rural p/ Indicação\n* `45` | `ECI` | Encargos Condominiais p/ Indicação\n* `99` | `Outros` | Outros\n ", "default": "02", "enum": [ "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "99" ] }, "document_type_label": { "type": "string", "nullable": true, "readOnly": true, "description": "Tipo de Documento (Sigla)" }, "document_number": { "type": "string", "nullable": true, "description": "Número do Documento", "example": null }, "acceptance": { "type": "string", "description": "Aceite:\n* `N` Não (Padrão)\n* `S` Sim", "default": "N", "enum": [ "N", "S" ] }, "our_number": { "type": "string", "nullable": true, "description": "Nosso Número. Se não informado, usará o Próximo Nosso Número da Carteira de Cobrança.", "example": null }, "processed_our_number": { "type": "string", "readOnly": true, "nullable": true, "description": "Nosso Número calculado com DV (formatado)" }, "processed_our_number_raw": { "type": "string", "readOnly": true, "nullable": true, "description": "Nosso Número calculado com DV (limpo)" }, "paid_amount": { "type": "number", "format": "float", "description": "Valor pago", "example": null }, "paid_at": { "type": "string", "format": "date", "nullable": true, "description": "Data do pagamento", "example": null }, "days_for_revoke": { "type": "integer", "nullable": true, "description": "Dias corridos para Baixa/Devolução", "example": null }, "days_for_negativation": { "type": "integer", "nullable": true, "example": null, "description": "Dias corridos para Negativação:\n\nDisponível apenas para os seguintes bancos e formatos.\n\n* Banco |\tCNAB 240|\tCNAB 400 |Webservice\n* Bradesco |\tSim |\tSim\t| Não\n* Itaú | Não | Sim | Não\n " }, "days_for_sue": { "type": "integer", "nullable": true, "description": "Dias corridos para Protesto", "example": null }, "sue_code": { "type": "string", "nullable": true, "description": "Código de Protesto(CNAB 240). Consulte os possíveis valores para cada banco.", "example": null }, "revoke_code": { "type": "string", "nullable": true, "description": "Código de Baixa(CNAB 240). Consulte os possíveis valores para cada banco.", "example": null }, "first_instruction": { "type": "string", "nullable": true, "description": "Primeira Instrução(CNAB 400). Consulte os possíveis valores para cada banco.", "example": null }, "second_instruction": { "type": "string", "nullable": true, "description": "Segunda Instrução(CNAB 400). Consulte os possíveis valores para cada banco.", "example": null }, "watermark": { "type": "boolean", "description": "Endereço", "example": null }, "divergent_payment_type": { "type": "integer", "nullable": true, "example": null, "description": "Tipo de pagamento divergente:\nVálido apenas para Itaú e Caixa.\n* `1` Aceita qualquer valor divergente\n* `2` Aceita pagamentos dentro de uma faixa de valores ou percentuais\n* `3` Não aceita pagamento de valores divergentes\n* `4` Aceita pagamentos de valores superiores a um valor ou percentual mínimo", "enum": [ null, 1, 2, 3, 4 ] }, "divergent_payment_value_type": { "type": "integer", "nullable": true, "example": null, "description": "Tipo de valor a considerar para os limites de pagamentos:\nVálido apenas para Itaú e Caixa.\n* `1` Informa pagamentos divergentes por valores\n* `2` Informa pagamentos divergentes por percentuais", "enum": [ null, 1, 2 ] }, "divergent_payment_maximum_value": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Valor mínimo para a faixa de pagamentos divergentes. " }, "divergent_payment_minimum_value": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Valor máximo para a faixa de pagamentos divergentes. " }, "divergent_payment_maximum_percentage": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Percentual mínimo para a faixa de pagamentos divergentes. " }, "divergent_payment_minimum_percentage": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Percentual máximo para a faixa de pagamentos divergentes." }, "divergent_payment_limit": { "type": "integer", "nullable": true, "example": null, "description": "Quantidade de pagamentos permitida. Obrigatório se informados dados para pagamento divergente. Usado somente pela Caixa." }, "prevent_registration": { "type": "boolean", "nullable": true, "example": null, "description": "Impedir envio de registro ao banco:\n\nCaso `true`, impede que o boleto seja registrado. Para ser usado nos casos em que o boleto já foi registrado fora da KOBANA mas deseja-se incluí-lo no sistema." }, "control_number": { "type": "string", "nullable": true, "example": null, "description": "Número de controle:\n\nPode conter qualquer informação de interesse da Empresa. A informação contida neste campo sempre retornará com o respectivo título no arquivo-retorno." }, "ignore_email": { "type": "boolean", "default": false, "nullable": true, "example": null, "description": "Não enviar este boleto por email" }, "ignore_sms": { "type": "boolean", "default": false, "nullable": true, "description": "Nunca enviar este boleto por SMS", "example": null }, "ignore_whatsapp": { "type": "boolean", "default": false, "nullable": true, "description": "Nunca enviar este boleto por WhatsApp", "example": null }, "addons": { "type": "string", "format": "jsonb", "nullable": true, "example": null, "description": "Endereço" }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "meta": { "type": "object", "deprecated": true, "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "notes": { "type": "string", "nullable": true, "example": null, "description": "Observações" }, "custom_attachment_name": { "type": "string", "nullable": true, "example": null, "description": "Nome para ser usado nos arquivos de boleto enviados para o cliente em notificações. Aceita uso de variáveis. Caso seja deixado vazio, o padrão é a palavra “boleto” acompanhada do ID." }, "split_payment": { "type": "boolean", "nullable": true, "example": null, "description": "Split de Pagamento.\nVálido apenas para ABC Brasil (remessa CNAB 240), Itaú e Bradesco (remessa CNAB 400).\nCaso true, o rateio do boleto será registrado.\nInformar as contas para rateio em `split_accounts`" }, "split_payment_type": { "type": "integer", "nullable": true, "example": null, "description": "Tipo de Split de Pagamento:\nVálido apenas para Itau. Usado apenas com Split de Pagamento true.\n* `1` Rateio de crédito por percentual (%) – Valor nominal do título\n* `2` Rateio de crédito em valor (R$) – Valor nominal do título\n* `3` Rateio de crédito por percentual (%) – Valor líquido recebido\n* `4` Rateio de crédito em valor (R$) – Valor líquido recebido, rateado proporcionalmente", "enum": [ 1, 2, 3, 4 ] }, "split_accounts": { "type": "array", "nullable": true, "example": null, "description": "Contas para Split de pagamento.", "items": { "$ref": "#/components/schemas/v2_split_accounts_object" } }, "payment_place": { "type": "string", "nullable": true, "maxLength": 100, "example": null, "description": "Local de Pagamento" }, "installment_id": { "type": "integer", "nullable": true, "readOnly": true, "description": "ID do Carnê" }, "installment_number": { "type": "integer", "nullable": true, "readOnly": true, "description": "Número da parcela do carnê" }, "installment_total": { "type": "integer", "nullable": true, "readOnly": true, "description": "Total de parcelas do carnê" }, "customer_subscription_id": { "type": "integer", "nullable": true, "readOnly": true, "description": "ID da Assinatura" }, "beneficiary_name": { "type": "string", "readOnly": true, "description": "Nome do Beneficiário" }, "beneficiary_cnpj_cpf": { "type": "string", "readOnly": true, "description": "CNPJ/CPF do Beneficiário" }, "beneficiary_address": { "type": "string", "readOnly": true, "description": "Endereço do Beneficiário" }, "beneficiary_assignor_code": { "type": "string", "nullable": true, "readOnly": true, "description": "Agência/Código do Beneficiário" }, "bank_contract_slug": { "type": "string", "nullable": true, "readOnly": true, "description": "Slug da Carteira" }, "agency_number": { "type": "string", "readOnly": true, "description": "Agência" }, "agency_digit": { "type": "string", "readOnly": true, "description": "Dígito da Agência" }, "account_number": { "type": "string", "readOnly": true, "description": "Conta" }, "account_digit": { "type": "string", "readOnly": true, "description": "Dígito da Conta" }, "extra1": { "type": "string", "readOnly": true, "description": "Campo extra 1" }, "extra1_digit": { "type": "string", "nullable": true, "readOnly": true, "description": "Digito do Campo extra 1" }, "extra2": { "type": "string", "nullable": true, "readOnly": true, "description": "Campo extra 2" }, "extra2_digit": { "type": "string", "nullable": true, "readOnly": true, "description": "Dígito do Campo extra 2" }, "created_via_api": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se o boleto foi criado por API" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do boleto" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do boleto" }, "registered_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora do registro" }, "register_type": { "type": "integer", "readOnly": true, "description": "Tipo de Registro:\n* `1` API\n* `2` Banco", "enum": [ 1, 2 ] }, "cancel_type": { "type": "integer", "readOnly": true, "description": "Tipo de Cancelamento:\n * `1` Cliente\n * `2` Banco", "enum": [ 1, 2 ] }, "payment_count": { "type": "integer", "nullable": true, "description": "Quantidade de pagamentos parciais aceitos para este boleto." }, "line": { "type": "string", "nullable": true, "readOnly": true, "description": "Linha Digitável" }, "barcode": { "type": "string", "nullable": true, "readOnly": true, "description": "Endereço" }, "shorten_url": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true, "description": "URL para visualização do boleto" }, "url": { "type": "string", "nullable": true, "readOnly": true, "description": "URL para visualização do boleto" }, "carne_url": { "type": "string", "nullable": true, "readOnly": true, "description": "URL para visualização do carnê(Quando for parcela)" }, "formats": { "type": "object", "nullable": true, "readOnly": true, "description": "URLs com formatos disponíveis. Ex.: PDF, Imagem, Pix e etc" }, "pix_enabled": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se o boleto é híbrido e tem QRcode Pix" }, "pix_qrcode": { "type": "string", "nullable": true, "readOnly": true, "description": "QRcode Pix do boleto híbrido" }, "status": { "type": "string", "readOnly": true, "description": "Situação do boleto:\n* `generating` Gerando\n* `draft` Rascunho\n* `generation_failed` Falha ao gerar\n* `opened` Aberto\n* `canceled` Cancelado\n* `paid` Pago\n* `overdue` Vencido\n* `validation_failed` Inválido\n* `chargeback` Estornado", "enum": [ "generating", "draft", "generation_failed", "validation_failed", "opened", "canceled", "paid", "overdue", "blocked", "chargeback" ] }, "recipient_account": { "type": "string", "nullable": true, "maxLength": 10, "description": "Conta Destinatária + Dígito" } } }, "v2_bank_billet_pay_object": { "type": "object", "required": [ "paid_at", "paid_amount" ], "properties": { "paid_amount": { "type": "number", "format": "float", "description": "Valor pago do boleto.", "example": 1345.56 }, "paid_at": { "type": "string", "format": "date", "description": "Data de pagamento do boleto", "example": "2023-12-12" }, "bank_rate": { "type": "string", "nullable": true, "description": "Valor da taxa bancária.", "example": "4,02" }, "direct_payment": { "type": "boolean", "nullable": true, "description": "Informa se o pagamento foi feito diretamente ao beneficiário.", "example": null } } }, "v2_bank_billet_update_object": { "type": "object", "properties": { "amount": { "type": "number", "format": "float", "description": "Valor do Boleto", "example": 10.99 }, "expire_at": { "type": "string", "format": "date", "description": "Data de vencimento", "example": "2023-12-12" }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas ao boleto", "example": null, "items": { "type": "string" } }, "notes": { "type": "string", "nullable": true, "example": null, "description": "Observações" }, "days_for_sue": { "type": "integer", "nullable": true, "description": "Dias corridos para Protesto", "example": null }, "days_for_revoke": { "type": "integer", "nullable": true, "description": "Dias corridos para Baixa\nBancos Suportados: Itaú", "example": null }, "sue_code": { "type": "string", "nullable": true, "description": "Código de Protesto(Somente por CNAB 240). Consulte os possíveis valores para cada banco.", "example": null }, "instructions": { "type": "string", "nullable": true, "description": "Instruções para o Caixa", "example": null }, "description": { "type": "string", "nullable": true, "description": "Descrição do produto ou serviço", "example": null }, "reduction_amount": { "type": "number", "format": "float", "description": "Valor do abatimento", "example": 30.25 } } }, "v2_bank_billet_cancel_object": { "type": "object", "properties": { "cancellation_reason": { "type": "integer", "nullable": true, "description": "Motivo do cancelamento:\n* `1` Outro\n* `2` Fraude\n* `3` Óbito\n* `4` Erro operacional\n* `5` Quitação paga", "enum": [ 1, 2, 3, 4, 5 ] } } }, "v2_bank_billet_cancel_all_object": { "type": "object", "properties": { "status": { "type": "string", "readOnly": true, "description": "Situação do boleto:\n* `generating` Gerando\n* `draft` Rascunho\n* `generation_failed` Falha ao gerar\n* `opened` Aberto\n* `canceled` Cancelado\n* `paid` Pago\n* `overdue` Vencido\n* `validation_failed` Inválido\n* `chargeback` Estornado", "enum": [ "generating", "draft", "generation_failed", "validation_failed", "opened", "canceled", "paid", "overdue", "blocked", "chargeback" ] }, "expire_from": { "type": "string", "format": "date", "description": "A partir de Data de vencimento", "example": "2023-12-12" }, "expire_to": { "type": "string", "format": "date", "description": "Até a Data de vencimento", "example": "2023-12-12" }, "cnpj_cpf": { "type": "string", "description": "CNPJ ou CPF do Pagador", "example": "16.974.923/0001-84" }, "bank_billet_ids": { "type": "array", "nullable": true, "description": "IDs de boletos a serem cancelados", "example": null, "items": { "type": "integer" } } } }, "v2_bank_billet_send_email_object": { "type": "object", "required": [ "form" ], "properties": { "form": { "type": "object", "required": [ "email_account_id" ], "description": "Formulário de E-mail.", "properties": { "to": { "type": "string", "format": "email", "description": "E-mail do pagador", "example": null }, "subject": { "type": "string", "description": "Nome do pagador", "example": null }, "message": { "type": "string", "description": "Mensagem de e-mail", "example": null }, "email_account_id": { "type": "integer", "description": "ID da conta de e-email", "example": null }, "email_template_id": { "type": "integer", "description": "ID do template de e-email. O template de email é criado via interface e Régua de Comunicação > E-mails > Templates", "example": null }, "bank_billet_in_pdf": { "type": "boolean", "description": "Boleto como PDF", "example": null }, "bank_billet_in_png": { "type": "boolean", "description": "Boleto como PNG", "example": null } } } } }, "v2_bank_billet_send_sms_object": { "type": "object", "required": [ "form" ], "properties": { "form": { "type": "object", "required": [ "sms_notification_id" ], "description": "Formulário de SMS.", "properties": { "phone_to": { "type": "string", "maxLength": 11, "description": "Telefone (com DDD) do pagador", "example": null }, "message": { "type": "string", "description": "Mensagem de sms", "example": null }, "sms_notification_id": { "type": "integer", "description": "ID da notificação", "example": null }, "sms_account_id": { "type": "integer", "description": "ID da conta de sms", "example": null } } } } }, "v2_payment": { "type": "object", "required": [ "amount", "kind", "paid_at", "payable" ], "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID do Recebimento." }, "amount": { "type": "number", "format": "float", "description": "Valor do Recebimento.", "example": 10.99 }, "kind": { "type": "string", "enum": [ "direct", "bank_billet", "pix" ], "description": "Tipo de Recebimento.", "example": "bank_billet" }, "paid_at": { "type": "string", "format": "date", "description": "Data do Recebimento." }, "payable": { "type": "object", "nullable": true, "description": "Recurso associado ao pagamento (Boleto ou Pix).", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do recurso associado ao pagamento." }, "uid": { "type": "string", "description": "UID do recurso associado ao pagamento." }, "type": { "type": "string", "enum": [ "BankBillet", "Pix" ], "description": "Tipo do recurso associado ao pagamento." } } }, "debtor": { "type": "object", "description": "Informações do devedor (sacado) do boleto.", "properties": { "is_payer": { "type": "boolean", "nullable": true, "description": "Indica se o devedor é quem realizou o pagamento. Preenchido automaticamente via consulta ao banco (D+2 úteis após pagamento). Null quando a consulta ainda não foi realizada ou os dados não estão disponíveis." }, "name": { "type": "string", "description": "Nome do devedor." }, "document_number": { "type": "string", "description": "CPF ou CNPJ do devedor." } } }, "payer": { "type": "object", "nullable": true, "readOnly": true, "description": "Informações de quem efetivamente realizou o pagamento (portador). Preenchido automaticamente via consulta diária ao banco, disponível D+2 dias úteis após o pagamento. Null quando a consulta ainda não foi realizada ou o banco não retornou os dados do pagador.", "properties": { "name": { "type": "string", "description": "Nome do pagador." }, "document_number": { "type": "string", "description": "CPF ou CNPJ do pagador." } } }, "bank": { "type": "object", "nullable": true, "readOnly": true, "description": "Informações bancárias.", "properties": { "rate": { "type": "number", "format": "float", "description": "Taxa bancária." } } }, "receiving": { "type": "object", "readOnly": true, "description": "Informações de recebimento.", "properties": { "bank": { "type": "string", "nullable": true, "maxLength": 3, "description": "Banco de Recebimento." }, "agency": { "type": "string", "nullable": true, "maxLength": 5, "description": "Agência de Recebimento (com dígito quando disponível)." }, "agency_number": { "type": "string", "nullable": true, "maxLength": 4, "description": "Número da Agência de Recebimento (sem dígito)." }, "agency_digit": { "type": "string", "nullable": true, "maxLength": 1, "description": "Dígito da Agência de Recebimento." } } }, "credit_at": { "type": "string", "format": "date", "nullable": true, "readOnly": true, "description": "Data de crédito." }, "created_via_api": { "type": "boolean", "readOnly": true, "description": "Enviado pela API." }, "transaction_identifier": { "type": "string", "nullable": true, "description": "Identificador da Transação." }, "status": { "type": "string", "description": "Situação.", "readOnly": true, "example": "confirmed" }, "duplicated": { "type": "object", "nullable": true, "readOnly": true, "description": "Presente quando o recebimento é uma duplicata. Contém o UID do recebimento original.", "properties": { "uid": { "type": "string", "format": "uuid", "nullable": true, "description": "UID do Recebimento original. Null quando o original é desconhecido." } } }, "created_at": { "type": "string", "format": "date", "readOnly": true, "description": "Data e hora de criação." }, "updated_at": { "type": "string", "format": "date", "readOnly": true, "description": "Data e hora da alteração." } } }, "v2_charge_payment": { "type": "object", "required": [ "amount", "kind", "paid_at", "payable" ], "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID do Recebimento." }, "amount": { "type": "number", "format": "float", "description": "Valor do Recebimento.", "example": 10.99 }, "kind": { "type": "string", "enum": [ "direct", "bank_billet", "pix" ], "description": "Tipo de Recebimento.", "example": "bank_billet" }, "paid_at": { "type": "string", "format": "date", "description": "Data do Recebimento." }, "payable": { "type": "object", "nullable": true, "description": "Recurso associado ao pagamento (Boleto ou Pix).", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do recurso associado ao pagamento." }, "uid": { "type": "string", "description": "UID do recurso associado ao pagamento." }, "type": { "type": "string", "enum": [ "BankBillet", "Pix" ], "description": "Tipo do recurso associado ao pagamento." } } }, "debtor": { "type": "object", "description": "Informações do devedor (sacado) do boleto.", "properties": { "is_payer": { "type": "boolean", "nullable": true, "description": "Indica se o devedor é quem realizou o pagamento. Preenchido automaticamente via consulta ao banco (D+2 úteis após pagamento). Null quando a consulta ainda não foi realizada ou os dados não estão disponíveis." }, "name": { "type": "string", "description": "Nome do devedor." }, "document_number": { "type": "string", "description": "CPF ou CNPJ do devedor." } } }, "payer": { "type": "object", "nullable": true, "readOnly": true, "description": "Informações de quem efetivamente realizou o pagamento (portador). Preenchido automaticamente via consulta diária ao banco, disponível D+2 dias úteis após o pagamento. Null quando a consulta ainda não foi realizada ou o banco não retornou os dados do pagador.", "properties": { "name": { "type": "string", "description": "Nome do pagador." }, "document_number": { "type": "string", "description": "CPF ou CNPJ do pagador." } } }, "bank": { "type": "object", "nullable": true, "readOnly": true, "description": "Informações bancárias.", "properties": { "rate": { "type": "number", "format": "float", "description": "Taxa bancária." } } }, "receiving": { "type": "object", "readOnly": true, "description": "Informações de recebimento.", "properties": { "bank": { "type": "string", "nullable": true, "maxLength": 3, "description": "Banco de Recebimento." }, "agency": { "type": "string", "nullable": true, "maxLength": 5, "description": "Agência de Recebimento (com dígito quando disponível)." }, "agency_number": { "type": "string", "nullable": true, "maxLength": 4, "description": "Número da Agência de Recebimento (sem dígito)." }, "agency_digit": { "type": "string", "nullable": true, "maxLength": 1, "description": "Dígito da Agência de Recebimento." } } }, "credit_at": { "type": "string", "format": "date", "nullable": true, "readOnly": true, "description": "Data de crédito." }, "created_via_api": { "type": "boolean", "readOnly": true, "description": "Enviado pela API." }, "transaction_identifier": { "type": "string", "nullable": true, "description": "Identificador da Transação." }, "status": { "type": "string", "description": "Situação.", "readOnly": true, "example": "confirmed" }, "duplicated": { "type": "object", "nullable": true, "readOnly": true, "description": "Presente quando o recebimento é uma duplicata. Contém o UID do recebimento original.", "properties": { "uid": { "type": "string", "format": "uuid", "nullable": true, "description": "UID do Recebimento original. Null quando o original é desconhecido." } } }, "created_at": { "type": "string", "format": "date", "readOnly": true, "description": "Data e hora de criação." }, "updated_at": { "type": "string", "format": "date", "readOnly": true, "description": "Data e hora da alteração." } } }, "v2_customer_subscription": { "type": "object", "required": [ "amount", "customer_person_name", "customer_cnpj_cpf", "customer_zipcode", "customer_address", "customer_neighborhood", "customer_city_name", "customer_state", "bank_billet_account_id" ], "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID da assinatura" }, "customer_id": { "type": "integer", "nullable": true, "description": "ID do Cliente. Quando esse ID é passado, os campos `customer_person_name`, `customer_cnpj_cpf`, `customer_zipcode`, `customer_address`, `customer_city_name`, `customer_state` e `customer_neighborhood` não são obrigatórios.", "example": null }, "customer_person_name": { "type": "string", "maxLength": 120, "description": "Nome do cliente", "example": "João Silva" }, "customer_nickname": { "type": "string", "nullable": true, "maxLength": 255, "description": "Apelido ou Nome Fantasia do Pagador", "example": null }, "customer_cnpj_cpf": { "type": "string", "maxLength": 20, "description": "CPF/CNPJ do cliente", "example": "16.974.923/0001-84" }, "customer_zipcode": { "type": "string", "maxLength": 8, "description": "CEP (formato 99999999)", "example": "01310100" }, "customer_email": { "type": "string", "nullable": true, "format": "email", "maxLength": 80, "description": "E-mail do Pagador", "example": null }, "customer_email_cc": { "type": "string", "nullable": true, "format": "email", "maxLength": 80, "description": "E-mail alternativo do Pagador", "example": null }, "customer_address": { "type": "string", "maxLength": 255, "description": "Endereço", "example": "Rua F, alamenda G" }, "customer_city_name": { "type": "string", "maxLength": 60, "description": "Cidade(Nome deve estar correto e completo)", "example": "São Paulo" }, "customer_state": { "type": "string", "maxLength": 2, "description": "Estado", "example": "SP" }, "customer_neighborhood": { "type": "string", "maxLength": 80, "description": "Bairro", "example": "Centro" }, "customer_address_number": { "type": "string", "maxLength": 10, "description": "Número", "example": null }, "customer_address_complement": { "type": "string", "nullable": true, "maxLength": 120, "description": "Complemento", "example": null }, "customer_phone_number": { "type": "string", "nullable": true, "maxLength": 11, "description": "Telefone (com DDD)", "example": null }, "customer_person_type": { "type": "string", "readOnly": true, "nullable": true, "maxLength": 10, "description": "Tipo de Pagador.\n* `individual` Pessoa Física\n* `juridical` Pessoa Jurídica", "enum": [ "individual", "juridical" ] }, "customer_mobile_local_code": { "type": "string", "nullable": true, "maxLength": 2, "description": "DDD do Celular", "example": null }, "customer_mobile_number": { "type": "string", "nullable": true, "maxLength": 9, "description": "Celular", "example": null }, "customer_notes": { "type": "string", "nullable": true, "description": "Observações do Pagador", "example": null }, "customer_ignore_email": { "type": "boolean", "nullable": true, "description": "Nunca enviar e-mail para este cliente", "example": null }, "customer_ignore_sms": { "type": "boolean", "nullable": true, "description": "Nunca enviar SMS para este cliente", "example": null }, "customer_contact_person": { "type": "string", "nullable": true, "maxLength": 120, "description": "Contato", "example": null }, "customer_update": { "type": "string", "nullable": true, "maxLength": 120, "description": "Contato", "example": null }, "bank_billet_account_id": { "type": "integer", "description": "ID da Carteira de Cobrança. Se não informado, usará a carteira padrão.", "example": null }, "amount": { "type": "number", "format": "float", "description": "Valor da Assinatura (R$)", "example": 10.99 }, "cycle": { "type": "string", "readOnly": true, "nullable": true, "maxLength": 20, "description": "Ciclo da assinatura. Default: monthly\n\n* `biweekly` Quinzenal\n* `bimonthly` Bimestral\n* `monthly` Mensal\n* `quarterly` Trimestral\n* `semiannual` Semestral\n* `annual` Anual", "enum": [ "biweekly", "bimonthly", "monthly", "quarterly", "semiannual", "annual" ] }, "next_billing": { "type": "string", "format": "date", "description": "Data da Primeira ou Próxima cobrança. Caso não seja enviado uma data, esse campo será calculado para ter o valor do dia da criação da assinatura mais o ciclo escolhido. Ex.: Mensal(Hoje + 30 dias)", "example": "2022-12-12" }, "end_at": { "type": "string", "format": "date", "nullable": true, "description": "Data em que deseja parar as cobranças. Caso em branco, as cobranças serão geradas automaticamente até que se informe uma data ou se exclua a assinatura.", "example": "2023-12-12" }, "description": { "type": "string", "nullable": true, "description": "Descrição do produto ou serviço", "example": null }, "instructions": { "type": "string", "nullable": true, "description": "Instruções para o Caixa", "example": null }, "days_in_advance": { "type": "integer", "description": "Com quantos dias de antecedência à data de vencimento a cobrança será gerada. Default: 7.", "example": 10 }, "fine_type": { "type": "integer", "nullable": true, "description": "Tipo de multa:\n* `0` Inexistente (Padrão)\n* `1` Para percentual do valor do boleto\n* `2` Para valor fixo", "enum": [ 0, 1, 2 ], "default": 0 }, "days_for_fine": { "type": "integer", "nullable": true, "description": "Quantidade de dias após o vencimento que a multa começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento).", "example": null }, "fine_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Porcentagem de Multa por Atraso Ex: 2% x R$ 250,00 = R$ 5,00. Obrigatória se fine_type é igual a 1", "example": null }, "fine_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor da multa (R$). Obrigatório se fine_type é igual a 2.", "example": null }, "interest_type": { "type": "integer", "nullable": true, "description": "Tipo de juros/mora:\n* `0` Inexistente (Padrão)\n* `1` Para porcentagem diária\n* `2` Para valor diário", "enum": [ 0, 1, 2 ], "default": 0 }, "days_for_interest": { "type": "integer", "nullable": true, "description": "Quantidade de dias após o vencimento que a mora começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento).", "example": null }, "interest_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Porcentagem diária de juros. De 0.0 a 100.0 (Ex 1.5% = 1.5) Obrigatório se interest_type é igual a 1.", "example": null }, "interest_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor diário de juros (R$). Obrigatório se interest_type é igual a 2.", "example": null }, "discount_type": { "type": "integer", "nullable": true, "description": "Tipo de desconto:\n\nO tipo de desconto será o mesmo para todos os três descontos, caso existam. :\n* `0` Inexistente (Padrão)\n* `1` Para valor fixo\n* `2` Para percentual do valor do boleto", "enum": [ 0, 1, 2 ], "default": 0 }, "days_for_discount": { "type": "integer", "nullable": true, "description": "Dias para desconto. Obrigatório se discount_type é diferente de 0(zero)", "example": null }, "discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao desconto. Obrigatório se discount_type é igual a 2", "example": null }, "discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do desconto (R$). Obrigatório se discount_type é igual a 1.", "example": null }, "days_for_second_discount": { "type": "integer", "nullable": true, "description": "Dias para segundo desconto.", "example": null }, "second_discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao segundo desconto.", "example": null }, "second_discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do segundo desconto (R$).", "example": null }, "days_for_third_discount": { "type": "integer", "nullable": true, "description": "Dias para terceiro desconto.", "example": null }, "third_discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao terceiro desconto.", "example": null }, "third_discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do terceiro desconto (R$).", "example": null }, "bank_billet_layout_id": { "type": "integer", "nullable": true, "description": "ID do Modelo de Boleto", "example": null }, "notes": { "type": "string", "nullable": true, "example": null, "description": "Observações" }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas ao boleto", "example": null, "items": { "type": "string" } }, "bank_billet_ids": { "type": "array", "nullable": true, "readOnly": true, "description": "IDs de boletos vinculados ao carnê", "example": null, "items": { "type": "integer" } }, "prevent_registration": { "type": "boolean", "nullable": true, "example": null, "description": "Impedir envio de registro ao banco:\nCaso `true`, impede que o boleto seja registrado. Para ser usado nos casos em que o boleto já foi registrado fora da KOBANA mas deseja-se incluí-lo no sistema." }, "divergent_payment_type": { "type": "integer", "nullable": true, "example": null, "description": "Tipo de pagamento divergente:\n\nVálido apenas para Itaú e Caixa.\n* `1` Aceita qualquer valor divergente\n* `2` Aceita pagamentos dentro de uma faixa de valores ou percentuais\n* `3` Não aceita pagamento de valores divergentes\n* `4` Aceita pagamentos de valores superiores a um valor ou percentual mínimo", "enum": [ null, 1, 2, 3, 4 ] }, "divergent_payment_value_type": { "type": "integer", "nullable": true, "example": null, "description": "Tipo de valor a considerar para os limites de pagamentos:\n\nVálido apenas para Itaú e Caixa.\n* `1` Informa pagamentos divergentes por valores\n* `2` Informa pagamentos divergentes por percentuais", "enum": [ null, 1, 2 ] }, "divergent_payment_maximum_value": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Valor máximo para a faixa de pagamentos divergentes. " }, "divergent_payment_minimum_value": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Valor mínimo para a faixa de pagamentos divergentes. " }, "divergent_payment_maximum_percentage": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Percentual máximo para a faixa de pagamentos divergentes. " }, "divergent_payment_minimum_percentage": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Percentual mínimo para a faixa de pagamentos divergentes." }, "divergent_payment_limit": { "type": "integer", "nullable": true, "example": null, "description": "Quantidade de pagamentos permitida. Obrigatório se informados dados para pagamento divergente. Usado somente pela Caixa." }, "custom_attachment_name": { "type": "string", "nullable": true, "example": null, "description": "Nome para ser usado nos arquivos de boleto enviados para o cliente em notificações. Aceita uso de variáveis. Caso seja deixado vazio, o padrão é a palavra “boleto” acompanhada do ID." }, "guarantor_name": { "type": "string", "nullable": true, "maxLength": 100, "description": "Nome do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_cnpj_cpf": { "type": "string", "nullable": true, "maxLength": 20, "description": "CNPJ/CPF do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_address_number": { "type": "string", "nullable": true, "maxLength": 10, "description": "Número do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_neighborhood": { "type": "string", "nullable": true, "maxLength": 80, "description": "Bairro do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_phone_number": { "type": "string", "nullable": true, "maxLength": 11, "description": "Telefone (com DDD) do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_city_name": { "type": "string", "nullable": true, "maxLength": 60, "description": "Cidade(Nome deve estar correto e completo) do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_state": { "type": "string", "nullable": true, "maxLength": 2, "description": "Estado do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_zipcode": { "type": "string", "nullable": true, "maxLength": 8, "description": "CEP (formato 99999999) do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_address": { "type": "string", "nullable": true, "maxLength": 255, "description": "Endereço do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_address_complement": { "type": "string", "nullable": true, "maxLength": 60, "description": "Complemento do Beneficiário final (Sacador/Avalista)", "example": null }, "days_for_revoke": { "type": "integer", "nullable": true, "description": "Dias corridos para Baixa/Devolução:\n\n Nulo/Branco: Obedece ao padrão do banco.\n 0: Baixa/Devolução no mesmo dia do vencimento.\n 1 ou mais: Baixa/Devolução após o vencimento(Vencimento + X dias corridos).\n ", "example": null }, "days_for_negativation": { "type": "integer", "nullable": true, "maximum": 99, "example": null, "description": "Dias corridos para Negativação:\n\nDisponível apenas para os seguintes bancos e formatos.\n\n* Banco |\tCNAB 240|\tCNAB 400 |Webservice\n* Bradesco |\tSim |\tSim\t| Não\n* Itaú | Não | Sim | Não\n " }, "days_for_sue": { "type": "integer", "nullable": true, "description": "Dias corridos para Protesto", "example": null }, "payment_count": { "type": "integer", "nullable": true, "description": "Quantidade de pagamentos parciais aceitos para este boleto." }, "import_id": { "type": "integer", "nullable": true, "readOnly": true, "description": "ID da Importação" }, "ignore_whatsapp": { "type": "boolean", "default": false, "nullable": true, "description": "Nunca enviar esta asinatura por WhatsApp", "example": null } } }, "v2_discharge_object": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do CNAB" }, "uid": { "type": "string", "readOnly": true, "description": "UID do CNAB" }, "filename": { "type": "string", "maxLength": 255, "nullable": true, "description": "Nome do arquivo" }, "status": { "type": "string", "readOnly": true, "description": "Situação do arquivo:\n * `unprocessed` Pendente\n * `processed` Processado", "enum": [ "unprocessed", "processed" ] }, "processed_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data de Processamento." }, "created_via_api": { "type": "boolean", "nullable": true, "description": "Enviado pela API", "example": null }, "bank_billet_account_id": { "type": "integer", "nullable": true, "description": "ID da [Carteira de Cobrança](/reference/post_v1-bank-billet-accounts).", "example": null }, "created_via_integration": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data de recebimento automático do banco." }, "external_id": { "type": "string", "maxLength": 255, "nullable": true, "description": "ID externo do CNAB" }, "custom_data": { "type": "object", "nullable": true, "description": "Dados customizados" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Tags para categorização" }, "tag_list": { "type": "string", "readOnly": true, "nullable": true, "description": "Lista de tags separadas por vírgula" }, "bank_billet_discharges": { "type": "array", "nullable": true, "example": null, "description": "Retornos bancários.", "items": { "$ref": "#/components/schemas/v2_bank_billet_discharge_object" } } } }, "v2_installment": { "type": "object", "required": [ "amount", "customer_person_name", "customer_cnpj_cpf", "customer_zipcode", "customer_address", "customer_neighborhood", "customer_city_name", "customer_state", "bank_billet_account_id", "start_at", "total", "document_type" ], "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do carnê" }, "uid": { "type": "string", "readOnly": true, "description": "UID do carnê" }, "bank_billet_account_id": { "type": "integer", "description": "ID da Carteira de Cobrança. Se não informado, usará a carteira padrão.", "example": null }, "bank_billet_layout_id": { "type": "integer", "nullable": true, "description": "ID do Modelo de Boleto", "example": null }, "amount": { "type": "number", "format": "float", "description": "Quantia", "example": 10.99 }, "customer_id": { "type": "integer", "nullable": true, "description": "ID do Cliente. Quando esse ID é passado, os campos `customer_person_name`, `customer_cnpj_cpf`, `customer_zipcode`, `customer_address`, `customer_city_name`, `customer_state` e `customer_neighborhood` não são obrigatórios.", "example": null }, "customer_person_name": { "type": "string", "maxLength": 120, "description": "Nome do cliente", "example": "João Silva" }, "customer_cnpj_cpf": { "type": "string", "maxLength": 20, "description": "CPF/CNPJ do cliente", "example": "16.974.923/0001-84" }, "customer_state": { "type": "string", "maxLength": 2, "description": "Estado", "example": "SP" }, "customer_city_name": { "type": "string", "maxLength": 60, "description": "Cidade(Nome deve estar correto e completo)", "example": "São Paulo" }, "customer_zipcode": { "type": "string", "maxLength": 8, "description": "CEP (formato 99999999)", "example": "01310100" }, "customer_address": { "type": "string", "maxLength": 255, "description": "Endereço", "example": "Rua F, alamenda G" }, "customer_address_complement": { "type": "string", "maxLength": 120, "description": "Complemento", "example": null }, "customer_address_number": { "type": "string", "maxLength": 10, "description": "Número", "example": null }, "customer_email": { "type": "string", "format": "email", "maxLength": 80, "description": "E-mail do Pagador", "example": null }, "customer_email_cc": { "type": "string", "format": "email", "maxLength": 80, "description": "E-mail alternativo do Pagador", "example": null }, "customer_neighborhood": { "type": "string", "maxLength": 80, "description": "Bairro", "example": "Centro" }, "customer_phone_number": { "type": "string", "maxLength": 15, "description": "Telefone (com DDD, DDI é opcional)", "example": null }, "customer_ignore_email": { "type": "boolean", "nullable": true, "description": "Nunca enviar e-mail para este cliente", "example": null }, "customer_ignore_sms": { "type": "boolean", "nullable": true, "description": "Nunca enviar SMS para este cliente", "example": null }, "customer_mobile_local_code": { "type": "string", "nullable": true, "maxLength": 2, "description": "DDD do Celular", "example": null }, "customer_mobile_number": { "type": "string", "nullable": true, "maxLength": 9, "description": "Celular", "example": null }, "customer_nickname": { "type": "string", "nullable": true, "maxLength": 255, "description": "Apelido ou Nome Fantasia do Pagador", "example": null }, "customer_notes": { "type": "string", "nullable": true, "description": "Observações do Pagador", "example": null }, "customer_contact_person": { "type": "string", "nullable": true, "maxLength": 120, "description": "Contato", "example": null }, "customer_update": { "type": "string", "nullable": true, "maxLength": 120, "description": "Contato", "example": null }, "start_at": { "type": "string", "format": "date", "description": "Data da primeira cobrança", "example": null }, "end_at": { "type": "string", "format": "date", "nullable": true, "description": "Data da última cobrança", "example": null }, "cycle": { "type": "string", "readOnly": true, "nullable": true, "maxLength": 20, "description": "Ciclo do carnê. Default: monthly\n* `biweekly` Quinzenal\n* `bimonthly` Bimestral\n* `monthly` Mensal\n* `quarterly` Trimestral\n* `semiannual` Semestral\n* `annual` Anual", "enum": [ "biweekly", "bimonthly", "monthly", "quarterly", "semiannual", "annual" ] }, "total": { "type": "integer", "maximum": 300, "description": "Quantidade de parcelas", "example": null }, "custom_bank_billets": { "type": "array", "nullable": true, "description": "Carnê customizado. Quando enviado, os valores de amount, start_at e end_at serão ignorados.", "example": null, "items": { "$ref": "#/components/schemas/v2_custom_bank_billets_object" } }, "bank_billet_ids": { "type": "array", "nullable": true, "readOnly": true, "description": "IDs de boletos vinculados ao carnê", "example": null, "items": { "type": "integer" } }, "interest_type": { "type": "integer", "nullable": true, "description": "Tipo de juros/mora:\n* `0` Inexistente (Padrão)\n* `1` Para porcentagem diária\n* `2` Para valor diário", "enum": [ 0, 1, 2 ], "default": 0 }, "days_for_interest": { "type": "integer", "nullable": true, "description": "Quantidade de dias após o vencimento que a mora começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento).", "example": null }, "interest_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Porcentagem diária de juros. De 0.0 a 100.0 (Ex 1.5% = 1.5) Obrigatório se interest_type é igual a 1.", "example": null }, "interest_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor diário de juros (R$). Obrigatório se interest_type é igual a 2.", "example": null }, "interest_days_type": { "type": "integer", "nullable": true, "description": "Tipo de Dias para juros:\n* `0` Corridos\n* `1` Úteis", "enum": [ 0, 1 ], "default": 0 }, "fine_type": { "type": "integer", "nullable": true, "description": "Tipo de multa:\n* `0` Inexistente (Padrão)\n* `1` Para percentual do valor do boleto\n* `2` Para valor fixo", "enum": [ 0, 1, 2 ], "default": 0 }, "days_for_fine": { "type": "integer", "nullable": true, "description": "Quantidade de dias após o vencimento que a multa começará a incidir. O valor default é 1 dia (o dia posterior ao vencimento).", "example": null }, "fine_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Porcentagem de Multa por Atraso Ex: 2% x R$ 250,00 = R$ 5,00. Obrigatória se fine_type é igual a 1", "example": null }, "fine_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor da multa (R$). Obrigatório se fine_type é igual a 2.", "example": null }, "discount_type": { "type": "integer", "nullable": true, "description": "Tipo de desconto:\nO tipo de desconto será o mesmo para todos os três descontos, caso existam. :\n* `0` Inexistente (Padrão)\n* `1` Para valor fixo\n* `2` Para percentual do valor do boleto", "enum": [ 0, 1, 2 ], "default": 0 }, "days_for_discount": { "type": "integer", "nullable": true, "description": "Dias para desconto. Obrigatório se discount_type é diferente de 0(zero), Não pode resultar numa data passada referente a criação.", "example": null }, "discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao desconto. Obrigatório se discount_type é igual a 2", "example": null }, "discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do desconto (R$). Obrigatório se discount_type é igual a 1.", "example": null }, "days_for_second_discount": { "type": "integer", "nullable": true, "description": "Dias para segundo desconto.", "example": null }, "second_discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao segundo desconto.", "example": null }, "second_discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do segundo desconto (R$).", "example": null }, "days_for_third_discount": { "type": "integer", "nullable": true, "description": "Dias para terceiro desconto.", "example": null }, "third_discount_percentage": { "type": "number", "format": "float", "nullable": true, "description": "Percentual do valor do boleto equivalente ao terceiro desconto.", "example": null }, "third_discount_value": { "type": "number", "format": "float", "nullable": true, "description": "Valor do terceiro desconto (R$).", "example": null }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas ao boleto", "example": null, "items": { "type": "string" } }, "guarantor_name": { "type": "string", "nullable": true, "maxLength": 100, "description": "Nome do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_cnpj_cpf": { "type": "string", "nullable": true, "maxLength": 20, "description": "CNPJ/CPF do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_address_number": { "type": "string", "nullable": true, "maxLength": 10, "description": "Número do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_neighborhood": { "type": "string", "nullable": true, "maxLength": 80, "description": "Bairro do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_phone_number": { "type": "string", "nullable": true, "maxLength": 11, "description": "Telefone (com DDD) do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_city_name": { "type": "string", "nullable": true, "maxLength": 60, "description": "Cidade(Nome deve estar correto e completo) do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_state": { "type": "string", "nullable": true, "maxLength": 2, "description": "Estado do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_zipcode": { "type": "string", "nullable": true, "maxLength": 8, "description": "CEP (formato 99999999) do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_address": { "type": "string", "nullable": true, "maxLength": 255, "description": "Endereço do Beneficiário final (Sacador/Avalista)", "example": null }, "guarantor_address_complement": { "type": "string", "nullable": true, "maxLength": 60, "description": "Complemento do Beneficiário final (Sacador/Avalista)", "example": null }, "description": { "type": "string", "nullable": true, "description": "Descrição do produto ou serviço", "example": null }, "instructions": { "type": "string", "nullable": true, "description": "Instruções para o Caixa", "example": null }, "document_date": { "type": "string", "format": "date", "nullable": true, "description": "Data do Documento", "example": null }, "document_type": { "type": "string", "maxLength": 2, "description": "Tipo de Documento:\n\n* `Código` | `Sigla` | Descrição\n* `01` | `CH` | Cheque\n* `02` | `DM` | Duplicata Mercantil (Padrão)\n* `03` | `DMI` | Duplicata Mercantil p/ Indicação\n* `04` | `DS` | Duplicata de Serviço\n* `05` | `DSI` | Duplicata de Serviço p/ Indicação\n* `06` | `DR` | Duplicata Rural\n* `07` | `LC` | Letra de Câmbio\n* `08` | `NCC` | Nota de Crédito Comercial\n* `09` | `NCE` | Nota de Crédito a Exportação\n* `10` | `NCI` | Nota de Crédito Industrial\n* `11` | `NCR` | Nota de Crédito Rural\n* `12` | `NP` | Nota Promissória\n* `13` | `NPR` | Nota Promissória Rural\n* `14` | `TM` | Triplicata Mercantil\n* `15` | `TS` | Triplicata de Serviço\n* `16` | `NS` | Nota de Seguro\n* `17` | `RC` | Recibo\n* `18` | `FAT` | Fatura\n* `19` | `ND` | Nota de Débito\n* `20` | `AP` | Apólice de Seguro\n* `21` | `ME` | Mensalidade Escolar\n* `22` | `PC` | Parcela de Consórcio\n* `23` | `NF` | Nota Fiscal\n* `24` | `DD` | Documento de Dívida\n* `25` | `CPR` | Cédula de Produto Rural\n* `26` | `CTR` | Contrato\n* `27` | `CSG` | Cosseguros\n* `28` | `EC` | Encargos Condominiais\n* `29` | `CPS` | Conta de Prestação de Serviços\n* `30` | `WR` | Warrant\n* `31` | `DP` | Duplicata Prestação\n* `32` | `CSR` | Cobrança Seriada\n* `33` | `CAR` | Carnê\n* `34` | `ARE` | Apólice Ramos Elementares\n* `35` | `CC` | Cartão de Crédito\n* `36` | `BDP` | Boleto de Proposta\n* `37` | `NPD` | Nota Promissória Direta\n* `38` | `DAE` | Dívida Ativa de Estado\n* `39` | `DAM` | Divida Ativa de Município\n* `40` | `DAU` | Dívida Ativa União\n* `41` | `CCB` | Célula de Crédito Bancário\n* `42` | `FI` | Financiamento\n* `43` | `RD` | Rateio de Despesas\n* `44` | `DRI` | Duplicata Rural p/ Indicação\n* `45` | `ECI` | Encargos Condominiais p/ Indicação\n* `99` | `Outros` | Outros\n ", "default": "02", "enum": [ "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "99" ] }, "document_number": { "type": "string", "nullable": true, "example": null, "description": "Número do Documento, Tamanho depende do banco e formato do arquivo Remessa:\n * Banco |\tFormato| Tamanho |\n * Abc |`Cnab240`|\t15\t|\n * Ailos |`Cnab240`|\t15 |\n * Arbi |`Cnab240`|\t15\t|\n * Banese |`Cnab240`|\t15\t|\n * Banestes |`Cnab400`|\t10\t|\n * Banrisul |`Cnab240`|\t15\t|\n * Banrisul |`Cnab400`|\t10\t|\n * Bb |`Cnab240`|\t15\t|\n * Bb |`Cnab400`|\t10\t|\n * Bib |`Cnab240`|\t15\t|\n * Bnb |`Cnab400`|\t10\t|\n * Bnpparibas |`Cnab400`|\t10\t|\n * Bradesco |`Cnab240`|\t15\t|\n * Bradesco |`Cnab400`|\t10\t|\n * Brb |`Cnab400`|\t10\t|\n * Caixa |`Cnab240`|\t11\t|\n * Caixa |`Cnab400`|\t10\t|\n * Caruana |`Cnab400`|\t10\t|\n * Citibank |`Cnab400`|\t10\t|\n * Credisis |`Cnab240`|\t15\t|\n * Cresol |`Cnab240`|\t10\t|\n * Cresol |`Cnab400`|\t10\t|\n * Cresol Bradesco |`Cnab240`|\t15\t|\n * Cresol Bradesco |`Cnab400`|\t10\t|\n * Daycoval |`Cnab400`|\t10\t|\n * Itau |`Cnab240`|\t10\t|\n * Itau |`Cnab400`|\t10\t|\n * Mercantil |`Cnab240`|\t10\t|\n * Moneyplus |`Cnab240`|\t10\t|\n * Rendimento |`Cnab400`|\t10\t|\n * Safra |`Cnab400`|\t102\t|\n * Santander |`Cnab240`|\t15\t|\n * Santander |`Cnab400`|\t10\t|\n * Semear |`Cnab400`|\t10\t|\n * Sicoob |`Cnab240`|\t15\t|\n * Sicoob |`Cnab400`|\t10\t|\n * Sicredi |`Cnab240`|\t15\t|\n * Sicredi |`Cnab400`|\t10\t|\n * Sofisa |`Cnab240`|\t15\t|\n * Unicred |`Cnab240`|\t15\t|\n * Uniprime |`Cnab400`|\t10\t|\n * Uniprime99 |`Cnab400`|\t10\t|\n * Santander |`Cnab400`|\t10 " }, "days_for_revoke": { "type": "integer", "nullable": true, "description": "Dias corridos para Baixa/Devolução", "example": null }, "days_for_negativation": { "type": "integer", "maxLength": 99, "nullable": true, "example": null, "description": "Dias corridos para Negativação:\n\nDisponível apenas para os seguintes bancos e formatos.\n\n* Banco |\tCNAB 240|\tCNAB 400 |Webservice\n* Bradesco |\tSim |\tSim\t| Não\n* Itaú | Não | Sim | Não\n " }, "days_for_sue": { "type": "integer", "nullable": true, "description": "Dias corridos para Protesto", "example": null }, "divergent_payment_type": { "type": "integer", "nullable": true, "example": null, "description": "Tipo de pagamento divergente:\nVálido apenas para Itaú e Caixa.\n* `1` Aceita qualquer valor divergente\n* `2` Aceita pagamentos dentro de uma faixa de valores ou percentuais\n* `3` Não aceita pagamento de valores divergentes\n* `4` Aceita pagamentos de valores superiores a um valor ou percentual mínimo", "enum": [ null, 1, 2, 3, 4 ] }, "divergent_payment_value_type": { "type": "integer", "nullable": true, "example": null, "description": "Tipo de valor a considerar para os limites de pagamentos:\nVálido apenas para Itaú e Caixa.\n* `1` Informa pagamentos divergentes por valores\n* `2` Informa pagamentos divergentes por percentuais", "enum": [ null, 1, 2 ] }, "divergent_payment_maximum_value": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Valor máximo para a faixa de pagamentos divergentes. " }, "divergent_payment_minimum_value": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Valor mínimo para a faixa de pagamentos divergentes. " }, "divergent_payment_maximum_percentage": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Percentual máximo para a faixa de pagamentos divergentes. " }, "divergent_payment_minimum_percentage": { "type": "number", "format": "float", "example": null, "nullable": true, "description": "Percentual mínimo para a faixa de pagamentos divergentes." }, "divergent_payment_limit": { "type": "integer", "nullable": true, "example": null, "description": "Quantidade de pagamentos permitida. Obrigatório se informados dados para pagamento divergente. Usado somente pela Caixa." }, "prevent_registration": { "type": "boolean", "nullable": true, "example": null, "description": "Impedir envio de registro ao banco:\n\nCaso `true`, impede que o boleto seja registrado. Para ser usado nos casos em que o boleto já foi registrado fora da KOBANA mas deseja-se incluí-lo no sistema." }, "notes": { "type": "string", "nullable": true, "example": null, "description": "Observações" }, "custom_attachment_name": { "type": "string", "nullable": true, "example": null, "description": "Nome para ser usado nos arquivos de boleto enviados para o cliente em notificações. Aceita uso de variáveis. Caso seja deixado vazio, o padrão é a palavra “boleto” acompanhada do ID." }, "created_via_api": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se o boleto foi criado por API" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do boleto" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do boleto" }, "payment_count": { "type": "integer", "nullable": true, "description": "Quantidade de pagamentos parciais aceitos para este boleto." }, "url": { "type": "string", "nullable": true, "readOnly": true, "description": "URL para visualização do carnê" }, "status": { "type": "string", "readOnly": true, "description": "Situação do carnê:\n* `created` Gerando\n* `processed` Parcelas criadas\n* `generated` Aberto", "enum": [ "created", "processed", "generated" ] }, "import_id": { "type": "integer", "nullable": true, "readOnly": true, "description": "ID da Importação" }, "ignore_whatsapp": { "type": "boolean", "default": false, "nullable": true, "description": "Nunca enviar este carnê por WhatsApp", "example": null } } }, "v2_remittance": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do CNAB" }, "uid": { "type": "string", "readOnly": true, "description": "UID do CNAB" }, "content": { "type": "string", "nullable": true, "description": "Conteúdo da remessa" }, "filename": { "type": "string", "maxLength": 255, "nullable": true, "description": "Nome do arquivo" }, "status": { "type": "string", "readOnly": true, "description": "Situação do arquivo:\n* `unprocessed` Pendente\n* `processed` Processado\n* `send` Enviada para o banco (Somente quando contratado envio automático)", "enum": [ "unprocessed", "processed", "send" ] }, "processed_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data de Processamento." }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação." }, "url": { "type": "string", "nullable": true, "description": "URL do arquivo de remessa." }, "created_via_api": { "type": "boolean", "nullable": true, "description": "Enviado pela API", "example": null }, "bank_billet_account_id": { "type": "integer", "nullable": true, "description": "ID da [Carteira de Cobrança](/reference/post_v1-bank-billet-accounts).", "example": null }, "remittance_number": { "type": "integer", "nullable": true, "description": "Número da remessa", "example": null }, "sent_via_integration": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de envio automático para o banco." }, "bank_billet_ids": { "type": "array", "nullable": true, "example": null, "readOnly": true, "description": "IDs de boletos.", "items": { "type": "integer" } }, "bank_billet_remittances": { "type": "array", "nullable": true, "example": null, "description": "Registros de Remessa.", "items": { "$ref": "#/components/schemas/v2_bank_billet_remittance_object" } }, "generated_by": { "type": "string", "readOnly": true, "description": "Remessa gerada por:\n`kobana`: Kobana.\n`customer`: Cliente", "enum": [ "kobana", "customer" ] }, "external_id": { "type": "string", "maxLength": 255, "nullable": true, "description": "ID externo do CNAB" }, "custom_data": { "type": "object", "nullable": true, "description": "Dados customizados" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Tags para categorização" }, "tag_list": { "type": "string", "readOnly": true, "nullable": true, "description": "Lista de tags separadas por vírgula" } } }, "v2_bank_billet_remittance_object": { "type": "object", "required": [ "our_code", "remittance_id", "bank_billet_id", "bank_billet_account_id" ], "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Registro de Remessa" }, "uid": { "type": "string", "readOnly": true, "description": "UID do Registro de Remessa" }, "our_code": { "type": "string", "maxLength": 6, "nullable": true, "description": "Código de operação de registro. Consulte os possíveis valores [para cada banco](/reference/bancos-suportados)." }, "occurrence": { "type": "string", "maxLength": 3, "nullable": true, "description": "Ocorrência." }, "remittance_id": { "type": "integer", "nullable": true, "description": "ID da Remessa.", "example": null }, "bank_billet_id": { "type": "integer", "nullable": true, "description": "ID do Boleto.", "example": null }, "bank_billet_account_id": { "type": "integer", "nullable": true, "description": "ID da Carteira.", "example": null }, "processed_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data de Processamento." }, "occurrence_detail": { "type": "string", "nullable": true, "description": "Descrição do evento na Remessa." } } }, "v2_bank_billet_discharge_object": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Registro de Retorno" }, "our_occurrence": { "type": "string", "maxLength": 4, "nullable": true, "description": "Código único de operação dentro da Kobana.\n\n| Código | Descrição |\n|---|---|\n| 2001 | Entrada Confirmada |\n| 2002 | Entrada Rejeitada |\n| 2003 | Liquidação |\n| 2004 | Baixa de Título Confirmada |\n| 2005 | Baixa de Título Rejeitada |\n| 2006 | Alteração do Vencimento Confirmada |\n| 2007 | Alteração do Vencimento Rejeitada |\n| 2008 | Baixa Solicitada |\n| 2009 | Títulos em Carteira (em ser) |\n| 2010 | Confirmação de Recebimento de Instrução de Abatimento |\n| 2011 | Confirmação de Recebimento de Instrução de Cancelamento Abatimento |\n| 2012 | Confirmação de Recebimento de Instrução de Alteração de Vencimento |\n| 2013 | Franco de Pagamento |\n| 2014 | Liquidação Após Baixa ou Liquidação Título Não Registrado |\n| 2015 | Confirmação Recebimento Instrução de Protesto |\n| 2016 | Confirmação Recebimento Instrução de Sustação/Cancelamento de Protesto |\n| 2017 | Remessa a Cartório (Aponte em Cartório) |\n| 2018 | Retirada de Cartório e Manutenção em Carteira |\n| 2019 | Protestado e Baixado (Baixa por ter sido Protestado) |\n| 2020 | Instrução Rejeitada |\n| 2021 | Confirmação do Pedido de Alteração de Outros Dados |\n| 2022 | Débito de Tarifas/Custas |\n| 2023 | Ocorrências do Sacado |\n| 2024 | Alteração de Dados Rejeitada |\n| 2025 | Título pago com cheque devolvido |\n| 2026 | Título pago com cheque pendente de compensação |\n| 2027 | Liquidado sem registro |\n| 2028 | Liquidação Normal |\n| 2029 | Liquidação por Conta/Parcial |\n| 2030 | Liquidação por Saldo |\n| 2031 | Transferência de Carteira/Entrada |\n| 2032 | Transferência de Carteira/Baixa |\n| 2033 | Abatimento Concedido |\n| 2034 | Abatimento Cancelado |\n| 2035 | Liquidação em Cartório |\n| 2036 | Confirmação de alteração de juros de mora |\n| 2037 | Débito em Conta |\n| 2038 | Alteração do Nome do Sacado |\n| 2039 | Alteração do Endereço do Sacado |\n| 2040 | Indicação de encaminhamento a cartório |\n| 2041 | Sustar Protesto |\n| 2042 | Dispensar Juros de mora |\n| 2043 | Alteração do número do título dado pelo Cedente (Seu número) – 10 e 15 posições |\n| 2044 | Manutenção de título vencido |\n| 2045 | Conceder desconto |\n| 2046 | Não conceder desconto |\n| 2047 | Retificar desconto |\n| 2048 | Alterar data para desconto |\n| 2049 | Cobrar Multa |\n| 2050 | Dispensar Multa |\n| 2051 | Dispensar Indexador |\n| 2052 | Dispensar prazo limite para recebimento |\n| 2053 | Alterar prazo limite para recebimento |\n| 2054 | Alteração do número do controle do participante (25 posições) |\n| 2055 | Alteração do número do documento do sacado (CNPJ/CPF) |\n| 2056 | Alteração de tipo de cobrança (específico para títulos das carteiras 11 e 17) |\n| 2057 | Confirmação de Instrução de Parâmetro de Pagamento Parcial |\n| 2058 | Despesas de Protesto |\n| 2059 | Despesas de Sustação de Protesto |\n| 2060 | Débito de Custas Antecipadas |\n| 2061 | Confirmação do recebimento da instrução de desconto |\n| 2062 | Confirmação do recebimento do cancelamento do desconto |\n| 2063 | Solicitação de 2a via de instrumento de protesto |\n| 2064 | 2a via de instrumento de protesto emitida pelo cartório |\n| 2065 | Confirmação da alteração dos dados do sacado |\n| 2066 | Confirmação da alteração dos dados do sacador avalista |\n| 2067 | Título DDA reconhecido pelo sacado |\n| 2068 | Título DDA não reconhecido pelo sacado |\n| 2069 | Título DDA recusado pela CIP |\n| 2070 | Instrução de protesto processada |\n| 2071 | Remessa rejeitada |\n| 2072 | Baixa de título liquidado por edital |\n| 2073 | Devolução automática |\n| 2074 | Baixado conforme instruções |\n| 2075 | Arquivo levantamento |\n| 2076 | Pagamento em cartório |\n| 2077 | Alteração de dados |\n| 2078 | Alteração de instruções |\n| 2079 | Aguardando autorização para protesto por edital |\n| 2080 | Protesto sustado por alteração de vencimento e prazo de cartório |\n| 2081 | Confirmação da entrada em cartório |\n| 2082 | cobrança a creditar (liquidação em trânsito) |\n| 2083 | Título em trânsito pago em cartório |\n| 2084 | Reembolso e transferência Desconto e Vendor ou carteira em garantia |\n| 2085 | Reembolso e devolução Desconto e Vendor |\n| 2086 | Reembolso não efetuado por falta de saldo |\n| 2087 | Despesa de aponte |\n| 2088 | Alteração de título |\n| 2089 | Relação de títulos |\n| 2090 | Manutenção mensal |\n| 2091 | Sustação de cartório e envio de título a cartório |\n| 2092 | Fornecimento de formulário pré-impresso |\n| 2093 | Confirmação de entrada – Pagador DDA |\n| 2094 | Acerto dos dados do rateio de crédito |\n| 2095 | Cancelamento dos dados do rateio |\n| 2096 | Pagamento por Conta |\n| 2097 | Baixa Simples |\n| 2098 | Devolvido - Protestado |\n| 2099 | Baixa automática |\n| 2100 | Alteração Depositária |\n| 2101 | Confirmação de Protesto |\n| 2102 | Título Pago em Cheque – Vinculado |\n| 2103 | Acerto de Depositária |\n| 2104 | Acerto do Controle do Participante |\n| 2105 | Título Com Pagamento Cancelado |\n| 2106 | Entrada rejeitada por CEP Irregular |\n| 2107 | Confirmação Receb.Inst.de Protesto Falimentar |\n| 2108 | Ocorrências do Pagador |\n| 2109 | Retirado de Cartório e Manutenção Carteira |\n| 2110 | Desagendamento do débito automático |\n| 2111 | Estorno de pagamento |\n| 2112 | Sustado judicial |\n| 2113 | Solicitação de Impressão de Títulos Confirmada |\n| 2114 | Confirmação de Inclusão Banco de Pagador |\n| 2115 | Confirmação de Alteração Banco de Pagador |\n| 2116 | Confirmação de Exclusão Banco de Pagador |\n| 2117 | Emissão de Boletos de Banco de Pagador |\n| 2118 | Manutenção de Pagador Rejeitada |\n| 2119 | Entrada de Título via Banco de Pagador Rejeitada |\n| 2120 | Manutenção de Banco de Pagador Rejeitada |\n| 2121 | Estorno de Baixa / Liquidação |\n| 2122 | Liquidação On-line |\n| 2123 | Estorno de Liquidação On-line |\n| 2124 | Confirmação de alteração do valor nominal do título |\n| 2125 | Confirmação de alteração do valor/percentual mínimo/máximo |\n| 2126 | Baixa Manual Confirmada |\n| 2127 | Uso da Empresa Alterado |\n| 2128 | Prazo de Protesto Alterado |\n| 2129 | Prazo de Devolução Alterado |\n| 2130 | Alteração com reemissão de Bloqueto Confirmada |\n| 2131 | Alteração da opção de Protesto para Devolução Confirmada |\n| 2132 | Alteração da opção de Devolução para Protesto Confirmada |\n| 2133 | Baixa por Devolução |\n| 2134 | Título enviado para Cartório |\n| 2135 | Estorno de Protesto |\n| 2136 | Estorno de Sustação de Protesto |\n| 2137 | Tarifa sobre Título Vencido |\n| 2138 | Outras Tarifas de Alteração |\n| 2139 | Tarifas Diversas |\n| 2140 | Rejeição do Título |\n| 2141 | Confirmação de Envio de SMS |\n| 2142 | Envio de SMS rejeitado |\n| 2143 | Cancelamento de SMS |\n| 2144 | Liquidação de boleto cooperativa emite e expede |\n| 2145 | Liquidação de boleto após baixa ou não registrado cooperativa emite e expede |\n| 2146 | Título em aberto não enviado ao pagador |\n| 2147 | Inconsistência Negativação Serasa |\n| 2148 | Inclusão Negativação via Serasa |\n| 2149 | Exclusão Negativação Serasa |\n| 2150 | Devolução por Decurso de Prazo |\n| 2151 | Confirmação de Pedido de Exclusão da Serasa |\n| 2152 | Título enviado para negativação |\n| 2153 | Alegação do Sacado |\n| 2154 | Título retirado de cartório |\n| 2155 | Custa de distribuição |\n| 2156 | Custa de sustação |\n| 2157 | Custa de protesto |\n| 2158 | Movimentação CIP |\n| 2159 | Alteração De Dados – Nova Entrada ou Alteração/Exclusão de Dados Acatada |\n| 2160 | Alteração de Dados – Baixa |\n| 2161 | Baixa Por Ter Sido Liquidado |\n| 2162 | Cobrança Contratual – Instruções/Alterações Rejeitadas/Pendentes |\n| 2163 | Confirmação Recebimento de Instrução de Não Protestar |\n| 2164 | Protesto Enviado a Cartório/Tarifa |\n| 2165 | Tarifa de Aviso de Cobrança |\n| 2166 | Tarifa de Extrato Posição |\n| 2167 | Tarifa de Relação das Liquidações |\n| 2168 | Tarifa de Manutenção de Títulos Vencidos |\n| 2169 | Débito Mensal de Tarifas (para entradas e baixas) |\n| 2170 | Custas de Edital |\n| 2171 | Tarifa de Emissão de Boleto/Tarifa de Envio de Duplicata |\n| 2172 | Tarifa de Instrução |\n| 2173 | Tarifa de Ocorrências |\n| 2174 | Tarifa Mensal de Emissão de Boleto/Tarifa Mensal de Envio de Duplicata |\n| 2175 | Débito Mensal de Tarifas – Extrato de Posição (b4ep/b4ox) |\n| 2176 | Débito Mensal de Tarifas – Outras Instruções |\n| 2177 | Débito Mensal de Tarifas – Manutenção de Títulos Vencidos |\n| 2178 | Débito Mensal de Tarifas – Outras Ocorrências |\n| 2179 | Débito Mensal de Tarifas – Protesto |\n| 2180 | Débito Mensal de Tarifas – Sustação de Protesto |\n| 2181 | Baixa Com Transferência Para Desconto |\n| 2182 | Custas de Sustação Judicial |\n| 2183 | Tarifa Mensal Referente A Entradas Bancos Correspondentes Na Carteira |\n| 2184 | Tarifa Mensal Baixas Na Carteira |\n| 2185 | Tarifa Mensal Baixas Em Bancos Correspondentes Na Carteira |\n| 2186 | Tarifa Mensal de Liquidações Na Carteira |\n| 2187 | Tarifa Mensal de Liquidações Em Bancos Correspondentes Na Carteira |\n| 2188 | Custas de Irregularidade |\n| 2189 | Instrução Cancelada |\n| 2190 | Comando Recusado |\n| 2191 | Código de IOF inválido |\n| 2192 | Título não existe |\n| 2193 | Prorrogação de Vencimento |\n| 2194 | Título Já Baixado/Protestado |\n| 2195 | Custas de Cartório |\n| 2196 | Confirmação de envio de e-mail/SMS |\n| 2197 | Envio de e-mail/SMS rejeitado |\n| 2198 | Título pago com cheque compensado |\n| 2199 | Instrução para protesto para fins falimentares confirmada |\n| 2200 | Alteração de contrato de cobrança |\n| 2201 | Confirmação da Instrução de Baixa de Título Negativado sem Protesto |\n| 2202 | Confirmação de Pedido de Dispensa de Multa |\n| 2203 | Confirmação do Pedido de Cobrança de Multa |\n| 2204 | Confirmação do Pedido de Alteração de Cobrança de Juros |\n| 2205 | Confirmação do Pedido de Alteração do Valor/Data de Desconto |\n| 2206 | Confirmação do Pedido de Alteração do Beneficiário do Título |\n| 2207 | Confirmação do Pedido de Dispensa de Juros de Mora |\n| 2208 | Confirmação de instrução de transferência de carteira/modalidade de cobrança |\n| 2209 | Confirmação de Desistência de Protesto |\n| 2210 | Encaminhado a Protesto |\n| 2211 | Baixado automaticamente via arquivo |\n| 2212 | Baixa rejeitada |\n| 2213 | Tarifa |\n| 2214 | Rejeição do pagador |\n| 2215 | Alteração rejeitada |\n| 2216 | Aceite do Pagador |\n| 2217 | Baixa por Crédito em Conta Corrente |\n| 2218 | Entrada Rejeitada Carnê |\n| 2219 | Tarifa Emissão Aviso de Movimentação de Títulos |\n| 2220 | Débito Mensal de Tarifas - Aviso de Movimentação de Títulos |\n| 2221 | Entrada Confirmada com Rateio de Crédito |\n| 2222 | Baixa por Crédito em Conta Corrente sem Título Correspondente |\n| 2223 | Confirmação de Entrada na Cobrança |\n| 2224 | Instrução de Negativação Expressa Rejeitada |\n| 2225 | Confirma o Recebimento de Instrução de Entrada Em Negativação Expressa |\n| 2226 | Confirma o Recebimento de Instrução de Exclusão de Entrada Em Negativação Expressa |\n| 2227 | Confirma o Recebimento de Instrução de Cancelamento de Negativação Expressa |\n| 2228 | Negativação Expressa Informacional |\n| 2229 | Confirma de Entrada Em Negativação Expressa / Tarifa |\n| 2230 | Confirma o Cancelamento Em Negativação Expressa / Tarifa |\n| 2231 | Confirma Exclusão de Entrada Em Negativação Expressa Por Liquidação / Tarifa |\n| 2232 | Tarifa Pacote Cobrança Ativa Eletrônica |\n| 2233 | Tarifa E-mail Cobrança Ativa Eletrônica |\n| 2234 | Tarifa Sms Cobrança Ativa Eletrônica |\n| 2235 | Tarifa Mensal Pacote Cobrança Ativa Eletrônica |\n| 2236 | Tarifa Mensal E-mail Cobrança Ativa Eletrônica |\n| 2237 | Tarifa Mensal Sms Cobrança Ativa Eletrônica |\n| 2238 | Tarifa Mensal de Exclusão de Entrada Em Negativação Expressa |\n| 2239 | Tarifa Mensal de Cancelamento de Negativação Expressa |\n| 2240 | Tarifa Mensal de Exclusão de Negativação Expressa Por Liquidação |\n| 2241 | Confirma Recebimento de Instrução de Não Negativar |\n| 2242 | Transferência de Beneficiário |\n| 2243 | Baixa de Título Protestado |\n| 2244 | Despesa de Cartório |\n| 2245 | Acerto de Data de Emissão |\n| 2246 | Acerto de Código de Espécie Documento |\n| 2247 | Instrução Negativação Aceita |\n| 2248 | Instrução Baixa de Negativação Aceita |\n| 2249 | Instrução Não Negativar Aceita |", "enum": [ "2001", "2002", "2003", "2004", "2005", "2006", "2007", "2008", "2009", "2010", "2011", "2012", "2013", "2014", "2015", "2016", "2017", "2018", "2019", "2020", "2021", "2022", "2023", "2024", "2025", "2026", "2027", "2028", "2029", "2030", "2031", "2032", "2033", "2034", "2035", "2036", "2037", "2038", "2039", "2040", "2041", "2042", "2043", "2044", "2045", "2046", "2047", "2048", "2049", "2050", "2051", "2052", "2053", "2054", "2055", "2056", "2057", "2058", "2059", "2060", "2061", "2062", "2063", "2064", "2065", "2066", "2067", "2068", "2069", "2070", "2071", "2072", "2073", "2074", "2075", "2076", "2077", "2078", "2079", "2080", "2081", "2082", "2083", "2084", "2085", "2086", "2087", "2088", "2089", "2090", "2091", "2092", "2093", "2094", "2095", "2096", "2097", "2098", "2099", "2100", "2101", "2102", "2103", "2104", "2105", "2106", "2107", "2108", "2109", "2110", "2111", "2112", "2113", "2114", "2115", "2116", "2117", "2118", "2119", "2120", "2121", "2122", "2123", "2124", "2125", "2126", "2127", "2128", "2129", "2130", "2131", "2132", "2133", "2134", "2135", "2136", "2137", "2138", "2139", "2140", "2141", "2142", "2143", "2144", "2145", "2146", "2147", "2148", "2149", "2150", "2151", "2152", "2153", "2154", "2155", "2156", "2157", "2158", "2159", "2160", "2161", "2162", "2163", "2164", "2165", "2166", "2167", "2168", "2169", "2170", "2171", "2172", "2173", "2174", "2175", "2176", "2177", "2178", "2179", "2180", "2181", "2182", "2183", "2184", "2185", "2186", "2187", "2188", "2189", "2190", "2191", "2192", "2193", "2194", "2195", "2196", "2197", "2198", "2199", "2200", "2201", "2202", "2203", "2204", "2205", "2206", "2207", "2208", "2209", "2210", "2211", "2212", "2213", "2214", "2215", "2216", "2217", "2218", "2219", "2220", "2221", "2222", "2223", "2224", "2225", "2226", "2227", "2228", "2229", "2230", "2231", "2232", "2233", "2234", "2235", "2236", "2237", "2238", "2239", "2240", "2241", "2242", "2243", "2244", "2245", "2246", "2247", "2248", "2249" ] }, "discharge_id": { "type": "integer", "nullable": true, "description": "ID do Retorno.", "example": null }, "bank_billet_id": { "type": "integer", "nullable": true, "description": "ID do Boleto.", "example": null }, "processed_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data de Processamento." }, "date_of_occurrence": { "type": "string", "format": "date", "nullable": true, "readOnly": true, "description": "Data da ocorrência." }, "occurrence": { "type": "string", "maxLength": 2, "nullable": true, "description": "Código da operação no banco." }, "occurrence_detail": { "type": "string", "nullable": true, "description": "Descrição do evento no Retorno." }, "occurrence_error": { "type": "string", "nullable": true, "description": "Erro no retorno." }, "occurrence_error_detail": { "type": "string", "nullable": true, "description": "Descrição do erro no retorno." }, "line_raw": { "type": "string", "format": "json", "nullable": true, "description": "Linha plana com informações vindas do banco.", "example": null }, "line_parsed": { "type": "string", "format": "json", "nullable": true, "description": "Linha parseada com informações vindas do banco:\n\nConteúdo do retorno bancário. Pode mudar de acordo com o banco e o formato 240 ou 400. Se algum dos campos estiver em branco é porque o seu banco não disponibiliza essa informação.\n\n| Valor | Descrição |\n|---|---|\n| paid_at | Data de pagamento |\n| paid_amount | Valor pago |\n| bank_rate | Taxa do boleto paga ao banco |\n| credit_at | Data de crédito |\n| credit_amount | Valor do Crédito |\n| our_number | Nosso número |\n| processed_our_number_raw | Nosso número formatado |\n| discount | Desconto |\n| billet_fine | Acréscimos(Multa/Juros cobrados) |\n| other_fines | Outras cobranças adicionais |\n| other_credit | Outros valores pagos |\n| value_rebate | Outras taxas |\n| error_code | Código de erro |\n| event_type | Ocorrência bancária |\n| agency_number | Agência |\n| account_number | Conta |\n| banco_recebedor | Banco recebedor |\n| agencia_recebedora | Agência recebedora |\n| control_number | Número de Controle |\n| document_number | Número do Documento |" } } }, "v2_custom_bank_billets_object": { "type": "object", "required": [ "expire_at", "amount_cents" ], "properties": { "amount_cents": { "type": "integer", "maxLength": 15, "description": "Valor da parcela (R$) com 2 casas decimais. Formato: 134556 corresponde 1.345,56" }, "expire_at": { "type": "string", "format": "date", "description": "Data de vencimento", "example": "2023-12-12" } } }, "v2_discharge_send_cnab_object": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "Arquivo" }, "filename": { "type": "string", "maxLength": 255, "nullable": true, "description": "Nome do arquivo" }, "bank_billet_account_id": { "type": "integer", "nullable": true, "description": "ID da [Carteira de Cobrança](/reference/post_v1-bank-billet-accounts).", "example": null }, "external_id": { "type": "string", "maxLength": 255, "nullable": true, "description": "ID externo do CNAB" }, "custom_data": { "type": "object", "nullable": true, "description": "Dados customizados" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Tags para categorização" } } }, "v2_remittance_create_cnab_object": { "type": "object", "properties": { "bank_billet_account_id": { "type": "integer", "nullable": true, "description": "ID da [Carteira de Cobrança](/reference/post_v1-bank-billet-accounts).", "example": null }, "bank_billet_remittance_ids": { "type": "array", "nullable": true, "example": null, "description": "IDs de [Registros de Remessa](/reference/get_v1-bank-billet-remittances).", "items": { "type": "integer" } }, "external_id": { "type": "string", "maxLength": 255, "nullable": true, "description": "ID externo do CNAB" }, "custom_data": { "type": "object", "nullable": true, "description": "Dados customizados" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Tags para categorização" } } }, "v2_automatic_pix_recurrence_object": { "type": "object", "properties": { "uid": { "type": "string", "description": "UID público da recorrência", "example": "9e45d2e2-90b7-4908-a013-1e5ea23e5a00", "readOnly": true }, "charge_automatic_pix_account_uid": { "type": "string", "description": "UID da conta Pix Automático", "example": "df329c26-7b88-4b1d-ae22-4c2df9e04dc2" }, "financial_account_uid": { "type": "string", "description": "UID da conta financeira (derivado da conta Pix Automático)", "readOnly": true, "example": "b71f1a3e-2b97-43c7-ae4e-21cba47b332b" }, "pix_uid": { "type": "string", "description": "UID do Pix (opcional). Quando informado junto com location_uid, o QR Code gerado será da jornada instant (Jornada 3) para Pix instantâneo ou offer (Jornada 4) para Pix com vencimento", "example": "12345678-1234-1234-1234-123456789abc", "nullable": true }, "location_uid": { "type": "string", "nullable": true, "description": "UID da localização. Quando informado, o QR Code será gerado conforme a jornada:\n - **recurrent (Jornada 2)**: apenas `location_uid`, sem `pix_uid`;\n - **instant (Jornada 3)**: `location_uid` + `pix_uid` para Pix instantâneo (Pix deve estar aberto e registrado);\n - **offer (Jornada 4)**: `location_uid` + `pix_uid` para Pix com vencimento (Pix deve estar aberto e registrado).", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "external_id": { "type": "string", "nullable": true, "example": "recurrence_123" }, "custom_data": { "type": "object", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "tag_list": { "type": "string", "nullable": true, "readOnly": true, "description": "Tags associadas ao registro" }, "financial_provider_external_id": { "type": "string", "readOnly": true, "nullable": true }, "document": { "type": "string", "maxLength": 35, "example": "12345678901", "description": "Número, identificador, ou código que representa o objeto da autorização (contrato, pedido etc.) e o vínculo usuário recebedor e usuário devedor." }, "description": { "type": "string", "maxLength": 35, "example": "Cobrança mensal" }, "debtor": { "type": "object", "description": "Informações da pessoa devedora", "properties": { "document_type": { "type": "string", "enum": [ "CPF", "CNPJ" ], "description": "Tipo do documento da pessoa", "example": "CPF" }, "document_number": { "type": "string", "description": "Número do documento da pessoa", "example": "12345678901" }, "kind": { "type": "string", "enum": [ "natural", "juridical" ], "description": "Tipo de pessoa: física (natural) ou jurídica (juridical)", "example": "natural" }, "name": { "type": "string", "maxLength": 140, "description": "Nome completo ou razão social", "example": "Maria da Silva" } } }, "start_at": { "type": "string", "format": "date_time", "example": "2024-01-01T00:00:00Z" }, "finish_at": { "type": "string", "format": "date_time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "recurrence_term": { "type": "string", "enum": [ "indefinite", "fixed" ], "example": "fixed" }, "cycle": { "type": "string", "enum": [ "weekly", "monthly", "quarterly", "semiannual", "annual" ], "example": "monthly" }, "amount_term": { "type": "string", "enum": [ "variable", "fixed" ], "example": "fixed" }, "amount": { "type": "number", "format": "float", "nullable": true, "example": 10000 }, "minimum_amount": { "type": "number", "format": "float", "nullable": true, "example": 5000 }, "agreement_code": { "type": "string", "maxLength": 60, "example": "123123", "description": "Número do Convênio de Pagamento." }, "retry_policy": { "type": "string", "enum": [ "disallow", "allow_3r7d" ], "example": "allow_3r7d" }, "journey": { "type": "string", "readOnly": true, "enum": [ "request", "recurrent", "instant", "offer", "awaiting" ], "example": "recurrent", "description": "Tipo de jornada da recorrência:\n* `request` (Jornada 1) Usuário pagador aceitou através de notificação externa\n* `recurrent` (Jornada 2) Usuário aceitou através de QR Code de recorrência\n* `instant` (Jornada 3) Usuário iniciou através de QR Code composto e pagamento imediato (requer pix_uid e location)\n* `offer` (Jornada 4) Usuário aderiu através de QR Code composto com vencimento (requer pix_uid e location)\n* `awaiting` Aguardando definição da jornada" }, "qrcode": { "type": "object", "nullable": true, "readOnly": true, "properties": { "emv": { "type": "string", "example": "000201..." }, "png": { "type": "string", "example": "data:image/png;base64,..." }, "journey": { "type": "string", "nullable": true, "enum": [ "request", "recurrent", "instant", "offer", "awaiting" ], "description": "Tipo de jornada associada ao QR Code", "example": "recurrent" } } }, "requests": { "type": "array", "nullable": true, "readOnly": true, "items": { "type": "object", "properties": { "expire_at": { "type": "string", "format": "date_time", "example": "2024-07-30T23:59:59Z" }, "recipient": { "type": "object", "description": "Informações do beneficiário", "properties": { "kind": { "type": "string", "enum": [ "checking", "savings", "payment" ], "description": "Tipo de conta", "example": "checking" }, "account_number": { "type": "string", "description": "Número da conta", "example": "12345" }, "agency_number": { "type": "string", "description": "Número da agência", "example": "0001" }, "bank": { "type": "object", "properties": { "number": { "type": "string", "description": "Número do banco", "example": "001" }, "ispb_number": { "type": "string", "description": "Código ISPB do banco", "example": "00000000" }, "name": { "type": "string", "description": "Nome do banco", "example": "Banco do Brasil S.A." } } }, "person_info": { "type": "object", "properties": { "document_type": { "type": "string", "enum": [ "CPF", "CNPJ" ], "description": "Tipo do documento da pessoa", "example": "CPF" }, "document_number": { "type": "string", "description": "Número do documento do titular", "example": "12345678901" }, "kind": { "type": "string", "enum": [ "natural", "juridical" ], "description": "Tipo de pessoa: física (natural) ou jurídica (juridical)", "example": "natural" }, "name": { "type": "string", "description": "Nome do titular", "example": "João Silva" } } } } } } } }, "financial_provider_status": { "type": "string", "nullable": true, "readOnly": true, "enum": [ "pending", "created", "approved", "rejected", "expired", "canceled" ], "example": "approved" }, "financial_provider_status_updates": { "type": "array", "nullable": true, "readOnly": true, "items": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "created", "approved", "rejected", "expired", "canceled" ], "example": "approved" }, "updated_at": { "type": "string", "format": "date_time", "example": "2024-02-01T10:00:00Z" } } } }, "cancellation": { "type": "object", "nullable": true, "readOnly": true, "properties": { "origin": { "type": "string", "enum": [ "recipient", "recipient_provider", "payer", "payer_provider" ], "example": "recipient" }, "occurred_at": { "type": "string", "format": "date_time", "example": "2024-07-03T13:00:00Z" }, "code": { "type": "string", "enum": [ "accl", "cpcl", "dcsd", "ersl", "frud", "pcfd", "slcr", "sldb" ], "example": "frud" }, "description": { "type": "string", "example": "Fraude identificada pelo recebedor" } } }, "rejection": { "type": "object", "nullable": true, "readOnly": true, "properties": { "occurred_at": { "type": "string", "format": "date_time", "example": "2024-07-03T13:00:00Z" }, "code": { "type": "string", "enum": [ "ap13", "ap14" ], "example": "ap13" }, "description": { "type": "string", "example": "Erro de autenticação" } } }, "use_line_of_credit": { "type": "boolean", "readOnly": true, "example": false }, "created_at": { "type": "string", "format": "date_time", "readOnly": true, "example": "2024-01-01T12:00:00Z" }, "updated_at": { "type": "string", "format": "date_time", "readOnly": true, "example": "2024-02-01T12:00:00Z" } } }, "v2_automatic_pix_recurrence_command_object": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Comando." }, "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "Identificador público (UUID) do Comando. Utilizado como parâmetro na consulta individual (`GET /commands/{uid}`)." }, "status": { "type": "string", "readOnly": true, "description": "Status do comando.\n\n`pending`: Comando ainda não executado. [Estado inicial]\n`confirmed`: Comando executado e confirmado.\n`failed`: Execução do comando falhou.\n" }, "operation": { "type": "string", "readOnly": true, "description": "Tipo da operação.\n\n`update`: Alteração de dados.\n`cancel`: Cancelamento.\n" }, "resource_type": { "type": "string", "readOnly": true, "nullable": true, "description": "Tipo do recurso ao qual o Comando pertence (ex.: `BankBillet`, `Pix`, `Financial::Account`)." }, "resource_uid": { "type": "string", "format": "uuid", "readOnly": true, "nullable": true, "description": "Identificador público (UUID) do recurso ao qual o Comando pertence." }, "financial_provider_slug": { "type": "string", "readOnly": true, "nullable": true, "description": "Slug do provedor financeiro (banco) responsável pela execução do Comando." }, "params": { "type": "object", "readOnly": true, "nullable": true, "description": "Parâmetros para a execução do Comando." }, "payload": { "type": "object", "readOnly": true, "nullable": true, "description": "Resposta do servidor com o resultado da operação." }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da criação do registro do Comando" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da atualização do registro do Comando." }, "confirmation_via": { "type": "string", "enum": [ "api", "edi" ], "readOnly": true, "nullable": true, "description": "Origem da confirmação do Comando.\n\n`api`: confirmado via resposta da API do banco (inclui webhooks, Recuperator e sync).\n`edi`: confirmado via retorno CNAB (arquivo de baixa).\n`null`: Sem origem registrada.\n" }, "recurrence": { "$ref": "#/components/schemas/v2_automatic_pix_recurrence_object" } } }, "v2_automatic_pix_request_object": { "type": "object", "required": [ "expire_at", "addressee_financial_account" ], "properties": { "uid": { "type": "string", "description": "UID público da solicitação Pix automática", "example": "2f9dbf64-58d2-403e-9827-d99982aa116e", "readOnly": true }, "automatic_pix_recurrence_uid": { "type": "string", "description": "UID da recorrência associada", "example": "9e45d2e2-90b7-4908-a013-1e5ea23e5a00" }, "charge_automatic_pix_account_uid": { "type": "string", "description": "UID da conta Pix Automático (derivado da recorrência)", "example": "73a7b219-0f8a-4097-9a6d-6e74b9e877fb", "readOnly": true }, "expire_at": { "type": "string", "format": "date_time", "description": "Data de expiração da solicitação", "example": "2025-01-01T23:59:59Z" }, "financial_provider_external_id": { "type": "string", "nullable": true, "readOnly": true, "description": "Identificador externo no provedor financeiro", "example": "req-874623" }, "financial_provider_status": { "type": "string", "nullable": true, "readOnly": true, "enum": [ "pending", "created", "sent", "received", "rejected", "accepted", "expired", "canceled" ], "description": "Status da solicitação no provedor financeiro", "example": "accepted" }, "financial_provider_status_updates": { "type": "array", "nullable": true, "readOnly": true, "description": "Histórico de atualizações de status da solicitação no provedor financeiro", "items": { "type": "object", "properties": { "status": { "type": "string", "nullable": true, "enum": [ "created", "sent", "received", "rejected", "accepted", "expired", "canceled" ], "example": "sent" }, "updated_at": { "type": "string", "format": "date_time", "example": "2025-01-01T10:00:00Z" } } } }, "rejection": { "type": "object", "nullable": true, "readOnly": true, "description": "Detalhamento da rejeição da solicitação (preenchido quando rejeitada)", "properties": { "occurred_at": { "type": "string", "format": "date_time", "example": "2024-07-03T13:00:00Z" }, "code": { "type": "string", "enum": [ "ac01", "ac04", "ac06", "ap01", "ap02", "ap03", "ap04", "ap05", "ap13", "ap14", "ap15", "ch16", "md01", "sa01" ], "example": "ap13" }, "description": { "type": "string", "example": "Rejeição do pagador por não reconhecimento do recebedor" } } }, "cancellation": { "type": "object", "nullable": true, "readOnly": true, "description": "Detalhamento do cancelamento da solicitação (preenchido quando cancelada)", "properties": { "origin": { "type": "string", "enum": [ "recipient", "recipient_provider", "payer", "payer_provider" ], "example": "recipient" }, "occurred_at": { "type": "string", "format": "date_time", "example": "2024-07-03T13:00:00Z" }, "code": { "type": "string", "enum": [ "nres", "ersl", "pcfd", "slcr" ], "example": "slcr" }, "description": { "type": "string", "example": "Cancelamento solicitado pelo usuário recebedor" } } }, "addressee_financial_account": { "type": "object", "nullable": false, "description": "Conta financeira do destinatário", "required": [ "kind", "account_number", "account_digit", "agency_number", "bank", "person_info" ], "properties": { "kind": { "type": "string", "enum": [ "checking", "savings", "payment" ], "description": "Tipo de conta", "example": "checking" }, "account_number": { "type": "string", "description": "Número da conta (sem o dígito verificador)", "example": "12345" }, "account_digit": { "type": "string", "description": "Dígito verificador da conta", "example": "6" }, "agency_number": { "type": "string", "description": "Número da agência", "example": "0001" }, "bank": { "type": "object", "nullable": false, "properties": { "number": { "type": "string", "description": "Número do banco", "example": "001", "nullable": true }, "ispb_number": { "type": "string", "description": "Código ISPB do banco", "example": "00000000", "nullable": true }, "name": { "type": "string", "description": "Nome do banco", "example": "Banco do Brasil S.A.", "nullable": true } } }, "person_info": { "type": "object", "nullable": false, "required": [ "document_type", "document_number", "kind", "name" ], "properties": { "document_type": { "type": "string", "enum": [ "CPF", "CNPJ" ], "description": "Tipo do documento da pessoa", "example": "CPF" }, "document_number": { "type": "string", "description": "Número do documento do titular", "example": "12345678901" }, "kind": { "type": "string", "enum": [ "natural", "juridical" ], "description": "Tipo de pessoa: física (natural) ou jurídica (juridical)", "example": "natural" }, "name": { "type": "string", "description": "Nome do titular", "example": "João Silva" } } } } }, "external_id": { "type": "string", "nullable": true, "example": "request_123", "description": "ID externo da solicitação" }, "custom_data": { "type": "object", "nullable": true, "description": "Dados personalizados da solicitação" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Lista de etiquetas da solicitação" }, "tag_list": { "type": "string", "nullable": true, "readOnly": true, "description": "Tags associadas ao registro" }, "created_at": { "type": "string", "format": "date_time", "readOnly": true, "example": "2025-07-01T09:00:00Z" }, "updated_at": { "type": "string", "format": "date_time", "readOnly": true, "example": "2025-07-01T12:00:00Z" } } }, "v2_automatic_pix_request_command_object": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Comando." }, "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "Identificador público (UUID) do Comando. Utilizado como parâmetro na consulta individual (`GET /commands/{uid}`)." }, "status": { "type": "string", "readOnly": true, "description": "Status do comando.\n\n`pending`: Comando ainda não executado. [Estado inicial]\n`confirmed`: Comando executado e confirmado.\n`failed`: Execução do comando falhou.\n" }, "operation": { "type": "string", "readOnly": true, "description": "Tipo da operação.\n\n`cancel`: Cancelamento.\n" }, "resource_type": { "type": "string", "readOnly": true, "nullable": true, "description": "Tipo do recurso ao qual o Comando pertence (ex.: `BankBillet`, `Pix`, `Financial::Account`)." }, "resource_uid": { "type": "string", "format": "uuid", "readOnly": true, "nullable": true, "description": "Identificador público (UUID) do recurso ao qual o Comando pertence." }, "financial_provider_slug": { "type": "string", "readOnly": true, "nullable": true, "description": "Slug do provedor financeiro (banco) responsável pela execução do Comando." }, "params": { "type": "object", "readOnly": true, "nullable": true, "description": "Parâmetros para a execução do Comando." }, "payload": { "type": "object", "readOnly": true, "nullable": true, "description": "Resposta do servidor com o resultado da operação." }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da criação do registro do Comando" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da atualização do registro do Comando." }, "confirmation_via": { "type": "string", "enum": [ "api", "edi" ], "readOnly": true, "nullable": true, "description": "Origem da confirmação do Comando.\n\n`api`: confirmado via resposta da API do banco (inclui webhooks, Recuperator e sync).\n`edi`: confirmado via retorno CNAB (arquivo de baixa).\n`null`: Sem origem registrada.\n" }, "request": { "$ref": "#/components/schemas/v2_automatic_pix_request_object" } } }, "v2_automatic_pix_pix_object": { "type": "object", "properties": { "uid": { "type": "string", "description": "UID público da cobrança Pix", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "readOnly": true }, "automatic_pix_recurrence_uid": { "type": "string", "description": "UID da recorrência associada", "example": "rec-uid-123" }, "charge_automatic_pix_account_uid": { "type": "string", "description": "UID da conta Pix Automático (derivado da recorrência)", "example": "apa-uid-789", "readOnly": true }, "amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor da cobrança", "example": 15000 }, "debtor": { "type": "object", "nullable": true, "description": "Informações da pessoa devedora", "properties": { "email": { "type": "string", "nullable": true, "description": "Email do devedor", "example": "maria.silva@example.com" }, "address": { "type": "object", "nullable": true, "description": "Endereço do devedor", "properties": { "street": { "type": "string", "description": "Logradouro", "example": "Rua das Flores" }, "number": { "type": "string", "description": "Número", "example": "123" }, "complement": { "type": "string", "description": "Complemento", "example": "Apto 101" }, "neighborhood": { "type": "string", "description": "Bairro", "example": "Centro" }, "state": { "type": "string", "description": "Estado (UF)", "example": "SP" }, "city_name": { "type": "string", "description": "Nome da cidade", "example": "São Paulo" }, "zip_code": { "type": "string", "description": "CEP", "example": "01234-567" } } } } }, "retry_policy": { "type": "string", "enum": [ "disallow", "allow_3r7d" ], "description": "Política de retentativa da cobrança", "example": "allow_3r7d" }, "financial_provider_status": { "type": "string", "nullable": true, "readOnly": true, "enum": [ "pending", "created", "active", "paid", "expired", "rejected", "canceled" ], "description": "Status da cobrança no provedor financeiro", "example": "active" }, "financial_provider_status_updates": { "type": "array", "nullable": true, "readOnly": true, "description": "Histórico de status no provedor financeiro", "items": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "created", "active", "paid", "expired", "rejected", "canceled" ], "example": "paid" }, "updated_at": { "type": "string", "format": "date_time", "example": "2025-07-01T15:00:00Z" } } } }, "cancellation": { "type": "object", "nullable": true, "readOnly": true, "description": "Informações de cancelamento da cobrança", "properties": { "origin": { "type": "string", "enum": [ "recipient", "recipient_provider", "payee", "payee_provider" ], "example": "recipient" }, "occurred_at": { "type": "string", "format": "date_time", "example": "2025-07-01T13:00:00Z" }, "code": { "type": "string", "enum": [ "acct", "blck", "ccld", "fail", "othr", "slbd", "slcr" ], "example": "fail" }, "description": { "type": "string", "example": "Falha técnica no provedor" } } }, "rejection": { "type": "object", "nullable": true, "readOnly": true, "description": "Informações de rejeição da cobrança", "properties": { "occurred_at": { "type": "string", "format": "date_time", "example": "2025-07-01T14:00:00Z" }, "code": { "type": "string", "enum": [ "ab10", "ac05", "ac06", "ag12", "am02", "am09", "denc", "ds27", "dted", "dtnt", "fbrd", "irnt", "midi", "msuc", "niec", "nipa", "nitx", "qunt", "rc09", "udei" ], "example": "dted" }, "description": { "type": "string", "example": "Data inválida" } } }, "retries": { "type": "array", "nullable": true, "readOnly": true, "description": "Lista de tentativas de cobrança", "items": { "type": "object", "properties": { "paid_at": { "type": "string", "format": "date_time", "nullable": true, "description": "Data de liquidação da tentativa. Preenchida somente quando a tentativa foi paga (status `paid`); nula nos demais status.", "example": "2025-07-02T10:00:00Z" }, "kind": { "type": "string", "enum": [ "agnd", "ntag", "rifl" ], "example": "agnd" }, "status": { "type": "string", "enum": [ "requested", "scheduled", "paid", "canceled", "rejected", "expired" ], "example": "scheduled" }, "end_to_end_id": { "type": "string", "example": "E1234567890123456789012345678901" }, "updates": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "requested", "scheduled", "paid", "canceled", "rejected", "expired" ], "example": "paid" }, "occurred_at": { "type": "string", "format": "date_time", "example": "2025-07-02T12:00:00Z" } } } }, "rejection": { "type": "object", "nullable": true, "properties": { "code": { "type": "string", "enum": [ "ab10", "ac05", "ac06", "ag12", "am02", "am09", "denc", "ds27", "dted", "dtnt", "fbrd", "irnt", "midi", "msuc", "niec", "nipa", "nitx", "qunt", "rc09", "udei" ], "example": "rc09" }, "description": { "type": "string", "example": "Erro no roteamento bancário" } } } } } }, "received_pix": { "type": "array", "nullable": true, "readOnly": true, "description": "Lista de pagamentos recebidos (Pix)", "items": { "type": "object", "properties": { "end_to_end_id": { "type": "string", "example": "E9876543210987654321098765432109" }, "txid": { "type": "string", "example": "TX1234567890PIXCODIGO" }, "amount": { "type": "number", "format": "float", "example": 15000 }, "paid_at": { "type": "string", "format": "date_time", "example": "2025-07-03T14:00:00Z" }, "message_payer": { "type": "string", "example": "Obrigado pelo serviço" }, "returns": { "type": "array", "items": { "type": "object", "properties": { "uid": { "type": "string", "example": "pixret-uid-001" }, "rtr_id": { "type": "string", "example": "RTR1234567890" }, "amount": { "type": "number", "format": "float", "example": 15000 }, "kind": { "type": "string", "enum": [ "original", "med_pix_automatico", "med_fraude" ], "example": "med_fraude" }, "description": { "type": "string", "example": "Retorno por fraude" }, "reason": { "type": "string", "example": "Suspeita de fraude detectada" }, "status": { "type": "string", "enum": [ "processing", "returned", "not_performed" ], "example": "returned" }, "requested_at": { "type": "string", "format": "date_time", "example": "2025-07-03T15:00:00Z" }, "settled_at": { "type": "string", "format": "date_time", "nullable": true, "example": "2025-07-03T16:00:00Z" } } } } } } }, "txid": { "type": "string", "nullable": true, "description": "Identificador da transação (opcional na criação; gerado automaticamente se omitido)", "example": "BSa1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p" }, "additional_info": { "type": "string", "nullable": true, "description": "Informações adicionais sobre a cobrança", "example": "Referente ao contrato 12345" }, "next_business_day": { "type": "boolean", "description": "Se deve considerar próximo dia útil", "example": true }, "expire_at": { "type": "string", "format": "date_time", "nullable": true, "description": "Data de expiração da cobrança", "example": "2025-08-01T23:59:59Z" }, "financial_provider_created_at": { "type": "string", "format": "date_time", "readOnly": true, "nullable": true, "description": "Data de criação no provedor financeiro", "example": "2025-07-01T10:00:00Z" }, "recipient_financial_account": { "type": "object", "nullable": true, "readOnly": true, "description": "Conta financeira do recebedor (derivada automaticamente da conta financeira da recorrência)", "required": [ "kind", "account_number", "account_digit" ], "properties": { "kind": { "type": "string", "enum": [ "checking", "savings", "payment" ], "description": "Tipo de conta", "example": "checking" }, "account_number": { "type": "string", "description": "Número da conta (sem o dígito verificador)", "example": "12345" }, "account_digit": { "type": "string", "description": "Dígito verificador da conta", "example": "6" }, "agency_number": { "type": "string", "description": "Número da agência", "example": "0001" } } }, "external_id": { "type": "string", "nullable": true, "example": "pix_123", "description": "ID externo da cobrança Pix" }, "custom_data": { "type": "object", "nullable": true, "description": "Dados personalizados da cobrança Pix" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Lista de etiquetas da cobrança Pix" }, "tag_list": { "type": "string", "nullable": true, "readOnly": true, "description": "Tags associadas ao registro" }, "created_at": { "type": "string", "format": "date_time", "readOnly": true, "example": "2025-07-01T09:00:00Z" }, "updated_at": { "type": "string", "format": "date_time", "readOnly": true, "example": "2025-07-01T12:00:00Z" } } }, "v2_automatic_pix_pix_command_object": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Comando." }, "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "Identificador público (UUID) do Comando. Utilizado como parâmetro na consulta individual (`GET /commands/{uid}`)." }, "status": { "type": "string", "readOnly": true, "description": "Status do comando.\n\n`pending`: Comando ainda não executado. [Estado inicial]\n`confirmed`: Comando executado e confirmado.\n`failed`: Execução do comando falhou.\n" }, "operation": { "type": "string", "readOnly": true, "description": "Tipo da operação.\n\n`update`: Alteração de dados.\n`cancel`: Cancelamento.\n" }, "resource_type": { "type": "string", "readOnly": true, "nullable": true, "description": "Tipo do recurso ao qual o Comando pertence (ex.: `BankBillet`, `Pix`, `Financial::Account`)." }, "resource_uid": { "type": "string", "format": "uuid", "readOnly": true, "nullable": true, "description": "Identificador público (UUID) do recurso ao qual o Comando pertence." }, "financial_provider_slug": { "type": "string", "readOnly": true, "nullable": true, "description": "Slug do provedor financeiro (banco) responsável pela execução do Comando." }, "params": { "type": "object", "readOnly": true, "nullable": true, "description": "Parâmetros para a execução do Comando." }, "payload": { "type": "object", "readOnly": true, "nullable": true, "description": "Resposta do servidor com o resultado da operação." }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da criação do registro do Comando" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da atualização do registro do Comando." }, "confirmation_via": { "type": "string", "enum": [ "api", "edi" ], "readOnly": true, "nullable": true, "description": "Origem da confirmação do Comando.\n\n`api`: confirmado via resposta da API do banco (inclui webhooks, Recuperator e sync).\n`edi`: confirmado via retorno CNAB (arquivo de baixa).\n`null`: Sem origem registrada.\n" }, "pix": { "$ref": "#/components/schemas/v2_automatic_pix_pix_object" } } }, "v2_automatic_pix_location_object": { "type": "object", "properties": { "uid": { "type": "string", "description": "UID público da location", "example": "9e45d2e2-90b7-4908-a013-1e5ea23e5a00", "readOnly": true }, "charge_automatic_pix_account_uid": { "type": "string", "description": "UID da conta Pix Automático", "example": "df329c26-7b88-4b1d-ae22-4c2df9e04dc2" }, "location": { "type": "string", "description": "URL da location Pix", "maxLength": 77, "nullable": true, "example": "pix.example.com/location/123" }, "financial_provider_created_at": { "type": "string", "format": "date_time", "nullable": true, "example": "2024-01-01T00:00:00Z" }, "financial_provider_external_id": { "type": "string", "nullable": true, "example": "provider_loc_123" }, "external_id": { "type": "string", "nullable": true, "example": "location_123" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true, "example": [ "tag1", "tag2" ] }, "tag_list": { "type": "string", "nullable": true, "readOnly": true, "description": "Tags associadas ao registro" }, "custom_data": { "type": "object", "nullable": true, "example": { "key": "value" } }, "created_at": { "type": "string", "format": "date_time", "example": "2024-01-01T00:00:00Z" }, "updated_at": { "type": "string", "format": "date_time", "example": "2024-01-01T00:00:00Z" } }, "required": [ "uid", "charge_automatic_pix_account_uid", "created_at", "updated_at" ], "example": { "uid": "9e45d2e2-90b7-4908-a013-1e5ea23e5a00", "charge_automatic_pix_account_uid": "df329c26-7b88-4b1d-ae22-4c2df9e04dc2", "location": "pix.example.com/location/123", "financial_provider_created_at": "2024-01-01T00:00:00Z", "financial_provider_external_id": "provider_loc_123", "external_id": "location_123", "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "custom_data": { "key": "value" }, "created_at": "2024-01-01T00:00:00Z", "updated_at": "2024-01-01T00:00:00Z" } }, "v2_automatic_pix_account_object": { "type": "object", "properties": { "uid": { "type": "string", "description": "UID público da conta de PIX automático", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "readOnly": true }, "financial_account_uid": { "type": "string", "description": "UID da conta financeira associada", "example": "finacc-uid-456" }, "connection_uid": { "type": "string", "nullable": true, "description": "UID da conexão associada", "example": "conn-uid-789" }, "financial_provider_slug": { "type": "string", "nullable": true, "readOnly": true, "description": "Slug do provedor financeiro, derivado da conta financeira associada", "example": "itau" }, "custom_name": { "type": "string", "nullable": true, "description": "Nome customizado da conta", "example": "Conta PIX Automático Principal" }, "status": { "type": "string", "readOnly": true, "description": "Status calculado da conta: active (ativa), inactive (validada mas não habilitada), pending (pendente de validação)", "enum": [ "active", "inactive", "pending" ], "example": "active" }, "external_id": { "type": "string", "nullable": true, "description": "ID externo para integração", "example": "ext-account-123" }, "custom_data": { "type": "object", "nullable": true, "description": "Dados customizados" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Tags da conta" }, "validated_at": { "type": "string", "nullable": true, "format": "date_time", "readOnly": true, "description": "Data de validação da conta Pix Automático" }, "enabled_at": { "type": "string", "nullable": true, "format": "date_time", "readOnly": true, "description": "Data de habilitação da conta Pix Automático" }, "created_at": { "type": "string", "nullable": true, "format": "date_time", "readOnly": true, "description": "Data de criação do registro" }, "updated_at": { "type": "string", "nullable": true, "format": "date_time", "readOnly": true, "description": "Data de atualização do registro" } }, "required": [ "financial_account_uid" ] }, "v2_new_automatic_pix_account": { "type": "object", "description": "Nova Conta de Pix Automático.", "required": [ "financial_account_uid" ], "properties": { "financial_account_uid": { "type": "string", "description": "UID da conta financeira associada", "example": "finacc-uid-456" }, "custom_name": { "type": "string", "nullable": true, "description": "Nome customizado da conta", "example": "Conta PIX Automático Principal" }, "external_id": { "type": "string", "nullable": true, "description": "ID externo para integração", "example": "ext-account-123" }, "enabled": { "type": "boolean", "nullable": true, "description": "Define se a conta está habilitada." }, "custom_data": { "type": "object", "nullable": true, "description": "Dados customizados" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Tags da conta" } } }, "v2_update_automatic_pix_account": { "type": "object", "description": "Atualização de Conta de Pix Automático.", "properties": { "custom_name": { "type": "string", "nullable": true, "description": "Nome customizado da conta" }, "external_id": { "type": "string", "nullable": true, "description": "ID externo para integração" }, "enabled": { "type": "boolean", "nullable": true, "description": "Define se a conta está habilitada." }, "custom_data": { "type": "object", "nullable": true, "description": "Dados customizados" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Tags da conta" } } }, "v2_new_automatic_pix_location": { "type": "object", "description": "Nova Location do Pix Automático.", "required": [ "charge_automatic_pix_account_uid" ], "properties": { "charge_automatic_pix_account_uid": { "type": "string", "description": "UID da conta Pix Automático", "example": "df329c26-7b88-4b1d-ae22-4c2df9e04dc2" }, "external_id": { "type": "string", "nullable": true, "description": "ID externo da location", "example": "location_123" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Tags para organização" }, "custom_data": { "type": "object", "nullable": true, "description": "Dados customizados" } } }, "v2_new_automatic_pix_recurrence": { "type": "object", "description": "Nova Recorrência do Pix Automático.", "required": [ "charge_automatic_pix_account_uid", "start_at", "document", "debtor", "retry_policy", "cycle", "recurrence_term", "amount_term" ], "properties": { "charge_automatic_pix_account_uid": { "type": "string", "description": "UID da conta Pix Automático. A conta financeira e a connection são herdadas desta conta.", "example": "df329c26-7b88-4b1d-ae22-4c2df9e04dc2" }, "pix_uid": { "type": "string", "nullable": true, "description": "UID do Pix (opcional). Quando informado junto com location_uid: o qrcode gerado será da jornada instant (Jornada 3) para Pix instantâneo ou offer (Jornada 4) para Pix com vencimento." }, "location_uid": { "type": "string", "nullable": true, "description": "UID da localização. Quando informado, o QR Code será gerado conforme a jornada (recurrent / instant / offer)." }, "document": { "type": "string", "maxLength": 35, "description": "Número, identificador, ou código que representa o objeto da autorização (contrato, pedido etc.)." }, "description": { "type": "string", "maxLength": 35, "nullable": true, "description": "Descrição da recorrência." }, "start_at": { "type": "string", "format": "date_time", "description": "Data de início da recorrência." }, "finish_at": { "type": "string", "format": "date_time", "nullable": true, "description": "Data de fim da recorrência." }, "recurrence_term": { "type": "string", "enum": [ "indefinite", "fixed" ], "description": "Prazo da recorrência." }, "cycle": { "type": "string", "enum": [ "weekly", "monthly", "quarterly", "semiannual", "annual" ], "description": "Ciclo da recorrência." }, "amount_term": { "type": "string", "enum": [ "fixed", "variable" ], "description": "Tipo do valor da recorrência." }, "amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor (quando amount_term é fixed)." }, "minimum_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor mínimo (quando amount_term é variable)." }, "agreement_code": { "type": "string", "maxLength": 60, "nullable": true, "description": "Número do Convênio de Pagamento." }, "retry_policy": { "type": "string", "enum": [ "disallow", "allow_3r7d" ], "description": "Política de retentativa." }, "external_id": { "type": "string", "nullable": true, "description": "ID externo da recorrência." }, "custom_data": { "type": "object", "nullable": true, "description": "Dados personalizados." }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Tags." }, "debtor": { "type": "object", "description": "Informações da pessoa devedora", "required": [ "document_type", "document_number", "kind", "name" ], "properties": { "document_type": { "type": "string", "enum": [ "CPF", "CNPJ" ], "description": "Tipo do documento." }, "document_number": { "type": "string", "description": "Número do documento." }, "kind": { "type": "string", "enum": [ "natural", "juridical" ], "description": "Tipo de pessoa." }, "name": { "type": "string", "maxLength": 140, "description": "Nome do devedor." } } } } }, "v2_update_automatic_pix_recurrence": { "type": "object", "description": "Atualização de Recorrência do Pix Automático.", "properties": { "external_id": { "type": "string", "nullable": true, "description": "ID externo da recorrência." }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Tags." }, "custom_data": { "type": "object", "nullable": true, "description": "Dados personalizados." } } }, "v2_command_update_automatic_pix_recurrence": { "type": "object", "description": "Atualização da Recorrência do Pix Automático. São editáveis a data de início, o nome do devedor, o Pix e a Location associados.", "properties": { "pix_uid": { "type": "string", "nullable": true, "description": "UID do Pix a ser associado à recorrência." }, "location_uid": { "type": "string", "nullable": true, "description": "UID da Location a ser associada à recorrência." }, "start_at": { "type": "string", "format": "date_time", "description": "Data estimada de primeiro pagamento." }, "debtor": { "type": "object", "description": "Informações da pessoa devedora (apenas nome é editável).", "properties": { "name": { "type": "string", "maxLength": 140, "description": "Nome do devedor." } } } } }, "v2_new_automatic_pix_pix": { "type": "object", "description": "Nova cobrança do Pix Automático. A conta financeira e a conta destinatária são herdadas automaticamente da recorrência.", "required": [ "amount", "retry_policy", "next_business_day", "expire_at" ], "properties": { "amount": { "type": "number", "format": "float", "description": "Valor da cobrança." }, "retry_policy": { "type": "string", "enum": [ "disallow", "allow_3r7d" ], "description": "Política de retentativa." }, "next_business_day": { "type": "boolean", "description": "Se deve considerar próximo dia útil." }, "expire_at": { "type": "string", "format": "date_time", "description": "Data de expiração da cobrança." }, "additional_info": { "type": "string", "nullable": true, "description": "Informações adicionais da cobrança." }, "txid": { "type": "string", "nullable": true, "description": "Identificador da transação (opcional; gerado automaticamente se omitido)." }, "external_id": { "type": "string", "nullable": true, "description": "ID externo da cobrança." }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Tags." }, "custom_data": { "type": "object", "nullable": true, "description": "Dados personalizados." }, "debtor": { "type": "object", "description": "Dados adicionais do devedor", "properties": { "email": { "type": "object", "properties": { "address": { "type": "string", "description": "Endereço de e-mail." } } }, "address": { "type": "object", "properties": { "street": { "type": "string", "description": "Logradouro." }, "number": { "type": "string", "description": "Número." }, "complement": { "type": "string", "description": "Complemento." }, "neighborhood": { "type": "string", "description": "Bairro." }, "state": { "type": "string", "description": "Estado (UF)." }, "city_name": { "type": "string", "description": "Nome da cidade." }, "zip_code": { "type": "string", "description": "CEP." } } } } } } }, "v2_update_automatic_pix_pix": { "type": "object", "description": "Atualização de cobrança do Pix Automático.", "properties": { "external_id": { "type": "string", "nullable": true, "description": "ID externo da cobrança." }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Tags." }, "custom_data": { "type": "object", "nullable": true, "description": "Dados personalizados." } } }, "v2_new_automatic_pix_request": { "type": "object", "description": "Nova solicitação do Pix Automático. A conta Pix Automático é herdada da recorrência.", "required": [ "expire_at", "addressee_financial_account" ], "properties": { "expire_at": { "type": "string", "format": "date_time", "description": "Data de expiração da solicitação." }, "external_id": { "type": "string", "nullable": true, "description": "ID externo da solicitação." }, "custom_data": { "type": "object", "nullable": true, "description": "Dados personalizados." }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Tags." }, "addressee_financial_account": { "type": "object", "description": "Conta Financeira do Destinatário (usuário pagador)", "required": [ "kind", "account_number", "account_digit", "agency_number", "bank", "person_info" ], "properties": { "kind": { "type": "string", "enum": [ "checking", "savings", "payment" ], "description": "Tipo de conta" }, "account_number": { "type": "string", "description": "Número da conta (sem o dígito verificador)" }, "account_digit": { "type": "string", "description": "Dígito verificador da conta" }, "agency_number": { "type": "string", "description": "Número da agência" }, "bank": { "type": "object", "properties": { "ispb_number": { "type": "string", "description": "Código ISPB do banco" } } }, "person_info": { "type": "object", "required": [ "document_type", "document_number", "kind", "name" ], "properties": { "document_type": { "type": "string", "enum": [ "CPF", "CNPJ" ], "description": "Tipo do documento" }, "document_number": { "type": "string", "description": "Número do documento do titular" }, "kind": { "type": "string", "enum": [ "natural", "juridical" ], "description": "Tipo de pessoa" }, "name": { "type": "string", "description": "Nome do titular" } } } } } } }, "v2_update_automatic_pix_request": { "type": "object", "description": "Atualização de solicitação do Pix Automático.", "properties": { "external_id": { "type": "string", "nullable": true, "description": "ID externo da solicitação." }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Tags." }, "custom_data": { "type": "object", "nullable": true, "description": "Dados personalizados." } } }, "v2_financial_provider": { "type": "object", "properties": { "kind": { "type": "string", "readOnly": true, "description": "Tipo de Instituição\n`bank`: Banco\n`ip`: Instituição de Pagamento\n" }, "slug": { "type": "string", "readOnly": true, "description": "Código Interno" }, "name": { "type": "string", "readOnly": true, "description": "Nome" }, "bcb_name": { "type": "string", "readOnly": true, "description": "Nome no Banco Central" }, "number": { "type": "string", "readOnly": true, "description": "Número do Código de Compensação" }, "number_with_digit": { "type": "string", "readOnly": true, "description": "Número do Código de Compensação com Dígito" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do registro" } } }, "v2_financial_account": { "type": "object", "required": [ "account_number", "account_digit", "agency_number", "financial_provider_slug", "person_info" ], "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID da Conta Financeira", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "kind": { "type": "string", "description": "Tipo da Conta\n\n`checking`: Conta Corrente\n`savings`: Conta Poupança\n`payment`: Conta Pagamento\n" }, "account_number": { "type": "string", "description": "Número da Conta" }, "account_digit": { "type": "string", "description": "Dígito da Conta" }, "agency_number": { "type": "string", "description": "Número da Agência" }, "agency_digit": { "type": "string", "nullable": true, "description": "Dígito da Agência. Opcional: será calculado automaticamente usando Módulo 11 quando o banco exigir e não for fornecido." }, "financial_provider_slug": { "type": "string", "description": "Provedor Financeiro" }, "bank_number": { "type": "integer", "description": "Número COMPE do Banco. Obrigatório se bank_id não for informado." }, "created_at": { "type": "string", "readOnly": true, "format": "date-time", "description": "Data da criação. Formato iso8601", "example": "2023-12-02T10:03:56-03:00" }, "custom_data": { "type": "object", "nullable": true, "description": "Hash com chave e valor no formato JSON. Opcional para controle interno." }, "custom_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "Nome da Conta Financeira para identificação dentro da Kobana." }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "payment_agreement_code": { "type": "string", "nullable": true, "description": "Número do Convênio de Pagamento contratado junto ao Banco." }, "person_info": { "type": "object", "nullable": true, "description": "Dados do Titular", "properties": { "document_number": { "type": "string", "nullable": false, "description": "Número do Documento (CPF ou CNPJ)", "example": "111.321.322-09" }, "name": { "type": "string", "nullable": false, "description": "Nome Completo ou Razão Social", "example": "João da Silva" } } }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas a importação. Opcional para controle interno.", "items": { "type": "string", "example": "tag 1" } }, "updated_at": { "type": "string", "readOnly": true, "format": "date-time", "description": "Data da última atualização. Formato iso8601", "example": "2023-12-02T10:03:56-03:00" }, "service_accounts": { "type": "array", "readOnly": true, "description": "Contas de serviço associadas a esta conta financeira.", "items": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "description": "Tipo da conta de serviço", "enum": [ "charge.bank_billet_account", "charge.automatic_pix_account", "statement.account", "payment.account", "transfer.account" ] }, "uid": { "type": "string", "format": "uuid", "description": "UID da conta de serviço" } } } } } }, "v2_financial_account_update": { "type": "object", "properties": { "kind": { "type": "string", "description": "Tipo da Conta\n\n`checking`: Conta Corrente\n`savings`: Conta Poupança\n`payment`: Conta Pagamento\n" }, "account_number": { "type": "string", "description": "Número da Conta" }, "account_digit": { "type": "string", "description": "Dígito da Conta" }, "agency_number": { "type": "string", "description": "Número da Agência" }, "agency_digit": { "type": "string", "nullable": true, "description": "Dígito da Agência. Opcional: será calculado automaticamente usando Módulo 11 quando o banco exigir e não for fornecido." }, "custom_data": { "type": "object", "nullable": true, "description": "Hash com chave e valor no formato JSON. Opcional para controle interno." }, "custom_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "Nome da Conta Financeira para identificação dentro da Kobana." }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "payment_agreement_code": { "type": "string", "nullable": true, "description": "Número do Convênio de Pagamento contratado junto ao Banco." }, "person_info": { "type": "object", "nullable": true, "description": "Dados do Titular", "properties": { "document_number": { "type": "string", "nullable": false, "description": "Número do Documento (CPF ou CNPJ)", "example": "111.321.322-09" }, "name": { "type": "string", "nullable": false, "description": "Nome Completo ou Razão Social", "example": "João da Silva" } } }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas a importação. Opcional para controle interno.", "items": { "type": "string", "example": "tag 1" } } } }, "v2_financial_account_balance": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID do Saldo", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "amount": { "type": "number", "format": "float", "description": "Valor do saldo", "example": 124.0 }, "blocked_amount": { "type": "number", "format": "float", "description": "Valor bloqueado", "example": 24.0 }, "automatically_invested_amount": { "type": "number", "format": "float", "description": "Valor automaticamente investido", "example": 50.0 }, "created_at": { "type": "string", "readOnly": true, "format": "date-time", "description": "Data da criação. Formato iso8601", "example": "2023-12-02T10:03:56-03:00" }, "custom_data": { "type": "object", "nullable": true, "description": "Hash com chave e valor no formato JSON. Opcional para controle interno." }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas a importação. Opcional para controle interno.", "items": { "type": "string", "example": "tag 1" } } } }, "v2_statement_transaction": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID da transação" }, "financial_account_uid": { "type": "string", "readOnly": true, "format": "uuid", "description": "UID da Conta Financeira", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "amount": { "type": "number", "format": "float", "example": 120.99, "description": "Quantia\nObs: Transações de crédito terão o valor positivo e transações de débito terão o valor negativo.\n" }, "person": { "type": "object", "nullable": true, "readOnly": true, "properties": { "document_number": { "type": "string", "nullable": true, "description": "Número do Documento.", "example": "05.813.794/0001-26" }, "name": { "type": "string", "nullable": true, "description": "Nome Completo ou Razão Social", "example": "Kobana Tecnologia Ltda." } } }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data/hora da criação da transação na Kobana" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização da transação na Kobana" }, "occurrence_date": { "type": "string", "format": "date", "description": "Data de ocorrência da transação.", "example": "2023-12-02" }, "description": { "type": "string", "nullable": true, "readOnly": true, "description": "Descrição da transação." }, "document_number": { "type": "string", "nullable": true, "readOnly": true, "description": "Número do documento da transação." }, "kind": { "type": "string", "readOnly": true, "description": "Tipo da transação\n\n`credit`: Crédito\n`debit`: Débito\n" }, "category": { "type": "integer", "readOnly": true, "description": "Categoria do Lançamento.\n" }, "category_description": { "type": "string", "readOnly": true, "description": "Descrição da Categoria do Lançamento.\n" }, "hashed_content": { "type": "string", "readOnly": true, "description": "Hash Code em MD5 do conteúdo da transação.\nNão é único e pode se repetir.\n\nFormado por:\nkind,\ndescription,\ndocument_number,\namount,\noccurrence_date\n\n" }, "hashed_id": { "type": "string", "readOnly": true, "deprecated": true, "description": "Hash Code em MD5 do conteúdo da transação.\nNão é único e pode se repetir.\n\nFormado por:\nkind,\ndescription,\ndocument_number,\namount,\noccurrence_date\n\n" } } }, "v2_statement_sync_request": { "type": "object", "description": "Log de uma sincronização de extrato solicitada. Agrega os comandos criados para a janela pedida.", "properties": { "uid": { "type": "string", "format": "uuid", "description": "Identificador único da solicitação. Use-o para consultar o status.", "example": "018c9160-5c85-725f-b56e-4af36f2564be" }, "status": { "type": "string", "enum": [ "pending", "processing", "done", "partial", "failed" ], "description": "Status agregado dos comandos da solicitação:\n* `pending` - nenhum comando começou a ser processado\n* `processing` - em andamento (parte dos comandos já terminou)\n* `done` - todos os comandos foram confirmados\n* `partial` - todos terminaram, mas parte falhou\n* `failed` - todos terminaram e nenhum foi confirmado\n", "example": "processing" }, "start_at": { "type": "string", "format": "date", "description": "Data inicial da janela sincronizada.", "example": "2026-01-15" }, "end_at": { "type": "string", "format": "date", "description": "Data final da janela sincronizada.", "example": "2026-03-10" }, "commands_count": { "type": "integer", "description": "Quantidade de comandos criados. Janelas que cruzam mais de um mês geram um comando por mês.", "example": 3 }, "commands_summary": { "type": "object", "additionalProperties": { "type": "integer" }, "description": "Quantidade de comandos por status. Útil para identificar qual mês falhou quando o status é `partial`.", "example": { "confirmed": 2, "failed": 1 } }, "commands": { "type": "array", "description": "Comandos da solicitação. Presente apenas na consulta individual.", "items": { "$ref": "#/components/schemas/v2_financial_account_command" } }, "created_at": { "type": "string", "format": "date-time", "description": "Data e hora da solicitação.", "example": "2026-03-17T10:00:00-03:00" }, "updated_at": { "type": "string", "format": "date-time", "description": "Data e hora da última atualização do status.", "example": "2026-03-17T10:05:00-03:00" } } }, "v2_financial_account_command": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Comando." }, "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "Identificador público (UUID) do Comando. Utilizado como parâmetro na consulta individual (`GET /commands/{uid}`)." }, "status": { "type": "string", "readOnly": true, "description": "Status do comando.\n\n`pending`: Comando ainda não executado. [Estado inicial]\n`confirmed`: Comando executado e confirmado.\n`failed`: Execução do comando falhou.\n" }, "operation": { "type": "string", "readOnly": true, "description": "Tipo da operação.\n\n`statement_sync`: Sincronização de Extrato.\n" }, "resource_type": { "type": "string", "readOnly": true, "nullable": true, "description": "Tipo do recurso ao qual o Comando pertence (ex.: `BankBillet`, `Pix`, `Financial::Account`)." }, "resource_uid": { "type": "string", "format": "uuid", "readOnly": true, "nullable": true, "description": "Identificador público (UUID) do recurso ao qual o Comando pertence." }, "financial_provider_slug": { "type": "string", "readOnly": true, "nullable": true, "description": "Slug do provedor financeiro (banco) responsável pela execução do Comando." }, "params": { "type": "object", "readOnly": true, "nullable": true, "description": "Parâmetros para a execução do Comando." }, "payload": { "type": "object", "readOnly": true, "nullable": true, "description": "Resposta do servidor com o resultado da operação." }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da criação do registro do Comando" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da atualização do registro do Comando." }, "confirmation_via": { "type": "string", "enum": [ "api", "edi" ], "readOnly": true, "nullable": true, "description": "Origem da confirmação do Comando.\n\n`api`: confirmado via resposta da API do banco (inclui webhooks, Recuperator e sync).\n`edi`: confirmado via retorno CNAB (arquivo de baixa).\n`null`: Sem origem registrada.\n" }, "financial_account": { "$ref": "#/components/schemas/v2_financial_account" } } }, "v2_import": { "type": "object", "properties": { "uid": { "type": "string", "readOnly": true, "description": "UID da Importação." }, "status": { "type": "string", "readOnly": true, "description": "Status da importação.\n\n`enqueued`: Aguardando processamento. [Estado inicial]\n`failed`: Processamento não realizado devido a erro.\n`processed`: Processamento concluído.\n" }, "started_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data/hora de início do processamento da Importação", "nullable": true }, "finished_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data/hora de fim do processamento da Importação", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data/hora da criação da Importação" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data/hora da atualização da Importação." }, "created_rows": { "type": "integer", "readOnly": true }, "enqueued_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "processed_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "failed_to_create_rows": { "type": "integer", "readOnly": true }, "failed_to_update_rows": { "type": "integer", "readOnly": true }, "import_errors": { "type": "object", "readOnly": true, "nullable": true }, "processed_rows": { "type": "integer", "readOnly": true }, "total_rows": { "type": "integer", "readOnly": true, "nullable": true }, "updated_rows": { "type": "integer", "readOnly": true }, "external_id": { "type": "string", "nullable": true, "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "example": null, "items": { "type": "string" } }, "created_via_api": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se o registro foi criado por API" } } }, "v2_import_send": { "type": "object", "required": [ "source" ], "properties": { "source": { "type": "string", "format": "binary", "description": "Arquivo para importação." }, "external_id": { "type": "string", "nullable": true, "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "example": null, "items": { "type": "string" } } } }, "v2_user": { "type": "object", "description": "Dados do usuário autenticado. Os campos de perfil (email, phone, first_name/middle_name/last_name/full_name, profile_photo_url, legal_data, birthday, gender, languages, timezone, accessibility_resources, disability_disclosure) só são retornados quando o token carrega o escopo correspondente (email, phone, profile, profile.legal, profile.identity, profile.communication, profile.preferences, profile.accessibility) ou o escopo all.", "properties": { "id": { "type": "integer", "deprecated": true, "description": "ID do usuário (deprecated, use uid)", "example": 456 }, "uid": { "type": "string", "description": "UID público do usuário", "example": "usr_9876543210" }, "intercom_id": { "type": "integer", "description": "ID do usuário usado para identificação no Intercom", "example": 456 }, "email": { "type": "string", "format": "email", "description": "E-mail do usuário", "example": "usuario@example.com" }, "phone": { "type": [ "string", "null" ], "description": "Telefone cadastrado (escopo phone)", "example": "+55 11 99999-0000" }, "first_name": { "type": [ "string", "null" ], "description": "Primeiro nome", "example": "João" }, "middle_name": { "type": [ "string", "null" ], "description": "Nome do meio", "example": "Silva" }, "last_name": { "type": [ "string", "null" ], "description": "Último nome", "example": "Santos" }, "full_name": { "type": [ "string", "null" ], "description": "Nome completo", "example": "João Silva Santos" }, "created_via_api": { "type": "boolean", "description": "Indica se foi criado via API", "example": false }, "permissions": { "type": "array", "items": { "type": "string" }, "description": "Permissões do usuário", "example": [ "charge.bank_billets.*", "crm.customers.*" ] }, "created_at": { "type": "string", "format": "date-time", "description": "Data de criação", "example": "2024-01-01T10:00:00Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "Data de atualização", "example": "2024-01-15T15:30:00Z" }, "enabled_at": { "type": [ "string", "null" ], "format": "date-time", "description": "Data de habilitação", "example": "2024-01-01T10:00:00Z" }, "legal_data": { "type": "object", "description": "Dados legais (nome civil e CPF)", "properties": { "name": { "type": [ "string", "null" ], "description": "Nome civil", "example": "João Silva Santos" }, "document_number": { "type": [ "string", "null" ], "description": "CPF formatado", "example": "529.982.247-25" } } }, "profile_photo_url": { "type": "string", "format": "uri", "description": "URL da foto de perfil (ActiveStorage) ou Gravatar como fallback", "example": "https://app.kobana.com.br/rails/active_storage/blobs/redirect/.../foto.jpg" }, "gender": { "type": [ "string", "null" ], "description": "Identidade de gênero (undisclosed, woman, man, non_binary, other_identity ou valor livre — escopo profile.identity)", "example": "male" }, "birthday": { "type": [ "string", "null" ], "format": "date", "description": "Data de nascimento (escopo profile)", "example": "1990-05-20" }, "languages": { "type": "array", "items": { "type": "string" }, "description": "Idiomas preferidos de comunicação do usuário (escopo profile.communication)", "example": [ "pt-BR", "en" ] }, "timezone": { "type": [ "string", "null" ], "description": "Fuso horário do usuário (escopo profile.preferences)", "example": "America/Sao_Paulo" }, "accessibility_resources": { "type": "array", "items": { "type": "string" }, "description": "Recursos de acessibilidade usados na plataforma (escopo profile.accessibility)", "example": [ "screen_reader", "keyboard_navigation" ] }, "disability_disclosure": { "type": "array", "items": { "type": "string" }, "description": "Deficiências informadas pelo usuário, opcional (escopo profile.accessibility)", "example": [ "visual" ] } } }, "v2_subaccount": { "type": "object", "required": [ "nickname" ], "properties": { "id": { "type": "integer", "readOnly": true, "deprecated": true, "description": "ID da subconta (deprecated, use uid)" }, "uid": { "type": "string", "readOnly": true, "description": "UID da subconta" }, "parent_id": { "type": "integer", "readOnly": true, "deprecated": true, "description": "ID da conta principal (deprecated, use parent_uid)" }, "parent_uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID da conta principal" }, "email": { "type": "string", "format": "email", "description": "E-mail", "example": "cliente@example.com" }, "business_name": { "type": "string", "nullable": true, "description": "Nome Fantasia", "example": null }, "business_cnpj": { "type": "string", "nullable": true, "description": "CNPJ da Empresa", "example": "16.974.923/0001-84" }, "nickname": { "type": "string", "description": "Apelido", "example": null }, "business_legal_name": { "type": "string", "nullable": true, "description": "Razão Social", "example": null }, "configuration": { "type": "string", "format": "json", "readOnly": true, "nullable": true, "description": "Configuração de dados padrões da conta", "example": null }, "api_access_token": { "type": "string", "readOnly": true, "nullable": true, "description": "Token de acesso da subconta", "example": null }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": { "codigo": "123", "vip": true }, "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas a Subconta", "example": [ "tag1", "tag2" ], "items": { "type": "string" } }, "created_via_api": { "type": "boolean", "readOnly": true, "nullable": true, "description": "Indica se o registro foi criado pela API", "example": null }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do registro" } } }, "v2_subaccount_update": { "type": "object", "properties": { "enabled": { "type": "integer", "nullable": true, "description": "Indica se a subconta está ativa ou inativa. Utilize `1` para ativar e `0` para desativar.", "enum": [ 0, 1 ], "example": 1 }, "id": { "type": "integer", "readOnly": true, "deprecated": true, "description": "ID da subconta (deprecated, use uid)" }, "uid": { "type": "string", "readOnly": true, "description": "UID da subconta" }, "parent_id": { "type": "integer", "readOnly": true, "deprecated": true, "description": "ID da conta principal (deprecated, use parent_uid)" }, "parent_uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID da conta principal" }, "email": { "type": "string", "format": "email", "description": "E-mail", "example": "cliente@example.com" }, "business_cnpj": { "type": "string", "nullable": true, "description": "CNPJ da Empresa", "example": "16.974.923/0001-84" }, "nickname": { "type": "string", "description": "Apelido", "example": null }, "business_legal_name": { "type": "string", "nullable": true, "description": "Razão Social", "example": null }, "account_type": { "type": "string", "readOnly": true, "nullable": true, "description": "Tipo de Conta:\n* `individual` Pessoa Física\n* `juridical` Pessoa Jurídica", "enum": [ "individual", "juridical" ] }, "first_name": { "type": "string", "nullable": true, "description": "Primeiro Nome do Responsável", "example": null }, "middle_name": { "type": "string", "nullable": true, "description": "Nome do Meio do Responsável", "example": null }, "last_name": { "type": "string", "nullable": true, "description": "Último Nome do Responsável", "example": null }, "full_name": { "type": "string", "nullable": true, "readOnly": true, "description": "Nome completo do Responsável", "example": null }, "gender": { "type": "string", "nullable": true, "description": "Gênero", "example": null }, "cpf": { "type": "string", "nullable": true, "description": "CPF", "example": "627.431.590-06" }, "address_street_name": { "type": "string", "nullable": true, "description": "Endereço", "example": null }, "address_state": { "type": "string", "nullable": true, "description": "Estado", "example": null }, "address_neighborhood": { "type": "string", "nullable": true, "description": "Bairro", "example": null }, "address_postal_code": { "type": "string", "nullable": true, "description": "CEP", "example": null }, "address_number": { "type": "string", "nullable": true, "description": "Número", "example": null }, "address_complement": { "type": "string", "nullable": true, "description": "Complemento", "example": null }, "address_city_name": { "type": "string", "nullable": true, "description": "Cidade", "example": null }, "phone_number": { "type": "string", "nullable": true, "description": "Telefone", "example": null }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Data de Nascimento", "example": "2020-01-01" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": { "codigo": "123", "vip": true }, "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas a Subconta", "example": [ "tag1", "tag2" ], "items": { "type": "string" } }, "business_category": { "type": "integer", "nullable": true, "description": "Categoria:\n\n| Código da Categoria | Descrição |\n|---|---|\n| 1000 | Arte e objetos de colecionadores |\n| 1001 | Bebês |\n| 1002 | Beleza e fragrâncias |\n| 1022 | Brinquedos e hobbies |\n| 1015 | Casa e jardim |\n| 1006 | Computadores |\n| 1004 | De empresa para empresa (B2B) |\n| 1007 | Educação |\n| 1008 | Eletrônicos e telecomunicações |\n| 1009 | Entretenimento e mídia |\n| 1021 | Esportes e atividades ao ar livre |\n| 1013 | Governo |\n| 1003 | Livros e revistas |\n| 1012 | Presentes e flores |\n| 1018 | Religião e espiritualidade (com fins lucrativos) |\n| 1014 | Saúde e cuidados pessoais |\n| 1016 | Sem fins lucrativos |\n| 1025 | Serviço |\n| 1020 | Serviços - Outro |\n| 1010 | Serviços e produtos financeiros |\n| 1019 | Varejo (não classificado em nenhum outro lugar) |\n| 1011 | Varejo e serviços de alimentação |\n| 1024 | Vendas de veículos |\n| 1005 | Vestuário |\n| 1023 | Viagem |", "enum": [ null, 1000, 1001, 1002, 1022, 1015, 1006, 1004, 1007, 1008, 1009, 1021, 1013, 1003, 1012, 1018, 1014, 1016, 1025, 1020, 1010, 1019, 1011, 1024, 1005, 1023 ] }, "business_subcategory": { "type": "integer", "nullable": true, "description": "Subcategoria:\n\n| Código da Categoria | Código da Subcategoria | Descrição |\n|---|---|---|\n| 1017 | 2173 | Animais de estimação especiais ou raros |\n| 1017 | 2171 | Medicamentos e suplementos |\n| 1017 | 2172 | Pet shops, alimentos e suprimentos para animais de estimação |\n| 1017 | 2174 | Serviços veterinários |\n| 1000 | 2000 | Antiguidades |\n| 1000 | 2004 | Arte digital |\n| 1000 | 2007 | Costura, bordado e tecidos |\n| 1000 | 2003 | Câmeras e suprimentos fotográficos |\n| 1000 | 2005 | Lembranças |\n| 1000 | 2006 | Loja de música - instrumentos e partituras |\n| 1000 | 2002 | Marchands e galerias |\n| 1000 | 2009 | Papel de carta, de impressão e escrita |\n| 1000 | 2008 | Selos e moedas |\n| 1000 | 2001 | Suprimentos de artesanato |\n| 1000 | 2010 | Vintage e artigos de colecionadores |\n| 1001 | 2012 | Móveis |\n| 1001 | 2013 | Produtos para bebês - Outro |\n| 1001 | 2014 | Segurança e saúde |\n| 1001 | 2011 | Vestuário |\n| 1002 | 2015 | Banho e corpo |\n| 1002 | 2016 | Fragrâncias e perfumes |\n| 1002 | 2017 | Maquiagem e cosméticos |\n| 1022 | 2252 | Artesanato |\n| 1022 | 2253 | Câmeras e suprimentos fotográficos |\n| 1022 | 2255 | Lembranças |\n| 1022 | 2256 | Loja de música - instrumentos e partituras |\n| 1022 | 2254 | Lojas de hobbies, brinquedos e jogos |\n| 1022 | 2258 | Papel de carta, de impressão e escrita |\n| 1022 | 2257 | Selos e moedas |\n| 1022 | 2260 | Videogames e sistemas |\n| 1022 | 2259 | Vintage e artigos de colecionadores |\n| 1015 | 2145 | Antiguidades |\n| 1015 | 2146 | Aparelhos |\n| 1015 | 2148 | Cama e banho |\n| 1015 | 2150 | Cortinas e tapeçaria |\n| 1015 | 2157 | Decoração residencial |\n| 1015 | 2162 | Equipamentos de segurança e vigilância |\n| 1015 | 2152 | Lareiras e telas para lareira |\n| 1015 | 2147 | Marchands e galerias |\n| 1015 | 2149 | Material de construção |\n| 1015 | 2156 | Máquinas e ferramentas |\n| 1015 | 2153 | Móveis |\n| 1015 | 2160 | Paisagismo |\n| 1015 | 2163 | Piscinas e spas |\n| 1015 | 2151 | Serviços de exterminação de pragas e desinfecção |\n| 1015 | 2154 | Suprimentos para jardim |\n| 1015 | 2161 | Tapetes e carpetes |\n| 1015 | 2159 | Utensílios de cozinha |\n| 1015 | 2158 | Utensílios domésticos |\n| 1015 | 2155 | Vidro, tinta e papel de parede |\n| 1006 | 2057 | Computadores e serviços de processamento de dados |\n| 1006 | 2059 | Conteúdo digital |\n| 1006 | 2058 | Desktops, laptops e notebooks |\n| 1006 | 2069 | Hospedagem e design para a Web |\n| 1006 | 2064 | Jogo online |\n| 1006 | 2062 | Monitores e projetores |\n| 1006 | 2066 | Periféricos |\n| 1006 | 2065 | Peças e acessórios |\n| 1006 | 2063 | Rede de comunicação |\n| 1006 | 2060 | Serviços de Comércio eletrônico |\n| 1006 | 2061 | Serviços de reparo e manutenção |\n| 1006 | 2068 | Serviços de treinamento |\n| 1006 | 2067 | Software |\n| 1004 | 2027 | Agrícola |\n| 1004 | 2047 | Atacado |\n| 1004 | 2031 | Construção |\n| 1004 | 2025 | Contabilidade |\n| 1004 | 2043 | Editoração e impressão |\n| 1004 | 2045 | Embalagem e envio |\n| 1004 | 2030 | Fotografia comercial, arte e gráficos |\n| 1004 | 2038 | Mala direta |\n| 1004 | 2039 | Marketing |\n| 1004 | 2040 | Marketing em vários níveis |\n| 1004 | 2041 | Móveis de escritório e comerciais |\n| 1004 | 2029 | Produtos químicos e assemelhados |\n| 1004 | 2026 | Propaganda |\n| 1004 | 2028 | Serviços de arquitetura, engenharia e prospecção |\n| 1004 | 2032 | Serviços de consultoria |\n| 1004 | 2044 | Serviços de cópia rápida e reprodução |\n| 1004 | 2046 | Serviços de estenografia e de secretaria |\n| 1004 | 2034 | Serviços de leasing e locação de equipamentos |\n| 1004 | 2036 | Serviços de recrutamento e seleção |\n| 1004 | 2035 | Serviços de reparo de equipamentos |\n| 1004 | 2033 | Serviços educacionais |\n| 1004 | 2042 | Suprimentos e equipamento de escritório |\n| 1004 | 2037 | Suprimentos industriais e de produção |\n| 1007 | 2073 | Academias, estúdios e escolas de dança |\n| 1007 | 2070 | Escolas comerciais e secretariais |\n| 1007 | 2074 | Escolas de ensino fundamental e médio |\n| 1007 | 2075 | Escolas vocacionais e de comércio |\n| 1007 | 2072 | Faculdades e universidades |\n| 1007 | 2071 | Serviços de cuidados infantis diários |\n| 1008 | 2079 | Acessórios eletrônicos em geral |\n| 1008 | 2085 | Cartões telefônicos |\n| 1008 | 2076 | Câmeras, camcorders e equipamentos |\n| 1008 | 2081 | Eletrônicos residenciais |\n| 1008 | 2083 | Equipamento de telecomunicações e vendas |\n| 1008 | 2082 | Segurança e vigilância |\n| 1008 | 2084 | Serviços de telecomunicação |\n| 1008 | 2077 | Som de carro e eletrônicos |\n| 1008 | 2078 | Telefones celulares, PDAs e pagers |\n| 1008 | 2080 | Áudio residencial |\n| 1009 | 2097 | Animadores de programas |\n| 1009 | 2094 | Brinquedos e jogos |\n| 1009 | 2095 | Caça níqueis |\n| 1009 | 2096 | Conteúdo digital |\n| 1009 | 2091 | Conteúdo digital adulto |\n| 1009 | 2088 | Filmes - DVDs, fitas de vídeo |\n| 1009 | 2087 | Ingressos de cinema |\n| 1009 | 2093 | Ingressos de teatro |\n| 1009 | 2092 | Ingressos para shows |\n| 1009 | 2098 | Jogo |\n| 1009 | 2099 | Jogos online |\n| 1009 | 2086 | Lembranças |\n| 1009 | 2089 | Música - CDs, cassetes e álbuns |\n| 1009 | 2090 | TV e rádio a cabo, por satélite e outros tipos pagos |\n| 1009 | 2100 | Videogames e sistemas |\n| 1021 | 2241 | Academias, estúdios e escolas de dança |\n| 1021 | 2244 | Acessórios de armas de fogo |\n| 1021 | 2248 | Armas de artes marciais |\n| 1021 | 2245 | Armas de fogo |\n| 1021 | 2237 | Calçados esportivos |\n| 1021 | 2240 | Camping e atividades ao ar livre |\n| 1021 | 2246 | Caça |\n| 1021 | 2243 | Engrenagem de relógio |\n| 1021 | 2250 | Equipamento esportivo |\n| 1021 | 2242 | Exercícios e condicionamento físico |\n| 1021 | 2247 | Facas |\n| 1021 | 2249 | Jogos e brinquedos esportivos |\n| 1021 | 2238 | Loja, serviço e reparo de bicicletas |\n| 1021 | 2251 | Piscinas e spas |\n| 1021 | 2239 | Remo, vela e acessórios |\n| 1013 | 2137 | Serviços governamentais (não classificado em nenhum outro lugar) |\n| 1003 | 2019 | Conteúdo digital |\n| 1003 | 2023 | Editoração e impressão |\n| 1003 | 2021 | Ficção e não ficção |\n| 1003 | 2020 | Livros de texto e educativos |\n| 1003 | 2018 | Livros em áudio |\n| 1003 | 2024 | Livros raros e usados |\n| 1003 | 2022 | Revistas |\n| 1012 | 2134 | Comidas de gourmet |\n| 1012 | 2132 | Floristas |\n| 1012 | 2133 | Lojas de presentes, cartões, novidades e lembranças |\n| 1012 | 2136 | Suprimentos para festas |\n| 1012 | 2135 | Viveiro de plantas e flores |\n| 1018 | 2176 | Mercadoria |\n| 1018 | 2177 | Serviços (não classificados em nenhum outro lugar) |\n| 1018 | 2175 | Serviços de associação |\n| 1014 | 2141 | Assistência médica |\n| 1014 | 2140 | Cuidados dentários |\n| 1014 | 2142 | Equipamentos e suprimentos médicos |\n| 1014 | 2138 | Farmácia (exceto prescrição de medicamentos) |\n| 1014 | 2139 | Farmácia (inclusive prescrição de medicamentos) |\n| 1014 | 2143 | Oftalmologia |\n| 1014 | 2144 | Vitaminas e suplementos |\n| 1016 | 2169 | Educacional |\n| 1016 | 2164 | Entidade assistencial |\n| 1016 | 2167 | Outro |\n| 1016 | 2168 | Pessoal |\n| 1016 | 2165 | Político |\n| 1016 | 2166 | Religioso |\n| 1025 | 2297 | Acessórios |\n| 1025 | 2296 | Aluguel de caminhões e trailers utilitários |\n| 1025 | 2293 | Aluguel de trailers e veículos recreativos |\n| 1025 | 2291 | Aluguel e leasing de barcos |\n| 1025 | 2294 | Ferramentas e equipamentos |\n| 1025 | 2292 | Lavagem de carros |\n| 1025 | 2288 | Locação de carros |\n| 1025 | 2284 | Peças e suprimentos novos - veículo motor |\n| 1025 | 2285 | Peças usadas - veículo motor |\n| 1025 | 2287 | Reparo e pintura de autos |\n| 1025 | 2295 | Serviço de guincho |\n| 1025 | 2289 | Serviços de autos |\n| 1025 | 2290 | Suprimento e serviços de pneus automotivos |\n| 1025 | 2286 | Áudio e vídeo |\n| 1020 | 2232 | Ajustes e alterações |\n| 1020 | 2216 | Assistência médica |\n| 1020 | 2188 | Carpintaria |\n| 1020 | 2217 | Clubes e organizações de associados |\n| 1020 | 2192 | Computadores e serviços de processamento de dados |\n| 1020 | 2225 | Conserto de rádios, televisores e estéreo |\n| 1020 | 2226 | Corretor de imóveis |\n| 1020 | 2197 | Cuidados dentários |\n| 1020 | 2205 | Desenho gráfico e comercial |\n| 1020 | 2230 | Embalagem e envio |\n| 1020 | 2204 | Empreiteiros em geral |\n| 1020 | 2220 | Encontros online |\n| 1020 | 2200 | Entretenimento |\n| 1020 | 2222 | Estúdios fotográficos - retratos |\n| 1020 | 2221 | Fotoacabamento |\n| 1020 | 2191 | Fotografia comercial |\n| 1020 | 2227 | Gerenciamento de locação de imóvel |\n| 1020 | 2207 | Identidades, certidões e passaportes |\n| 1020 | 2208 | Importação e exportação |\n| 1020 | 2203 | Jogo |\n| 1020 | 2190 | Limpeza e manutenção |\n| 1020 | 2215 | Loterias e concursos |\n| 1020 | 2218 | Misc. publicação e impressão |\n| 1020 | 2219 | Mudança e depósito |\n| 1020 | 2235 | Oftalmologia |\n| 1020 | 2212 | Paisagismo e horticultura |\n| 1020 | 2202 | Planejamento de eventos e casamentos |\n| 1020 | 2185 | Propaganda |\n| 1020 | 2199 | Reparo de dispositivos pequenos e elétricos |\n| 1020 | 2228 | Reparos de móveis e estofamento |\n| 1020 | 2236 | Reparos de relógios e joias |\n| 1020 | 2210 | Seguros - auto e residência |\n| 1020 | 2211 | Seguros - vida e anuidade |\n| 1020 | 2214 | Serviço de entrega local |\n| 1020 | 2233 | Serviço de telecomunicação |\n| 1020 | 2229 | Serviços (não classificados em nenhum outro lugar) |\n| 1020 | 2198 | Serviços de Comércio eletrônico |\n| 1020 | 2195 | Serviços de aconselhamento |\n| 1020 | 2187 | Serviços de carreira |\n| 1020 | 2194 | Serviços de consultoria |\n| 1020 | 2189 | Serviços de cuidados com crianças |\n| 1020 | 2224 | Serviços de cópia rápida e reprodução |\n| 1020 | 2196 | Serviços de entregas |\n| 1020 | 2201 | Serviços de leasing e locação de equipamentos |\n| 1020 | 2231 | Serviços de piscinas |\n| 1020 | 2223 | Serviços de proteção e segurança |\n| 1020 | 2209 | Serviços de recuperação de informações |\n| 1020 | 2193 | Serviços de rede de computador |\n| 1020 | 2186 | Serviços e clubes de compras |\n| 1020 | 2213 | Serviços jurídicos e advogados |\n| 1020 | 2206 | Spas de saúde e beleza |\n| 1020 | 2234 | Utilitários |\n| 1010 | 2122 | Agentes e corretores de títulos |\n| 1010 | 2115 | Agentes ou corretores de hipotecas |\n| 1010 | 2103 | Bolsa de commodities e futuros |\n| 1010 | 2118 | Cartões de valores pré-pagos e armazenados |\n| 1010 | 2109 | Companhia financeira |\n| 1010 | 2110 | Consultoria financeira e de investimentos |\n| 1010 | 2101 | Contabilidade |\n| 1010 | 2106 | Cooperativa de crédito |\n| 1010 | 2119 | Corretor de imóveis |\n| 1010 | 2107 | Corretores e câmbio |\n| 1010 | 2108 | Custódia de títulos |\n| 1010 | 2114 | Empresa de serviços financeiros |\n| 1010 | 2104 | Empresas de informação de crédito de consumidor |\n| 1010 | 2120 | Entrega |\n| 1010 | 2102 | Escritório de cobrança |\n| 1010 | 2121 | Gerenciamento de locação de imóvel |\n| 1010 | 2113 | Investimentos - geral |\n| 1010 | 2116 | Moeda de jogo online |\n| 1010 | 2117 | Pagamento antecipado ou empréstimo contra salário |\n| 1010 | 2111 | Seguros - auto e residência |\n| 1010 | 2112 | Seguros - vida e anuidade |\n| 1010 | 2105 | Serviço de orientação sobre débitos |\n| 1010 | 2123 | Transferência eletrônica e ordem de pagamento |\n| 1019 | 2181 | Bens duráveis |\n| 1019 | 2182 | Bens não duráveis |\n| 1019 | 2179 | Loja de departamentos |\n| 1019 | 2180 | Loja de descontos |\n| 1019 | 2183 | Loja de usados e segunda mão |\n| 1019 | 2184 | Loja de variedades |\n| 1019 | 2178 | Produtos químicos e assemelhados |\n| 1011 | 2124 | Bebidas alcoólicas |\n| 1011 | 2126 | Café e chá |\n| 1011 | 2127 | Comidas de gourmet |\n| 1011 | 2130 | Fumo |\n| 1011 | 2128 | Lojas de alimentos variados e especialidades |\n| 1011 | 2129 | Restaurante |\n| 1011 | 2125 | Serviços de bufê |\n| 1011 | 2131 | Vitaminas e suplementos |\n| 1024 | 2277 | Aviação |\n| 1024 | 2283 | Vintage e artigos de colecionadores |\n| 1024 | 2275 | vendedor de autos - novos e usados |\n| 1024 | 2276 | vendedor de autos - somente usados |\n| 1024 | 2278 | vendedor de barcos |\n| 1024 | 2280 | vendedor de motocicletas |\n| 1024 | 2279 | vendedor de trailers |\n| 1024 | 2281 | vendedor de trailers utilitários e recreativos |\n| 1024 | 2282 | vendedor de veículos recreativos |\n| 1005 | 2053 | Acessórios |\n| 1005 | 2055 | Atacado - pedras e metais preciosos |\n| 1005 | 2056 | Joalheria da moda |\n| 1005 | 2050 | Roupas femininas |\n| 1005 | 2048 | Roupas infantis |\n| 1005 | 2049 | Roupas masculinas |\n| 1005 | 2051 | Sapatos |\n| 1005 | 2052 | Uniformes de serviço militar e civil |\n| 1005 | 2054 | Varejo - joalheria fina e relógios |\n| 1023 | 2268 | Acampamento de esportes e recreação |\n| 1023 | 2274 | Agência de viagens |\n| 1023 | 2264 | Cruzeiros |\n| 1023 | 2265 | Hospedagem e acomodações |\n| 1023 | 2261 | Linha aérea |\n| 1023 | 2263 | Linha de ônibus |\n| 1023 | 2262 | Locação de carros |\n| 1023 | 2266 | Malas e mercadorias em couro |\n| 1023 | 2272 | Parques ou acampamentos de trailers |\n| 1023 | 2270 | Propriedades de lazer compartilhado |\n| 1023 | 2267 | Serviços de recreação |\n| 1023 | 2273 | Serviços de transporte - outros |\n| 1023 | 2269 | Táxis e limusines |\n| 1023 | 2271 | Viagens |", "enum": [ null, 2173, 2171, 2172, 2174, 2000, 2004, 2007, 2003, 2005, 2006, 2002, 2009, 2008, 2001, 2010, 2012, 2013, 2014, 2011, 2015, 2016, 2017, 2252, 2253, 2255, 2256, 2254, 2258, 2257, 2260, 2259, 2145, 2146, 2148, 2150, 2157, 2162, 2152, 2147, 2149, 2156, 2153, 2160, 2163, 2151, 2154, 2161, 2159, 2158, 2155, 2057, 2059, 2058, 2069, 2064, 2062, 2066, 2065, 2063, 2060, 2061, 2068, 2067, 2027, 2047, 2031, 2025, 2043, 2045, 2030, 2038, 2039, 2040, 2041, 2029, 2026, 2028, 2032, 2044, 2046, 2034, 2036, 2035, 2033, 2042, 2037, 2073, 2070, 2074, 2075, 2072, 2071, 2079, 2085, 2076, 2081, 2083, 2082, 2084, 2077, 2078, 2080, 2097, 2094, 2095, 2096, 2091, 2088, 2087, 2093, 2092, 2098, 2099, 2086, 2089, 2090, 2100, 2241, 2244, 2248, 2245, 2237, 2240, 2246, 2243, 2250, 2242, 2247, 2249, 2238, 2251, 2239, 2137, 2019, 2023, 2021, 2020, 2018, 2024, 2022, 2134, 2132, 2133, 2136, 2135, 2176, 2177, 2175, 2141, 2140, 2142, 2138, 2139, 2143, 2144, 2169, 2164, 2167, 2168, 2165, 2166, 2297, 2296, 2293, 2291, 2294, 2292, 2288, 2284, 2285, 2287, 2295, 2289, 2290, 2286, 2232, 2216, 2188, 2217, 2192, 2225, 2226, 2197, 2205, 2230, 2204, 2220, 2200, 2222, 2221, 2191, 2227, 2207, 2208, 2203, 2190, 2215, 2218, 2219, 2235, 2212, 2202, 2185, 2199, 2228, 2236, 2210, 2211, 2214, 2233, 2229, 2198, 2195, 2187, 2194, 2189, 2224, 2196, 2201, 2231, 2223, 2209, 2193, 2186, 2213, 2206, 2234, 2122, 2115, 2103, 2118, 2109, 2110, 2101, 2106, 2119, 2107, 2108, 2114, 2104, 2120, 2102, 2121, 2113, 2116, 2117, 2111, 2112, 2105, 2123, 2181, 2182, 2179, 2180, 2183, 2184, 2178, 2124, 2126, 2127, 2130, 2128, 2129, 2125, 2131, 2277, 2283, 2275, 2276, 2278, 2280, 2279, 2281, 2282, 2053, 2055, 2056, 2050, 2048, 2049, 2051, 2052, 2054, 2268, 2274, 2264, 2265, 2261, 2263, 2262, 2266, 2272, 2270, 2267, 2273, 2269, 2271 ] }, "business_website": { "type": "string", "nullable": true, "description": "Website", "example": null }, "business_name": { "type": "string", "nullable": true, "description": "Nome Fantasia", "example": null }, "business_type": { "type": "string", "nullable": true, "description": "Tipo da Empresa:\n* `mei` Microempreendedor Individual\n* `individual` Micro Empresa/Empresa de pequeno porte\n* `proprietorship` Sociedade Empresária Limitada\n* `partnership` Sociedade Anônima de Capital Fechado\n* `corporation` Sociedade Anônima de Capital Aberto\n* `nonprofit` Sem fins lucrativos\n* `government` Governamental", "enum": [ null, "mei", "individual", "proprietorship", "partnership", "corporation", "nonprofit", "government" ] }, "mother_name": { "type": "string", "nullable": true, "description": "Nome da Mãe", "example": null }, "father_name": { "type": "string", "nullable": true, "description": "Nome do Pai", "example": null }, "configuration": { "type": "string", "format": "json", "readOnly": true, "nullable": true, "description": "Configuração de dados padrões para boleto", "example": null }, "api_access_token": { "type": "string", "readOnly": true, "nullable": true, "description": "Token de acesso da subconta", "example": null }, "created_via_api": { "type": "boolean", "readOnly": true, "nullable": true, "description": "Indica se o registro foi criado pela API", "example": null }, "billing_email": { "type": "string", "nullable": true, "description": "E-mail de cobrança", "example": null }, "simple_opting": { "type": "boolean", "nullable": true, "description": "Optante pelo simples", "example": null }, "rate_limits": { "type": "object", "readOnly": true, "nullable": true, "description": "Limites de requisições - Hash com chave e valor no formato JSON.", "example": null } } }, "v2_certificate": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID", "deprecated": true }, "uid": { "type": "string", "readOnly": true, "format": "uuid", "description": "UID do Certificado", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "account_id": { "type": "integer", "readOnly": true, "description": "ID da Conta" }, "label": { "type": "string", "nullable": true, "maxLength": 255, "description": "Nome dado ao certificado", "example": "Meu Certificado" }, "subaccounts": { "type": "boolean", "nullable": true, "description": "Indica se o certificado está liberado para uso nas subcontas" }, "common_name": { "type": "string", "nullable": true, "maxLength": 255, "description": "Nome comum", "example": null }, "issuer": { "type": "string", "nullable": true, "maxLength": 255, "description": "Emissor", "example": null }, "cnpj_cpf": { "type": "string", "maxLength": 20, "description": "CPF/CNPJ", "example": "16.974.923/0001-84" }, "created_via_api": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se o registro foi criado por API" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do registro" }, "expiration_date": { "type": "string", "format": "date", "nullable": true, "readOnly": true, "description": "Data de expiração do certificado" }, "status": { "type": "string", "readOnly": true, "description": "Status do certificado:\n* `draft` Rascunho\n* `validated` Válido\n* `expired` Expirado", "enum": [ "draft", "validated", "expired" ] }, "created_by": { "type": "string", "readOnly": true, "description": "Criado por:\n* `user` Cliente\n* `system` Sistema", "enum": [ "user", "system" ] } } }, "v2_certificate_create": { "type": "object", "required": [ "label", "cnpj_cpf", "type", "files" ], "properties": { "label": { "type": "string", "nullable": true, "maxLength": 255, "description": "Nome dado ao certificado", "example": "Meu Certificado" }, "cnpj_cpf": { "type": "string", "maxLength": 20, "description": "CPF/CNPJ", "example": "16.974.923/0001-84" }, "subaccounts": { "type": "boolean", "nullable": true, "description": "Indica se o certificado está liberado para uso nas subcontas" }, "type": { "type": "string", "description": "Tipo do certificado:\nSe o tipo do certificado for `CRT` é obrigatório enviar o `crt_file` e o `crt_private_key_file`, se o tipo for `PFX` é obrigatório `pfx_file` e `pfx_password`.\n\n* `crt` CRT\n* `pfx` PFX", "enum": [ "crt", "pfx" ] }, "files": { "type": "object", "description": "Arquivo do certificado e senha.\nSe o tipo do certificado for `CRT` é obrigatório enviar o `crt_file` e o `crt_private_key_file`, se o tipo for `PFX` é obrigatório `pfx_file` e `pfx_password`.", "properties": { "crt_file": { "type": "string", "format": "binary", "description": "Arquivo .cer/.crt" }, "crt_private_key_file": { "type": "string", "format": "binary", "description": "Arquivo .key para certificado `crt`" }, "pfx_file": { "type": "string", "format": "binary", "description": "Arquivo .p12/.pfx" }, "pfx_password": { "type": "string", "format": "password", "description": "Senha do certificado para certificado `pfx`" } } } } }, "v2_transaction": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do transação" }, "uid": { "type": "string", "readOnly": true, "description": "UID da transação" }, "financial_provider_external_id": { "type": "string", "readOnly": true, "description": "ID da transação no provedor financeiro" }, "amount": { "type": "number", "description": "Valor da transação" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "Data de criação da transação" }, "description": { "type": "string", "description": "Descrição da transação" }, "kind": { "type": "string", "description": "Tipo da transação" }, "processed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Data de processamento da transação" }, "sent_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Data de envio da transação" }, "status": { "type": "string", "description": "Status da transação" }, "credit_at": { "type": "string", "format": "date", "nullable": true, "description": "Data de crédito da transação" } } }, "v2_connection": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "description": "UID da Conexão", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "label": { "type": "string", "description": "Nome da Conexão", "nullable": true }, "provider_slug": { "type": "string", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n" }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais.\n" }, "certificate_uid": { "type": "string", "format": "uuid", "example": "018df180-7208-727b-a10a-ea545e4a75a8", "nullable": true, "description": "UID do Certificado." }, "keypair_uid": { "type": "string", "format": "uuid", "example": "018df180-7208-727b-a10a-ea545e4a75a8", "nullable": true, "description": "UID do Keypair." }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e Hora de Criação do Registro" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e Hora da Última Atualização do Registro" }, "enabled_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e Hora de Ativação da Conexão" }, "validated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e Hora de Validação da Conexão" }, "validate_failed_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e Hora da última falha de validação/provisionamento da Conexão. Distingue \"ainda não validada\" de \"falhou e não muda sozinha\"." }, "association_failures": { "type": "array", "readOnly": true, "description": "Recursos que o provedor recusou no último provisionamento. Reenviar a mesma chamada de associação completa o que faltou, sem repetir o que já foi feito.", "items": { "type": "object", "properties": { "slug": { "type": "string", "description": "Slug do recurso recusado" }, "uid": { "type": "string", "description": "UID do recurso recusado" }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Mensagens do provedor" } } } }, "associations": { "type": "array", "readOnly": true, "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n" } } }, "v2_connection_update": { "type": "object", "properties": { "label": { "type": "string", "description": "Nome da Conexão", "nullable": true }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Esse campo será ignorado no nosso ambiente de Sandbox\n" }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais.\n" }, "certificate_uid": { "type": "string", "format": "uuid", "example": "018df180-7208-727b-a10a-ea545e4a75a8", "nullable": true, "description": "UUID do Certificado." }, "keypair_uid": { "type": "string", "format": "uuid", "example": "018df180-7208-727b-a10a-ea545e4a75a8", "nullable": true, "description": "UUID do Par de Chaves." }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": null, "example": null }, "revalidate": { "type": "boolean", "nullable": true, "description": "Revalida as credenciais no provedor financeiro. Se passado true, a conexão só será alterada se as credenciais e permissões forem válidas.", "default": false, "example": true } } }, "v2_association": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "v2_command": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Comando." }, "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "Identificador público (UUID) do Comando. Utilizado como parâmetro na consulta individual (`GET /commands/{uid}`)." }, "status": { "type": "string", "readOnly": true, "description": "Status do comando.\n\n`pending`: Comando ainda não executado. [Estado inicial]\n`confirmed`: Comando executado e confirmado.\n`failed`: Execução do comando falhou.\n" }, "operation": { "type": "string", "readOnly": true, "description": "Tipo da operação.\n\n`register`: Registro.\n`cancel`: Cancelamento.\n`update`: Alteração.\n`add`: Inclusão.\n`remove`: Exclusão.\n`approve`: Liberação.\n`reprove`: Rejeição.\n`reschedule`: Reagendamento.\n`add_pix`: Adicionar Pix ao Boleto.\n`protest`: Protesto.\n`unregister`: Desregistro.\n`refund`: Devolução.\n`retry`: Reenvio.\n" }, "resource_type": { "type": "string", "readOnly": true, "nullable": true, "description": "Tipo do recurso ao qual o Comando pertence (ex.: `BankBillet`, `Pix`, `Financial::Account`)." }, "resource_uid": { "type": "string", "format": "uuid", "readOnly": true, "nullable": true, "description": "Identificador público (UUID) do recurso ao qual o Comando pertence." }, "financial_provider_slug": { "type": "string", "readOnly": true, "nullable": true, "description": "Slug do provedor financeiro (banco) responsável pela execução do Comando." }, "params": { "type": "object", "readOnly": true, "nullable": true, "description": "Parâmetros para a execução do Comando." }, "payload": { "type": "object", "readOnly": true, "nullable": true, "description": "Resposta do servidor com o resultado da operação." }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da criação do registro do Comando" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da atualização do registro do Comando." }, "confirmation_via": { "type": "string", "enum": [ "api", "edi" ], "readOnly": true, "nullable": true, "description": "Origem da confirmação do Comando.\n\n`api`: confirmado via resposta da API do banco (inclui webhooks, Recuperator e sync).\n`edi`: confirmado via retorno CNAB (arquivo de baixa).\n`null`: Sem origem registrada.\n" } } }, "v2_new_connection_spc_1": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Spc", "nullable": true }, "provider_slug": { "type": "string", "default": "spc", "example": "spc", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "operator": { "type": "string", "description": "Operador" }, "password": { "type": "string", "description": "Senha" } } }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_unicred_1": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Unicred", "nullable": true }, "provider_slug": { "type": "string", "default": "unicred", "example": "unicred", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "username": { "type": "string", "description": "Usuário" }, "password": { "type": "string", "description": "Senha" }, "cooperative": { "type": "string", "description": "Cooperativa" }, "beneficiary_id": { "type": "string", "description": "ID Beneficiário" }, "variation": { "type": "string", "description": "Variação Carteira" } } }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_uniprime_1": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Uniprime", "nullable": true }, "provider_slug": { "type": "string", "default": "uniprime", "example": "uniprime", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "general_access_key": { "type": "string", "description": "Chave de acesso geral" }, "account_access_key": { "type": "string", "description": "Chave de acesso da conta" } } }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_uniprime99_1": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Uniprime99", "nullable": true }, "provider_slug": { "type": "string", "default": "uniprime99", "example": "uniprime99", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "general_access_key": { "type": "string", "description": "Chave de acesso geral" }, "account_access_key": { "type": "string", "description": "Chave de acesso da conta" } } }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_abc_1": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Abc", "nullable": true }, "provider_slug": { "type": "string", "default": "abc", "example": "abc", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "client_secret": { "type": "string", "description": "Client Secret" }, "username": { "type": "string", "description": "Username" }, "password": { "type": "string", "description": "Password" }, "codigo_empresa": { "type": "string", "description": "Código da Empresa" } } }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_abc_2": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Abc", "nullable": true }, "provider_slug": { "type": "string", "default": "abc", "example": "abc", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "client_secret": { "type": "string", "description": "Client Secret" } } }, "certificate_uid": { "type": "string", "format": "uuid", "example": "018df180-7208-727b-a10a-ea545e4a75a8", "nullable": true, "description": "UID do Certificado.\n\n*Obrigatório caso no campo `apis` seja passado alguma das opções:\n`charge/pix`: Pix\n" }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_ailos_1": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Ailos", "nullable": true }, "provider_slug": { "type": "string", "default": "ailos", "example": "ailos", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": {} }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_asaas_1": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Asaas", "nullable": true }, "provider_slug": { "type": "string", "default": "asaas", "example": "asaas", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "access_token": { "type": "string", "description": "Access Token" } } }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_banrisul_1": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Banrisul", "nullable": true }, "provider_slug": { "type": "string", "default": "banrisul", "example": "banrisul", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "client_secret": { "type": "string", "description": "Client Secret" } } }, "certificate_uid": { "type": "string", "format": "uuid", "example": "018df180-7208-727b-a10a-ea545e4a75a8", "nullable": true, "description": "UID do Certificado.\n\n*Obrigatório caso no campo `apis` seja passado alguma das opções:\n`charge/pix`: Pix\n" }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_bb_2": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Bb", "nullable": true }, "provider_slug": { "type": "string", "default": "bb", "example": "bb", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "client_secret": { "type": "string", "description": "Client Secret" }, "application_key": { "type": "string", "description": "Application key" } } }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_bradesco_1": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Bradesco", "nullable": true }, "provider_slug": { "type": "string", "default": "bradesco", "example": "bradesco", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": {} }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_bradesco_2": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Bradesco", "nullable": true }, "provider_slug": { "type": "string", "default": "bradesco", "example": "bradesco", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "client_secret": { "type": "string", "description": "Client Secret" } } }, "certificate_uid": { "type": "string", "format": "uuid", "example": "018df180-7208-727b-a10a-ea545e4a75a8", "nullable": true, "description": "UID do Certificado.\n\n*Obrigatório caso no campo `apis` seja passado alguma das opções:\n`charge/pix`: Pix.\n`transfer`: Transferência Pix\n" }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_bradesco_4": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Bradesco", "nullable": true }, "provider_slug": { "type": "string", "default": "bradesco", "example": "bradesco", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "client_secret": { "type": "string", "description": "Client Secret" } } }, "certificate_uid": { "type": "string", "format": "uuid", "example": "018df180-7208-727b-a10a-ea545e4a75a8", "nullable": true, "description": "UID do Certificado.\n\n*Obrigatório caso no campo `apis` seja passado alguma das opções:\n`charge/bank_billet`: Boleto.\n`statement`: Extrato.\n`transfer`: Transferência/Pagamentos.\n`payment`: Pagamento\n" }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_btg_1": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Btg", "nullable": true }, "provider_slug": { "type": "string", "default": "btg", "example": "btg", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "client_secret": { "type": "string", "description": "Client Secret" } } }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_btg_enterprise_1": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "BtgEnterprise", "nullable": true }, "provider_slug": { "type": "string", "default": "btg_enterprise", "example": "btg_enterprise", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "client_secret": { "type": "string", "description": "Client Secret" }, "account_id": { "type": "string", "description": "Account ID" } } }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_bv_1": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Bv", "nullable": true }, "provider_slug": { "type": "string", "default": "bv", "example": "bv", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "client_secret": { "type": "string", "description": "Client Secret" } } }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_c6_1": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "C6", "nullable": true }, "provider_slug": { "type": "string", "default": "c6", "example": "c6", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "client_secret": { "type": "string", "description": "Client Secret" } } }, "certificate_uid": { "type": "string", "format": "uuid", "example": "018df180-7208-727b-a10a-ea545e4a75a8", "nullable": true, "description": "UID do Certificado.\n\n*Obrigatório caso no campo `apis` seja passado alguma das opções:\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix\n" }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_caixa_1": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Caixa", "nullable": true }, "provider_slug": { "type": "string", "default": "caixa", "example": "caixa", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": {} }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_cora_1": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Cora", "nullable": true }, "provider_slug": { "type": "string", "default": "cora", "example": "cora", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "client_id": { "type": "string", "description": "Client ID" } } }, "certificate_uid": { "type": "string", "format": "uuid", "example": "018df180-7208-727b-a10a-ea545e4a75a8", "nullable": true, "description": "UID do Certificado.\n\n*Obrigatório caso no campo `apis` seja passado alguma das opções:\n`charge/bank_billet`: Boleto.\n`charge/bank_billet`: Boleto V2\n" }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_cresol_1": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Cresol", "nullable": true }, "provider_slug": { "type": "string", "default": "cresol", "example": "cresol", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "username": { "type": "string", "description": "Nome do Usuário" }, "password": { "type": "string", "description": "Senha" }, "client_id": { "type": "string", "description": "ID do Cliente" }, "client_secret": { "type": "string", "description": "Chave de Acesso" } } }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_daycoval_1": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Daycoval", "nullable": true }, "provider_slug": { "type": "string", "default": "daycoval", "example": "daycoval", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "operator": { "type": "string", "description": "Operador" }, "password": { "type": "string", "description": "Senha" } } }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_digisac_1": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Digisac", "nullable": true }, "provider_slug": { "type": "string", "default": "digisac", "example": "digisac", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "base_host": { "type": "string", "description": "" }, "access_token": { "type": "string", "description": "" }, "service_id": { "type": "string", "description": "" } } }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_example_bank_1": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "ExampleBank", "nullable": true }, "provider_slug": { "type": "string", "default": "example_bank", "example": "example_bank", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "client_secret": { "type": "string", "description": "Client Secret" }, "username": { "type": "string", "description": "Username" } } }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_inter_2": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Inter", "nullable": true }, "provider_slug": { "type": "string", "default": "inter", "example": "inter", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "client_secret": { "type": "string", "description": "Client Secret" } } }, "certificate_uid": { "type": "string", "format": "uuid", "example": "018df180-7208-727b-a10a-ea545e4a75a8", "nullable": true, "description": "UID do Certificado.\n\n*Obrigatório caso no campo `apis` seja passado alguma das opções:\n`charge/bank_billet`: Boleto.\n`charge/bank_billet`: Boleto V3.\n`charge/pix`: Pix.\n`statement`: Extrato.\n`payment`: Pagamento.\n`transfer`: Transferência/Pagamentos\n" }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_itau_2": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Itau", "nullable": true }, "provider_slug": { "type": "string", "default": "itau", "example": "itau", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "client_secret": { "type": "string", "description": "Client Secret" } } }, "keypair_uid": { "type": "string", "format": "uuid", "example": "018df180-7208-727b-a10a-ea545e4a75a8", "nullable": true, "description": "UID do Keypair." }, "certificate_uid": { "type": "string", "format": "uuid", "example": "018df180-7208-727b-a10a-ea545e4a75a8", "nullable": true, "description": "UID do Certificado.\n\n*Obrigatório caso no campo `apis` seja passado alguma das opções:\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`charge/automatic_pix`: Pix Automático.\n`transfer`: Transferência/Pagamentos.\n`payment`: Pagamento.\n`statement`: Extrato\n" }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_itau_3": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Itau", "nullable": true }, "provider_slug": { "type": "string", "default": "itau", "example": "itau", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "access_token_tmp": { "type": "string", "description": "Token Temporário Itaú" }, "session_key": { "type": "string", "description": "Chave de Sessão (AES)" } } }, "keypair_uid": { "type": "string", "format": "uuid", "example": "018df180-7208-727b-a10a-ea545e4a75a8", "nullable": true, "description": "UID do Keypair." }, "certificate_uid": { "type": "string", "format": "uuid", "example": "018df180-7208-727b-a10a-ea545e4a75a8", "nullable": true, "description": "UID do Certificado.\n\n*Obrigatório caso no campo `apis` seja passado alguma das opções:\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`charge/automatic_pix`: Pix Automático.\n`transfer`: Transferência/Pagamentos.\n`payment`: Pagamento.\n`statement`: Extrato\n" }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_pjbank_1": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Pjbank", "nullable": true }, "provider_slug": { "type": "string", "default": "pjbank", "example": "pjbank", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "credencial": { "type": "string", "description": "Credencial" }, "chave": { "type": "string", "description": "Chave" }, "webhook_chave": { "type": "string", "description": "Chave Webhook" } } }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_qitech_1": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Qitech", "nullable": true }, "provider_slug": { "type": "string", "default": "qitech", "example": "qitech", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "api_key": { "type": "string", "description": "Chave de Integração" } } }, "keypair_uid": { "type": "string", "format": "uuid", "example": "018df180-7208-727b-a10a-ea545e4a75a8", "nullable": true, "description": "UID do Keypair." }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_safra_1": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Safra", "nullable": true }, "provider_slug": { "type": "string", "default": "safra", "example": "safra", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "username": { "type": "string", "description": "Usuário" }, "password": { "type": "string", "description": "Senha" } } }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_safra_2": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Safra", "nullable": true }, "provider_slug": { "type": "string", "default": "safra", "example": "safra", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "client_secret": { "type": "string", "description": "cliente secret da credencial a ser usado" } } }, "certificate_uid": { "type": "string", "format": "uuid", "example": "018df180-7208-727b-a10a-ea545e4a75a8", "nullable": true, "description": "UID do Certificado.\n\n*Obrigatório caso no campo `apis` seja passado alguma das opções:\n`charge/pix`: Pix\n" }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_santander_1": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Santander", "nullable": true }, "provider_slug": { "type": "string", "default": "santander", "example": "santander", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "station_code": { "type": "string", "description": "Código de Estação" } } }, "certificate_uid": { "type": "string", "format": "uuid", "example": "018df180-7208-727b-a10a-ea545e4a75a8", "nullable": true, "description": "UID do Certificado.\n\n*Obrigatório caso no campo `apis` seja passado alguma das opções:\n`charge/bank_billet`: Boleto\n" }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_santander_2": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Santander", "nullable": true }, "provider_slug": { "type": "string", "default": "santander", "example": "santander", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "client_secret": { "type": "string", "description": "Client Secret" } } }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_santander_3": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Santander", "nullable": true }, "provider_slug": { "type": "string", "default": "santander", "example": "santander", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "client_secret": { "type": "string", "description": "Client Secret" } } }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_semear_1": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Semear", "nullable": true }, "provider_slug": { "type": "string", "default": "semear", "example": "semear", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "client_secret": { "type": "string", "description": "Client Secret" }, "user": { "type": "string", "description": "Usuário" }, "password": { "type": "string", "description": "Senha" }, "public_certificate": { "type": "string", "description": "Certificado público" } } }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_sicoob_2": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Sicoob", "nullable": true }, "provider_slug": { "type": "string", "default": "sicoob", "example": "sicoob", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "client_id": { "type": "string", "description": "Client ID" } } }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_sicredi_2": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Sicredi", "nullable": true }, "provider_slug": { "type": "string", "default": "sicredi", "example": "sicredi", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "client_secret": { "type": "string", "description": "Client Secret" } } }, "certificate_uid": { "type": "string", "format": "uuid", "example": "018df180-7208-727b-a10a-ea545e4a75a8", "nullable": true, "description": "UID do Certificado.\n\n*Obrigatório caso no campo `apis` seja passado alguma das opções:\n`charge/pix`: Pix.\n`transfer`: Transferência/Pagamentos.\n`payment`: Pagamento.\n`charge/automatic_pix`: Pix Automático\n" }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_new_connection_sicredi_3": { "type": "object", "required": [ "credentials", "provider_slug" ], "properties": { "label": { "type": "string", "description": "Nome da Conexão", "default": "Sicredi", "nullable": true }, "provider_slug": { "type": "string", "default": "sicredi", "example": "sicredi", "description": "Slug do provedor financeiro\n\n*Pode ser consultado no endpoint v2/financial/providers.\n" }, "environment": { "type": "string", "enum": [ "production", "homologation" ], "default": "production", "description": "Ambiente de conexão com o provedor financeiro.\n\n`production`: Produção.\n`homologation`: Homologação\n\n* Por motivos de segurança, esse campo será ignorado no nosso ambiente de Sandbox.\n" }, "enabled": { "type": "boolean", "nullable": true, "description": "Habilita conexão", "default": false, "example": null }, "apis": { "type": "array", "items": { "type": "string" }, "description": "APIs permitidas para o provedor financeiro.\n\n`charge/bank_billet`: Boleto.\n`charge/pix`: Pix.\n`payment`: Pagamento.\n`transfer`: Transferência\n" }, "credentials": { "type": "object", "description": "Credenciais usadas na autenticação e autorização junto ao provedor.", "properties": { "username": { "type": "string", "description": "Username" }, "password": { "type": "string", "description": "Password" }, "api_key": { "type": "string", "description": "Access Token" } } }, "associations": { "type": "array", "items": { "type": "object", "required": [ "resource" ], "properties": { "resource": { "type": "object", "required": [ "slug", "uid" ], "properties": { "slug": { "type": "string", "enum": [ "charge.bank_billet_account", "charge.pix_account", "charge.automatic_pix_account", "payment.account", "transfer.account", "statement.account" ], "description": "Tipo da conta de serviço associada.", "example": "charge.bank_billet_account" }, "uid": { "type": "string", "description": "UUID da conta de serviço associada.", "example": "14a31e1b-6fa5-4825-8e54-61579842d520" } } } } }, "description": " Contas de serviço associadas.\n\n`charge.bank_billet_account`: Carteira de Boleto.\n`charge.pix_account`: Conta Pix.\n`payment.account`: Conta de Pagamento.\n`transfer.account`: Conta de Transferência.\n`statement.account`: Conta de Extrato\n\n*Observação sobre `charge.pix_account`*: por padrão a validação da chave Pix no PSP é síncrona — falhas retornam `422`. Em algumas contas a validação ocorre em background; nesse caso a resposta `201` é retornada antes de a validação concluir — acompanhe o resultado via `validated_at` e `enabled_at` na PixAccount.\n\n*Observação sobre `payment.account` e `transfer.account`*: a validação junto ao provedor é síncrona — a associação já está feita quando a resposta `201` retorna, e falhas retornam `422` com a mensagem do provedor.\n" } } }, "v2_transfer_account": { "type": "object", "properties": { "uid": { "type": "string", "readOnly": true, "description": "UUID da conta de transferência", "example": "e596865f-07a4-4458-88c1-fbb4ffd196e1" }, "financial_account_uid": { "type": "string", "readOnly": true, "description": "UUID da conta financeira associada", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "connection_uid": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true, "description": "Conexão bancária da conta.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "agreement_code": { "type": "string", "nullable": true, "description": "Código do convênio", "example": "123456" }, "provider_data": { "type": "object", "nullable": true, "description": "Dados específicos do provider. Para Sicoob, expõe `service_point_number` e `cooperative_cnpj`.", "properties": { "service_point_number": { "type": "string", "nullable": true, "description": "Número do ponto de atendimento. Envie `null` para limpar o valor.", "example": "0001" }, "cooperative_cnpj": { "type": "string", "nullable": true, "description": "CNPJ da cooperativa Sicoob do titular da conta.", "example": "13.009.717/0001-46" } } }, "external_id": { "type": "string", "nullable": true, "description": "Identificador externo da conta de transferência", "example": "external-transfer-123" }, "balance_validation_enabled_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora em que a validação de saldo foi habilitada" }, "remittance_enabled_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora em que a remessa EDI foi habilitada" }, "remittance_enabled": { "type": "boolean", "writeOnly": true, "description": "Habilita ou desabilita a geração de remessas EDI para esta conta." }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data e hora da última atualização do registro" } } }, "v2_new_transfer_account": { "type": "object", "description": "Cria uma conta de transferência sob uma conta financeira.", "required": [ "financial_account_uid" ], "properties": { "financial_account_uid": { "type": "string", "description": "UUID da Conta Financeira que receberá a nova conta de transferência", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "agreement_code": { "type": "string", "nullable": true, "description": "Código do convênio (até 30 caracteres)", "example": "123456" }, "external_id": { "type": "string", "nullable": true, "description": "Identificador externo da conta de transferência", "example": "external-transfer-123" }, "remittance_enabled": { "type": "boolean", "nullable": true, "description": "Habilita ou desabilita a geração de remessas EDI para esta conta. Se omitido na criação, herda automaticamente `true` quando a conta financeira já possui um EdiBox de pagamento ativo (carta EDI validada e habilitada); caso contrário, nasce `false`. Enviar `null` explicitamente equivale a `false` (desabilita e não aciona a herança automática)." }, "provider_data": { "type": "object", "nullable": true, "description": "Atributos específicos do provider bancário.", "properties": { "service_point_number": { "type": "string", "nullable": true, "description": "Número do ponto de atendimento (ex.: `numeroPa` no Sicoob).", "example": "0001" }, "cooperative_cnpj": { "type": "string", "nullable": true, "description": "CNPJ da cooperativa Sicoob do titular da conta.", "example": "13.009.717/0001-46" } } } } }, "v2_transfer": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID da Transferência" }, "status": { "readOnly": true, "type": "string", "description": "Status.\n`pending`: Pendente. [Estado Inicial]\n`awaiting_approval`: Aguardando aprovação.\n`confirmed`: Confirmado.\n`reproved`: Reprovado.\n`approved`: Aprovado.\n`rejected`: Rejeitado.\n" }, "registration_status": { "readOnly": true, "type": "string", "description": "Status de Registro.\n`pending`: Pendente. [Estado Inicial]\n`requested`: Aguardando aprovação.\n`confirmed`: Confirmado.\n`rejected`: Rejeitado.\n`failed`: Falha.\n" }, "transfer_purpose": { "readOnly": true, "type": "object", "nullable": true, "properties": { "code": { "type": "string", "description": "Código do objetivo da transferência", "example": "98" }, "description": { "type": "string", "description": "Descrição do objetivo da transferência", "example": "Pagamentos Diversos" } }, "description": "Objetivo da Transferência.\n`01`: Cobrança\n`03`: Boleto de Pagamento Eletrônico\n`04`: Conciliação Bancária\n`05`: Débitos\n`06`: Custódia de Cheques\n`07`: Gestão de Caixa\n`08`: Consulta/Informação Margem\n`09`: Averbação da Consignação/Retenção\n`10`: Pagamento Dividendos\n`11`: Manutenção da Consignação\n`12`: Consignação de Parcelas\n`13`: Glosa da Consignação (INSS)\n`14`: Consulta de Tributos a pagar\n`20`: Pagamento Fornecedor\n`22`: Pagamento de Contas, Tributos e Impostos\n`23`: Interoperabilidade entre Contas de Instituições de Pagamentos\n`25`: Compror\n`26`: Compror Rotativo\n`29`: Alegação do Pagador\n`30`: Pagamento Salários\n`32`: Pagamento de honorários\n`33`: Pagamento de bolsa auxílio\n`34`: Pagamento de prebenda (remuneração a padres e sacerdotes)\n`40`: Vendor\n`41`: Vendor a Termo\n`50`: Pagamento Sinistros Segurados\n`60`: Pagamento Despesas Viajante em Trânsito\n`70`: Pagamento Autorizado\n`75`: Pagamento Credenciados\n`77`: Pagamento de Remuneração\n`80`: Pagamento Representantes / Vendedores Autorizados\n`90`: Pagamento Benefícios\n`98`: Pagamentos Diversos\n" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transfer_account_uid": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true, "description": "UID da Conta de Transferência origem. Se a conta de transferência não foi informada, a primeira conta de transferência que foi associada a conta financeira foi utilizada automaticamente.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "amount": { "type": "number", "format": "float", "description": "Quantia" }, "scheduled_to": { "type": "string", "nullable": true, "format": "date", "example": "2023-12-12", "description": "Data de Agendamento" }, "confirmed_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2023-12-12", "description": "Data em que a Kobana processou a confirmação da operação. Não representa necessariamente a data em que o valor saiu da conta — para isso use transaction_date." }, "rejected_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2023-12-12", "description": "Data da Rejeição" }, "rejected_error": { "type": "string", "readOnly": true, "nullable": true, "description": "Motivo da rejeição retornado pelo banco" }, "transaction_code": { "readOnly": true, "nullable": true, "type": "string", "description": "Código de Autenticação", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transaction_date": { "readOnly": true, "nullable": true, "type": "string", "format": "date-time", "description": "Data oficial da liquidação/débito informada pelo banco (data da autenticação). Reflete quando o valor efetivamente saiu da conta.", "example": "2023-12-12" }, "source": { "readOnly": true, "nullable": true, "type": "string", "description": "Origem da Transferência.\n\n`api`: API.\n`view`: Manual\n" }, "target": { "type": "object", "properties": { "transfer_kind": { "type": "string", "nullable": false, "description": "Tipo da transferência\n\n`pix`: Pix.\n`ted`: TED.\n`internal`: Entre Contas\n" }, "pix": { "type": "object", "nullable": true, "description": "Dados do Pix (Presente se o campo `transfer_kind` for `pix`)", "properties": { "txid": { "type": "string", "nullable": true, "description": "TXID" }, "pix_type": { "type": "string", "description": "Tipo do Pix\n\n`key`: Chave.\n`bank_account`: Dados bancários\n" }, "key_type": { "type": "string", "nullable": true, "description": "Tipo da Chave (Presente se o campo `pix_type` for `key`)\n\n`cpf`: CPF.\n`cnpj`: CNPJ.\n`random`: Aleatória.\n`email`: E-mail.\n`phone`: Celular\n" }, "key": { "type": "string", "nullable": true, "description": "Chave Pix (Presente se o campo `pix_type` for `key`)" } } }, "bank_account": { "type": "object", "description": "Dados bancários (Presente se o campo `transfer_kind` for `ted`)", "nullable": true, "properties": { "compe_number": { "type": "integer", "description": "Código COMPE do banco.\n\nExemplos: `1` (Banco do Brasil), `237` (Bradesco), `341` (Itaú)", "example": 1 }, "ispb_number": { "type": "integer", "nullable": true, "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 }, "agency_number": { "type": "string", "description": "Número da Agência" }, "agency_digit": { "type": "string", "description": "Dígito da Agência" }, "account_number": { "type": "string", "description": "Número da Conta" }, "account_digit": { "type": "string", "description": "Dígito da Conta" } } }, "beneficiary": { "type": "object", "description": "Dados do Recebedor", "properties": { "document_number": { "type": "string", "nullable": false, "description": "Número do Documento (CPF ou CNPJ)" }, "name": { "type": "string", "nullable": false, "description": "Nome Completo ou Razão Social" } } } } }, "formats": { "readOnly": true, "nullable": true, "type": "object", "description": "URLs do comprovante de transferência (disponível após confirmação)", "properties": { "default": { "type": "object", "properties": { "html": { "type": "string", "nullable": true, "description": "URL HTML do comprovante" }, "png": { "type": "string", "nullable": true, "description": "URL PNG do comprovante" }, "pdf": { "type": "string", "nullable": true, "description": "URL PDF do comprovante" } } } } }, "identifier": { "type": "string", "nullable": true, "description": "Identificação do pagamento no comprovante do provedor financeiro. (Uso exclusivo do banco)\n\nBancos que aceitam esse campo (via API): Itaú\n" }, "financial_provider_external_id": { "type": "string", "nullable": true, "readOnly": true, "description": "ID na instituição financeira" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da criação. Formato iso8601" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da atualização. Formato iso8601" } } }, "v2_generic_transfer": { "type": "object", "description": "Transferência Genérica - Pode ser de qualquer tipo (Pix, TED ou Interna)", "anyOf": [ { "$ref": "#/components/schemas/v2_transfer_pix" }, { "$ref": "#/components/schemas/v2_transfer_ted" }, { "$ref": "#/components/schemas/v2_transfer_internal" } ] }, "v2_new_generic_transfer": { "type": "object", "description": "Nova Transferência Genérica.\n\nO tipo de transferência é especificado pelo campo 'kind':\n- `kind: \"pix\"`: Cria uma transferência Pix (dados em `pix: {}`)\n- `kind: \"ted\"`: Cria uma transferência TED (dados em `ted: {}`)\n- `kind: \"internal\"`: Cria uma transferência entre contas (dados em `internal: {}`)\n\nO campo 'kind' é obrigatório e deve estar no nível raiz do payload.", "oneOf": [ { "type": "object", "description": "Payload para criar uma Transferência Pix", "required": [ "financial_account_uid", "amount", "kind", "pix", "beneficiary" ], "properties": { "amount": { "type": "number", "format": "float", "example": 120.99, "description": "Quantia" }, "scheduled_to": { "type": "string", "nullable": true, "format": "date", "example": "2023-12-12", "description": "Data de Agendamento" }, "transfer_purpose": { "type": "string", "nullable": true, "description": "Objetivo da Transferência (código)", "example": "98" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transfer_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de transferência de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "beneficiary": { "type": "object", "nullable": false, "description": "Dados do beneficiário da transferência", "required": [ "name", "document_number" ], "properties": { "name": { "type": "string", "description": "Nome do beneficiário", "example": "João da Silva" }, "document_number": { "type": "string", "description": "CPF/CNPJ do beneficiário", "example": "123.456.789-00" } } }, "identifier": { "type": "string", "nullable": true, "description": "Identificação da transferência no comprovante do provedor financeiro. (Uso exclusivo do banco)\n\nBancos que aceitam esse campo (via API): Itaú\n" }, "kind": { "type": "string", "enum": [ "pix" ], "description": "Tipo da transferência (deve ser \"pix\")" }, "pix": { "type": "object", "required": [ "data" ], "description": "Dados específicos do Pix (dados dentro de data)", "properties": { "data": { "type": "object", "required": [ "type" ], "description": "Payload com os dados reais do Pix", "oneOf": [ { "type": "object", "required": [ "type", "key_type", "key" ], "description": "Pix por Chave", "properties": { "type": { "type": "string", "enum": [ "key" ], "description": "Tipo do Pix - por chave" }, "key_type": { "type": "string", "enum": [ "random", "phone", "email", "cnpj", "cpf" ], "description": "Tipo da Chave Pix" }, "key": { "type": "string", "description": "Chave Pix" } } }, { "type": "object", "required": [ "type", "bank_account" ], "description": "Pix por Conta Bancária", "properties": { "type": { "type": "string", "enum": [ "bank_account" ], "description": "Tipo do Pix - por conta bancária" }, "bank_account": { "type": "object", "required": [ "compe_number", "agency_number", "account_number" ], "description": "Dados bancários", "properties": { "compe_number": { "type": "string", "description": "Código do banco (COMPE)", "example": "237" }, "ispb_number": { "type": "string", "nullable": true, "description": "ISPB do banco" }, "agency_number": { "type": "string", "description": "Número da agência", "example": "1234" }, "agency_digit": { "type": "string", "nullable": true, "description": "Dígito da agência" }, "account_number": { "type": "string", "description": "Número da conta", "example": "56789-0" }, "account_digit": { "type": "string", "nullable": true, "description": "Dígito da conta" } } } } } ] } } } } }, { "type": "object", "description": "Payload para criar uma Transferência TED", "required": [ "financial_account_uid", "amount", "kind", "ted", "beneficiary" ], "properties": { "amount": { "type": "number", "format": "float", "example": 120.99, "description": "Quantia" }, "scheduled_to": { "type": "string", "nullable": true, "format": "date", "example": "2023-12-12", "description": "Data de Agendamento" }, "transfer_purpose": { "type": "string", "nullable": true, "description": "Objetivo da Transferência (código)", "example": "98" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transfer_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de transferência de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "beneficiary": { "type": "object", "nullable": false, "description": "Dados do beneficiário da transferência", "required": [ "name", "document_number" ], "properties": { "name": { "type": "string", "description": "Nome do beneficiário", "example": "João da Silva" }, "document_number": { "type": "string", "description": "CPF/CNPJ do beneficiário", "example": "123.456.789-00" } } }, "identifier": { "type": "string", "nullable": true, "description": "Identificação da transferência no comprovante do provedor financeiro. (Uso exclusivo do banco)\n\nBancos que aceitam esse campo (via API): Itaú\n" }, "kind": { "type": "string", "enum": [ "ted" ], "description": "Tipo da transferência (deve ser \"ted\")" }, "ted": { "type": "object", "required": [ "data" ], "description": "Dados específicos do TED (dados dentro de data)", "properties": { "data": { "type": "object", "required": [ "bank_account" ], "description": "Payload com os dados reais do TED", "properties": { "bank_account": { "type": "object", "required": [ "compe_number", "agency_number", "account_number" ], "description": "Dados bancários", "properties": { "compe_number": { "type": "string", "description": "Código do banco (COMPE)", "example": "341" }, "ispb_number": { "type": "string", "nullable": true, "description": "ISPB do banco" }, "agency_number": { "type": "string", "description": "Número da agência", "example": "4321" }, "agency_digit": { "type": "string", "nullable": true, "description": "Dígito da agência", "example": "5" }, "account_number": { "type": "string", "description": "Número da conta", "example": "98765-4" }, "account_digit": { "type": "string", "nullable": true, "description": "Dígito da conta" } } } } } } } } }, { "type": "object", "description": "Payload para criar uma Transferência Interna", "required": [ "financial_account_uid", "amount", "kind", "internal", "beneficiary" ], "properties": { "amount": { "type": "number", "format": "float", "example": 120.99, "description": "Quantia" }, "scheduled_to": { "type": "string", "nullable": true, "format": "date", "example": "2023-12-12", "description": "Data de Agendamento" }, "transfer_purpose": { "type": "string", "nullable": true, "description": "Objetivo da Transferência (código)", "example": "98" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transfer_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de transferência de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "beneficiary": { "type": "object", "nullable": false, "description": "Dados do beneficiário da transferência", "required": [ "name", "document_number" ], "properties": { "name": { "type": "string", "description": "Nome do beneficiário", "example": "João da Silva" }, "document_number": { "type": "string", "description": "CPF/CNPJ do beneficiário", "example": "123.456.789-00" } } }, "identifier": { "type": "string", "nullable": true, "description": "Identificação da transferência no comprovante do provedor financeiro. (Uso exclusivo do banco)\n\nBancos que aceitam esse campo (via API): Itaú\n" }, "kind": { "type": "string", "enum": [ "internal" ], "description": "Tipo da transferência (deve ser \"internal\")" }, "internal": { "type": "object", "required": [ "data" ], "description": "Dados específicos da conta destino (dados dentro de data)", "properties": { "data": { "type": "object", "required": [ "agency_number", "account_number" ], "description": "Payload com os dados reais da transferência interna", "properties": { "agency_number": { "type": "string", "description": "Número da agência", "example": "0001" }, "agency_digit": { "type": "string", "nullable": true, "description": "Dígito da agência" }, "account_number": { "type": "string", "description": "Número da conta", "example": "12345-6" }, "account_digit": { "type": "string", "nullable": true, "description": "Dígito da conta" } } } } } } } ] }, "v2_transfer_pix": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID da Transferência" }, "status": { "readOnly": true, "type": "string", "description": "Status.\n`pending`: Pendente. [Estado Inicial]\n`awaiting_approval`: Aguardando aprovação.\n`confirmed`: Confirmado.\n`reproved`: Reprovado.\n`approved`: Aprovado.\n`rejected`: Rejeitado.\n" }, "registration_status": { "readOnly": true, "type": "string", "description": "Status de Registro.\n`pending`: Pendente. [Estado Inicial]\n`requested`: Aguardando aprovação.\n`confirmed`: Confirmado.\n`rejected`: Rejeitado.\n`failed`: Falha.\n" }, "transfer_purpose": { "readOnly": true, "type": "object", "nullable": true, "properties": { "code": { "type": "string", "description": "Código do objetivo da transferência", "example": "98" }, "description": { "type": "string", "description": "Descrição do objetivo da transferência", "example": "Pagamentos Diversos" } }, "description": "Objetivo da Transferência.\n`01`: Cobrança\n`03`: Boleto de Pagamento Eletrônico\n`04`: Conciliação Bancária\n`05`: Débitos\n`06`: Custódia de Cheques\n`07`: Gestão de Caixa\n`08`: Consulta/Informação Margem\n`09`: Averbação da Consignação/Retenção\n`10`: Pagamento Dividendos\n`11`: Manutenção da Consignação\n`12`: Consignação de Parcelas\n`13`: Glosa da Consignação (INSS)\n`14`: Consulta de Tributos a pagar\n`20`: Pagamento Fornecedor\n`22`: Pagamento de Contas, Tributos e Impostos\n`23`: Interoperabilidade entre Contas de Instituições de Pagamentos\n`25`: Compror\n`26`: Compror Rotativo\n`29`: Alegação do Pagador\n`30`: Pagamento Salários\n`32`: Pagamento de honorários\n`33`: Pagamento de bolsa auxílio\n`34`: Pagamento de prebenda (remuneração a padres e sacerdotes)\n`40`: Vendor\n`41`: Vendor a Termo\n`50`: Pagamento Sinistros Segurados\n`60`: Pagamento Despesas Viajante em Trânsito\n`70`: Pagamento Autorizado\n`75`: Pagamento Credenciados\n`77`: Pagamento de Remuneração\n`80`: Pagamento Representantes / Vendedores Autorizados\n`90`: Pagamento Benefícios\n`98`: Pagamentos Diversos\n" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transfer_account_uid": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true, "description": "UID da Conta de Transferência origem. Se a conta de transferência não foi informada, a primeira conta de transferência que foi associada a conta financeira foi utilizada automaticamente.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "amount": { "type": "number", "format": "float", "description": "Quantia" }, "scheduled_to": { "type": "string", "nullable": true, "format": "date", "example": "2023-12-12", "description": "Data de Agendamento" }, "confirmed_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2023-12-12", "description": "Data em que a Kobana processou a confirmação da operação. Não representa necessariamente a data em que o valor saiu da conta — para isso use transaction_date." }, "rejected_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2023-12-12", "description": "Data da Rejeição" }, "rejected_error": { "type": "string", "readOnly": true, "nullable": true, "description": "Motivo da rejeição retornado pelo banco" }, "transaction_code": { "readOnly": true, "nullable": true, "type": "string", "description": "Código de Autenticação", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transaction_date": { "readOnly": true, "nullable": true, "type": "string", "format": "date-time", "description": "Data oficial da liquidação/débito informada pelo banco (data da autenticação). Reflete quando o valor efetivamente saiu da conta.", "example": "2023-12-12" }, "source": { "readOnly": true, "nullable": true, "type": "string", "description": "Origem da Transferência.\n\n`api`: API.\n`view`: Manual\n" }, "target": { "type": "object", "properties": { "transfer_kind": { "type": "string", "nullable": false, "description": "Tipo da transferência\n\n`pix`: Pix.\n`ted`: TED.\n`internal`: Entre Contas\n" }, "pix": { "type": "object", "nullable": true, "description": "Dados do Pix (Presente se o campo `transfer_kind` for `pix`)", "properties": { "txid": { "type": "string", "nullable": true, "description": "TXID" }, "pix_type": { "type": "string", "description": "Tipo do Pix\n\n`key`: Chave.\n`bank_account`: Dados bancários\n" }, "key_type": { "type": "string", "nullable": true, "description": "Tipo da Chave (Presente se o campo `pix_type` for `key`)\n\n`cpf`: CPF.\n`cnpj`: CNPJ.\n`random`: Aleatória.\n`email`: E-mail.\n`phone`: Celular\n" }, "key": { "type": "string", "nullable": true, "description": "Chave Pix (Presente se o campo `pix_type` for `key`)" } } }, "bank_account": { "type": "object", "description": "Dados bancários (Presente se o campo `transfer_kind` for `ted`)", "nullable": true, "properties": { "compe_number": { "type": "integer", "description": "Código COMPE do banco.\n\nExemplos: `1` (Banco do Brasil), `237` (Bradesco), `341` (Itaú)", "example": 1 }, "ispb_number": { "type": "integer", "nullable": true, "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 }, "agency_number": { "type": "string", "description": "Número da Agência" }, "agency_digit": { "type": "string", "description": "Dígito da Agência" }, "account_number": { "type": "string", "description": "Número da Conta" }, "account_digit": { "type": "string", "description": "Dígito da Conta" } } }, "beneficiary": { "type": "object", "description": "Dados do Recebedor", "properties": { "document_number": { "type": "string", "nullable": false, "description": "Número do Documento (CPF ou CNPJ)" }, "name": { "type": "string", "nullable": false, "description": "Nome Completo ou Razão Social" } } } } }, "formats": { "readOnly": true, "nullable": true, "type": "object", "description": "URLs do comprovante de transferência (disponível após confirmação)", "properties": { "default": { "type": "object", "properties": { "html": { "type": "string", "nullable": true, "description": "URL HTML do comprovante" }, "png": { "type": "string", "nullable": true, "description": "URL PNG do comprovante" }, "pdf": { "type": "string", "nullable": true, "description": "URL PDF do comprovante" } } } } }, "identifier": { "type": "string", "nullable": true, "description": "Identificação do pagamento no comprovante do provedor financeiro. (Uso exclusivo do banco)\n\nBancos que aceitam esse campo (via API): Itaú\n" }, "financial_provider_external_id": { "type": "string", "nullable": true, "readOnly": true, "description": "ID na instituição financeira" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da criação. Formato iso8601" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da atualização. Formato iso8601" }, "kind": { "type": "string", "enum": [ "pix" ], "description": "Tipo da transferência (sempre \"pix\" para este schema)" }, "beneficiary": { "type": "object", "nullable": true, "description": "Dados do beneficiário da transferência", "required": [ "name", "document_number" ], "properties": { "name": { "type": "string", "description": "Nome do beneficiário", "example": "João da Silva" }, "document_number": { "type": "string", "description": "CPF/CNPJ do beneficiário", "example": "123.456.789-00" } } } }, "description": "Transferência Pix" }, "v2_transfer_ted": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID da Transferência" }, "status": { "readOnly": true, "type": "string", "description": "Status.\n`pending`: Pendente. [Estado Inicial]\n`awaiting_approval`: Aguardando aprovação.\n`confirmed`: Confirmado.\n`reproved`: Reprovado.\n`approved`: Aprovado.\n`rejected`: Rejeitado.\n" }, "registration_status": { "readOnly": true, "type": "string", "description": "Status de Registro.\n`pending`: Pendente. [Estado Inicial]\n`requested`: Aguardando aprovação.\n`confirmed`: Confirmado.\n`rejected`: Rejeitado.\n`failed`: Falha.\n" }, "transfer_purpose": { "readOnly": true, "type": "object", "nullable": true, "properties": { "code": { "type": "string", "description": "Código do objetivo da transferência", "example": "98" }, "description": { "type": "string", "description": "Descrição do objetivo da transferência", "example": "Pagamentos Diversos" } }, "description": "Objetivo da Transferência.\n`01`: Cobrança\n`03`: Boleto de Pagamento Eletrônico\n`04`: Conciliação Bancária\n`05`: Débitos\n`06`: Custódia de Cheques\n`07`: Gestão de Caixa\n`08`: Consulta/Informação Margem\n`09`: Averbação da Consignação/Retenção\n`10`: Pagamento Dividendos\n`11`: Manutenção da Consignação\n`12`: Consignação de Parcelas\n`13`: Glosa da Consignação (INSS)\n`14`: Consulta de Tributos a pagar\n`20`: Pagamento Fornecedor\n`22`: Pagamento de Contas, Tributos e Impostos\n`23`: Interoperabilidade entre Contas de Instituições de Pagamentos\n`25`: Compror\n`26`: Compror Rotativo\n`29`: Alegação do Pagador\n`30`: Pagamento Salários\n`32`: Pagamento de honorários\n`33`: Pagamento de bolsa auxílio\n`34`: Pagamento de prebenda (remuneração a padres e sacerdotes)\n`40`: Vendor\n`41`: Vendor a Termo\n`50`: Pagamento Sinistros Segurados\n`60`: Pagamento Despesas Viajante em Trânsito\n`70`: Pagamento Autorizado\n`75`: Pagamento Credenciados\n`77`: Pagamento de Remuneração\n`80`: Pagamento Representantes / Vendedores Autorizados\n`90`: Pagamento Benefícios\n`98`: Pagamentos Diversos\n" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transfer_account_uid": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true, "description": "UID da Conta de Transferência origem. Se a conta de transferência não foi informada, a primeira conta de transferência que foi associada a conta financeira foi utilizada automaticamente.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "amount": { "type": "number", "format": "float", "description": "Quantia" }, "scheduled_to": { "type": "string", "nullable": true, "format": "date", "example": "2023-12-12", "description": "Data de Agendamento" }, "confirmed_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2023-12-12", "description": "Data em que a Kobana processou a confirmação da operação. Não representa necessariamente a data em que o valor saiu da conta — para isso use transaction_date." }, "rejected_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2023-12-12", "description": "Data da Rejeição" }, "rejected_error": { "type": "string", "readOnly": true, "nullable": true, "description": "Motivo da rejeição retornado pelo banco" }, "transaction_code": { "readOnly": true, "nullable": true, "type": "string", "description": "Código de Autenticação", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transaction_date": { "readOnly": true, "nullable": true, "type": "string", "format": "date-time", "description": "Data oficial da liquidação/débito informada pelo banco (data da autenticação). Reflete quando o valor efetivamente saiu da conta.", "example": "2023-12-12" }, "source": { "readOnly": true, "nullable": true, "type": "string", "description": "Origem da Transferência.\n\n`api`: API.\n`view`: Manual\n" }, "target": { "type": "object", "properties": { "transfer_kind": { "type": "string", "nullable": false, "description": "Tipo da transferência\n\n`pix`: Pix.\n`ted`: TED.\n`internal`: Entre Contas\n" }, "pix": { "type": "object", "nullable": true, "description": "Dados do Pix (Presente se o campo `transfer_kind` for `pix`)", "properties": { "txid": { "type": "string", "nullable": true, "description": "TXID" }, "pix_type": { "type": "string", "description": "Tipo do Pix\n\n`key`: Chave.\n`bank_account`: Dados bancários\n" }, "key_type": { "type": "string", "nullable": true, "description": "Tipo da Chave (Presente se o campo `pix_type` for `key`)\n\n`cpf`: CPF.\n`cnpj`: CNPJ.\n`random`: Aleatória.\n`email`: E-mail.\n`phone`: Celular\n" }, "key": { "type": "string", "nullable": true, "description": "Chave Pix (Presente se o campo `pix_type` for `key`)" } } }, "bank_account": { "type": "object", "description": "Dados bancários (Presente se o campo `transfer_kind` for `ted`)", "nullable": true, "properties": { "compe_number": { "type": "integer", "description": "Código COMPE do banco.\n\nExemplos: `1` (Banco do Brasil), `237` (Bradesco), `341` (Itaú)", "example": 1 }, "ispb_number": { "type": "integer", "nullable": true, "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 }, "agency_number": { "type": "string", "description": "Número da Agência" }, "agency_digit": { "type": "string", "description": "Dígito da Agência" }, "account_number": { "type": "string", "description": "Número da Conta" }, "account_digit": { "type": "string", "description": "Dígito da Conta" } } }, "beneficiary": { "type": "object", "description": "Dados do Recebedor", "properties": { "document_number": { "type": "string", "nullable": false, "description": "Número do Documento (CPF ou CNPJ)" }, "name": { "type": "string", "nullable": false, "description": "Nome Completo ou Razão Social" } } } } }, "formats": { "readOnly": true, "nullable": true, "type": "object", "description": "URLs do comprovante de transferência (disponível após confirmação)", "properties": { "default": { "type": "object", "properties": { "html": { "type": "string", "nullable": true, "description": "URL HTML do comprovante" }, "png": { "type": "string", "nullable": true, "description": "URL PNG do comprovante" }, "pdf": { "type": "string", "nullable": true, "description": "URL PDF do comprovante" } } } } }, "identifier": { "type": "string", "nullable": true, "description": "Identificação do pagamento no comprovante do provedor financeiro. (Uso exclusivo do banco)\n\nBancos que aceitam esse campo (via API): Itaú\n" }, "financial_provider_external_id": { "type": "string", "nullable": true, "readOnly": true, "description": "ID na instituição financeira" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da criação. Formato iso8601" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da atualização. Formato iso8601" }, "kind": { "type": "string", "enum": [ "ted" ], "description": "Tipo da transferência (sempre \"ted\" para este schema)" }, "beneficiary": { "type": "object", "nullable": true, "description": "Dados do beneficiário da transferência", "required": [ "name", "document_number" ], "properties": { "name": { "type": "string", "description": "Nome do beneficiário", "example": "João da Silva" }, "document_number": { "type": "string", "description": "CPF/CNPJ do beneficiário", "example": "123.456.789-00" } } } }, "description": "Transferência TED" }, "v2_transfer_internal": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID da Transferência" }, "status": { "readOnly": true, "type": "string", "description": "Status.\n`pending`: Pendente. [Estado Inicial]\n`awaiting_approval`: Aguardando aprovação.\n`confirmed`: Confirmado.\n`reproved`: Reprovado.\n`approved`: Aprovado.\n`rejected`: Rejeitado.\n" }, "registration_status": { "readOnly": true, "type": "string", "description": "Status de Registro.\n`pending`: Pendente. [Estado Inicial]\n`requested`: Aguardando aprovação.\n`confirmed`: Confirmado.\n`rejected`: Rejeitado.\n`failed`: Falha.\n" }, "transfer_purpose": { "readOnly": true, "type": "object", "nullable": true, "properties": { "code": { "type": "string", "description": "Código do objetivo da transferência", "example": "98" }, "description": { "type": "string", "description": "Descrição do objetivo da transferência", "example": "Pagamentos Diversos" } }, "description": "Objetivo da Transferência.\n`01`: Cobrança\n`03`: Boleto de Pagamento Eletrônico\n`04`: Conciliação Bancária\n`05`: Débitos\n`06`: Custódia de Cheques\n`07`: Gestão de Caixa\n`08`: Consulta/Informação Margem\n`09`: Averbação da Consignação/Retenção\n`10`: Pagamento Dividendos\n`11`: Manutenção da Consignação\n`12`: Consignação de Parcelas\n`13`: Glosa da Consignação (INSS)\n`14`: Consulta de Tributos a pagar\n`20`: Pagamento Fornecedor\n`22`: Pagamento de Contas, Tributos e Impostos\n`23`: Interoperabilidade entre Contas de Instituições de Pagamentos\n`25`: Compror\n`26`: Compror Rotativo\n`29`: Alegação do Pagador\n`30`: Pagamento Salários\n`32`: Pagamento de honorários\n`33`: Pagamento de bolsa auxílio\n`34`: Pagamento de prebenda (remuneração a padres e sacerdotes)\n`40`: Vendor\n`41`: Vendor a Termo\n`50`: Pagamento Sinistros Segurados\n`60`: Pagamento Despesas Viajante em Trânsito\n`70`: Pagamento Autorizado\n`75`: Pagamento Credenciados\n`77`: Pagamento de Remuneração\n`80`: Pagamento Representantes / Vendedores Autorizados\n`90`: Pagamento Benefícios\n`98`: Pagamentos Diversos\n" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transfer_account_uid": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true, "description": "UID da Conta de Transferência origem. Se a conta de transferência não foi informada, a primeira conta de transferência que foi associada a conta financeira foi utilizada automaticamente.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "amount": { "type": "number", "format": "float", "description": "Quantia" }, "scheduled_to": { "type": "string", "nullable": true, "format": "date", "example": "2023-12-12", "description": "Data de Agendamento" }, "confirmed_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2023-12-12", "description": "Data em que a Kobana processou a confirmação da operação. Não representa necessariamente a data em que o valor saiu da conta — para isso use transaction_date." }, "rejected_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2023-12-12", "description": "Data da Rejeição" }, "rejected_error": { "type": "string", "readOnly": true, "nullable": true, "description": "Motivo da rejeição retornado pelo banco" }, "transaction_code": { "readOnly": true, "nullable": true, "type": "string", "description": "Código de Autenticação", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transaction_date": { "readOnly": true, "nullable": true, "type": "string", "format": "date-time", "description": "Data oficial da liquidação/débito informada pelo banco (data da autenticação). Reflete quando o valor efetivamente saiu da conta.", "example": "2023-12-12" }, "source": { "readOnly": true, "nullable": true, "type": "string", "description": "Origem da Transferência.\n\n`api`: API.\n`view`: Manual\n" }, "target": { "type": "object", "properties": { "transfer_kind": { "type": "string", "nullable": false, "description": "Tipo da transferência\n\n`pix`: Pix.\n`ted`: TED.\n`internal`: Entre Contas\n" }, "pix": { "type": "object", "nullable": true, "description": "Dados do Pix (Presente se o campo `transfer_kind` for `pix`)", "properties": { "txid": { "type": "string", "nullable": true, "description": "TXID" }, "pix_type": { "type": "string", "description": "Tipo do Pix\n\n`key`: Chave.\n`bank_account`: Dados bancários\n" }, "key_type": { "type": "string", "nullable": true, "description": "Tipo da Chave (Presente se o campo `pix_type` for `key`)\n\n`cpf`: CPF.\n`cnpj`: CNPJ.\n`random`: Aleatória.\n`email`: E-mail.\n`phone`: Celular\n" }, "key": { "type": "string", "nullable": true, "description": "Chave Pix (Presente se o campo `pix_type` for `key`)" } } }, "bank_account": { "type": "object", "description": "Dados bancários (Presente se o campo `transfer_kind` for `ted`)", "nullable": true, "properties": { "compe_number": { "type": "integer", "description": "Código COMPE do banco.\n\nExemplos: `1` (Banco do Brasil), `237` (Bradesco), `341` (Itaú)", "example": 1 }, "ispb_number": { "type": "integer", "nullable": true, "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 }, "agency_number": { "type": "string", "description": "Número da Agência" }, "agency_digit": { "type": "string", "description": "Dígito da Agência" }, "account_number": { "type": "string", "description": "Número da Conta" }, "account_digit": { "type": "string", "description": "Dígito da Conta" } } }, "beneficiary": { "type": "object", "description": "Dados do Recebedor", "properties": { "document_number": { "type": "string", "nullable": false, "description": "Número do Documento (CPF ou CNPJ)" }, "name": { "type": "string", "nullable": false, "description": "Nome Completo ou Razão Social" } } } } }, "formats": { "readOnly": true, "nullable": true, "type": "object", "description": "URLs do comprovante de transferência (disponível após confirmação)", "properties": { "default": { "type": "object", "properties": { "html": { "type": "string", "nullable": true, "description": "URL HTML do comprovante" }, "png": { "type": "string", "nullable": true, "description": "URL PNG do comprovante" }, "pdf": { "type": "string", "nullable": true, "description": "URL PDF do comprovante" } } } } }, "identifier": { "type": "string", "nullable": true, "description": "Identificação do pagamento no comprovante do provedor financeiro. (Uso exclusivo do banco)\n\nBancos que aceitam esse campo (via API): Itaú\n" }, "financial_provider_external_id": { "type": "string", "nullable": true, "readOnly": true, "description": "ID na instituição financeira" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da criação. Formato iso8601" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da atualização. Formato iso8601" }, "kind": { "type": "string", "enum": [ "internal" ], "description": "Tipo da transferência (sempre \"internal\" para este schema)" }, "beneficiary": { "type": "object", "nullable": true, "description": "Dados do beneficiário da transferência", "required": [ "name", "document_number" ], "properties": { "name": { "type": "string", "description": "Nome do beneficiário", "example": "João da Silva" }, "document_number": { "type": "string", "description": "CPF/CNPJ do beneficiário", "example": "123.456.789-00" } } } }, "description": "Transferência Interna" }, "v2_new_transfer_pix": { "type": "object", "description": "Nova Transferência Pix", "required": [ "amount", "financial_account_uid", "type", "beneficiary" ], "properties": { "amount": { "type": "number", "format": "float", "example": 120.99, "description": "Quantia\n" }, "scheduled_to": { "type": "string", "nullable": true, "format": "date", "example": "2023-12-12", "description": "Data de Agendamento" }, "transfer_purpose": { "type": "string", "nullable": true, "description": "Objetivo da Transferência", "example": "98" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transfer_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de transferência de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "beneficiary": { "type": "object", "description": "Dados do Recebedor", "required": [ "name", "document_number" ], "properties": { "document_number": { "type": "string", "nullable": false, "description": "Número do Documento (CPF ou CNPJ)" }, "name": { "type": "string", "nullable": false, "description": "Nome Completo ou Razão Social" } } }, "type": { "type": "string", "nullable": false, "description": "Tipo do Pix\n\n`key`: Chave.\n`bank_account`: Dados bancários\n" }, "key_type": { "type": "string", "description": "Tipo da Chave (Obrigatório se o campo `type` for `key`)\n\n`cpf`: CPF.\n`cnpj`: CNPJ.\n`random`: Aleatória.\n`email`: E-mail.\n`phone`: Celular\n" }, "key": { "type": "string", "description": "Chave Pix (Obrigatório se o campo `type` for `key`)" }, "bank_account": { "type": "object", "description": "Dados bancários (Obrigatório se o campo `type` for `bank_account`)", "nullable": false, "properties": { "compe_number": { "type": "integer", "description": "Código COMPE do banco.\n\nExemplos: `1` (Banco do Brasil), `237` (Bradesco), `341` (Itaú)", "example": 1 }, "ispb_number": { "type": "integer", "nullable": true, "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 }, "agency_number": { "type": "string", "description": "Número da Agência" }, "agency_digit": { "type": "string", "description": "Dígito da Agência" }, "account_number": { "type": "string", "description": "Número da Conta" }, "account_digit": { "type": "string", "description": "Dígito da Conta" } } }, "identifier": { "type": "string", "nullable": true, "description": "Identificação do pagamento no comprovante do provedor financeiro. (Uso exclusivo do banco)\n\nBancos que aceitam esse campo (via API): Itaú\n" } } }, "v2_new_transfer_ted": { "type": "object", "description": "Nova Transferência TED", "required": [ "amount", "financial_account_uid", "bank_account", "beneficiary" ], "properties": { "amount": { "type": "number", "format": "float", "example": 120.99, "description": "Quantia\n" }, "scheduled_to": { "type": "string", "nullable": true, "format": "date", "example": "2023-12-12", "description": "Data de Agendamento" }, "transfer_purpose": { "type": "string", "nullable": true, "description": "Objetivo da Transferência", "example": "98" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transfer_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de transferência de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "beneficiary": { "type": "object", "description": "Dados do Recebedor", "required": [ "name", "document_number" ], "properties": { "document_number": { "type": "string", "nullable": false, "description": "Número do Documento (CPF ou CNPJ)" }, "name": { "type": "string", "nullable": false, "description": "Nome Completo ou Razão Social" } } }, "bank_account": { "type": "object", "description": "Dados bancários", "nullable": false, "properties": { "compe_number": { "type": "integer", "description": "Código COMPE do banco.\n\nExemplos: `1` (Banco do Brasil), `237` (Bradesco), `341` (Itaú)", "example": 1 }, "ispb_number": { "type": "integer", "nullable": true, "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 }, "agency_number": { "type": "string", "description": "Número da Agência" }, "agency_digit": { "type": "string", "description": "Dígito da Agência" }, "account_number": { "type": "string", "description": "Número da Conta" }, "account_digit": { "type": "string", "description": "Dígito da Conta" } } } } }, "v2_new_transfer_internal": { "type": "object", "description": "Nova Transferência Entre Contas", "required": [ "amount", "financial_account_uid", "internal", "beneficiary" ], "properties": { "amount": { "type": "number", "format": "float", "example": 120.99, "description": "Quantia\n" }, "scheduled_to": { "type": "string", "nullable": true, "format": "date", "example": "2023-12-12", "description": "Data de Agendamento" }, "transfer_purpose": { "type": "string", "nullable": true, "description": "Objetivo da Transferência", "example": "98" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transfer_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de transferência de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "beneficiary": { "type": "object", "description": "Dados do Recebedor", "required": [ "name", "document_number" ], "properties": { "document_number": { "type": "string", "nullable": false, "description": "Número do Documento (CPF ou CNPJ)" }, "name": { "type": "string", "nullable": false, "description": "Nome Completo ou Razão Social" } } }, "internal": { "type": "object", "description": "Dados bancários", "nullable": false, "properties": { "agency_number": { "type": "string", "description": "Número da Agência" }, "agency_digit": { "type": "string", "description": "Dígito da Agência" }, "account_number": { "type": "string", "description": "Número da Conta" }, "account_digit": { "type": "string", "description": "Dígito da Conta" } } } } }, "v2_transfer_batch": { "type": "object", "required": [ "financial_account_uid" ], "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID do Lote de Transferência" }, "status": { "readOnly": true, "type": "string", "description": "Status.\n`pending`: Pendente. [Estado Inicial]\n`awaiting_approval`: Aguardando aprovação.\n`confirmed`: Confirmado.\n`reproved`: Reprovado.\n`approved`: Aprovado.\n`rejected`: Rejeitado.\n`canceled`: Cancelado.\n" }, "registration_status": { "readOnly": true, "type": "string", "description": "Status de Registro.\n`pending`: Pendente. [Estado Inicial]\n`requested`: Aguardando aprovação.\n`confirmed`: Confirmado.\n`rejected`: Rejeitado.\n`failed`: Falha.\n" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transfer_account_uid": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true, "description": "UID da Conta de Transferência utilizada. Se nenhuma foi especificada, a primeira conta de transferência da conta financeira foi utilizada automaticamente.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transport_kind": { "type": "string", "readOnly": true, "description": "Tipo de Transação" }, "transfers": { "type": "array", "description": "Lista de Transferências. Abaixo segue esquemas dos tipos de transferências possíveis.", "items": { "$ref": "#/components/schemas/v2_transfer" } }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da criação. Formato iso8601" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da atualização. Formato iso8601" } } }, "v2_new_transfer_batch_pix": { "type": "object", "required": [ "financial_account_uid", "transfers" ], "properties": { "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transfer_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de transferência aplicada a todo o lote (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à conta financeira do lote.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transfers": { "type": "array", "description": "Lista de Transferências Pix novas ou existentes.", "items": { "anyOf": [ { "type": "object", "description": "Nova Transferência Pix", "required": [ "amount", "financial_account_uid", "type", "beneficiary" ], "properties": { "amount": { "type": "number", "format": "float", "example": 120.99, "description": "Quantia\n" }, "scheduled_to": { "type": "string", "nullable": true, "format": "date", "example": "2023-12-12", "description": "Data de Agendamento" }, "transfer_purpose": { "type": "string", "nullable": true, "description": "Objetivo da Transferência", "example": "98" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transfer_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de transferência de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "beneficiary": { "type": "object", "description": "Dados do Recebedor", "required": [ "name", "document_number" ], "properties": { "document_number": { "type": "string", "nullable": false, "description": "Número do Documento (CPF ou CNPJ)" }, "name": { "type": "string", "nullable": false, "description": "Nome Completo ou Razão Social" } } }, "type": { "type": "string", "nullable": false, "description": "Tipo do Pix\n\n`key`: Chave.\n`bank_account`: Dados bancários\n" }, "key_type": { "type": "string", "description": "Tipo da Chave (Obrigatório se o campo `type` for `key`)\n\n`cpf`: CPF.\n`cnpj`: CNPJ.\n`random`: Aleatória.\n`email`: E-mail.\n`phone`: Celular\n" }, "key": { "type": "string", "description": "Chave Pix (Obrigatório se o campo `type` for `key`)" }, "bank_account": { "type": "object", "description": "Dados bancários (Obrigatório se o campo `type` for `bank_account`)", "nullable": false, "properties": { "compe_number": { "type": "integer", "description": "Código COMPE do banco.\n\nExemplos: `1` (Banco do Brasil), `237` (Bradesco), `341` (Itaú)", "example": 1 }, "ispb_number": { "type": "integer", "nullable": true, "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 }, "agency_number": { "type": "string", "description": "Número da Agência" }, "agency_digit": { "type": "string", "description": "Dígito da Agência" }, "account_number": { "type": "string", "description": "Número da Conta" }, "account_digit": { "type": "string", "description": "Dígito da Conta" } } }, "identifier": { "type": "string", "nullable": true, "description": "Identificação do pagamento no comprovante do provedor financeiro. (Uso exclusivo do banco)\n\nBancos que aceitam esse campo (via API): Itaú\n" } } }, { "type": "object", "required": [ "uid" ], "description": "Transferência existente.", "properties": { "uid": { "type": "string", "format": "uuid", "description": "UID de uma Transferência", "example": "018df180-7208-727b-a10a-ea545e4a75a8" } } } ] } } } }, "v2_new_transfer_batch_ted": { "type": "object", "required": [ "financial_account_uid", "transfers" ], "properties": { "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transfer_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de transferência aplicada a todo o lote (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à conta financeira do lote.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transfers": { "type": "array", "description": "Lista de Transferências TED novas ou existentes.", "items": { "anyOf": [ { "type": "object", "description": "Nova Transferência TED", "required": [ "amount", "financial_account_uid", "bank_account", "beneficiary" ], "properties": { "amount": { "type": "number", "format": "float", "example": 120.99, "description": "Quantia\n" }, "scheduled_to": { "type": "string", "nullable": true, "format": "date", "example": "2023-12-12", "description": "Data de Agendamento" }, "transfer_purpose": { "type": "string", "nullable": true, "description": "Objetivo da Transferência", "example": "98" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transfer_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de transferência de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "beneficiary": { "type": "object", "description": "Dados do Recebedor", "required": [ "name", "document_number" ], "properties": { "document_number": { "type": "string", "nullable": false, "description": "Número do Documento (CPF ou CNPJ)" }, "name": { "type": "string", "nullable": false, "description": "Nome Completo ou Razão Social" } } }, "bank_account": { "type": "object", "description": "Dados bancários", "nullable": false, "properties": { "compe_number": { "type": "integer", "description": "Código COMPE do banco.\n\nExemplos: `1` (Banco do Brasil), `237` (Bradesco), `341` (Itaú)", "example": 1 }, "ispb_number": { "type": "integer", "nullable": true, "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 }, "agency_number": { "type": "string", "description": "Número da Agência" }, "agency_digit": { "type": "string", "description": "Dígito da Agência" }, "account_number": { "type": "string", "description": "Número da Conta" }, "account_digit": { "type": "string", "description": "Dígito da Conta" } } } } }, { "type": "object", "required": [ "uid" ], "description": "Transferência existente.", "properties": { "uid": { "type": "string", "format": "uuid", "description": "UID de uma Transferência", "example": "018df180-7208-727b-a10a-ea545e4a75a8" } } } ] } } } }, "v2_new_transfer_batch_internal": { "type": "object", "required": [ "financial_account_uid", "transfers" ], "properties": { "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transfer_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de transferência aplicada a todo o lote (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à conta financeira do lote.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transfers": { "type": "array", "description": "Lista de Transferências Entre Contas novas ou existentes.", "items": { "anyOf": [ { "type": "object", "description": "Nova Transferência Entre Contas", "required": [ "amount", "financial_account_uid", "internal", "beneficiary" ], "properties": { "amount": { "type": "number", "format": "float", "example": 120.99, "description": "Quantia\n" }, "scheduled_to": { "type": "string", "nullable": true, "format": "date", "example": "2023-12-12", "description": "Data de Agendamento" }, "transfer_purpose": { "type": "string", "nullable": true, "description": "Objetivo da Transferência", "example": "98" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transfer_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de transferência de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "beneficiary": { "type": "object", "description": "Dados do Recebedor", "required": [ "name", "document_number" ], "properties": { "document_number": { "type": "string", "nullable": false, "description": "Número do Documento (CPF ou CNPJ)" }, "name": { "type": "string", "nullable": false, "description": "Nome Completo ou Razão Social" } } }, "internal": { "type": "object", "description": "Dados bancários", "nullable": false, "properties": { "agency_number": { "type": "string", "description": "Número da Agência" }, "agency_digit": { "type": "string", "description": "Dígito da Agência" }, "account_number": { "type": "string", "description": "Número da Conta" }, "account_digit": { "type": "string", "description": "Dígito da Conta" } } } } }, { "type": "object", "required": [ "uid" ], "description": "Transferência existente.", "properties": { "uid": { "type": "string", "format": "uuid", "description": "UID de uma Transferência", "example": "018df180-7208-727b-a10a-ea545e4a75a8" } } } ] } } } }, "v2_transfer_batch_command": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Comando." }, "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "Identificador público (UUID) do Comando. Utilizado como parâmetro na consulta individual (`GET /commands/{uid}`)." }, "status": { "type": "string", "readOnly": true, "description": "Status do comando.\n\n`pending`: Comando ainda não executado. [Estado inicial]\n`confirmed`: Comando executado e confirmado.\n`failed`: Execução do comando falhou.\n" }, "operation": { "type": "string", "readOnly": true, "description": "Tipo da operação.\n\n`approve`: Aprovação.\n`reprove`: Reprovação.\n" }, "resource_type": { "type": "string", "readOnly": true, "nullable": true, "description": "Tipo do recurso ao qual o Comando pertence (ex.: `BankBillet`, `Pix`, `Financial::Account`)." }, "resource_uid": { "type": "string", "format": "uuid", "readOnly": true, "nullable": true, "description": "Identificador público (UUID) do recurso ao qual o Comando pertence." }, "financial_provider_slug": { "type": "string", "readOnly": true, "nullable": true, "description": "Slug do provedor financeiro (banco) responsável pela execução do Comando." }, "params": { "type": "object", "readOnly": true, "nullable": true, "description": "Parâmetros para a execução do Comando." }, "payload": { "type": "object", "readOnly": true, "nullable": true, "description": "Resposta do servidor com o resultado da operação." }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da criação do registro do Comando" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da atualização do registro do Comando." }, "confirmation_via": { "type": "string", "enum": [ "api", "edi" ], "readOnly": true, "nullable": true, "description": "Origem da confirmação do Comando.\n\n`api`: confirmado via resposta da API do banco (inclui webhooks, Recuperator e sync).\n`edi`: confirmado via retorno CNAB (arquivo de baixa).\n`null`: Sem origem registrada.\n" }, "pix": { "$ref": "#/components/schemas/v2_transfer_batch" } } }, "v2_transfer_command": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Comando." }, "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "Identificador público (UUID) do Comando. Utilizado como parâmetro na consulta individual (`GET /commands/{uid}`)." }, "status": { "type": "string", "readOnly": true, "description": "Status do comando.\n\n`pending`: Comando ainda não executado. [Estado inicial]\n`confirmed`: Comando executado e confirmado.\n`failed`: Execução do comando falhou.\n" }, "operation": { "type": "string", "readOnly": true, "description": "Tipo da operação.\n\n`cancel`: Cancelamento.\n" }, "resource_type": { "type": "string", "readOnly": true, "nullable": true, "description": "Tipo do recurso ao qual o Comando pertence (ex.: `BankBillet`, `Pix`, `Financial::Account`)." }, "resource_uid": { "type": "string", "format": "uuid", "readOnly": true, "nullable": true, "description": "Identificador público (UUID) do recurso ao qual o Comando pertence." }, "financial_provider_slug": { "type": "string", "readOnly": true, "nullable": true, "description": "Slug do provedor financeiro (banco) responsável pela execução do Comando." }, "params": { "type": "object", "readOnly": true, "nullable": true, "description": "Parâmetros para a execução do Comando." }, "payload": { "type": "object", "readOnly": true, "nullable": true, "description": "Resposta do servidor com o resultado da operação." }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da criação do registro do Comando" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da atualização do registro do Comando." }, "confirmation_via": { "type": "string", "enum": [ "api", "edi" ], "readOnly": true, "nullable": true, "description": "Origem da confirmação do Comando.\n\n`api`: confirmado via resposta da API do banco (inclui webhooks, Recuperator e sync).\n`edi`: confirmado via retorno CNAB (arquivo de baixa).\n`null`: Sem origem registrada.\n" }, "financial_transfer": { "$ref": "#/components/schemas/v2_transfer" } } }, "v2_unprocessable_content": { "type": "object", "required": [ "status", "errors" ], "properties": { "status": { "type": "integer", "minimum": 100, "maximum": 599, "description": "Status HTTP do erro. Ex: `400`.", "examples": [ 400, 401, 422, 500 ] }, "errors": { "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Descrição breve do erro. Ex: `Token de API inválido`.", "examples": [ "Token de API inválido", "Parâmetro obrigatório" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Código do erro. Ex: `validation_error`.", "examples": [ "validation_error", "authentication_error", "not_found" ] }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Nome do parâmetro que falhou a validação. Ex: `amount`.", "examples": [ "amount", "customer_email", "expire_at" ] }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "object" } ], "description": "Detalhe da validação que gerou o erro. Ex: `não pode ficar em branco`.", "examples": [ "não pode ficar em branco", "deve ser um email válido" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "object" } ] } }, "additionalProperties": false }, "description": "Erros aninhados" } }, "additionalProperties": false } } }, "additionalProperties": false }, "v2_not_found": { "type": "object", "required": [ "status", "errors" ], "properties": { "status": { "type": "integer", "minimum": 100, "maximum": 599, "description": "Status HTTP do erro. Ex: `400`.", "examples": [ 400, 401, 422, 500 ] }, "errors": { "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Descrição breve do erro. Ex: `Token de API inválido`.", "examples": [ "Token de API inválido", "Parâmetro obrigatório" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Código do erro. Ex: `validation_error`.", "examples": [ "validation_error", "authentication_error", "not_found" ] }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Nome do parâmetro que falhou a validação. Ex: `amount`.", "examples": [ "amount", "customer_email", "expire_at" ] }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "object" } ], "description": "Detalhe da validação que gerou o erro. Ex: `não pode ficar em branco`.", "examples": [ "não pode ficar em branco", "deve ser um email válido" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "object" } ] } }, "additionalProperties": false }, "description": "Erros aninhados" } }, "additionalProperties": false } } }, "additionalProperties": false }, "v2_unauthorized": { "type": "object", "required": [ "status", "errors" ], "properties": { "status": { "type": "integer", "minimum": 100, "maximum": 599, "description": "Status HTTP do erro. Ex: `400`.", "examples": [ 400, 401, 422, 500 ] }, "errors": { "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Descrição breve do erro. Ex: `Token de API inválido`.", "examples": [ "Token de API inválido", "Parâmetro obrigatório" ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Código do erro. Ex: `validation_error`.", "examples": [ "validation_error", "authentication_error", "not_found" ] }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Nome do parâmetro que falhou a validação. Ex: `amount`.", "examples": [ "amount", "customer_email", "expire_at" ] }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "object" } ], "description": "Detalhe da validação que gerou o erro. Ex: `não pode ficar em branco`.", "examples": [ "não pode ficar em branco", "deve ser um email válido" ] }, "errors": { "type": "array", "items": { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "object" } ] } }, "additionalProperties": false }, "description": "Erros aninhados" } }, "additionalProperties": false } } }, "additionalProperties": false }, "v2_dda_account": { "type": "object", "properties": { "uid": { "type": "string", "readOnly": true, "description": "Identificador único da conta DDA (UUID). Utilize para consultar, atualizar, habilitar ou desabilitar via API.", "example": "e596865f-07a4-4458-88c1-fbb4ffd196e1" }, "cnpj": { "type": "string", "description": "CNPJ ou CPF da empresa/pessoa para a qual o DDA foi habilitado. Cada conta Kobana pode ter apenas uma conta DDA ativa.", "example": "11.222.333/0001-81" }, "name": { "type": "string", "nullable": true, "description": "Nome descritivo da carta DDA, gerado automaticamente com base nos dados da empresa.", "example": "Carta DDA Empresa X" }, "signers": { "type": "array", "description": "Lista de signatários da carta de adesão ao DDA (mínimo 1, máximo 3). Cada signatário recebe um e-mail com link para assinatura digital.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Nome completo do signatário conforme documento de identidade." }, "document_number": { "type": "string", "description": "CPF do signatário." }, "email": { "type": "string", "nullable": true, "description": "Email do signatário para envi-o do link de assinatura digital." }, "role": { "type": "string", "nullable": true, "description": "Cargo/função do signatário na empresa. Valores: `partner` (sócio), `witness` (testemunha), `legal` (jurídico), `attorney` (procurador), `financial` (financeiro), `director` (diretor), `representative` (representante).", "enum": [ "partner", "witness", "legal", "attorney", "financial", "director", "representative" ], "example": "partner" } } } }, "editable": { "type": "boolean", "readOnly": true, "description": "Indica se a conta permite edição de signatários. `true`: conta recém-criada ou reabilitada — é possível adicionar/remover/editar signatários. `false`: carta já foi gerada e enviada para assinatura — não é possível editar. Para editar quando `false`: desabilite a conta (PUT /disable), habilite novamente (PUT /enable), depois atualize os signatários (PUT /dda_accounts/:uid).", "example": true }, "status": { "type": "string", "enum": [ "pending", "awaiting_approval", "approved", "signature_rejected" ], "readOnly": true, "description": "Status geral de aprovação da conta DDA. `pending` (aguardando conclusão da carta de adesão — signatários ainda não assinaram), `awaiting_approval` (carta assinada por todos — aguardando aprovação pelo Manager Kobana), `approved` (conta aprovada e ativa — boletos DDA sincronizados automaticamente — campo `enabled_at` preenchido), `signature_rejected` (carta rejeitada pelo Manager Kobana — consulte `rejection_reason` e `rejected_at`).", "example": "pending" }, "letter_status": { "type": "string", "enum": [ "not_created", "creating", "created", "failed" ], "readOnly": true, "description": "Status da geração do PDF da carta de adesão. `not_created` (PDF ainda não gerado), `creating` (geração em andamento), `created` (PDF gerado com sucesso — carta enviada para assinatura), `failed` (falha na geração — consulte `error_message`).", "example": "not_created" }, "external_letter_status": { "type": "string", "nullable": true, "enum": [ "pending", "waiting_signatures", "signed", "failed" ], "readOnly": true, "description": "Status da assinatura digital da carta de adesão junto ao provedor. `pending` (carta gerada, aguardando envio para assinatura), `waiting_signatures` (carta enviada — aguardando assinatura dos signatários), `signed` (todos os signatários assinaram — carta concluída), `failed` (falha no processo de assinatura junto ao provedor).", "example": "pending" }, "letter_signed_url": { "type": "string", "nullable": true, "readOnly": true, "description": "URL para download da carta DDA assinada. Quando `external_letter_status` é `signed`, esta URL aponta para o PDF assinado por todos os signatários. A URL é gerenciada via ActiveStorage e permanece válida. Retorna `null` quando a carta ainda não foi assinada ou não está disponível.", "example": "https://app.kobana.com.br/rails/active_storage/blobs/.../dda_letter_signed_123.pdf" }, "error_message": { "type": "string", "nullable": true, "readOnly": true, "description": "Mensagem de erro detalhada quando ocorre falha na geração da carta de adesão. Retorna `null` quando não há erro.", "example": null }, "enabled_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora (ISO 8601) em que a conta DDA foi habilitada/ativada, **confirmada pelo provedor**. Quando `null`, a conta está desabilitada (ou uma habilitação foi solicitada e ainda aguarda confirmação — veja `enable_requested_at`)." }, "disabled_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora (ISO 8601) em que a conta DDA foi desabilitada, **confirmada pelo provedor**. Após desabilitação, há um período de carência de 21 minutos antes de poder reabilitar (exigência do provedor)." }, "enable_requested_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora (ISO 8601) em que a habilitação foi solicitada (via PUT /enable), ainda aguardando confirmação do provedor. Quando presente e `enabled_at` ainda é `null`, a conta está no estado \"aguardando confirmação\". Fica `null` novamente assim que a confirmação chega." }, "disable_requested_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora (ISO 8601) em que a desabilitação foi solicitada (via PUT /disable), ainda aguardando confirmação do provedor. Quando presente e `disabled_at` ainda é `null`, a conta está no estado \"aguardando confirmação\". Fica `null` novamente assim que a confirmação chega." }, "validated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora (ISO 8601) em que a carta DDA foi validada/aprovada pelo Manager Kobana." }, "rejected_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora (ISO 8601) em que a carta foi rejeitada pelo Manager Kobana. Preenchido quando `status` é `signature_rejected`." }, "rejection_reason": { "type": "string", "nullable": true, "readOnly": true, "description": "Motivo informado pelo Manager Kobana ao rejeitar a carta de adesão. Preenchido quando `status` é `signature_rejected`." }, "bank_billets_sync_last_updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora (ISO 8601) da última sincronização bem-sucedida de boletos DDA. Indica quando o sistema buscou e processou novos boletos do provedor para esta conta." }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data e hora (ISO 8601) em que a conta DDA foi criada na plataforma Kobana." }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data e hora (ISO 8601) da última atualização desta conta DDA." }, "business_legal_name": { "type": "string", "nullable": true, "maxLength": 255, "description": "Razão social da empresa associada ao CNPJ da conta DDA. Campo opcional, informado diretamente pelo cliente da API (sem consulta automática de CNPJ).", "example": "Empresa Exemplo Ltda" }, "phone_number": { "type": "string", "nullable": true, "maxLength": 20, "description": "Telefone de contato da empresa associada ao CNPJ da conta DDA. Campo opcional.", "example": "11987654321" }, "address": { "type": "object", "description": "Endereço da empresa associada ao CNPJ da conta DDA. Todos os subcampos são opcionais. Retorna `{}` quando nenhum subcampo foi informado. Uma atualização substitui o hash inteiro — não faz merge parcial com o valor anterior.", "properties": { "zip_code": { "type": "string", "nullable": true, "maxLength": 8, "description": "CEP (formato 99999999 — traços e outros caracteres não numéricos são removidos automaticamente).", "example": "01310100" }, "street": { "type": "string", "nullable": true, "maxLength": 255, "description": "Logradouro (rua, avenida, etc.).", "example": "Av. Paulista" }, "number": { "type": "string", "nullable": true, "maxLength": 10, "description": "Número do endereço.", "example": "1000" }, "complement": { "type": "string", "nullable": true, "maxLength": 60, "description": "Complemento (sala, andar, etc.).", "example": "Sala 101" }, "neighborhood": { "type": "string", "nullable": true, "maxLength": 80, "description": "Bairro.", "example": "Bela Vista" }, "city_name": { "type": "string", "nullable": true, "maxLength": 60, "description": "Cidade.", "example": "São Paulo" }, "state": { "type": "string", "nullable": true, "maxLength": 2, "description": "Sigla da UF. Deve ser uma UF brasileira válida.", "example": "SP" } } } } }, "v2_new_dda_account": { "type": "object", "required": [ "cnpj" ], "properties": { "cnpj": { "type": "string", "description": "CNPJ ou CPF da empresa/pessoa para a qual o DDA será habilitado. Deve ser um documento válido. Cada conta Kobana pode ter apenas uma conta DDA ativa.", "example": "11.222.333/0001-81" }, "signers": { "type": "array", "description": "Lista de 1 a 3 signatários da carta de adesão ao DDA. Cada signatário receberá um e-mail com link para assinatura digital.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Nome completo do signatário conforme documento de identidade.", "example": "João da Silva" }, "document_number": { "type": "string", "description": "CPF do signatário (formato: 000.000.000-00 ou somente números).", "example": "111.222.333-44" }, "email": { "type": "string", "description": "E-mail do signatário para envio do link de assinatura digital.", "example": "joao@exemplo.com" }, "role": { "type": "string", "nullable": true, "description": "Cargo/função do signatário na empresa. Campo opcional. Valores: `partner` (sócio), `witness` (testemunha), `legal` (jurídico), `attorney` (procurador), `financial` (financeiro), `director` (diretor), `representative` (representante).", "enum": [ "partner", "witness", "legal", "attorney", "financial", "director", "representative" ], "example": "partner" } }, "required": [ "name", "document_number", "email" ] } }, "business_legal_name": { "type": "string", "nullable": true, "maxLength": 255, "description": "Razão social da empresa associada ao CNPJ da conta DDA. Campo opcional.", "example": "Empresa Exemplo Ltda" }, "phone_number": { "type": "string", "nullable": true, "maxLength": 20, "description": "Telefone de contato da empresa associada ao CNPJ da conta DDA. Campo opcional.", "example": "11987654321" }, "address": { "type": "object", "description": "Endereço da empresa associada ao CNPJ da conta DDA. Campo opcional; todos os subcampos também são opcionais.", "properties": { "zip_code": { "type": "string", "nullable": true, "maxLength": 8, "description": "CEP (formato 99999999 — traços e outros caracteres não numéricos são removidos automaticamente).", "example": "01310100" }, "street": { "type": "string", "nullable": true, "maxLength": 255, "description": "Logradouro (rua, avenida, etc.).", "example": "Av. Paulista" }, "number": { "type": "string", "nullable": true, "maxLength": 10, "description": "Número do endereço.", "example": "1000" }, "complement": { "type": "string", "nullable": true, "maxLength": 60, "description": "Complemento (sala, andar, etc.).", "example": "Sala 101" }, "neighborhood": { "type": "string", "nullable": true, "maxLength": 80, "description": "Bairro.", "example": "Bela Vista" }, "city_name": { "type": "string", "nullable": true, "maxLength": 60, "description": "Cidade.", "example": "São Paulo" }, "state": { "type": "string", "nullable": true, "maxLength": 2, "description": "Sigla da UF. Deve ser uma UF brasileira válida.", "example": "SP" } } } } }, "v2_update_dda_account": { "type": "object", "properties": { "signers": { "type": "array", "description": "Lista de 1 a 3 signatários da carta de adesão ao DDA. Cada signatário receberá um e-mail com link para assinatura digital.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Nome completo do signatário conforme documento de identidade.", "example": "João da Silva" }, "document_number": { "type": "string", "description": "CPF do signatário (formato: 000.000.000-00 ou somente números).", "example": "111.222.333-44" }, "email": { "type": "string", "description": "E-mail do signatário para envio do link de assinatura digital.", "example": "joao@exemplo.com" }, "role": { "type": "string", "nullable": true, "description": "Cargo/função do signatário na empresa. Campo opcional. Valores: `partner` (sócio), `witness` (testemunha), `legal` (jurídico), `attorney` (procurador), `financial` (financeiro), `director` (diretor), `representative` (representante).", "enum": [ "partner", "witness", "legal", "attorney", "financial", "director", "representative" ], "example": "partner" } }, "required": [ "name", "document_number", "email" ] } }, "business_legal_name": { "type": "string", "nullable": true, "maxLength": 255, "description": "Razão social da empresa associada ao CNPJ da conta DDA. Campo opcional.", "example": "Empresa Exemplo Ltda" }, "phone_number": { "type": "string", "nullable": true, "maxLength": 20, "description": "Telefone de contato da empresa associada ao CNPJ da conta DDA. Campo opcional.", "example": "11987654321" }, "address": { "type": "object", "description": "Endereço da empresa associada ao CNPJ da conta DDA. Campo opcional; todos os subcampos também são opcionais. Substitui o hash inteiro salvo anteriormente — não faz merge parcial.", "properties": { "zip_code": { "type": "string", "nullable": true, "maxLength": 8, "description": "CEP (formato 99999999 — traços e outros caracteres não numéricos são removidos automaticamente).", "example": "01310100" }, "street": { "type": "string", "nullable": true, "maxLength": 255, "description": "Logradouro (rua, avenida, etc.).", "example": "Av. Paulista" }, "number": { "type": "string", "nullable": true, "maxLength": 10, "description": "Número do endereço.", "example": "1000" }, "complement": { "type": "string", "nullable": true, "maxLength": 60, "description": "Complemento (sala, andar, etc.).", "example": "Sala 101" }, "neighborhood": { "type": "string", "nullable": true, "maxLength": 80, "description": "Bairro.", "example": "Bela Vista" }, "city_name": { "type": "string", "nullable": true, "maxLength": 60, "description": "Cidade.", "example": "São Paulo" }, "state": { "type": "string", "nullable": true, "maxLength": 2, "description": "Sigla da UF. Deve ser uma UF brasileira válida.", "example": "SP" } } } } }, "v2_dda_bank_billet": { "type": "object", "properties": { "uid": { "type": "string", "readOnly": true, "description": "Identificador único do boleto DDA (UUID). Utilize este valor para consultar, liberar ou rejeitar o boleto via API.", "example": "e596865f-07a4-4458-88c1-fbb4ffd196e1" }, "status": { "type": "string", "readOnly": true, "enum": [ "pending", "released", "rejected", "paid" ], "description": "Status interno do boleto DDA na plataforma Kobana. Representa o fluxo de aprovação pelo cliente: `pending` (disponível para ação: liberar ou rejeitar), `released` (liberado pelo cliente para pagamento — campo `released_at` preenchido), `rejected` (rejeitado pelo cliente — transição irreversível — campo `rejected_at` preenchido), `paid` (pago via Kobana — campo `payment_uid` preenchido).", "example": "pending" }, "external_status": { "type": "string", "nullable": true, "readOnly": true, "enum": [ "open", "overdue", "paid", "canceled", "downloaded", "blocked" ], "description": "Status externo do boleto informado pelo provedor. Completamente independente do campo `status` e pode mudar a qualquer momento via sincronização. `open` (em aberto, disponível para pagamento), `overdue` (vencido — podem incidir juros e multa), `paid` (pago confirmado pelo banco — pode ocorrer antes ou independente de `status: paid`), `canceled` (cancelado pelo beneficiário ou banco), `downloaded` (baixado — equivale a pago para fins de processamento interno), `blocked` (bloqueado — o boleto foi criado, mas ainda não está disponível para pagamento).", "example": "open" }, "barcode": { "type": "string", "nullable": true, "readOnly": true, "description": "Código de barras do boleto (44 dígitos). Pode ser nulo quando o boleto ainda está em fase de sincronização inicial.", "example": "34193497900000150001740000000148050088825000" }, "line": { "type": "string", "nullable": true, "readOnly": true, "description": "Linha digitável do boleto — representação formatada do código de barras para digitação manual. Pode ser nula durante sincronização inicial.", "example": "34191.74001 00000.148050 08882.500009 3 49790000015000" }, "our_number": { "type": "string", "nullable": true, "readOnly": true, "description": "Nosso número atribuído pelo banco emissor. Identificador único do boleto no sistema bancário do beneficiário.", "example": "123556238" }, "description": { "type": "string", "nullable": true, "readOnly": true, "description": "Descrição ou instruções do boleto informadas pelo beneficiário (cedente).", "example": "Pagamento de serviço" }, "nominal_amount": { "type": "number", "format": "float", "nullable": true, "readOnly": true, "description": "Valor original (face) do boleto em reais (BRL), sem acréscimos ou descontos. Pode diferir do `amount` após o vencimento quando juros/multa são aplicados.", "example": 150.0 }, "amount": { "type": "number", "format": "float", "nullable": true, "readOnly": true, "description": "Valor atualizado do boleto em reais (BRL), já considerando juros, multa, descontos e abatimentos aplicáveis. Pode diferir do `nominal_amount` após o vencimento.", "example": 76.0 }, "min_payment_amount": { "type": "number", "format": "float", "nullable": true, "readOnly": true, "description": "Valor mínimo aceito para pagamento do boleto em reais (BRL). Relevante quando `allow_parcial_payment` é `true`.", "example": 10.0 }, "max_payment_amount": { "type": "number", "format": "float", "nullable": true, "readOnly": true, "description": "Valor máximo aceito para pagamento do boleto em reais (BRL).", "example": 200.0 }, "expire_at": { "type": "string", "format": "date", "nullable": true, "readOnly": true, "description": "Data de vencimento do boleto (formato ISO 8601: AAAA-MM-DD). Após essa data, podem incidir juros e multa conforme configurado pelo beneficiário.", "example": "2026-04-01" }, "issue_date": { "type": "string", "format": "date", "nullable": true, "readOnly": true, "description": "Data de emissão do boleto pelo beneficiário (formato ISO 8601: AAAA-MM-DD).", "example": "2026-03-04" }, "reference_month": { "type": "string", "nullable": true, "readOnly": true, "enum": [ "january", "february", "march", "april", "may", "june", "july", "august", "september", "october", "november", "december" ], "description": "Mês de referência/competência do boleto (ex: mês do serviço cobrado). Valores em inglês.", "example": "march" }, "beneficiary_name": { "type": "string", "nullable": true, "readOnly": true, "description": "Nome ou razão social do beneficiário (cedente) — empresa ou pessoa que emitiu o boleto e receberá o pagamento.", "example": "Kobana Tecnologia Ltda." }, "beneficiary_cnpj_cpf": { "type": "string", "nullable": true, "readOnly": true, "description": "CPF ou CNPJ do beneficiário (cedente).", "example": "05.813.794/0001-26" }, "beneficiary_bank_name": { "type": "string", "nullable": true, "readOnly": true, "description": "Nome do banco onde o beneficiário possui conta para recebimento.", "example": "Banco do Brasil" }, "beneficiary_bank_number": { "type": "string", "nullable": true, "readOnly": true, "description": "Código COMPE (3 dígitos) do banco do beneficiário. Ex: `001` (Banco do Brasil), `341` (Itaú), `237` (Bradesco).", "example": "001" }, "owner_cnpj_cpf": { "type": "string", "nullable": true, "readOnly": true, "description": "CPF ou CNPJ do pagador (sacado). Corresponde ao CNPJ/CPF cadastrado na conta DDA.", "example": "83.191.445/0001-23" }, "owner_person_name": { "type": "string", "nullable": true, "readOnly": true, "description": "Nome ou razão social do pagador (sacado) — empresa ou pessoa em cujo nome o boleto foi emitido.", "example": "Empresa Pagadora S.A." }, "fine_amount": { "type": "number", "format": "float", "nullable": true, "readOnly": true, "description": "Valor fixo da multa por atraso em reais (BRL). Aplicável após a `fine_date`.", "example": 2.4 }, "fine_percentage": { "type": "number", "format": "float", "nullable": true, "readOnly": true, "description": "Percentual da multa por atraso sobre o valor do boleto. Aplicável após a `fine_date`.", "example": 2.4 }, "fine_date": { "type": "string", "format": "date", "nullable": true, "readOnly": true, "description": "Data a partir da qual a multa por atraso passa a ser cobrada (formato ISO 8601).", "example": "2026-04-02" }, "interest_amount": { "type": "number", "format": "float", "nullable": true, "readOnly": true, "description": "Valor fixo de juros por dia de atraso em reais (BRL). Aplicável após a `interest_date`.", "example": 2.4 }, "interest_percentage": { "type": "number", "format": "float", "nullable": true, "readOnly": true, "description": "Percentual de juros por dia/mês de atraso. Aplicável após a `interest_date`.", "example": 2.4 }, "interest_date": { "type": "string", "format": "date", "nullable": true, "readOnly": true, "description": "Data a partir da qual os juros por atraso passam a incidir (formato ISO 8601).", "example": "2026-04-03" }, "discount_amount": { "type": "number", "format": "float", "nullable": true, "readOnly": true, "description": "Valor fixo de desconto para pagamento antecipado em reais (BRL). Válido até a `discount_date`.", "example": 5.0 }, "discount_date": { "type": "string", "format": "date", "nullable": true, "readOnly": true, "description": "Data limite para obter o desconto por pagamento antecipado (formato ISO 8601). Após essa data, o desconto não se aplica.", "example": "2026-03-31" }, "reduction_amount": { "type": "number", "format": "float", "nullable": true, "readOnly": true, "description": "Valor do abatimento concedido pelo beneficiário em reais (BRL). Diferente do desconto, o abatimento reduz o valor total independente da data de pagamento.", "example": 0.0 }, "allow_parcial_payment": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se o boleto aceita pagamento parcial (valor inferior ao total). Quando `true`, o pagamento pode ser feito com valor entre `min_payment_amount` e `max_payment_amount`.", "example": false }, "released_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora (ISO 8601) em que o boleto foi liberado para pagamento pelo cliente. Preenchido apenas quando `status` é `released` ou `paid`." }, "rejected_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora (ISO 8601) em que o boleto foi rejeitado pelo cliente. Preenchido apenas quando `status` é `rejected`." }, "payment_uid": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true, "description": "UUID do pagamento Kobana vinculado a este boleto DDA. Permite rastrear o pagamento originado a partir deste boleto. Preenchido quando o boleto é associado a um pagamento via API." }, "dda_account_uid": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true, "description": "UUID da conta DDA (Dda::Account) que originou este boleto. Permite atribuir cada boleto à sua conta DDA quando a conta macro possui múltiplas contas DDA (CNPJs distintos). Nulo para registros legados ainda não backfillados." }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data e hora (ISO 8601) em que o boleto DDA foi recebido e registrado na plataforma Kobana." }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data e hora (ISO 8601) da última atualização deste boleto (alteração de status, sincronização de dados, etc.)." } } }, "v2_payment_account": { "type": "object", "properties": { "uid": { "type": "string", "readOnly": true, "description": "UUID da conta de pagamento", "example": "e596865f-07a4-4458-88c1-fbb4ffd196e1" }, "financial_account_uid": { "type": "string", "readOnly": true, "description": "UUID da conta financeira associada", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "connection_uid": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true, "description": "Conexão bancária da conta.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "agreement_code": { "type": "string", "nullable": true, "description": "Código do convênio", "example": "123456" }, "provider_data": { "type": "object", "nullable": true, "description": "Dados específicos do provider.", "properties": { "service_point_number": { "type": "string", "nullable": true, "description": "Número do ponto de atendimento. Envie `null` para limpar o valor.", "example": "0001" }, "cooperative_cnpj": { "type": "string", "nullable": true, "description": "CNPJ da cooperativa Sicoob do titular da conta. Envie `null` para limpar o valor.", "examples": [ "13.009.717/0001-46", "13009717000146" ] } } }, "external_id": { "type": "string", "nullable": true, "description": "Identificador externo da conta de pagamento", "example": "external-payment-123" }, "balance_validation_enabled_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora em que a validação de saldo foi habilitada" }, "remittance_enabled_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora em que a remessa EDI foi habilitada" }, "remittance_enabled": { "type": "boolean", "writeOnly": true, "description": "Habilita ou desabilita a geração de remessas EDI para esta conta." }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data e hora da última atualização do registro" } } }, "v2_new_payment_account": { "type": "object", "description": "Cria uma conta de pagamento sob uma conta financeira.", "required": [ "financial_account_uid" ], "properties": { "financial_account_uid": { "type": "string", "description": "UUID da Conta Financeira que receberá a nova conta de pagamento", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "agreement_code": { "type": "string", "nullable": true, "description": "Código do convênio (até 30 caracteres)", "example": "123456" }, "external_id": { "type": "string", "nullable": true, "description": "Identificador externo da conta de pagamento", "example": "external-payment-123" }, "remittance_enabled": { "type": "boolean", "nullable": true, "description": "Habilita ou desabilita a geração de remessas EDI para esta conta. Se omitido na criação, herda automaticamente `true` quando a conta financeira já possui um EdiBox de pagamento ativo (carta EDI validada e habilitada); caso contrário, nasce `false`. Enviar `null` explicitamente equivale a `false` (desabilita e não aciona a herança automática)." }, "provider_data": { "type": "object", "nullable": true, "description": "Atributos específicos do provider bancário.", "properties": { "service_point_number": { "type": "string", "nullable": true, "description": "Número do ponto de atendimento (ex.: `numeroPa` no Sicoob).", "example": "0001" }, "cooperative_cnpj": { "type": "string", "nullable": true, "description": "CNPJ da cooperativa Sicoob do titular da conta.", "example": "13.009.717/0001-46" } } } } }, "v2_payment_bank_billet": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID do Pagamento", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "kind": { "type": "string", "readOnly": true, "enum": [ "bank_billet", "darf", "utility", "gru", "pix", "tax" ], "description": "Tipo do Pagamento", "example": "pix" }, "amount": { "type": "number", "readOnly": true, "format": "float", "example": 120.99, "description": "Quantia\n" }, "scheduled_to": { "type": "string", "readOnly": true, "nullable": true, "format": "date", "example": "2023-12-12", "description": "Data de Agendamento" }, "status": { "readOnly": true, "type": "string", "description": "Status do Pagamento.\n\n`pending`: Pendente.\n`rejected`: Rejeitado.\n`approved`: Aprovado.\n`reproved`: Reprovado.\n`failed`: Falha.\n`confirmed`: Confirmado.\n`canceled`: Cancelado.\n`awaiting_approval`: Aguardando Aprovação.\n`scheduled`: Agendado.\n`awaiting_scheduled_date`: Aguardando Data Agendada.\n`overdue`: Vencido.\n`awaiting_funds`: Aguardando Saldo.\n`finishing`: Finalizando\n" }, "registration_status": { "readOnly": true, "type": "string", "description": "Status de Registro.\n\n`pending`: Pendente.\n`requested`: Requisitado.\n`confirmed`: Confirmado.\n`rejected`: Rejeitado.\n`failed`: Falha\n" }, "confirmed_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2023-12-12", "description": "Data em que a Kobana processou a confirmação da operação. Não representa necessariamente a data em que o valor saiu da conta — para isso use transaction_date." }, "rejected_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2023-12-12", "description": "Data da Rejeição" }, "rejected_error": { "type": "string", "readOnly": true, "nullable": true, "description": "Motivo da rejeição retornado pelo banco" }, "transaction_code": { "readOnly": true, "nullable": true, "type": "string", "description": "Código de Autenticação", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transaction_date": { "readOnly": true, "nullable": true, "type": "string", "format": "date-time", "description": "Data oficial da liquidação/débito informada pelo banco (data da autenticação). Reflete quando o valor efetivamente saiu da conta.", "example": "2023-12-12" }, "financial_account_uid": { "type": "string", "readOnly": true, "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "readOnly": true, "nullable": true, "format": "uuid", "description": "Conta de pagamento de origem. Quando não informada na criação, usou-se automaticamente a mais antiga da conta financeira.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "batch_uid": { "type": "string", "readOnly": true, "nullable": true, "format": "uuid", "description": "UID do Lote ao qual este pagamento pertence", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "source": { "readOnly": true, "nullable": true, "type": "string", "description": "Origem do Pagamento.\n\n`api`: API.\n`dda`: DDA.\n`view`: Manual\n" }, "beneficiary": { "readOnly": true, "nullable": true, "type": "object", "description": "Dados do Beneficiário (quando disponível)", "properties": { "name": { "type": "string", "nullable": true, "description": "Nome ou Razão Social do Beneficiário", "example": "João da Silva" }, "document_number": { "type": "string", "nullable": true, "description": "CPF ou CNPJ do Beneficiário", "example": "111.321.322-09" } } }, "bank_billet": { "type": "object", "description": "Dados do boleto a ser pago.", "properties": { "code": { "type": "string", "readOnly": true, "description": "Código de Barras ou Linha Digitável" }, "beneficiary": { "type": "object", "description": "Dados do Beneficiário", "properties": { "document_number": { "type": "string", "nullable": true, "readOnly": true, "description": "Número do Documento (CPF ou CNPJ)", "example": "111.321.322-09" }, "name": { "type": "string", "nullable": true, "readOnly": true, "description": "Nome Completo ou Razão Social", "example": "João da Silva" } } } } }, "formats": { "readOnly": true, "nullable": true, "type": "object", "description": "URLs do comprovante de pagamento (disponível após confirmação)", "properties": { "default": { "type": "object", "properties": { "html": { "type": "string", "nullable": true, "description": "URL HTML do comprovante" }, "png": { "type": "string", "nullable": true, "description": "URL PNG do comprovante" }, "pdf": { "type": "string", "nullable": true, "description": "URL PDF do comprovante" } } } } }, "identifier": { "type": "string", "nullable": true, "description": "Identificação do pagamento no comprovante do provedor financeiro. (Uso exclusivo do banco)\n\nBancos que aceitam esse campo (via API): Itaú\n" }, "financial_provider_external_id": { "type": "string", "nullable": true, "readOnly": true, "description": "ID na instituição financeira" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data e hora de criação do registro no banco de dados" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data e hora da última atualização do registro no banco de dados" } }, "required": [ "bank_billet" ] }, "v2_new_payment_bank_billet": { "type": "object", "description": "Novo Pagamento de Boleto.", "required": [ "amount", "financial_account_uid", "code" ], "properties": { "amount": { "type": "number", "format": "float", "example": 120.99, "description": "Quantia\n" }, "scheduled_to": { "type": "string", "format": "date", "nullable": true, "description": "Data de Agendamento", "example": "2023-12-12" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de pagamento de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "code": { "type": "string", "description": "Código de Barras ou Linha Digitável" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "beneficiary": { "type": "object", "nullable": true, "description": "Dados do Beneficiário. Obrigatório quando a conta financeira for BB; caso contrário, opcional — quando informado, substitui os dados extraídos do código de barras.", "properties": { "name": { "type": "string", "nullable": true, "description": "Nome Completo ou Razão Social", "example": "João da Silva" }, "document_number": { "type": "string", "nullable": true, "description": "Número do Documento (CPF ou CNPJ). Obrigatório quando a conta financeira for BB.", "example": "111.321.322-09" } } } } }, "v2_payment_batch": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID do Lote de Pagamento" }, "status": { "readOnly": true, "type": "string", "description": "Status.\n\n`pending`: Pendente.\n`awaiting_approval`: Aguardando Aprovação.\n`confirmed`: Confirmado.\n`approved`: Aprovado.\n`reproved`: Reprovado.\n`rejected`: Rejeitado.\n`scheduled`: Agendado.\n`finishing`: Finalizando.\n`canceled`: Cancelado\n" }, "registration_status": { "readOnly": true, "type": "string", "description": "Status de Registro.\n\n`pending`: Pendente.\n`requested`: Requisitado.\n`confirmed`: Confirmado.\n`rejected`: Rejeitado.\n`failed`: Falha\n" }, "payments": { "type": "array", "description": "Lista de Pagamentos. Abaixo segue esquemas dos tipos de pagamento possíveis.", "items": { "anyOf": [ { "$ref": "#/components/schemas/v2_payment_bank_billet" }, { "$ref": "#/components/schemas/v2_payment_darf" }, { "$ref": "#/components/schemas/v2_payment_tax" }, { "$ref": "#/components/schemas/v2_payment_pix" } ] } }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "readOnly": true, "nullable": true, "format": "uuid", "description": "Conta de pagamento de origem. Quando não informada na criação, usou-se automaticamente a mais antiga da conta financeira.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da criação. Formato iso8601" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da atualização. Formato iso8601" } } }, "v2_new_payment_batch_bank_billet": { "type": "object", "required": [ "financial_account_uid", "payments" ], "properties": { "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de pagamento aplicada a todo o lote (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à conta financeira do lote.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payments": { "type": "array", "description": "Lista de Pagamentos de Boletos novos ou existentes.", "items": { "anyOf": [ { "type": "object", "description": "Novo Pagamento de Boleto.", "required": [ "amount", "code" ], "properties": { "amount": { "type": "number", "format": "float", "example": 120.99, "description": "Quantia\n" }, "scheduled_to": { "type": "string", "format": "date", "nullable": true, "description": "Data de Agendamento", "example": "2023-12-12" }, "payment_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de pagamento de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "code": { "type": "string", "description": "Código de Barras ou Linha Digitável" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "beneficiary": { "type": "object", "nullable": true, "description": "Dados do Beneficiário. Obrigatório quando a conta financeira for BB; caso contrário, opcional — quando informado, substitui os dados extraídos do código de barras.", "properties": { "name": { "type": "string", "nullable": true, "description": "Nome Completo ou Razão Social", "example": "João da Silva" }, "document_number": { "type": "string", "nullable": true, "description": "Número do Documento (CPF ou CNPJ). Obrigatório quando a conta financeira for BB.", "example": "111.321.322-09" } } } } }, { "type": "object", "required": [ "uid" ], "description": "Pagamento existente.", "properties": { "uid": { "type": "string", "format": "uuid", "description": "UID de um Pagamento", "example": "018df180-7208-727b-a10a-ea545e4a75a8" } } } ] } } } }, "v2_payment_batch_bank_billet": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID do Lote de Pagamento" }, "status": { "readOnly": true, "type": "string", "description": "Status.\n\n`pending`: Pendente.\n`awaiting_approval`: Aguardando Aprovação.\n`confirmed`: Confirmado.\n`approved`: Aprovado.\n`reproved`: Reprovado.\n`rejected`: Rejeitado.\n`scheduled`: Agendado.\n`finishing`: Finalizando.\n`canceled`: Cancelado\n" }, "registration_status": { "readOnly": true, "type": "string", "description": "Status de Registro.\n\n`pending`: Pendente.\n`requested`: Requisitado.\n`confirmed`: Confirmado.\n`rejected`: Rejeitado.\n`failed`: Falha\n" }, "payments": { "type": "array", "description": "Lista de Pagamentos. Abaixo segue esquemas dos tipos de pagamento possíveis.", "items": { "$ref": "#/components/schemas/v2_payment_bank_billet" } }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "readOnly": true, "nullable": true, "format": "uuid", "description": "Conta de pagamento de origem. Quando não informada na criação, usou-se automaticamente a mais antiga da conta financeira.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da criação. Formato iso8601" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da atualização. Formato iso8601" } } }, "v2_payment_batch_command": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Comando." }, "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "Identificador público (UUID) do Comando. Utilizado como parâmetro na consulta individual (`GET /commands/{uid}`)." }, "status": { "type": "string", "readOnly": true, "description": "Status do comando.\n\n`pending`: Comando ainda não executado. [Estado inicial]\n`confirmed`: Comando executado e confirmado.\n`failed`: Execução do comando falhou.\n" }, "operation": { "type": "string", "readOnly": true, "description": "Tipo da operação.\n\n`approve`: Aprovação.\n`reprove`: Reprovação.\n" }, "resource_type": { "type": "string", "readOnly": true, "nullable": true, "description": "Tipo do recurso ao qual o Comando pertence (ex.: `BankBillet`, `Pix`, `Financial::Account`)." }, "resource_uid": { "type": "string", "format": "uuid", "readOnly": true, "nullable": true, "description": "Identificador público (UUID) do recurso ao qual o Comando pertence." }, "financial_provider_slug": { "type": "string", "readOnly": true, "nullable": true, "description": "Slug do provedor financeiro (banco) responsável pela execução do Comando." }, "params": { "type": "object", "readOnly": true, "nullable": true, "description": "Parâmetros para a execução do Comando." }, "payload": { "type": "object", "readOnly": true, "nullable": true, "description": "Resposta do servidor com o resultado da operação." }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da criação do registro do Comando" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da atualização do registro do Comando." }, "confirmation_via": { "type": "string", "enum": [ "api", "edi" ], "readOnly": true, "nullable": true, "description": "Origem da confirmação do Comando.\n\n`api`: confirmado via resposta da API do banco (inclui webhooks, Recuperator e sync).\n`edi`: confirmado via retorno CNAB (arquivo de baixa).\n`null`: Sem origem registrada.\n" }, "pix": { "$ref": "#/components/schemas/v2_payment_batch" } } }, "v2_payment_command": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Comando." }, "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "Identificador público (UUID) do Comando. Utilizado como parâmetro na consulta individual (`GET /commands/{uid}`)." }, "status": { "type": "string", "readOnly": true, "description": "Status do comando.\n\n`pending`: Comando ainda não executado. [Estado inicial]\n`confirmed`: Comando executado e confirmado.\n`failed`: Execução do comando falhou.\n" }, "operation": { "type": "string", "readOnly": true, "description": "Tipo da operação.\n\n`cancel`: Cancelamento.\n" }, "resource_type": { "type": "string", "readOnly": true, "nullable": true, "description": "Tipo do recurso ao qual o Comando pertence (ex.: `BankBillet`, `Pix`, `Financial::Account`)." }, "resource_uid": { "type": "string", "format": "uuid", "readOnly": true, "nullable": true, "description": "Identificador público (UUID) do recurso ao qual o Comando pertence." }, "financial_provider_slug": { "type": "string", "readOnly": true, "nullable": true, "description": "Slug do provedor financeiro (banco) responsável pela execução do Comando." }, "params": { "type": "object", "readOnly": true, "nullable": true, "description": "Parâmetros para a execução do Comando." }, "payload": { "type": "object", "readOnly": true, "nullable": true, "description": "Resposta do servidor com o resultado da operação." }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da criação do registro do Comando" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da atualização do registro do Comando." }, "confirmation_via": { "type": "string", "enum": [ "api", "edi" ], "readOnly": true, "nullable": true, "description": "Origem da confirmação do Comando.\n\n`api`: confirmado via resposta da API do banco (inclui webhooks, Recuperator e sync).\n`edi`: confirmado via retorno CNAB (arquivo de baixa).\n`null`: Sem origem registrada.\n" }, "payment": { "$ref": "#/components/schemas/v2_generic_payment" } } }, "v2_payment_utility": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID do Pagamento", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "kind": { "type": "string", "readOnly": true, "enum": [ "bank_billet", "darf", "utility", "gru", "pix", "tax" ], "description": "Tipo do Pagamento", "example": "pix" }, "amount": { "type": "number", "readOnly": true, "format": "float", "example": 120.99, "description": "Quantia\n" }, "scheduled_to": { "type": "string", "readOnly": true, "nullable": true, "format": "date", "example": "2023-12-12", "description": "Data de Agendamento" }, "status": { "readOnly": true, "type": "string", "description": "Status do Pagamento.\n\n`pending`: Pendente.\n`rejected`: Rejeitado.\n`approved`: Aprovado.\n`reproved`: Reprovado.\n`failed`: Falha.\n`confirmed`: Confirmado.\n`canceled`: Cancelado.\n`awaiting_approval`: Aguardando Aprovação.\n`scheduled`: Agendado.\n`awaiting_scheduled_date`: Aguardando Data Agendada.\n`overdue`: Vencido.\n`awaiting_funds`: Aguardando Saldo.\n`finishing`: Finalizando\n" }, "registration_status": { "readOnly": true, "type": "string", "description": "Status de Registro.\n\n`pending`: Pendente.\n`requested`: Requisitado.\n`confirmed`: Confirmado.\n`rejected`: Rejeitado.\n`failed`: Falha\n" }, "confirmed_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2023-12-12", "description": "Data em que a Kobana processou a confirmação da operação. Não representa necessariamente a data em que o valor saiu da conta — para isso use transaction_date." }, "rejected_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2023-12-12", "description": "Data da Rejeição" }, "rejected_error": { "type": "string", "readOnly": true, "nullable": true, "description": "Motivo da rejeição retornado pelo banco" }, "transaction_code": { "readOnly": true, "nullable": true, "type": "string", "description": "Código de Autenticação", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transaction_date": { "readOnly": true, "nullable": true, "type": "string", "format": "date-time", "description": "Data oficial da liquidação/débito informada pelo banco (data da autenticação). Reflete quando o valor efetivamente saiu da conta.", "example": "2023-12-12" }, "financial_account_uid": { "type": "string", "readOnly": true, "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "readOnly": true, "nullable": true, "format": "uuid", "description": "Conta de pagamento de origem. Quando não informada na criação, usou-se automaticamente a mais antiga da conta financeira.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "batch_uid": { "type": "string", "readOnly": true, "nullable": true, "format": "uuid", "description": "UID do Lote ao qual este pagamento pertence", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "source": { "readOnly": true, "nullable": true, "type": "string", "description": "Origem do Pagamento.\n\n`api`: API.\n`dda`: DDA.\n`view`: Manual\n" }, "beneficiary": { "readOnly": true, "nullable": true, "type": "object", "description": "Dados do Beneficiário (quando disponível)", "properties": { "name": { "type": "string", "nullable": true, "description": "Nome ou Razão Social do Beneficiário", "example": "João da Silva" }, "document_number": { "type": "string", "nullable": true, "description": "CPF ou CNPJ do Beneficiário", "example": "111.321.322-09" } } }, "utility": { "type": "object", "description": "Dados da Conta de Consumo a ser paga.", "properties": { "code": { "type": "string", "readOnly": true, "description": "Código de Barras ou Linha Digitável" }, "beneficiary": { "type": "object", "description": "Dados do Beneficiário", "properties": { "document_number": { "type": "string", "readOnly": true, "nullable": true, "description": "Número do CNPJ", "example": "80.897.837/0001-14" }, "name": { "type": "string", "readOnly": true, "nullable": true, "description": "Razão Social", "example": "Empresa Prestadora de Serviços Ltda." } } } } }, "formats": { "readOnly": true, "nullable": true, "type": "object", "description": "URLs do comprovante de pagamento (disponível após confirmação)", "properties": { "default": { "type": "object", "properties": { "html": { "type": "string", "nullable": true, "description": "URL HTML do comprovante" }, "png": { "type": "string", "nullable": true, "description": "URL PNG do comprovante" }, "pdf": { "type": "string", "nullable": true, "description": "URL PDF do comprovante" } } } } }, "identifier": { "type": "string", "nullable": true, "description": "Identificação do pagamento no comprovante do provedor financeiro. (Uso exclusivo do banco)\n\nBancos que aceitam esse campo (via API): Itaú\n" }, "financial_provider_external_id": { "type": "string", "nullable": true, "readOnly": true, "description": "ID na instituição financeira" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data e hora de criação do registro no banco de dados" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data e hora da última atualização do registro no banco de dados" } }, "required": [ "utility" ] }, "v2_new_payment_utility": { "type": "object", "description": "Novo Pagamento de uma Conta de Consumo.", "required": [ "amount", "financial_account_uid", "code" ], "properties": { "amount": { "type": "number", "format": "float", "example": 120.99, "description": "Quantia\n" }, "scheduled_to": { "type": "string", "format": "date", "nullable": true, "description": "Data de Agendamento", "example": "2023-12-12" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de pagamento de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "code": { "type": "string", "description": "Código de Barras ou Linha Digitável" } } }, "v2_payment_batch_utility": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID do Lote de Pagamento" }, "status": { "readOnly": true, "type": "string", "description": "Status.\n\n`pending`: Pendente.\n`awaiting_approval`: Aguardando Aprovação.\n`confirmed`: Confirmado.\n`approved`: Aprovado.\n`reproved`: Reprovado.\n`rejected`: Rejeitado.\n`scheduled`: Agendado.\n`finishing`: Finalizando.\n`canceled`: Cancelado\n" }, "registration_status": { "readOnly": true, "type": "string", "description": "Status de Registro.\n\n`pending`: Pendente.\n`requested`: Requisitado.\n`confirmed`: Confirmado.\n`rejected`: Rejeitado.\n`failed`: Falha\n" }, "payments": { "type": "array", "description": "Lista de Pagamentos. Abaixo segue esquemas dos tipos de pagamento possíveis.", "items": { "$ref": "#/components/schemas/v2_payment_utility" } }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "readOnly": true, "nullable": true, "format": "uuid", "description": "Conta de pagamento de origem. Quando não informada na criação, usou-se automaticamente a mais antiga da conta financeira.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da criação. Formato iso8601" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da atualização. Formato iso8601" } } }, "v2_new_payment_batch_utility": { "type": "object", "required": [ "financial_account_uid", "payments" ], "properties": { "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de pagamento aplicada a todo o lote (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à conta financeira do lote.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payments": { "type": "array", "description": "Lista de Pagamentos de Contas de Consumo novas ou existentes.", "items": { "anyOf": [ { "type": "object", "description": "Novo Pagamento de uma Conta de Consumo.", "required": [ "amount", "code" ], "properties": { "amount": { "type": "number", "format": "float", "example": 120.99, "description": "Quantia\n" }, "scheduled_to": { "type": "string", "format": "date", "nullable": true, "description": "Data de Agendamento", "example": "2023-12-12" }, "payment_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de pagamento de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "code": { "type": "string", "description": "Código de Barras ou Linha Digitável" } } }, { "type": "object", "required": [ "uid" ], "description": "Pagamento existente.", "properties": { "uid": { "type": "string", "format": "uuid", "description": "UID de um Pagamento", "example": "018df180-7208-727b-a10a-ea545e4a75a8" } } } ] } } } }, "v2_payment_pix": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID do Pagamento", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "kind": { "type": "string", "readOnly": true, "enum": [ "bank_billet", "darf", "utility", "gru", "pix", "tax" ], "description": "Tipo do Pagamento", "example": "pix" }, "amount": { "type": "number", "readOnly": true, "format": "float", "example": 120.99, "description": "Quantia\n" }, "scheduled_to": { "type": "string", "readOnly": true, "nullable": true, "format": "date", "example": "2023-12-12", "description": "Data de Agendamento" }, "status": { "readOnly": true, "type": "string", "description": "Status do Pagamento.\n\n`pending`: Pendente.\n`rejected`: Rejeitado.\n`approved`: Aprovado.\n`reproved`: Reprovado.\n`failed`: Falha.\n`confirmed`: Confirmado.\n`canceled`: Cancelado.\n`awaiting_approval`: Aguardando Aprovação.\n`scheduled`: Agendado.\n`awaiting_scheduled_date`: Aguardando Data Agendada.\n`overdue`: Vencido.\n`awaiting_funds`: Aguardando Saldo.\n`finishing`: Finalizando\n" }, "registration_status": { "readOnly": true, "type": "string", "description": "Status de Registro.\n\n`pending`: Pendente.\n`requested`: Requisitado.\n`confirmed`: Confirmado.\n`rejected`: Rejeitado.\n`failed`: Falha\n" }, "confirmed_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2023-12-12", "description": "Data em que a Kobana processou a confirmação da operação. Não representa necessariamente a data em que o valor saiu da conta — para isso use transaction_date." }, "rejected_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2023-12-12", "description": "Data da Rejeição" }, "rejected_error": { "type": "string", "readOnly": true, "nullable": true, "description": "Motivo da rejeição retornado pelo banco" }, "transaction_code": { "readOnly": true, "nullable": true, "type": "string", "description": "Código de Autenticação", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transaction_date": { "readOnly": true, "nullable": true, "type": "string", "format": "date-time", "description": "Data oficial da liquidação/débito informada pelo banco (data da autenticação). Reflete quando o valor efetivamente saiu da conta.", "example": "2023-12-12" }, "financial_account_uid": { "type": "string", "readOnly": true, "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "readOnly": true, "nullable": true, "format": "uuid", "description": "Conta de pagamento de origem. Quando não informada na criação, usou-se automaticamente a mais antiga da conta financeira.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "batch_uid": { "type": "string", "readOnly": true, "nullable": true, "format": "uuid", "description": "UID do Lote ao qual este pagamento pertence", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "source": { "readOnly": true, "nullable": true, "type": "string", "description": "Origem do Pagamento.\n\n`api`: API.\n`dda`: DDA.\n`view`: Manual\n" }, "beneficiary": { "readOnly": true, "nullable": true, "type": "object", "description": "Dados do Beneficiário (quando disponível)", "properties": { "name": { "type": "string", "nullable": true, "description": "Nome ou Razão Social do Beneficiário", "example": "João da Silva" }, "document_number": { "type": "string", "nullable": true, "description": "CPF ou CNPJ do Beneficiário", "example": "111.321.322-09" } } }, "pix": { "type": "object", "description": "Dados do Pix a ser pago.", "properties": { "qrcode": { "type": "string", "readOnly": true, "description": "QR Code Copia e Cola" }, "beneficiary": { "type": "object", "description": "Dados do Beneficiário", "properties": { "document_number": { "type": "string", "nullable": true, "readOnly": true, "description": "Número do CNPJ", "example": "80.897.837/0001-14" }, "name": { "type": "string", "nullable": true, "readOnly": true, "description": "Razão Social", "example": "Empresa Prestadora de Serviços Ltda." } } } } }, "formats": { "readOnly": true, "nullable": true, "type": "object", "description": "URLs do comprovante de pagamento (disponível após confirmação)", "properties": { "default": { "type": "object", "properties": { "html": { "type": "string", "nullable": true, "description": "URL HTML do comprovante" }, "png": { "type": "string", "nullable": true, "description": "URL PNG do comprovante" }, "pdf": { "type": "string", "nullable": true, "description": "URL PDF do comprovante" } } } } }, "identifier": { "type": "string", "nullable": true, "description": "Identificação do pagamento no comprovante do provedor financeiro. (Uso exclusivo do banco)\n\nBancos que aceitam esse campo (via API): Itaú\n" }, "financial_provider_external_id": { "type": "string", "nullable": true, "readOnly": true, "description": "ID na instituição financeira" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data e hora de criação do registro no banco de dados" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data e hora da última atualização do registro no banco de dados" } }, "required": [ "pix" ] }, "v2_new_payment_pix": { "type": "object", "description": "Novo Pagamento Pix.", "required": [ "financial_account_uid", "qrcode" ], "properties": { "amount": { "type": "number", "format": "float", "nullable": true, "example": 120.99, "description": "Quantia. Opcional, o valor será extraído automaticamente do `qrcode`.\n" }, "scheduled_to": { "type": "string", "format": "date", "nullable": true, "description": "Data de Agendamento", "example": "2023-12-12" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de pagamento de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "qrcode": { "type": "string", "description": "QR Code Copia e Cola" }, "identifier": { "type": "string", "nullable": true, "description": "Identificação do pagamento no comprovante do provedor financeiro. (Uso exclusivo do banco)\n\nBancos que aceitam esse campo (via API): Itaú\n" } } }, "v2_new_payment_pix_single": { "type": "object", "description": "Novo Pagamento Pix.", "required": [ "financial_account_uid", "qrcode" ], "properties": { "amount": { "type": "number", "format": "float", "nullable": true, "example": 120.99, "description": "Quantia. Opcional, o valor será extraído automaticamente do `qrcode`.\n" }, "scheduled_to": { "type": "string", "format": "date", "nullable": true, "description": "Data de Agendamento", "example": "2023-12-12" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de pagamento de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "qrcode": { "type": "string", "description": "QR Code Copia e Cola" }, "identifier": { "type": "string", "nullable": true, "description": "Identificação do pagamento no comprovante do provedor financeiro. (Uso exclusivo do banco)\n\nBancos que aceitam esse campo (via API): Itaú\n" }, "beneficiary": { "type": "object", "nullable": true, "description": "Dados do beneficiário.", "properties": { "name": { "type": "string", "nullable": true, "description": "Nome / Razão Social do beneficiário", "example": "Empresa Prestadora de Serviços Ltda." }, "document_number": { "type": "string", "nullable": true, "description": "CPF/CNPJ do beneficiário", "example": "80.897.837/0001-14" } } } } }, "v2_payment_batch_pix": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID do Lote de Pagamento" }, "status": { "readOnly": true, "type": "string", "description": "Status.\n\n`pending`: Pendente.\n`awaiting_approval`: Aguardando Aprovação.\n`confirmed`: Confirmado.\n`approved`: Aprovado.\n`reproved`: Reprovado.\n`rejected`: Rejeitado.\n`scheduled`: Agendado.\n`finishing`: Finalizando.\n`canceled`: Cancelado\n" }, "registration_status": { "readOnly": true, "type": "string", "description": "Status de Registro.\n\n`pending`: Pendente.\n`requested`: Requisitado.\n`confirmed`: Confirmado.\n`rejected`: Rejeitado.\n`failed`: Falha\n" }, "payments": { "type": "array", "description": "Lista de Pagamentos. Abaixo segue esquemas dos tipos de pagamento possíveis.", "items": { "$ref": "#/components/schemas/v2_payment_pix" } }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "readOnly": true, "nullable": true, "format": "uuid", "description": "Conta de pagamento de origem. Quando não informada na criação, usou-se automaticamente a mais antiga da conta financeira.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da criação. Formato iso8601" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da atualização. Formato iso8601" } } }, "v2_new_payment_batch_pix": { "type": "object", "required": [ "financial_account_uid", "payments" ], "properties": { "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de pagamento aplicada a todo o lote (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à conta financeira do lote.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payments": { "type": "array", "description": "Lista de Pagamentos de Pix novos ou existentes.", "items": { "anyOf": [ { "type": "object", "description": "Novo Pagamento Pix.", "required": [ "qrcode" ], "properties": { "amount": { "type": "number", "format": "float", "nullable": true, "example": 120.99, "description": "Quantia. Opcional, o valor será extraído automaticamente do `qrcode`.\n" }, "scheduled_to": { "type": "string", "format": "date", "nullable": true, "description": "Data de Agendamento", "example": "2023-12-12" }, "payment_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de pagamento de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "qrcode": { "type": "string", "description": "QR Code Copia e Cola" }, "identifier": { "type": "string", "nullable": true, "description": "Identificação do pagamento no comprovante do provedor financeiro. (Uso exclusivo do banco)\n\nBancos que aceitam esse campo (via API): Itaú\n" } } }, { "type": "object", "required": [ "uid" ], "description": "Pagamento existente.", "properties": { "uid": { "type": "string", "format": "uuid", "description": "UID de um Pagamento", "example": "018df180-7208-727b-a10a-ea545e4a75a8" } } } ] } } } }, "v2_payment_darf": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID do Pagamento", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "kind": { "type": "string", "readOnly": true, "enum": [ "bank_billet", "darf", "utility", "gru", "pix", "tax" ], "description": "Tipo do Pagamento", "example": "pix" }, "amount": { "type": "number", "readOnly": true, "format": "float", "example": 120.99, "description": "Quantia\n" }, "scheduled_to": { "type": "string", "readOnly": true, "nullable": true, "format": "date", "example": "2023-12-12", "description": "Data de Agendamento" }, "status": { "readOnly": true, "type": "string", "description": "Status do Pagamento.\n\n`pending`: Pendente.\n`rejected`: Rejeitado.\n`approved`: Aprovado.\n`reproved`: Reprovado.\n`failed`: Falha.\n`confirmed`: Confirmado.\n`canceled`: Cancelado.\n`awaiting_approval`: Aguardando Aprovação.\n`scheduled`: Agendado.\n`awaiting_scheduled_date`: Aguardando Data Agendada.\n`overdue`: Vencido.\n`awaiting_funds`: Aguardando Saldo.\n`finishing`: Finalizando\n" }, "registration_status": { "readOnly": true, "type": "string", "description": "Status de Registro.\n\n`pending`: Pendente.\n`requested`: Requisitado.\n`confirmed`: Confirmado.\n`rejected`: Rejeitado.\n`failed`: Falha\n" }, "confirmed_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2023-12-12", "description": "Data em que a Kobana processou a confirmação da operação. Não representa necessariamente a data em que o valor saiu da conta — para isso use transaction_date." }, "rejected_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2023-12-12", "description": "Data da Rejeição" }, "rejected_error": { "type": "string", "readOnly": true, "nullable": true, "description": "Motivo da rejeição retornado pelo banco" }, "transaction_code": { "readOnly": true, "nullable": true, "type": "string", "description": "Código de Autenticação", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transaction_date": { "readOnly": true, "nullable": true, "type": "string", "format": "date-time", "description": "Data oficial da liquidação/débito informada pelo banco (data da autenticação). Reflete quando o valor efetivamente saiu da conta.", "example": "2023-12-12" }, "financial_account_uid": { "type": "string", "readOnly": true, "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "readOnly": true, "nullable": true, "format": "uuid", "description": "Conta de pagamento de origem. Quando não informada na criação, usou-se automaticamente a mais antiga da conta financeira.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "batch_uid": { "type": "string", "readOnly": true, "nullable": true, "format": "uuid", "description": "UID do Lote ao qual este pagamento pertence", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "source": { "readOnly": true, "nullable": true, "type": "string", "description": "Origem do Pagamento.\n\n`api`: API.\n`dda`: DDA.\n`view`: Manual\n" }, "beneficiary": { "readOnly": true, "nullable": true, "type": "object", "description": "Dados do Beneficiário (quando disponível)", "properties": { "name": { "type": "string", "nullable": true, "description": "Nome ou Razão Social do Beneficiário", "example": "João da Silva" }, "document_number": { "type": "string", "nullable": true, "description": "CPF ou CNPJ do Beneficiário", "example": "111.321.322-09" } } }, "darf": { "type": "object", "description": "Dados do DARF a ser pago.", "properties": { "code": { "type": "string", "nullable": true, "readOnly": true, "description": "Código de Barras ou Linha Digitável (quando disponível)" }, "calculation_date": { "type": "string", "format": "date", "nullable": true, "description": "Data de Encerramento do Período de Apuração", "example": "2023-12-31" }, "expire_at": { "type": "string", "format": "date", "nullable": true, "description": "Data de Vencimento", "example": "2023-12-02" }, "reference_number": { "type": "string", "nullable": true, "description": "Número de Referência da DARF", "example": "123456" }, "taxpayer_number": { "type": "string", "nullable": true, "description": "CPF/CNPJ do Contribuinte", "example": "16.974.923/0001-84" }, "taxpayer_name": { "type": "string", "nullable": true, "description": "Nome do Contribuinte", "example": "João da Silva" }, "tax_code": { "type": "string", "nullable": true, "description": "Código da Receita", "example": "0107" }, "fine_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor da Multa", "example": 15.0 }, "interest_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor dos Juros", "example": 5.5 }, "gross_income_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor do Rendimento Bruto", "example": 0.0 } } }, "formats": { "readOnly": true, "nullable": true, "type": "object", "description": "URLs do comprovante de pagamento (disponível após confirmação)", "properties": { "default": { "type": "object", "properties": { "html": { "type": "string", "nullable": true, "description": "URL HTML do comprovante" }, "png": { "type": "string", "nullable": true, "description": "URL PNG do comprovante" }, "pdf": { "type": "string", "nullable": true, "description": "URL PDF do comprovante" } } } } }, "identifier": { "type": "string", "nullable": true, "description": "Identificação do pagamento no comprovante do provedor financeiro. (Uso exclusivo do banco)\n\nBancos que aceitam esse campo (via API): Itaú\n" }, "financial_provider_external_id": { "type": "string", "nullable": true, "readOnly": true, "description": "ID na instituição financeira" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data e hora de criação do registro no banco de dados" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data e hora da última atualização do registro no banco de dados" } }, "required": [ "darf" ] }, "v2_new_payment_darf": { "type": "object", "description": "Novo Pagamento DARF.", "required": [ "amount", "financial_account_uid", "tax_code", "taxpayer_number", "taxpayer_name", "calculation_date", "expire_at" ], "properties": { "amount": { "type": "number", "format": "float", "example": 120.99, "description": "Quantia" }, "scheduled_to": { "type": "string", "format": "date", "nullable": true, "description": "Data de Agendamento", "example": "2023-12-12" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de pagamento de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "calculation_date": { "type": "string", "format": "date", "description": "Data de Encerramento do Período de Apuração", "example": "2023-12-31" }, "expire_at": { "type": "string", "format": "date", "description": "Data de Vencimento", "example": "2023-12-02" }, "reference_number": { "type": "string", "nullable": true, "description": "Número de Referência da DARF", "example": "123456" }, "taxpayer_number": { "type": "string", "description": "CPF/CNPJ do Contribuinte", "example": "16.974.923/0001-84" }, "taxpayer_name": { "type": "string", "description": "Nome do Contribuinte", "example": "João da Silva" }, "tax_code": { "type": "string", "description": "Código da Receita", "example": "0107" }, "fine_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor da Multa", "example": 15.0 }, "interest_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor dos Juros", "example": 5.5 }, "gross_income_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor do Rendimento Bruto", "example": 0.0 } } }, "v2_payment_batch_darf": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID do Lote de Pagamento" }, "status": { "readOnly": true, "type": "string", "description": "Status.\n\n`pending`: Pendente.\n`awaiting_approval`: Aguardando Aprovação.\n`confirmed`: Confirmado.\n`approved`: Aprovado.\n`reproved`: Reprovado.\n`rejected`: Rejeitado.\n`scheduled`: Agendado.\n`finishing`: Finalizando.\n`canceled`: Cancelado\n" }, "registration_status": { "readOnly": true, "type": "string", "description": "Status de Registro.\n\n`pending`: Pendente.\n`requested`: Requisitado.\n`confirmed`: Confirmado.\n`rejected`: Rejeitado.\n`failed`: Falha\n" }, "payments": { "type": "array", "description": "Lista de Pagamentos. Abaixo segue esquemas dos tipos de pagamento possíveis.", "items": { "$ref": "#/components/schemas/v2_payment_darf" } }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "readOnly": true, "nullable": true, "format": "uuid", "description": "Conta de pagamento de origem. Quando não informada na criação, usou-se automaticamente a mais antiga da conta financeira.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da criação. Formato iso8601" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da atualização. Formato iso8601" } } }, "v2_new_payment_batch_darf": { "type": "object", "required": [ "financial_account_uid", "payments" ], "properties": { "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de pagamento aplicada a todo o lote (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à conta financeira do lote.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payments": { "type": "array", "description": "Lista de Pagamentos de Darf novos ou existentes.", "items": { "anyOf": [ { "type": "object", "description": "Novo Pagamento DARF.", "required": [ "amount", "tax_code", "taxpayer_number", "taxpayer_name", "calculation_date", "expire_at" ], "properties": { "amount": { "type": "number", "format": "float", "example": 120.99, "description": "Quantia" }, "scheduled_to": { "type": "string", "format": "date", "nullable": true, "description": "Data de Agendamento", "example": "2023-12-12" }, "payment_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de pagamento de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "calculation_date": { "type": "string", "format": "date", "description": "Data de Encerramento do Período de Apuração", "example": "2023-12-31" }, "expire_at": { "type": "string", "format": "date", "description": "Data de Vencimento", "example": "2023-12-02" }, "reference_number": { "type": "string", "nullable": true, "description": "Número de Referência da DARF", "example": "123456" }, "taxpayer_number": { "type": "string", "description": "CPF/CNPJ do Contribuinte", "example": "16.974.923/0001-84" }, "taxpayer_name": { "type": "string", "description": "Nome do Contribuinte", "example": "João da Silva" }, "tax_code": { "type": "string", "description": "Código da Receita", "example": "0107" }, "fine_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor da Multa", "example": 15.0 }, "interest_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor dos Juros", "example": 5.5 }, "gross_income_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor do Rendimento Bruto", "example": 0.0 } } }, { "type": "object", "required": [ "uid" ], "description": "Pagamento existente.", "properties": { "uid": { "type": "string", "format": "uuid", "description": "UID de um Pagamento", "example": "018df180-7208-727b-a10a-ea545e4a75a8" } } } ] } } } }, "v2_payment_gru": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID do Pagamento", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "kind": { "type": "string", "readOnly": true, "enum": [ "bank_billet", "darf", "utility", "gru", "pix", "tax" ], "description": "Tipo do Pagamento", "example": "pix" }, "amount": { "type": "number", "readOnly": true, "format": "float", "example": 120.99, "description": "Quantia\n" }, "scheduled_to": { "type": "string", "readOnly": true, "nullable": true, "format": "date", "example": "2023-12-12", "description": "Data de Agendamento" }, "status": { "readOnly": true, "type": "string", "description": "Status do Pagamento.\n\n`pending`: Pendente.\n`rejected`: Rejeitado.\n`approved`: Aprovado.\n`reproved`: Reprovado.\n`failed`: Falha.\n`confirmed`: Confirmado.\n`canceled`: Cancelado.\n`awaiting_approval`: Aguardando Aprovação.\n`scheduled`: Agendado.\n`awaiting_scheduled_date`: Aguardando Data Agendada.\n`overdue`: Vencido.\n`awaiting_funds`: Aguardando Saldo.\n`finishing`: Finalizando\n" }, "registration_status": { "readOnly": true, "type": "string", "description": "Status de Registro.\n\n`pending`: Pendente.\n`requested`: Requisitado.\n`confirmed`: Confirmado.\n`rejected`: Rejeitado.\n`failed`: Falha\n" }, "confirmed_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2023-12-12", "description": "Data em que a Kobana processou a confirmação da operação. Não representa necessariamente a data em que o valor saiu da conta — para isso use transaction_date." }, "rejected_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2023-12-12", "description": "Data da Rejeição" }, "rejected_error": { "type": "string", "readOnly": true, "nullable": true, "description": "Motivo da rejeição retornado pelo banco" }, "transaction_code": { "readOnly": true, "nullable": true, "type": "string", "description": "Código de Autenticação", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transaction_date": { "readOnly": true, "nullable": true, "type": "string", "format": "date-time", "description": "Data oficial da liquidação/débito informada pelo banco (data da autenticação). Reflete quando o valor efetivamente saiu da conta.", "example": "2023-12-12" }, "financial_account_uid": { "type": "string", "readOnly": true, "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "readOnly": true, "nullable": true, "format": "uuid", "description": "Conta de pagamento de origem. Quando não informada na criação, usou-se automaticamente a mais antiga da conta financeira.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "batch_uid": { "type": "string", "readOnly": true, "nullable": true, "format": "uuid", "description": "UID do Lote ao qual este pagamento pertence", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "source": { "readOnly": true, "nullable": true, "type": "string", "description": "Origem do Pagamento.\n\n`api`: API.\n`dda`: DDA.\n`view`: Manual\n" }, "beneficiary": { "readOnly": true, "nullable": true, "type": "object", "description": "Dados do Beneficiário (quando disponível)", "properties": { "name": { "type": "string", "nullable": true, "description": "Nome ou Razão Social do Beneficiário", "example": "João da Silva" }, "document_number": { "type": "string", "nullable": true, "description": "CPF ou CNPJ do Beneficiário", "example": "111.321.322-09" } } }, "gru": { "type": "object", "description": "Dados da GRU a ser paga.", "properties": { "code": { "type": "string", "nullable": true, "readOnly": true, "description": "Código de Barras ou Linha Digitável da GRU (quando disponível)" }, "beneficiary": { "type": "object", "nullable": true, "description": "Dados do Beneficiário", "properties": { "name": { "type": "string", "nullable": true, "description": "Nome ou Razão Social do Beneficiário", "example": "Margret Santos LTDA" }, "document_number": { "type": "string", "nullable": true, "description": "CPF ou CNPJ do Beneficiário", "example": "34.414.342/0000-99" } } }, "expire_at": { "type": "string", "format": "date", "nullable": true, "description": "Data de Vencimento", "example": "2023-12-02" }, "reference_number": { "type": "string", "nullable": true, "description": "Número de Referência da GRU", "example": "1161307" }, "competency_date": { "type": "string", "format": "date", "nullable": true, "description": "Data de Competência", "example": "2023-12-31" }, "discount_amount_cents": { "type": "integer", "nullable": true, "deprecated": true, "description": "DEPRECATED: valor do desconto em centavos. Use `discount_amount` (em reais). Será removido em versão futura.", "example": 1 }, "other_deduction_amount_cents": { "type": "integer", "nullable": true, "deprecated": true, "description": "DEPRECATED: valor de outras deduções em centavos. Use `other_deduction_amount` (em reais). Será removido em versão futura.", "example": 2 }, "fine_amount_cents": { "type": "integer", "nullable": true, "deprecated": true, "description": "DEPRECATED: valor da multa em centavos. Use `fine_amount` (em reais). Será removido em versão futura.", "example": 3 }, "interest_amount_cents": { "type": "integer", "nullable": true, "deprecated": true, "description": "DEPRECATED: valor dos juros em centavos. Use `interest_amount` (em reais). Será removido em versão futura.", "example": 4 }, "other_addition_amount_cents": { "type": "integer", "nullable": true, "deprecated": true, "description": "DEPRECATED: valor de outros acréscimos em centavos. Use `other_addition_amount` (em reais). Será removido em versão futura.", "example": 5 }, "total_amount_cents": { "type": "integer", "nullable": true, "deprecated": true, "description": "DEPRECATED: valor total em centavos. Use `total_amount` (em reais). Será removido em versão futura.", "example": 100 }, "discount_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor do desconto (em reais)", "example": 0.01 }, "other_deduction_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de outras deduções (em reais)", "example": 0.02 }, "fine_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor da multa (em reais)", "example": 0.03 }, "interest_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor dos juros (em reais)", "example": 0.04 }, "other_addition_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de outros acréscimos (em reais)", "example": 0.05 }, "total_amount": { "type": "number", "format": "float", "description": "Valor total (em reais)", "example": 1.0 } } }, "formats": { "readOnly": true, "nullable": true, "type": "object", "description": "URLs do comprovante de pagamento (disponível após confirmação)", "properties": { "default": { "type": "object", "properties": { "html": { "type": "string", "nullable": true, "description": "URL HTML do comprovante" }, "png": { "type": "string", "nullable": true, "description": "URL PNG do comprovante" }, "pdf": { "type": "string", "nullable": true, "description": "URL PDF do comprovante" } } } } }, "identifier": { "type": "string", "nullable": true, "description": "Identificação do pagamento no comprovante do provedor financeiro. (Uso exclusivo do banco)\n\nBancos que aceitam esse campo (via API): Itaú\n" }, "financial_provider_external_id": { "type": "string", "nullable": true, "readOnly": true, "description": "ID na instituição financeira" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data e hora de criação do registro no banco de dados" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data e hora da última atualização do registro no banco de dados" } }, "required": [ "gru" ] }, "v2_payment_tax": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID do Pagamento", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "kind": { "type": "string", "readOnly": true, "enum": [ "bank_billet", "darf", "utility", "gru", "pix", "tax" ], "description": "Tipo do Pagamento", "example": "pix" }, "amount": { "type": "number", "readOnly": true, "format": "float", "example": 120.99, "description": "Quantia\n" }, "scheduled_to": { "type": "string", "readOnly": true, "nullable": true, "format": "date", "example": "2023-12-12", "description": "Data de Agendamento" }, "status": { "readOnly": true, "type": "string", "description": "Status do Pagamento.\n\n`pending`: Pendente.\n`rejected`: Rejeitado.\n`approved`: Aprovado.\n`reproved`: Reprovado.\n`failed`: Falha.\n`confirmed`: Confirmado.\n`canceled`: Cancelado.\n`awaiting_approval`: Aguardando Aprovação.\n`scheduled`: Agendado.\n`awaiting_scheduled_date`: Aguardando Data Agendada.\n`overdue`: Vencido.\n`awaiting_funds`: Aguardando Saldo.\n`finishing`: Finalizando\n" }, "registration_status": { "readOnly": true, "type": "string", "description": "Status de Registro.\n\n`pending`: Pendente.\n`requested`: Requisitado.\n`confirmed`: Confirmado.\n`rejected`: Rejeitado.\n`failed`: Falha\n" }, "confirmed_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2023-12-12", "description": "Data em que a Kobana processou a confirmação da operação. Não representa necessariamente a data em que o valor saiu da conta — para isso use transaction_date." }, "rejected_at": { "type": "string", "nullable": true, "format": "date-time", "example": "2023-12-12", "description": "Data da Rejeição" }, "rejected_error": { "type": "string", "readOnly": true, "nullable": true, "description": "Motivo da rejeição retornado pelo banco" }, "transaction_code": { "readOnly": true, "nullable": true, "type": "string", "description": "Código de Autenticação", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "transaction_date": { "readOnly": true, "nullable": true, "type": "string", "format": "date-time", "description": "Data oficial da liquidação/débito informada pelo banco (data da autenticação). Reflete quando o valor efetivamente saiu da conta.", "example": "2023-12-12" }, "financial_account_uid": { "type": "string", "readOnly": true, "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "readOnly": true, "nullable": true, "format": "uuid", "description": "Conta de pagamento de origem. Quando não informada na criação, usou-se automaticamente a mais antiga da conta financeira.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "batch_uid": { "type": "string", "readOnly": true, "nullable": true, "format": "uuid", "description": "UID do Lote ao qual este pagamento pertence", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "source": { "readOnly": true, "nullable": true, "type": "string", "description": "Origem do Pagamento.\n\n`api`: API.\n`dda`: DDA.\n`view`: Manual\n" }, "beneficiary": { "readOnly": true, "nullable": true, "type": "object", "description": "Dados do Beneficiário (quando disponível)", "properties": { "name": { "type": "string", "nullable": true, "description": "Nome ou Razão Social do Beneficiário", "example": "João da Silva" }, "document_number": { "type": "string", "nullable": true, "description": "CPF ou CNPJ do Beneficiário", "example": "111.321.322-09" } } }, "tax": { "type": "object", "description": "Dados do Tributo a ser pago - formato especificado pelo campo \"format\".", "required": [ "format", "kind" ], "properties": { "format": { "type": "string", "readOnly": true, "enum": [ "code", "data" ], "description": "Formato do tributo (code ou data)" }, "kind": { "type": "string", "readOnly": true, "enum": [ "itbi", "icms", "iss", "iptu", "fgts", "dare", "darf", "gru", "gps" ], "description": "Tipo do Tributo" }, "code": { "type": "string", "nullable": true, "readOnly": true, "description": "Código de Barras ou Linha Digitável do Tributo (presente se format=code)" }, "data": { "type": "object", "nullable": true, "readOnly": true, "description": "Campos estruturados do tributo (presente se format=data)", "anyOf": [ { "type": "object", "description": "Dados estruturados do DARF", "properties": { "tax_code": { "type": "string", "description": "Código da receita", "example": "0107" }, "reference_number": { "type": "string", "nullable": true, "description": "Número de referência", "example": "1161307" }, "taxpayer_type": { "type": "string", "enum": [ "cnpj", "cpf", "nit", "pis", "pasep", "cei", "nb", "title_number", "debcad", "reference" ], "description": "Tipo de contribuinte", "example": "cpf" }, "taxpayer_number": { "type": "string", "description": "CPF/CNPJ do contribuinte", "example": "12345678901" }, "taxpayer_name": { "type": "string", "description": "Nome do contribuinte", "example": "João da Silva" }, "calculation_date": { "type": "string", "format": "date", "description": "Data do cálculo", "example": "2026-01-15" }, "expire_at": { "type": "string", "format": "date", "description": "Data de vencimento", "example": "2026-02-28" }, "fine_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de multa", "example": 15.0 }, "interest_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de juros", "example": 5.5 }, "gross_income_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor do rendimento bruto", "example": 0.0 } } }, { "type": "object", "description": "Dados estruturados do GRU", "properties": { "reference_number": { "type": "string", "nullable": true, "description": "Número de referência", "example": "12345678901234" }, "expire_at": { "type": "string", "format": "date", "description": "Data de vencimento", "example": "2026-02-28" }, "total_amount": { "type": "number", "format": "float", "description": "Valor total", "example": 250.5 }, "discount_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de desconto", "example": 10.0 }, "other_deduction_amount": { "type": "number", "format": "float", "nullable": true, "description": "Outras deduções", "example": 5.0 }, "fine_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de multa", "example": 15.0 }, "interest_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de juros", "example": 8.5 }, "other_addition_amount": { "type": "number", "format": "float", "nullable": true, "description": "Outras adições", "example": 2.0 } } }, { "type": "object", "description": "Dados estruturados do GPS", "properties": { "tax_code": { "type": "string", "description": "Código de Pagamento", "example": "1007" }, "taxpayer_type": { "type": "string", "enum": [ "cnpj", "cpf", "nit", "pis", "pasep", "cei" ], "description": "Tipo de contribuinte", "example": "cpf" }, "taxpayer_number": { "type": "string", "description": "CPF/CNPJ do contribuinte", "example": "12345678901" }, "taxpayer_name": { "type": "string", "description": "Nome do contribuinte", "example": "João da Silva" }, "competence_date": { "type": "string", "format": "date", "description": "Data de competência", "example": "2026-01-01" }, "expire_at": { "type": "string", "format": "date", "description": "Data de vencimento", "example": "2026-02-15" }, "other_entities_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de outras entidades", "example": 10.0 }, "monetary_update_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de atualização monetária", "example": 5.0 }, "fine_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de multa", "example": 15.0 }, "interest_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de juros", "example": 8.5 } } }, { "type": "object", "description": "Dados estruturados do FGTS", "properties": { "contributor_code": { "type": "string", "description": "Código do contribuinte", "example": "12345678" }, "fgts_code": { "type": "string", "description": "Código FGTS", "example": "87654321" }, "collection_code": { "type": "string", "description": "Código de recolhimento", "example": "11223344" }, "pis_pasep_number": { "type": "string", "description": "Número PIS/PASEP", "example": "12345678901" }, "jam_percentage": { "type": "number", "format": "float", "minimum": 0, "maximum": 99.99, "description": "Percentual JAM (0 a 99,99)", "example": 5.5 }, "connectivity_seal": { "type": "string", "nullable": true, "description": "Selo conectividade", "example": "SEAL123456789012345678" } } } ] }, "beneficiary": { "type": "object", "description": "Dados do Beneficiário", "properties": { "document_number": { "type": "string", "nullable": true, "readOnly": true, "description": "Número do Documento (CPF ou CNPJ)", "example": "111.321.322-09" }, "name": { "type": "string", "nullable": true, "readOnly": true, "description": "Nome ou Razão Social", "example": "Prefeitura Municipal" } } } } }, "formats": { "readOnly": true, "nullable": true, "type": "object", "description": "URLs do comprovante de pagamento (disponível após confirmação)", "properties": { "default": { "type": "object", "properties": { "html": { "type": "string", "nullable": true, "description": "URL HTML do comprovante" }, "png": { "type": "string", "nullable": true, "description": "URL PNG do comprovante" }, "pdf": { "type": "string", "nullable": true, "description": "URL PDF do comprovante" } } } } }, "identifier": { "type": "string", "nullable": true, "description": "Identificação do pagamento no comprovante do provedor financeiro. (Uso exclusivo do banco)\n\nBancos que aceitam esse campo (via API): Itaú\n" }, "financial_provider_external_id": { "type": "string", "nullable": true, "readOnly": true, "description": "ID na instituição financeira" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data e hora de criação do registro no banco de dados" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data e hora da última atualização do registro no banco de dados" } }, "required": [ "tax" ] }, "v2_new_payment_tax": { "type": "object", "description": "Novo Pagamento de Tributo.", "required": [ "amount", "financial_account_uid", "kind" ], "properties": { "amount": { "type": "number", "format": "float", "example": 120.99, "description": "Quantia" }, "scheduled_to": { "type": "string", "format": "date", "nullable": true, "description": "Data de Agendamento", "example": "2023-12-12" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de pagamento de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "kind": { "type": "string", "enum": [ "itbi", "icms", "iss", "iptu", "fgts", "dare", "darf", "gru", "gps" ], "description": "Tipo do Tributo" }, "format": { "type": "string", "enum": [ "code", "data" ], "default": "code", "description": "Formato do tributo.\n\n`code`: Informar código de barras/linha digitável (padrão).\n`data`: Informar campos estruturados (disponível para kinds: darf, gru, gps, fgts).\n" }, "code": { "type": "string", "nullable": true, "description": "Código de Barras ou Linha Digitável do Tributo. Obrigatório quando format=code." }, "data": { "type": "object", "nullable": true, "description": "Campos estruturados do tributo. Obrigatório quando format=data.", "oneOf": [ { "type": "object", "title": "DARF", "description": "Dados estruturados do DARF (kind=darf)", "required": [ "tax_code", "taxpayer_type", "taxpayer_number", "taxpayer_name", "calculation_date", "expire_at" ], "properties": { "tax_code": { "type": "string", "description": "Código da receita", "example": "0107" }, "reference_number": { "type": "string", "nullable": true, "description": "Número de referência", "example": "1161307" }, "taxpayer_type": { "type": "string", "enum": [ "cnpj", "cpf", "nit", "pis", "pasep", "cei", "nb", "title_number", "debcad", "reference" ], "description": "Tipo de contribuinte" }, "taxpayer_number": { "type": "string", "description": "CPF/CNPJ do contribuinte", "example": "12345678901" }, "taxpayer_name": { "type": "string", "description": "Nome do contribuinte", "example": "João da Silva" }, "calculation_date": { "type": "string", "format": "date", "description": "Data do cálculo", "example": "2026-01-15" }, "expire_at": { "type": "string", "format": "date", "description": "Data de vencimento", "example": "2026-02-28" }, "fine_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de multa", "example": 15.0 }, "interest_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de juros", "example": 5.5 }, "gross_income_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor do rendimento bruto", "example": 0.0 } } }, { "type": "object", "title": "GRU", "description": "Dados estruturados do GRU (kind=gru)", "required": [ "expire_at", "total_amount" ], "properties": { "reference_number": { "type": "string", "nullable": true, "description": "Número de referência", "example": "12345678901234" }, "expire_at": { "type": "string", "format": "date", "description": "Data de vencimento", "example": "2026-02-28" }, "total_amount": { "type": "number", "format": "float", "description": "Valor total", "example": 250.5 }, "discount_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de desconto", "example": 10.0 }, "other_deduction_amount": { "type": "number", "format": "float", "nullable": true, "description": "Outras deduções", "example": 5.0 }, "fine_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de multa", "example": 15.0 }, "interest_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de juros", "example": 8.5 }, "other_addition_amount": { "type": "number", "format": "float", "nullable": true, "description": "Outras adições", "example": 2.0 } } }, { "type": "object", "title": "GPS", "description": "Dados estruturados do GPS (kind=gps)", "required": [ "tax_code", "taxpayer_type", "taxpayer_number", "taxpayer_name", "competence_date", "expire_at" ], "properties": { "tax_code": { "type": "string", "description": "Código de Pagamento", "example": "1007" }, "taxpayer_type": { "type": "string", "enum": [ "cnpj", "cpf", "nit", "pis", "pasep", "cei" ], "description": "Tipo de contribuinte", "example": "cpf" }, "taxpayer_number": { "type": "string", "description": "CPF/CNPJ do contribuinte", "example": "12345678901" }, "taxpayer_name": { "type": "string", "description": "Nome do contribuinte", "example": "João da Silva" }, "competence_date": { "type": "string", "format": "date", "description": "Data de competência", "example": "2026-01-01" }, "expire_at": { "type": "string", "format": "date", "description": "Data de vencimento", "example": "2026-02-15" }, "other_entities_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de outras entidades", "example": 10.0 }, "monetary_update_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de atualização monetária", "example": 5.0 }, "fine_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de multa", "example": 15.0 }, "interest_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de juros", "example": 8.5 } } }, { "type": "object", "title": "FGTS", "description": "Dados estruturados do FGTS (kind=fgts)", "required": [ "contributor_code", "fgts_code", "collection_code", "pis_pasep_number", "jam_percentage" ], "properties": { "contributor_code": { "type": "string", "description": "Código do contribuinte", "example": "12345678" }, "fgts_code": { "type": "string", "description": "Código FGTS", "example": "87654321" }, "collection_code": { "type": "string", "description": "Código de recolhimento", "example": "11223344" }, "pis_pasep_number": { "type": "string", "description": "Número PIS/PASEP", "example": "12345678901" }, "jam_percentage": { "type": "number", "format": "float", "minimum": 0, "maximum": 99.99, "description": "Percentual JAM (0 a 99,99)", "example": 5.5 }, "connectivity_seal": { "type": "string", "nullable": true, "description": "Selo conectividade", "example": "SEAL123456789012345678" } } } ] } } }, "v2_payment_batch_tax": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID do Lote de Pagamento" }, "status": { "readOnly": true, "type": "string", "description": "Status.\n\n`pending`: Pendente.\n`awaiting_approval`: Aguardando Aprovação.\n`confirmed`: Confirmado.\n`approved`: Aprovado.\n`reproved`: Reprovado.\n`rejected`: Rejeitado.\n`scheduled`: Agendado.\n`finishing`: Finalizando.\n`canceled`: Cancelado\n" }, "registration_status": { "readOnly": true, "type": "string", "description": "Status de Registro.\n\n`pending`: Pendente.\n`requested`: Requisitado.\n`confirmed`: Confirmado.\n`rejected`: Rejeitado.\n`failed`: Falha\n" }, "payments": { "type": "array", "description": "Lista de Pagamentos. Abaixo segue esquemas dos tipos de pagamento possíveis.", "items": { "$ref": "#/components/schemas/v2_payment_tax" } }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "readOnly": true, "nullable": true, "format": "uuid", "description": "Conta de pagamento de origem. Quando não informada na criação, usou-se automaticamente a mais antiga da conta financeira.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da criação. Formato iso8601" }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "Data da atualização. Formato iso8601" } } }, "v2_new_payment_batch_tax": { "type": "object", "required": [ "financial_account_uid", "payments" ], "properties": { "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de pagamento aplicada a todo o lote (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à conta financeira do lote.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payments": { "type": "array", "description": "Lista de Pagamentos de Tributo novos ou existentes.", "items": { "anyOf": [ { "type": "object", "description": "Novo Pagamento de Tributo.", "required": [ "amount", "kind" ], "properties": { "amount": { "type": "number", "format": "float", "example": 120.99, "description": "Quantia" }, "scheduled_to": { "type": "string", "format": "date", "nullable": true, "description": "Data de Agendamento", "example": "2023-12-12" }, "payment_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de pagamento de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "kind": { "type": "string", "enum": [ "itbi", "icms", "iss", "iptu", "fgts", "dare", "darf", "gru", "gps" ], "description": "Tipo do Tributo" }, "format": { "type": "string", "enum": [ "code", "data" ], "default": "code", "description": "Formato do tributo.\n\n`code`: Informar código de barras/linha digitável (padrão).\n`data`: Informar campos estruturados (disponível para kinds: darf, gru, gps, fgts).\n" }, "code": { "type": "string", "nullable": true, "description": "Código de Barras ou Linha Digitável do Tributo. Obrigatório quando format=code." }, "data": { "type": "object", "nullable": true, "description": "Campos estruturados do tributo. Obrigatório quando format=data.", "oneOf": [ { "type": "object", "title": "DARF", "description": "Dados estruturados do DARF (kind=darf)", "required": [ "tax_code", "taxpayer_type", "taxpayer_number", "taxpayer_name", "calculation_date", "expire_at" ], "properties": { "tax_code": { "type": "string", "description": "Código da receita", "example": "0107" }, "reference_number": { "type": "string", "nullable": true, "description": "Número de referência", "example": "1161307" }, "taxpayer_type": { "type": "string", "enum": [ "cnpj", "cpf", "nit", "pis", "pasep", "cei", "nb", "title_number", "debcad", "reference" ], "description": "Tipo de contribuinte" }, "taxpayer_number": { "type": "string", "description": "CPF/CNPJ do contribuinte", "example": "12345678901" }, "taxpayer_name": { "type": "string", "description": "Nome do contribuinte", "example": "João da Silva" }, "calculation_date": { "type": "string", "format": "date", "description": "Data do cálculo", "example": "2026-01-15" }, "expire_at": { "type": "string", "format": "date", "description": "Data de vencimento", "example": "2026-02-28" }, "fine_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de multa", "example": 15.0 }, "interest_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de juros", "example": 5.5 }, "gross_income_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor do rendimento bruto", "example": 0.0 } } }, { "type": "object", "title": "GRU", "description": "Dados estruturados do GRU (kind=gru)", "required": [ "expire_at", "total_amount" ], "properties": { "reference_number": { "type": "string", "nullable": true, "description": "Número de referência", "example": "12345678901234" }, "expire_at": { "type": "string", "format": "date", "description": "Data de vencimento", "example": "2026-02-28" }, "total_amount": { "type": "number", "format": "float", "description": "Valor total", "example": 250.5 }, "discount_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de desconto", "example": 10.0 }, "other_deduction_amount": { "type": "number", "format": "float", "nullable": true, "description": "Outras deduções", "example": 5.0 }, "fine_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de multa", "example": 15.0 }, "interest_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de juros", "example": 8.5 }, "other_addition_amount": { "type": "number", "format": "float", "nullable": true, "description": "Outras adições", "example": 2.0 } } }, { "type": "object", "title": "GPS", "description": "Dados estruturados do GPS (kind=gps)", "required": [ "tax_code", "taxpayer_type", "taxpayer_number", "taxpayer_name", "competence_date", "expire_at" ], "properties": { "tax_code": { "type": "string", "description": "Código de Pagamento", "example": "1007" }, "taxpayer_type": { "type": "string", "enum": [ "cnpj", "cpf", "nit", "pis", "pasep", "cei" ], "description": "Tipo de contribuinte", "example": "cpf" }, "taxpayer_number": { "type": "string", "description": "CPF/CNPJ do contribuinte", "example": "12345678901" }, "taxpayer_name": { "type": "string", "description": "Nome do contribuinte", "example": "João da Silva" }, "competence_date": { "type": "string", "format": "date", "description": "Data de competência", "example": "2026-01-01" }, "expire_at": { "type": "string", "format": "date", "description": "Data de vencimento", "example": "2026-02-15" }, "other_entities_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de outras entidades", "example": 10.0 }, "monetary_update_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de atualização monetária", "example": 5.0 }, "fine_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de multa", "example": 15.0 }, "interest_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de juros", "example": 8.5 } } }, { "type": "object", "title": "FGTS", "description": "Dados estruturados do FGTS (kind=fgts)", "required": [ "contributor_code", "fgts_code", "collection_code", "pis_pasep_number", "jam_percentage" ], "properties": { "contributor_code": { "type": "string", "description": "Código do contribuinte", "example": "12345678" }, "fgts_code": { "type": "string", "description": "Código FGTS", "example": "87654321" }, "collection_code": { "type": "string", "description": "Código de recolhimento", "example": "11223344" }, "pis_pasep_number": { "type": "string", "description": "Número PIS/PASEP", "example": "12345678901" }, "jam_percentage": { "type": "number", "format": "float", "minimum": 0, "maximum": 99.99, "description": "Percentual JAM (0 a 99,99)", "example": 5.5 }, "connectivity_seal": { "type": "string", "nullable": true, "description": "Selo conectividade", "example": "SEAL123456789012345678" } } } ] } } }, { "type": "object", "required": [ "uid" ], "description": "Pagamento existente.", "properties": { "uid": { "type": "string", "format": "uuid", "description": "UID de um Pagamento", "example": "018df180-7208-727b-a10a-ea545e4a75a8" } } } ] } } } }, "v2_generic_payment": { "type": "object", "description": "Pagamento Genérico - Pode ser de qualquer tipo (Pix, Boleto, DARF, Tributo ou Conta de Consumo)", "discriminator": { "propertyName": "kind", "mapping": { "pix": "#/components/schemas/payment_pix", "bank_billet": "#/components/schemas/payment_bank_billet", "darf": "#/components/schemas/payment_darf", "gru": "#/components/schemas/payment_gru", "tax": "#/components/schemas/payment_tax", "utility": "#/components/schemas/payment_utility" } }, "oneOf": [ { "$ref": "#/components/schemas/v2_payment_pix" }, { "$ref": "#/components/schemas/v2_payment_bank_billet" }, { "$ref": "#/components/schemas/v2_payment_darf" }, { "$ref": "#/components/schemas/v2_payment_gru" }, { "$ref": "#/components/schemas/v2_payment_tax" }, { "$ref": "#/components/schemas/v2_payment_utility" } ] }, "v2_new_generic_payment": { "type": "object", "description": "Novo Pagamento Genérico.\n\nO tipo de pagamento é detectado automaticamente pela presença de uma das chaves específicas:\n- `pix`: Cria um Payment::Pix\n- `bank_billet`: Cria um Payment::BankBillet\n- `darf`: Cria um Payment::Darf\n- `tax`: Cria um Payment::Tax\n- `utility`: Cria um Payment::Utility\n\nApenas uma dessas chaves deve estar presente no payload.", "oneOf": [ { "type": "object", "description": "Payload para criar um Pagamento Pix", "required": [ "kind", "financial_account_uid", "pix" ], "properties": { "kind": { "type": "string", "enum": [ "pix", "bank_billet", "darf", "tax", "utility" ], "description": "Tipo do pagamento (obrigatório)", "example": "pix" }, "beneficiary": { "type": "object", "nullable": true, "description": "Informações do beneficiário. Obrigatório quando `kind = bank_billet` e a conta financeira for BB.", "properties": { "name": { "type": "string", "nullable": true, "description": "Nome do beneficiário", "example": "João da Silva" }, "document_number": { "type": "string", "nullable": true, "description": "CPF/CNPJ do beneficiário. Obrigatório quando `kind = bank_billet` e a conta financeira for BB.", "example": "123.456.789-00" } } }, "amount": { "type": "number", "format": "float", "nullable": true, "example": 120.99, "description": "Quantia. Opcional, o valor será extraído automaticamente do qrcode." }, "scheduled_to": { "type": "string", "format": "date", "nullable": true, "description": "Data de Agendamento", "example": "2023-12-12" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de pagamento de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "pix": { "type": "object", "required": [ "qrcode" ], "description": "Dados do Pix", "properties": { "qrcode": { "type": "string", "description": "QR Code Copia e Cola" }, "identifier": { "type": "string", "nullable": true, "description": "Identificação do pagamento no comprovante do provedor financeiro. (Uso exclusivo do banco). Bancos que aceitam esse campo (via API): Itaú" } } } } }, { "type": "object", "description": "Payload para criar um Pagamento de Boleto", "required": [ "kind", "amount", "financial_account_uid", "bank_billet" ], "properties": { "kind": { "type": "string", "enum": [ "pix", "bank_billet", "darf", "tax", "utility" ], "description": "Tipo do pagamento (obrigatório)", "example": "pix" }, "beneficiary": { "type": "object", "nullable": true, "description": "Informações do beneficiário. Obrigatório quando `kind = bank_billet` e a conta financeira for BB.", "properties": { "name": { "type": "string", "nullable": true, "description": "Nome do beneficiário", "example": "João da Silva" }, "document_number": { "type": "string", "nullable": true, "description": "CPF/CNPJ do beneficiário. Obrigatório quando `kind = bank_billet` e a conta financeira for BB.", "example": "123.456.789-00" } } }, "amount": { "type": "number", "format": "float", "example": 120.99, "description": "Quantia\n" }, "scheduled_to": { "type": "string", "format": "date", "nullable": true, "description": "Data de Agendamento", "example": "2023-12-12" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de pagamento de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "bank_billet": { "type": "object", "required": [ "code" ], "description": "Dados do Boleto", "properties": { "code": { "type": "string", "description": "Código de Barras ou Linha Digitável" } } } } }, { "type": "object", "description": "Payload para criar um Pagamento DARF", "required": [ "kind", "amount", "financial_account_uid", "darf" ], "properties": { "kind": { "type": "string", "enum": [ "pix", "bank_billet", "darf", "tax", "utility" ], "description": "Tipo do pagamento (obrigatório)", "example": "pix" }, "beneficiary": { "type": "object", "nullable": true, "description": "Informações do beneficiário. Obrigatório quando `kind = bank_billet` e a conta financeira for BB.", "properties": { "name": { "type": "string", "nullable": true, "description": "Nome do beneficiário", "example": "João da Silva" }, "document_number": { "type": "string", "nullable": true, "description": "CPF/CNPJ do beneficiário. Obrigatório quando `kind = bank_billet` e a conta financeira for BB.", "example": "123.456.789-00" } } }, "amount": { "type": "number", "format": "float", "example": 120.99, "description": "Quantia" }, "scheduled_to": { "type": "string", "format": "date", "nullable": true, "description": "Data de Agendamento", "example": "2023-12-12" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de pagamento de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "darf": { "type": "object", "required": [ "tax_code", "taxpayer_number", "taxpayer_name", "calculation_date", "expire_at" ], "description": "Dados do DARF", "properties": { "calculation_date": { "type": "string", "format": "date", "description": "Data de Encerramento do Período de Apuração", "example": "2023-12-31" }, "expire_at": { "type": "string", "format": "date", "description": "Data de Vencimento", "example": "2023-12-02" }, "reference_number": { "type": "string", "nullable": true, "description": "Número de Referência da DARF", "example": "123456" }, "taxpayer_type": { "type": "string", "enum": [ "cnpj", "cpf", "nit", "pis", "pasep", "cei", "nb", "title_number", "debcad", "reference" ], "default": "cnpj", "description": "Tipo do Contribuinte. Padrão: cnpj.", "example": "cpf" }, "taxpayer_number": { "type": "string", "description": "CPF/CNPJ do Contribuinte", "example": "16.974.923/0001-84" }, "taxpayer_name": { "type": "string", "description": "Nome do Contribuinte", "example": "João da Silva" }, "tax_code": { "type": "string", "description": "Código da Receita", "example": "0107" }, "fine_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor da Multa", "example": 15.0 }, "interest_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor dos Juros", "example": 5.5 }, "gross_income_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor do Rendimento Bruto", "example": 0.0 } } } } }, { "type": "object", "description": "Payload para criar um Pagamento de Tributo", "required": [ "kind", "amount", "financial_account_uid", "tax" ], "properties": { "kind": { "type": "string", "enum": [ "pix", "bank_billet", "darf", "tax", "utility" ], "description": "Tipo do pagamento (obrigatório)", "example": "pix" }, "beneficiary": { "type": "object", "nullable": true, "description": "Informações do beneficiário. Obrigatório quando `kind = bank_billet` e a conta financeira for BB.", "properties": { "name": { "type": "string", "nullable": true, "description": "Nome do beneficiário", "example": "João da Silva" }, "document_number": { "type": "string", "nullable": true, "description": "CPF/CNPJ do beneficiário. Obrigatório quando `kind = bank_billet` e a conta financeira for BB.", "example": "123.456.789-00" } } }, "amount": { "type": "number", "format": "float", "example": 120.99, "description": "Quantia" }, "scheduled_to": { "type": "string", "format": "date", "nullable": true, "description": "Data de Agendamento", "example": "2023-12-12" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de pagamento de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "tax": { "type": "object", "required": [ "kind", "format" ], "description": "Dados do Tributo - formato especificado pelo campo \"format\"", "oneOf": [ { "type": "object", "required": [ "kind", "format", "code" ], "description": "Tributo via código de barras", "properties": { "kind": { "type": "string", "enum": [ "itbi", "icms", "iss", "iptu", "fgts", "dare", "darf", "gru", "gps" ], "description": "Tipo do Tributo" }, "format": { "type": "string", "enum": [ "code" ], "description": "Formato do payload - código de barras" }, "code": { "type": "string", "description": "Código de Barras ou Linha Digitável do Tributo" } } }, { "type": "object", "required": [ "kind", "format", "data" ], "description": "Tributo DARF via campos estruturados", "properties": { "kind": { "type": "string", "enum": [ "darf" ], "description": "Tipo do Tributo - DARF" }, "format": { "type": "string", "enum": [ "data" ], "description": "Formato do payload - campos estruturados" }, "data": { "type": "object", "required": [ "tax_code", "taxpayer_type", "taxpayer_number", "taxpayer_name", "calculation_date", "expire_at" ], "description": "Campos estruturados do DARF", "properties": { "tax_code": { "type": "string", "description": "Código da receita (4 dígitos)", "example": "0107" }, "reference_number": { "type": "string", "description": "Número de referência", "example": "1161307", "nullable": true }, "taxpayer_type": { "type": "string", "enum": [ "cnpj", "cpf", "nit", "pis", "pasep", "cei", "nb", "title_number", "debcad", "reference" ], "description": "Tipo de contribuinte", "example": "cpf" }, "taxpayer_number": { "type": "string", "description": "CPF/CNPJ do contribuinte", "example": "12345678901" }, "taxpayer_name": { "type": "string", "description": "Nome do contribuinte", "example": "João da Silva" }, "calculation_date": { "type": "string", "format": "date", "description": "Data do cálculo", "example": "2026-01-15" }, "expire_at": { "type": "string", "format": "date", "description": "Data de vencimento", "example": "2026-02-28" }, "fine_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de multa", "example": 15.0 }, "interest_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de juros", "example": 5.5 }, "gross_income_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor do rendimento bruto", "example": 0.0 } } } } }, { "type": "object", "required": [ "kind", "format", "data" ], "description": "Tributo GRU via campos estruturados", "properties": { "kind": { "type": "string", "enum": [ "gru" ], "description": "Tipo do Tributo - GRU" }, "format": { "type": "string", "enum": [ "data" ], "description": "Formato do payload - campos estruturados" }, "data": { "type": "object", "required": [ "total_amount", "expire_at" ], "description": "Campos estruturados do GRU", "properties": { "reference_number": { "type": "string", "description": "Número de referência", "example": "12345678901234", "nullable": true }, "expire_at": { "type": "string", "format": "date", "description": "Data de vencimento", "example": "2026-02-28" }, "total_amount": { "type": "number", "format": "float", "description": "Valor total", "example": 250.5 }, "discount_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de desconto", "example": 10.0 }, "other_deduction_amount": { "type": "number", "format": "float", "nullable": true, "description": "Outras deduções", "example": 5.0 }, "fine_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de multa", "example": 15.0 }, "interest_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de juros", "example": 8.5 }, "other_addition_amount": { "type": "number", "format": "float", "nullable": true, "description": "Outras adições", "example": 2.0 } } } } }, { "type": "object", "required": [ "kind", "format", "data" ], "description": "Tributo GPS via campos estruturados", "properties": { "kind": { "type": "string", "enum": [ "gps" ], "description": "Tipo do Tributo - GPS (Guia da Previdência Social)" }, "format": { "type": "string", "enum": [ "data" ], "description": "Formato do payload - campos estruturados" }, "data": { "type": "object", "required": [ "tax_code", "taxpayer_type", "taxpayer_number", "taxpayer_name", "competence_date", "expire_at" ], "description": "Campos estruturados do GPS", "properties": { "tax_code": { "type": "string", "description": "Código de Pagamento", "example": "1007" }, "taxpayer_type": { "type": "string", "enum": [ "cnpj", "cpf", "nit", "pis", "pasep", "cei" ], "description": "Tipo de contribuinte", "example": "cpf" }, "taxpayer_number": { "type": "string", "description": "CPF/CNPJ do contribuinte", "example": "12345678901" }, "taxpayer_name": { "type": "string", "description": "Nome do contribuinte", "example": "João da Silva" }, "competence_date": { "type": "string", "format": "date", "description": "Data de competência (mês de referência)", "example": "2026-01-01" }, "expire_at": { "type": "string", "format": "date", "description": "Data de vencimento", "example": "2026-02-15" }, "other_entities_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de outras entidades", "example": 10.0 }, "monetary_update_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de atualização monetária", "example": 5.0 }, "fine_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de multa", "example": 15.0 }, "interest_amount": { "type": "number", "format": "float", "nullable": true, "description": "Valor de juros", "example": 8.5 } } } } }, { "type": "object", "required": [ "kind", "format", "data" ], "description": "Tributo FGTS via campos estruturados", "properties": { "kind": { "type": "string", "enum": [ "fgts" ], "description": "Tipo do Tributo - FGTS (Fundo de Garantia do Tempo de Serviço)" }, "format": { "type": "string", "enum": [ "data" ], "description": "Formato do payload - campos estruturados" }, "data": { "type": "object", "required": [ "contributor_code", "fgts_code", "collection_code", "pis_pasep_number", "jam_percentage" ], "description": "Campos estruturados do FGTS", "properties": { "contributor_code": { "type": "string", "description": "Código do contribuinte (até 8 caracteres)", "example": "12345678" }, "fgts_code": { "type": "string", "description": "Código FGTS (até 8 caracteres)", "example": "87654321" }, "collection_code": { "type": "string", "description": "Código de recolhimento (até 8 caracteres)", "example": "11223344" }, "pis_pasep_number": { "type": "string", "description": "Número PIS/PASEP (até 11 caracteres)", "example": "12345678901" }, "jam_percentage": { "type": "number", "format": "float", "minimum": 0, "maximum": 99.99, "description": "Percentual JAM (0 a 99,99)", "example": 5.5 }, "connectivity_seal": { "type": "string", "nullable": true, "description": "Selo conectividade (até 23 caracteres)", "example": "SEAL123456789012345678" } } } } } ] } } }, { "type": "object", "description": "Payload para criar um Pagamento de Conta de Consumo", "required": [ "kind", "amount", "financial_account_uid", "utility" ], "properties": { "kind": { "type": "string", "enum": [ "pix", "bank_billet", "darf", "tax", "utility" ], "description": "Tipo do pagamento (obrigatório)", "example": "pix" }, "beneficiary": { "type": "object", "nullable": true, "description": "Informações do beneficiário. Obrigatório quando `kind = bank_billet` e a conta financeira for BB.", "properties": { "name": { "type": "string", "nullable": true, "description": "Nome do beneficiário", "example": "João da Silva" }, "document_number": { "type": "string", "nullable": true, "description": "CPF/CNPJ do beneficiário. Obrigatório quando `kind = bank_billet` e a conta financeira for BB.", "example": "123.456.789-00" } } }, "amount": { "type": "number", "format": "float", "example": 120.99, "description": "Quantia" }, "scheduled_to": { "type": "string", "format": "date", "nullable": true, "description": "Data de Agendamento", "example": "2023-12-12" }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "payment_account_uid": { "type": "string", "format": "uuid", "nullable": true, "description": "Conta de pagamento de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à `financial_account_uid`.", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "external_id": { "type": "string", "nullable": true, "example": "123456-abc-789", "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "items": { "type": "string", "example": "tag1" } }, "utility": { "type": "object", "required": [ "code" ], "description": "Dados da Conta de Consumo", "properties": { "code": { "type": "string", "description": "Código de Barras ou Linha Digitável" } } } } } ] }, "v2_person": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Registro" }, "name": { "type": "string", "nullable": true, "description": "Nome Completo ou Razão Social", "example": "Kobana Tecnologia Ltda." }, "nickname": { "type": "string", "nullable": true, "description": "Apelido ou Nome Fantasia", "example": "Kobana" }, "kind": { "type": "string", "nullable": true, "description": "Tipo de Pessoa", "example": "natural" }, "external_code": { "type": "string", "maxLength": 120, "nullable": true, "description": "Código ou ID no seu sistema de gestão.", "example": "000001" }, "birthday": { "type": "string", "format": "date", "nullable": true, "description": "Data de Nascimento.", "example": "1978-06-12" }, "document_type": { "type": "string", "nullable": true, "description": "Tipo do Documento. Valores válidos: CPF, CNPJ", "example": "CNPJ" }, "document_number": { "type": "string", "nullable": true, "description": "Número do Documento.", "example": "05.813.794/0001-26" }, "addresses": { "type": "array", "nullable": true, "description": "Lista de Endereços", "items": { "type": "object", "required": [ "street", "neighborhood", "city_name", "zip_code" ], "properties": { "street": { "type": "string", "nullable": false, "maxLength": 255, "description": "Logradouro", "example": "Av. Rio Branco" }, "number": { "type": "string", "nullable": true, "maxLength": 10, "description": "Número", "example": "26" }, "complement": { "type": "string", "nullable": true, "maxLength": 60, "description": "Complemento", "example": "Sobreloja" }, "neighborhood": { "type": "string", "nullable": false, "maxLength": 80, "description": "Bairro", "example": "Centro" }, "city_name": { "type": "string", "nullable": false, "maxLength": 60, "description": "Cidade. Nome deve estar correto e completo", "example": "Rio de Janeiro" }, "state": { "type": "string", "nullable": true, "maxLength": 2, "description": "Estado", "example": "RJ" }, "zip_code": { "type": "string", "nullable": false, "maxLength": 8, "description": "CEP (formato 99999999)", "example": "20090001" }, "short": { "type": "string", "readOnly": true, "description": "Endereço Curto", "example": "Av. Rio Branco, 26, Sobreloja" }, "full": { "type": "string", "readOnly": true, "description": "Endereço Completo", "example": "Av. Rio Branco, 26, Sobreloja, Centro, Rio de Janeiro, RJ. CEP: 20090-001" }, "google_maps": { "type": "string", "readOnly": true, "description": "Endereço para Google Maps", "example": "Av. Rio Branco, 26, Centro, Rio de Janeiro, RJ" } } } }, "phones": { "type": "array", "nullable": true, "description": "Lista de Telefones", "items": { "type": "object", "required": [ "number" ], "properties": { "kind": { "type": "string", "nullable": true, "enum": [ "mobile", "landline" ], "description": "Tipo (Celular/Fixo)", "example": "mobile" }, "country_code": { "type": "string", "nullable": true, "minLength": 2, "maxLength": 6, "description": "Código do País", "example": "55" }, "local_code": { "type": "string", "nullable": true, "minLength": 2, "maxLength": 2, "description": "Código Local", "example": "21" }, "number": { "type": "string", "nullable": false, "minLength": 8, "maxLength": 9, "description": "Número do Telefone", "example": "30030386" } } } }, "emails": { "type": "array", "nullable": true, "description": "Lista de Emails", "items": { "type": "object", "required": [ "address" ], "properties": { "label": { "type": "string", "nullable": true, "description": "Etiqueta (label)", "example": "work" }, "address": { "type": "string", "nullable": false, "maxLength": 80, "description": "Endereço de E-mail", "example": "kobana@example.com" } } } }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas ao registro", "example": null, "items": { "type": "string" } }, "tag_list": { "type": "string", "nullable": true, "readOnly": true, "description": "Lista de tags separadas por vírgula" }, "custom_data": { "type": "object", "nullable": true, "description": "Disponível para envio de um JSON com uma estrutura de dados livre", "example": "{\"source\": \"ERP X\", \"migration\": true}" }, "notes": { "type": "string", "nullable": true, "description": "Observações. Campo de texto livre", "example": "Essa é a empresa da plataforma de automação financeira." }, "created_via_api": { "type": "boolean", "readOnly": true, "description": "Indica se o registro foi criado pela API", "example": null }, "created_at": { "type": "string", "format": "date-time", "nullable": false, "readOnly": true, "description": "Data e hora de criação do registro no banco de dados" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do registro no banco de dados" } } }, "v2_customer": { "type": "object", "required": [ "person_name", "zipcode", "address", "neighborhood", "city_name" ], "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID" }, "uid": { "type": "string", "readOnly": true, "description": "UID" }, "external_code": { "type": "string", "nullable": true, "maxLength": 255, "description": "Código Externo", "example": "C0001" }, "cnpj_cpf": { "type": "string", "maxLength": 20, "description": "CPF/CNPJ", "example": "16.974.923/0001-84" }, "person_name": { "type": "string", "maxLength": 120, "description": "Nome ou Razão Social", "example": "João Silva" }, "contact_person": { "type": "string", "nullable": true, "maxLength": 120, "description": "Pessoa de Contato (quando Empresa)", "example": null }, "nickname": { "type": "string", "nullable": true, "maxLength": 255, "description": "Apelido ou Nome Fantasia do Pagador", "example": null }, "birthday": { "type": "string", "nullable": true, "format": "date", "description": "Data de Nascimento", "example": "1978-06-12" }, "email": { "type": "string", "format": "email", "maxLength": 80, "description": "E-mail principal", "example": "cliente@example.com" }, "email_cc": { "type": "string", "format": "email", "maxLength": 80, "description": "E-mail alternativo", "example": "outroemail@example.com" }, "address": { "type": "string", "maxLength": 255, "description": "Endereço", "example": "Rua F, alamenda G" }, "address_complement": { "type": "string", "nullable": true, "maxLength": 120, "description": "Complemento do Endereço", "example": null }, "address_number": { "type": "string", "maxLength": 10, "description": "Número", "example": null }, "neighborhood": { "type": "string", "maxLength": 80, "description": "Bairro", "example": "Centro" }, "zipcode": { "type": "string", "maxLength": 8, "description": "CEP (formato 99999999)", "example": "01310100" }, "state": { "type": "string", "maxLength": 2, "description": "Estado", "example": "SP" }, "city_name": { "type": "string", "maxLength": 60, "description": "Cidade (Nome deve estar correto e completo)", "example": "São Paulo" }, "phone_number": { "type": "string", "nullable": true, "maxLength": 11, "description": "Telefone (com DDD)", "example": null }, "mobile_local_code": { "type": "string", "nullable": true, "maxLength": 2, "description": "DDD do Celular", "example": null }, "mobile_number": { "type": "string", "nullable": true, "maxLength": 9, "description": "Celular", "example": null }, "ignore_email": { "type": "boolean", "default": false, "nullable": true, "description": "Nunca enviar e-mail para este cliente", "example": null }, "ignore_sms": { "type": "boolean", "default": false, "nullable": true, "description": "Nunca enviar SMS para este cliente", "example": null }, "ignore_whatsapp": { "type": "boolean", "default": false, "nullable": true, "description": "Nunca enviar Whatsapp para este cliente", "example": null }, "notes": { "type": "string", "nullable": true, "description": "Observações", "example": null }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas ao registro", "example": null, "items": { "type": "string" } }, "tag_list": { "type": "string", "nullable": true, "readOnly": true, "description": "Tags associadas ao registro" }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "created_via_api": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se o registro foi criado por API" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do registro" } } }, "v2_customer_update_object": { "type": "object", "required": [ "person_name", "zipcode", "address", "neighborhood", "city_name" ], "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID" }, "uid": { "type": "string", "readOnly": true, "description": "UID" }, "external_code": { "type": "string", "nullable": true, "maxLength": 255, "description": "Código Externo", "example": "C0001" }, "person_name": { "type": "string", "maxLength": 120, "description": "Nome ou Razão Social", "example": "João Silva" }, "contact_person": { "type": "string", "nullable": true, "maxLength": 120, "description": "Pessoa de Contato (quando Empresa)", "example": null }, "nickname": { "type": "string", "nullable": true, "maxLength": 255, "description": "Apelido ou Nome Fantasia do Pagador", "example": null }, "birthday": { "type": "string", "nullable": true, "format": "date", "description": "Data de Nascimento", "example": "1978-06-12" }, "email": { "type": "string", "format": "email", "maxLength": 80, "description": "E-mail principal", "example": "cliente@example.com" }, "email_cc": { "type": "string", "format": "email", "maxLength": 80, "description": "E-mail alternativo", "example": "outroemail@example.com" }, "address": { "type": "string", "maxLength": 255, "description": "Endereço", "example": "Rua F, alamenda G" }, "address_complement": { "type": "string", "nullable": true, "maxLength": 120, "description": "Complemento do Endereço", "example": null }, "address_number": { "type": "string", "maxLength": 10, "description": "Número", "example": null }, "neighborhood": { "type": "string", "maxLength": 80, "description": "Bairro", "example": "Centro" }, "zipcode": { "type": "string", "maxLength": 8, "description": "CEP (formato 99999999)", "example": "01310100" }, "state": { "type": "string", "maxLength": 2, "description": "Estado", "example": "SP" }, "city_name": { "type": "string", "maxLength": 60, "description": "Cidade (Nome deve estar correto e completo)", "example": "São Paulo" }, "phone_number": { "type": "string", "nullable": true, "maxLength": 11, "description": "Telefone (com DDD)", "example": null }, "mobile_local_code": { "type": "string", "nullable": true, "maxLength": 2, "description": "DDD do Celular", "example": null }, "mobile_number": { "type": "string", "nullable": true, "maxLength": 9, "description": "Celular", "example": null }, "ignore_email": { "type": "boolean", "default": false, "nullable": true, "description": "Nunca enviar e-mail para este cliente", "example": null }, "ignore_sms": { "type": "boolean", "default": false, "nullable": true, "description": "Nunca enviar SMS para este cliente", "example": null }, "ignore_whatsapp": { "type": "boolean", "default": false, "nullable": true, "description": "Nunca enviar Whatsapp para este cliente", "example": null }, "notes": { "type": "string", "nullable": true, "description": "Observações", "example": null }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas ao registro", "example": null, "items": { "type": "string" } }, "tag_list": { "type": "string", "nullable": true, "readOnly": true, "description": "Tags associadas ao registro" }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "created_via_api": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se o registro foi criado por API" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do registro" } } }, "v2_event": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Evento" }, "uid": { "type": "string", "readOnly": true, "description": "UID do Evento" }, "code": { "type": "string", "readOnly": true, "example": "payment.pix.cancel.confirmed", "description": "Código do evento.\n\n**IMPORTANTE:** Além dos eventos listados abaixo, o sistema gera eventos específicos por tipo de operação:\n\n- Para **pagamentos**, use: `payment.{tipo}.{operação}.{status}`\n - Tipos: `pix`, `bank_billet`, `darf`, `tax`, `utility`, `gru`\n - Operações: `register`, `approve`, `reschedule`, `cancel`, `get`, `sync`\n - Status: `requested`, `confirmed`, `failed`, `error`\n - Exemplo: `payment.pix.cancel.confirmed`\n\n- Para **transferências**, use: `transfer.{tipo}.{operação}.{status}`\n - Tipos: `ted`, `pix`, `internal`\n - Operações: `register`, `reschedule`, `approve`, `cancel`, `get`, `sync`\n - Status: `requested`, `confirmed`, `failed`, `error`\n - Exemplo: `transfer.ted.register.confirmed`\n\n- Para **lotes**, use: `payment.{tipo}_batch.*` ou `transfer.{tipo}_batch.*`\n - Exemplo: `payment.pix_batch.register.confirmed`\n\n**Lista de eventos comuns:**\n* `ping` Ping\n* `access_token.db.created` Token de Acesso criado.\n* `access_token.db.updated` Token de Acesso atualizado.\n* `access_token.db.deleted` Token de Acesso excluído.\n* `access_token.reminder` Lembrete de expiração do Token de Acesso.\n* `access_token.expired` Token de Acesso expirou.\n* `account.updated` Conta atualizada.\n* `account.blocked` Conta bloqueada.\n* `account.bank_billet_creation_blocked` Emissão de boletos bloqueada.\n* `bank_billet.created` Boleto criado.\n* `bank_billet.updated` Boleto atualizado.\n* `bank_billet.generated` PDF do Boleto Gerado ou Atualizado.\n* `bank_billet.canceled` Boleto cancelado.\n* `bank_billet.blocked` Boleto foi bloqueado.\n* `bank_billet.overdue` Boleto ficou vencido.\n* `bank_billet.paid` Boleto foi pago.\n* `bank_billet.due_date` Notifica boleto com 15, 7, 3 e 1 dias antes do vencimento.\n* `bank_billet.rejected` Boleto rejeitado.\n* `bank_billet.cancel.requested` Cancelamento do Boleto solicitado.\n* `bank_billet.cancel.confirmed` Cancelamento do Boleto confirmado.\n* `bank_billet.cancel.failed` Falha no cancelamento do Boleto.\n* `bank_billet.cancel.error` Ocorreu um erro no cancelamento do Boleto.\n* `bank_billet.register.requested` Registro do Boleto solicitado.\n* `bank_billet.register.confirmed` Registro do Boleto confirmado.\n* `bank_billet.register.failed` Falha no registro do Boleto.\n* `bank_billet.register.error` Ocorreu um erro no registro do Boleto.\n* `bank_billet.update.requested` Atualização do Boleto solicitada.\n* `bank_billet.update.confirmed` Atualização do Boleto confirmada.\n* `bank_billet.update.failed` Falha na atualização do Boleto.\n* `bank_billet.update.error` Ocorreu um erro na atualização do Boleto.\n* `bank_billet.registered` Boleto registrado.\n* `bank_billet.deleted` Boleto excluído.\n* `bank_billet.sync.requested` Sincronização do Boleto solicitada.\n* `bank_billet.sync.confirmed` Sincronização do Boleto confirmada.\n* `bank_billet.sync.failed` Falha na sincronização do Boleto.\n* `bank_billet.sync.error` Ocorreu um erro na sincronização do Boleto.\n* `bank_billet.get.requested` Informação do Boleto solicitada.\n* `bank_billet.get.confirmed` Informação do Boleto confirmada.\n* `bank_billet.get.failed` Falha na informação do Boleto.\n* `bank_billet.get.error` Ocorreu um erro na informação do Boleto.\n* `bank_billet.get_child.requested` Informação do Boleto filho solicitada.\n* `bank_billet.get_child.confirmed` Informação do Boleto filho confirmada.\n* `bank_billet.get_child.failed` Falha na informação do Boleto filho.\n* `bank_billet.get_child.error` Ocorreu um erro na informação do Boleto filho.\n* `bank_billet.find.requested` Busca de Boleto solicitada.\n* `bank_billet.find.confirmed` Busca de Boleto confirmada.\n* `bank_billet.find.failed` Falha na busca de Boleto.\n* `bank_billet.find.error` Ocorreu um erro na busca de Boleto.\n* `bank_billet.add_pix.requested` Adição do Pix ao Boleto solicitada.\n* `bank_billet.add_pix.confirmed` Adição do Pix ao Boleto confirmada.\n* `bank_billet.add_pix.failed` Falha na adição do Pix ao Boleto.\n* `bank_billet.add_pix.error` Ocorreu um erro na adição do Pix ao Boleto.\n* `bank_billet.get_pix.requested` Consulta do Pix do Boleto solicitada.\n* `bank_billet.get_pix.confirmed` Consulta do Pix do Boleto confirmada.\n* `bank_billet.get_pix.failed` Falha na consulta do Pix do Boleto.\n* `bank_billet.get_pix.error` Ocorreu um erro na consulta do Pix do Boleto.\n* `bank_billet.protest.requested` Protesto do Boleto solicitado.\n* `bank_billet.protest.confirmed` Protesto do Boleto confirmado.\n* `bank_billet.protest.failed` Falha no protesto do Boleto.\n* `bank_billet.protest.error` Ocorreu um erro no protesto do Boleto.\n* `bank_billet_discharge.created` Registro de retorno criado.\n* `bank_billet_discharge.updated` Registro de retorno atualizado.\n* `bank_billet_discharge.deleted` Registro de retorno excluído.\n* `bank_billet_remittance.created` Registro de remessa criado.\n* `bank_billet_remittance.updated` Registro de remessa atualizado.\n* `bank_billet_remittance.deleted` Registro de remessa excluído.\n* `bank_billet_registration.created` Registro de Boleto criado.\n* `bank_billet_registration.updated` Registro de Boleto atualizado.\n* `bank_billet_registration.deleted` Registro de Boleto excluído.\n* `bank_billet_payment.created` Recebimento criado.\n* `bank_billet_payment.updated` Recebimento atualizado.\n* `bank_billet_payment.deleted` Recebimento excluído.\n* `customer.created` Cliente criado.\n* `customer.updated` Cliente atualizado.\n* `customer.portal_password_updated` Senha do portal do cliente atualizada.\n* `customer.deleted` Cliente excluído.\n* `transaction.created` Transação criada.\n* `transaction.updated` Transação atualizada.\n* `transaction.processed` Transação processada.\n* `withdrawal.transferred` Saque transferido.\n* `withdrawal.requested` Saque solicitado.\n* `addon.activated` Addon ativado.\n* `addon.removed` Addon removido.\n* `plan_subscription.activated` Plano ativado.\n* `plan_subscription.removed` Plano removido.\n* `plan_subscription.fee` Cobrança do plano.\n* `plan_subscription.updated` Plano atualizado.\n* `user.created` Usuário criado.\n* `user.updated` Usuário atualizado.\n* `user.deleted` Usuário excluído.\n* `remittance.created` Remessa criada.\n* `remittance.processed` Remessa processada.\n* `remittance.downloaded` Download de Remessa realizado.\n* `remittance.sent` Remessa enviada.\n* `remittance.deleted` Remessa excluída.\n* `remittance.line.db.created` Linha de Remessa criada.\n* `remittance.line.db.updated` Linha de Remessa atualizada.\n* `remittance.line.db.deleted` Linha de Remessa excluída.\n* `discharge.created` Retorno criado.\n* `discharge.processed` Retorno processado.\n* `discharge.deleted` Retorno excluído.\n* `bank_billet_account.created` Conta de Cobrança criada.\n* `bank_billet_account.homologated` Conta de Cobrança enviada para homologação.\n* `bank_billet_account.homologation_failed` Falha na homologação da Conta de Cobrança.\n* `bank_billet_account.homologation_started` Conta de Cobrança enviada para homologação.\n* `bank_billet_account.validated` Conta de Cobrança homologada.\n* `bank_billet_account.validation_released` Conta de Cobrança homologada.\n* `bank_billet_account.activated` Conta de Cobrança ativada.\n* `bank_billet_account.updated` Conta de Cobrança atualizada.\n* `bank_billet_account.deleted` Conta de Cobrança excluída.\n* `edi.remittance_line.created` Linha de Remessa criada.\n* `edi.remittance_line.updated` Linha de Remessa atualizada.\n* `edi.remittance_line.deleted` Linha de Remessa excluída.\n* `edi.edi_box.activated` EDI ativado.\n* `edi.edi_box.db.created` EDI criado.\n* `edi.edi_box.db.deleted` EDI excluído.\n* `edi.edi_box.db.updated` EDI atualizado.\n* `edi.edi_box.generated` Carta Gerada\n* `edi.edi_box.demand_received` Demanda recepcionada\n* `edi.edi_box.confirming_at_bank` Aguardando confirmação do banco\n* `edi.edi_box.testing_by_customer` Aguardando teste do cliente\n* `edi.edi_box.waiting_for_validations` Aguardando validações\n* `customer_subscription.created` Assinatura criada.\n* `customer_subscription.updated` Assinatura atualizada.\n* `customer_subscription.deleted` Assinatura excluída.\n* `installment.created` Carnê criado.\n* `installment.processed` Carnê processado.\n* `installment.generated` Carnê gerado.\n* `installment.deleted` Carnê excluído.\n* `import.created` Importação criada.\n* `import.processed` Importação processada.\n* `import.deleted` Importação excluída.\n* `export.db.created` Exportação criada.\n* `export.db.updated` Exportação atualizada.\n* `export.db.deleted` Exportação excluída.\n* `pix.db.created` Pix criado.\n* `pix.db.updated` Pix atualizado.\n* `pix.db.deleted` Pix excluído.\n* `pix.register.requested` Registro do Pix solicitado.\n* `pix.register.confirmed` Registro do Pix confirmado.\n* `pix.register.failed` Falha no registro do Pix.\n* `pix.register.error` Ocorreu um erro no registro do Pix.\n* `pix.update.requested` Atualização do Pix solicitada.\n* `pix.update.confirmed` Atualização do Pix confirmada.\n* `pix.update.failed` Falha na atualização do Pix.\n* `pix.update.error` Ocorreu um erro na atualização do Pix.\n* `pix.paid` Pix pago.\n* `pix.overdue` Pix vencido (somente Pix Cobrança).\n* `pix.cancel.requested` Cancelamento do Pix solicitado.\n* `pix.cancel.confirmed` Cancelamento do Pix confirmado.\n* `pix.cancel.failed` Falha no cancelamento do Pix.\n* `pix.cancel.error` Ocorreu um erro no cancelamento do Pix.\n* `pix.sync.requested` Sincronização do Pix solicitada.\n* `pix.sync.confirmed` Sincronização do Pix confirmada.\n* `pix.sync.failed` Falha na sincronização do Pix.\n* `pix.sync.error` Ocorreu um erro na sincronização do Pix.\n* `pix.get.requested` Informação do Pix solicitada.\n* `pix.get.confirmed` Informação do Pix confirmada.\n* `pix.get.failed` Falha na informação do Pix.\n* `pix.get.error` Ocorreu um erro na informação do Pix.\n* `financial.account.balance_sync.requested` Sincronização do Saldo solicitada.\n* `financial.account.balance_sync.confirmed` Sincronização do Saldo confirmada.\n* `financial.account.balance_sync.failed` Falha na sincronização do Saldo.\n* `financial.account.balance_sync.error` Ocorreu um erro na sincronização do Saldo.\n* `financial.account.statement_sync.requested` Sincronização do Extrato solicitada.\n* `financial.account.statement_sync.confirmed` Sincronização do Extrato confirmada.\n* `financial.account.statement_sync.failed` Falha na sincronização do Extrato.\n* `financial.account.statement_sync.error` Ocorreu um erro na sincronização do Extrato.\n* `financial.account.db.created` Conta Financeira criada.\n* `financial.account.db.updated` Conta Financeira atualizada.\n* `financial.account.db.deleted` Conta Financeira excluída.\n* `financial.account.statement.updated` Extrato atualizado.\n* `financial.account.balance.updated` Saldo da conta financeira atualizado.\n* `financial.account_balance.db.created` Saldo criado.\n* `transfer.batch.db.created` Lote de transferência criado.\n* `transfer.batch.db.updated` Lote de transferência atualizado.\n* `transfer.batch.db.deleted` Lote de transferência excluído.\n* `transfer.batch.awaiting_approval` Lote de transferência aguardando liberação.\n* `transfer.pix_batch.awaiting_approval` Lote de Transferência Pix aguardando liberação.\n* `transfer.pix_batch.get.requested` Informação do Lote de Transferência Pix solicitada.\n* `transfer.pix_batch.get.confirmed` Informação do Lote de Transferência Pix confirmada.\n* `transfer.pix_batch.get.failed` Falha na informação do Lote de Transferência Pix.\n* `transfer.pix_batch.get.error` Ocorreu um erro na informação do Lote de Transferência Pix.\n* `transfer.pix_batch.sync.requested` Sincronização de Lote de transferência Pix solicitada.\n* `transfer.pix_batch.sync.confirmed` Sincronização de Lote de transferência Pix confirmada.\n* `transfer.pix_batch.sync.failed` Falha na sincronização de Lote de transferência Pix.\n* `transfer.pix_batch.sync.error` Ocorreu um erro na sincronização de Lote de transferência Pix.\n* `transfer.pix_batch.register.requested` Lote de Transferência Pix solicitado.\n* `transfer.pix_batch.register.confirmed` Lote de Transferência Pix confirmado.\n* `transfer.pix_batch.register.failed` Falha no envio de Lote de Transferência Pix.\n* `transfer.pix_batch.register.error` Ocorreu um erro no envio de Lote de Transferência Pix.\n* `transfer.pix_batch.approve.requested` Liberação de Lote de Transferência Pix solicitada.\n* `transfer.pix_batch.approve.confirmed` Liberação de Lote de Transferência Pix confirmada.\n* `transfer.pix_batch.approve.failed` Falha na liberação de Lote de Transferência Pix.\n* `transfer.pix_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência Pix.\n* `transfer.pix_batch.reprove.requested` Rejeição de Lote de Transferência Pix solicitada.\n* `transfer.pix_batch.reprove.confirmed` Rejeição de Lote de transferência Pix confirmada.\n* `transfer.pix_batch.reprove.failed` Falha na rejeição de Lote de Transferência Pix.\n* `transfer.pix_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência Pix.\n* `transfer.pix_batch.cancel.requested` Cancelamento de Lote de Transferência Pix solicitado.\n* `transfer.pix_batch.cancel.confirmed` Cancelamento de Lote de Transferência Pix confirmado.\n* `transfer.pix_batch.cancel.failed` Falha no cancelamento de Lote de Transferência Pix.\n* `transfer.pix_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Transferência Pix.\n* `transfer.ted_batch.awaiting_approval` Lote de Transferência TED aguardando liberação.\n* `transfer.ted_batch.get.requested` Informação do Lote de Transferência TED solicitada.\n* `transfer.ted_batch.get.confirmed` Informação do Lote de Transferência TED confirmada.\n* `transfer.ted_batch.get.failed` Falha na informação do Lote de Transferência TED.\n* `transfer.ted_batch.get.error` Ocorreu um erro na informação do Lote de Transferência TED.\n* `transfer.ted_batch.sync.requested` Sincronização de Lote de transferência TED solicitada.\n* `transfer.ted_batch.sync.confirmed` Sincronização de Lote de transferência TED confirmada.\n* `transfer.ted_batch.sync.failed` Falha na sincronização de Lote de transferência TED.\n* `transfer.ted_batch.sync.error` Ocorreu um erro na sincronização de Lote de transferência TED.\n* `transfer.ted_batch.register.requested` Lote de Transferência TED solicitado.\n* `transfer.ted_batch.register.confirmed` Lote de Transferência TED confirmado.\n* `transfer.ted_batch.register.failed` Falha no envio de Lote de Transferência TED.\n* `transfer.ted_batch.register.error` Ocorreu um erro no envio de Lote de Transferência TED.\n* `transfer.ted_batch.approve.requested` Liberação de Lote de Transferência TED solicitada.\n* `transfer.ted_batch.approve.confirmed` Liberação de Lote de Transferência TED confirmada.\n* `transfer.ted_batch.approve.failed` Falha na liberação de Lote de Transferência TED.\n* `transfer.ted_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência TED.\n* `transfer.ted_batch.reprove.requested` Rejeição de Lote de Transferência TED solicitada.\n* `transfer.ted_batch.reprove.confirmed` Rejeição de Lote de transferência TED confirmada.\n* `transfer.ted_batch.reprove.failed` Falha na rejeição de Lote de Transferência TED.\n* `transfer.ted_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência TED.\n* `transfer.ted_batch.cancel.requested` Cancelamento de Lote de Transferência TED solicitado.\n* `transfer.ted_batch.cancel.confirmed` Cancelamento de Lote de Transferência TED confirmado.\n* `transfer.ted_batch.cancel.failed` Falha no cancelamento de Lote de Transferência TED.\n* `transfer.ted_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Transferência TED.\n* `transfer.internal_batch.awaiting_approval` Lote de Transferência Entre Contas do Mesmo Banco aguardando liberação.\n* `transfer.internal_batch.get.requested` Informação do Lote de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.get.confirmed` Informação do Lote de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.get.failed` Falha na informação do Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.get.error` Ocorreu um erro na informação do Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.sync.requested` Sincronização de Lote de transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.sync.confirmed` Sincronização de Lote de transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.sync.failed` Falha na sincronização de Lote de transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.sync.error` Ocorreu um erro na sincronização de Lote de transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.register.requested` Lote de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal_batch.register.confirmed` Lote de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal_batch.register.failed` Falha no envio de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.register.error` Ocorreu um erro no envio de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.approve.requested` Liberação de Lote de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.approve.confirmed` Liberação de Lote de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.approve.failed` Falha na liberação de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.reprove.requested` Rejeição de Lote de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.reprove.confirmed` Rejeição de Lote de transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.reprove.failed` Falha na rejeição de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.cancel.requested` Cancelamento de Lote de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal_batch.cancel.confirmed` Cancelamento de Lote de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal_batch.cancel.failed` Falha no cancelamento de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.db.created` Transferência criada.\n* `transfer.db.updated` Transferência atualizada.\n* `transfer.db.deleted` Transferência excluída.\n* `transfer.pix.register.requested` Transferência Pix solicitada.\n* `transfer.pix.register.confirmed` Transferência Pix confirmada.\n* `transfer.pix.register.failed` Falha no envio da Transferência Pix.\n* `transfer.pix.register.error` Ocorreu um erro no envio da Transferência Pix.\n* `transfer.pix.reschedule.requested` Reagendamento de Transferência Pix solicitado.\n* `transfer.pix.reschedule.confirmed` Reagendamento de Transferência Pix confirmado.\n* `transfer.pix.reschedule.failed` Falha no reagendamento da Transferência Pix.\n* `transfer.pix.reschedule.error` Ocorreu um erro no reagendamento da Transferência Pix.\n* `transfer.pix.approve.requested` Liberação de Transferência Pix solicitada.\n* `transfer.pix.approve.confirmed` Liberação de Transferência Pix confirmada.\n* `transfer.pix.approve.failed` Falha na liberação da transferência Pix.\n* `transfer.pix.approve.error` Ocorreu um erro na liberação da Transferência Pix.\n* `transfer.pix.reprove.requested` Rejeição de Transferência Pix solicitada.\n* `transfer.pix.reprove.confirmed` Rejeição de Transferência Pix confirmada.\n* `transfer.pix.reprove.failed` Falha na rejeição da transferência Pix.\n* `transfer.pix.reprove.error` Ocorreu um erro na rejeição da Transferência Pix.\n* `transfer.pix.cancel.requested` Cancelamento de Transferência Pix solicitado.\n* `transfer.pix.cancel.confirmed` Cancelamento de Transferência Pix confirmado.\n* `transfer.pix.cancel.failed` Falha no cancelamento da Transferência Pix.\n* `transfer.pix.cancel.error` Ocorreu um erro no cancelamento da Transferência Pix.\n* `transfer.pix.get.requested` Informação da Transferência Pix solicitada.\n* `transfer.pix.get.confirmed` Informação da Transferência Pix confirmada.\n* `transfer.pix.get.failed` Falha na informação da Transferência Pix.\n* `transfer.pix.get.error` Ocorreu um erro na informação da Transferência Pix.\n* `transfer.pix.sync.requested` Sincronização da Transferência Pix solicitada.\n* `transfer.pix.sync.confirmed` Sincronização da Transferência Pix confirmada.\n* `transfer.pix.sync.failed` Falha na sincronização da Transferência Pix.\n* `transfer.pix.sync.error` Ocorreu um erro na sincronização da Transferência Pix.\n* `transfer.ted.register.requested` Transferência TED solicitada.\n* `transfer.ted.register.confirmed` Transferência TED confirmada.\n* `transfer.ted.register.failed` Falha no envio da Transferência TED.\n* `transfer.ted.register.error` Ocorreu um erro no envio da Transferência TED.\n* `transfer.ted.reschedule.requested` Reagendamento de Transferência TED solicitado.\n* `transfer.ted.reschedule.confirmed` Reagendamento de Transferência TED confirmado.\n* `transfer.ted.reschedule.failed` Falha no Reagendamento de Transferência TED.\n* `transfer.ted.reschedule.error` Ocorreu um erro no Reagendamento de Transferência TED.\n* `transfer.ted.approve.requested` Liberação de Transferência TED solicitada.\n* `transfer.ted.approve.confirmed` Liberação de Transferência TED confirmada.\n* `transfer.ted.approve.failed` Falha na liberação da transferência TED.\n* `transfer.ted.approve.error` Ocorreu um erro na liberação da Transferência TED.\n* `transfer.ted.reprove.requested` Rejeição de Transferência TED solicitada.\n* `transfer.ted.reprove.confirmed` Rejeição de Transferência TED confirmada.\n* `transfer.ted.reprove.failed` Falha na rejeição da transferência TED.\n* `transfer.ted.reprove.error` Ocorreu um erro na rejeição da Transferência TED.\n* `transfer.ted.cancel.requested` Cancelamento de Transferência TED solicitado.\n* `transfer.ted.cancel.confirmed` Cancelamento de Transferência TED confirmado.\n* `transfer.ted.cancel.failed` Falha no cancelamento de Transferência TED.\n* `transfer.ted.cancel.error` Ocorreu um erro no cancelamento de Transferência TED.\n* `transfer.ted.get.requested` Informação da Transferência TED solicitada.\n* `transfer.ted.get.confirmed` Informação da Transferência TED confirmada.\n* `transfer.ted.get.failed` Falha na informação da Transferência TED.\n* `transfer.ted.get.error` Ocorreu um erro na informação da Transferência TED.\n* `transfer.ted.sync.requested` Sincronização da Transferência TED solicitada.\n* `transfer.ted.sync.confirmed` Sincronização da Transferência TED confirmada.\n* `transfer.ted.sync.failed` Falha na sincronização da Transferência TED.\n* `transfer.ted.sync.error` Ocorreu um erro na sincronização da Transferência TED.\n* `transfer.internal.register.requested` Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.register.confirmed` Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.register.failed` Falha no envio da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.register.error` Ocorreu um erro no envio da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reschedule.requested` Reagendamento de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal.reschedule.confirmed` Reagendamento de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal.reschedule.failed` Falha no Reagendamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reschedule.error` Ocorreu um erro no Reagendamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.approve.requested` Liberação de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.approve.confirmed` Liberação de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.approve.failed` Falha na liberação da transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.approve.error` Ocorreu um erro na liberação da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reprove.requested` Rejeição de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.reprove.confirmed` Rejeição de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.reprove.failed` Falha na rejeição da transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reprove.error` Ocorreu um erro na rejeição da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.cancel.requested` Cancelamento de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal.cancel.confirmed` Cancelamento de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal.cancel.failed` Falha no cancelamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.cancel.error` Ocorreu um erro no cancelamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.get.requested` Informação da Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.get.confirmed` Informação da Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.get.failed` Falha na informação da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.get.error` Ocorreu um erro na informação da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.sync.requested` Sincronização da Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.sync.confirmed` Sincronização da Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.sync.failed` Falha na sincronização da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.sync.error` Ocorreu um erro na sincronização da Transferência Entre Contas do Mesmo Banco.\n* `payment.db.created` Pagamento criado.\n* `payment.db.updated` Pagamento atualizado.\n* `payment.db.deleted` Pagamento excluído.\n* `payment.bank_billet.register.requested` Pagamento de Boleto solicitado.\n* `payment.bank_billet.register.confirmed` Pagamento de Boleto confirmado.\n* `payment.bank_billet.register.failed` Falha no envio do Pagamento de Boleto.\n* `payment.bank_billet.register.error` Ocorreu um erro no envio de Pagamento de Boleto.\n* `payment.bank_billet.approve.requested` Liberação de Pagamento de Boleto solicitada.\n* `payment.bank_billet.approve.confirmed` Liberação de Pagamento de Boleto confirmada.\n* `payment.bank_billet.approve.failed` Falha na liberação de Pagamento de Boleto.\n* `payment.bank_billet.approve.error` Ocorreu um erro na liberação de Pagamento de Boleto.\n* `payment.bank_billet.reprove.requested` Rejeição de Pagamento de Boleto solicitada.\n* `payment.bank_billet.reprove.confirmed` Rejeição de Pagamento de Boleto confirmada.\n* `payment.bank_billet.reprove.failed` Falha na rejeição de Pagamento de Boleto.\n* `payment.bank_billet.reprove.error` Ocorreu um erro na rejeição de Pagamento de Boleto.\n* `payment.bank_billet.reschedule.requested` Reagendamento de Pagamento de Boleto solicitado.\n* `payment.bank_billet.reschedule.confirmed` Reagendamento de Pagamento de Boleto confirmado.\n* `payment.bank_billet.reschedule.failed` Falha no Reagendamento de Pagamento de Boleto.\n* `payment.bank_billet.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Boleto.\n* `payment.bank_billet.cancel.requested` Cancelamento de Pagamento de Boleto solicitado.\n* `payment.bank_billet.cancel.confirmed` Cancelamento de Pagamento de Boleto confirmada.\n* `payment.bank_billet.cancel.failed` Falha no cancelamento de Pagamento de Boleto.\n* `payment.bank_billet.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Boleto.\n* `payment.bank_billet.get.requested` Informação do Pagamento de Boleto solicitada.\n* `payment.bank_billet.get.confirmed` Informação do Pagamento de Boleto confirmada.\n* `payment.bank_billet.get.failed` Falha na informação do Pagamento de Boleto.\n* `payment.bank_billet.get.error` Ocorreu um erro na informação do Pagamento de Boleto.\n* `payment.bank_billet.sync.requested` Sincronização do Pagamento de Boleto solicitada.\n* `payment.bank_billet.sync.confirmed` Sincronização do Pagamento de Boleto confirmada.\n* `payment.bank_billet.sync.failed` Falha na sincronização do Pagamento de Boleto.\n* `payment.bank_billet.sync.error` Ocorreu um erro na sincronização do Pagamento de Boleto.\n* `payment.darf.register.requested` Pagamento de DARF solicitado.\n* `payment.darf.register.confirmed` Pagamento de DARF confirmado.\n* `payment.darf.register.failed` Falha no envio do Pagamento de DARF.\n* `payment.darf.register.error` Ocorreu um erro no envio de Pagamento de DARF.\n* `payment.darf.approve.requested` Liberação de Pagamento de DARF solicitada.\n* `payment.darf.approve.confirmed` Liberação de Pagamento de DARF confirmada.\n* `payment.darf.approve.failed` Falha na liberação de Pagamento de DARF.\n* `payment.darf.approve.error` Ocorreu um erro na liberação de Pagamento de DARF.\n* `payment.darf.reprove.requested` Rejeição de Pagamento de DARF solicitada.\n* `payment.darf.reprove.confirmed` Rejeição de Pagamento de DARF confirmada.\n* `payment.darf.reprove.failed` Falha na rejeição de Pagamento de DARF.\n* `payment.darf.reprove.error` Ocorreu um erro na rejeição de Pagamento de DARF.\n* `payment.darf.reschedule.requested` Reagendamento de Pagamento de DARF solicitado.\n* `payment.darf.reschedule.confirmed` Reagendamento de Pagamento de DARF confirmado.\n* `payment.darf.reschedule.failed` Falha no Reagendamento de Pagamento de DARF.\n* `payment.darf.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de DARF.\n* `payment.darf.cancel.requested` Cancelamento de Pagamento de DARF solicitado.\n* `payment.darf.cancel.confirmed` Cancelamento de Pagamento de DARF confirmada.\n* `payment.darf.cancel.failed` Falha no cancelamento de Pagamento de DARF.\n* `payment.darf.cancel.error` Ocorreu um erro no cancelamento de Pagamento de DARF.\n* `payment.darf.get.requested` Informação do Pagamento de DARF solicitada.\n* `payment.darf.get.confirmed` Informação do Pagamento de DARF confirmada.\n* `payment.darf.get.failed` Falha na informação do Pagamento de DARF.\n* `payment.darf.get.error` Ocorreu um erro na informação do Pagamento de DARF.\n* `payment.darf.sync.requested` Sincronização do Pagamento de DARF solicitada.\n* `payment.darf.sync.confirmed` Sincronização do Pagamento de DARF confirmada.\n* `payment.darf.sync.failed` Falha na sincronização do Pagamento de DARF.\n* `payment.darf.sync.error` Ocorreu um erro na sincronização do Pagamento de DARF.\n* `payment.utility.register.requested` Pagamento de Conta de Consumo solicitado.\n* `payment.utility.register.confirmed` Pagamento de Conta de Consumo confirmado.\n* `payment.utility.register.failed` Falha no envio do Pagamento de Conta de Consumo.\n* `payment.utility.register.error` Ocorreu um erro no envio de Pagamento de Conta de Consumo.\n* `payment.utility.approve.requested` Liberação de Pagamento de Conta de Consumo solicitada.\n* `payment.utility.approve.confirmed` Liberação de Pagamento de Conta de Consumo confirmada.\n* `payment.utility.approve.failed` Falha na liberação de Pagamento de Conta de Consumo.\n* `payment.utility.approve.error` Ocorreu um erro na liberação de Pagamento de Conta de Consumo.\n* `payment.utility.reprove.requested` Rejeição de Pagamento de Conta de Consumo solicitada.\n* `payment.utility.reprove.confirmed` Rejeição de Pagamento de Conta de Consumo confirmada.\n* `payment.utility.reprove.failed` Falha na rejeição de Pagamento de Conta de Consumo.\n* `payment.utility.reprove.error` Ocorreu um erro na rejeição de Pagamento de Conta de Consumo.\n* `payment.utility.reschedule.requested` Reagendamento de Pagamento de Conta de Consumo solicitado.\n* `payment.utility.reschedule.confirmed` Reagendamento de Pagamento de Conta de Consumo confirmado.\n* `payment.utility.reschedule.failed` Falha no Reagendamento de Pagamento de Conta de Consumo.\n* `payment.utility.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Conta de Consumo.\n* `payment.utility.cancel.requested` Cancelamento de Pagamento de Conta de Consumo solicitado.\n* `payment.utility.cancel.confirmed` Cancelamento de Pagamento de Conta de Consumo confirmada.\n* `payment.utility.cancel.failed` Falha no cancelamento de Pagamento de Conta de Consumo.\n* `payment.utility.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Conta de Consumo.\n* `payment.utility.get.requested` Informação do Pagamento de Conta de Consumo solicitada.\n* `payment.utility.get.confirmed` Informação do Pagamento de Conta de Consumo confirmada.\n* `payment.utility.get.failed` Falha na informação do Pagamento de Conta de Consumo.\n* `payment.utility.get.error` Ocorreu um erro na informação do Pagamento de Conta de Consumo.\n* `payment.utility.sync.requested` Sincronização do Pagamento de Conta de Consumo solicitada.\n* `payment.utility.sync.confirmed` Sincronização do Pagamento de Conta de Consumo confirmada.\n* `payment.utility.sync.failed` Falha na sincronização do Pagamento de Conta de Consumo.\n* `payment.utility.sync.error` Ocorreu um erro na sincronização do Pagamento de Conta de Consumo.\n* `payment.gru.register.requested` Pagamento de GRU solicitado.\n* `payment.gru.register.confirmed` Pagamento de GRU confirmado.\n* `payment.gru.register.failed` Falha no envio do Pagamento de GRU.\n* `payment.gru.register.error` Ocorreu um erro no envio de Pagamento de GRU.\n* `payment.gru.approve.requested` Liberação de Pagamento de GRU solicitada.\n* `payment.gru.approve.confirmed` Liberação de Pagamento de GRU confirmada.\n* `payment.gru.approve.failed` Falha na liberação de Pagamento de GRU.\n* `payment.gru.approve.error` Ocorreu um erro na liberação de Pagamento de GRU.\n* `payment.gru.reprove.requested` Rejeição de Pagamento de GRU solicitada.\n* `payment.gru.reprove.confirmed` Rejeição de Pagamento de GRU confirmada.\n* `payment.gru.reprove.failed` Falha na rejeição de Pagamento de GRU.\n* `payment.gru.reprove.error` Ocorreu um erro na rejeição de Pagamento de GRU.\n* `payment.gru.reschedule.requested` Reagendamento de Pagamento de GRU solicitado.\n* `payment.gru.reschedule.confirmed` Reagendamento de Pagamento de GRU confirmado.\n* `payment.gru.reschedule.failed` Falha no Reagendamento de Pagamento de GRU.\n* `payment.gru.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de GRU.\n* `payment.gru.cancel.requested` Cancelamento de Pagamento de GRU solicitado.\n* `payment.gru.cancel.confirmed` Cancelamento de Pagamento de GRU confirmada.\n* `payment.gru.cancel.failed` Falha no cancelamento de Pagamento de GRU.\n* `payment.gru.cancel.error` Ocorreu um erro no cancelamento de Pagamento de GRU.\n* `payment.gru.get.requested` Informação do Pagamento de GRU solicitada.\n* `payment.gru.get.confirmed` Informação do Pagamento de GRU confirmada.\n* `payment.gru.get.failed` Falha na informação do Pagamento de GRU.\n* `payment.gru.get.error` Ocorreu um erro na informação do Pagamento de GRU.\n* `payment.gru.sync.requested` Sincronização do Pagamento de GRU solicitada.\n* `payment.gru.sync.confirmed` Sincronização do Pagamento de GRU confirmada.\n* `payment.gru.sync.failed` Falha na sincronização do Pagamento de GRU.\n* `payment.gru.sync.error` Ocorreu um erro na sincronização do Pagamento de GRU.\n* `payment.pix.register.requested` Pagamento de Pix solicitado.\n* `payment.pix.register.confirmed` Pagamento de Pix confirmado.\n* `payment.pix.register.failed` Falha no envio do Pagamento de Pix.\n* `payment.pix.register.error` Ocorreu um erro no envio de Pagamento de Pix.\n* `payment.pix.approve.requested` Liberação de Pagamento de Pix solicitada.\n* `payment.pix.approve.confirmed` Liberação de Pagamento de Pix confirmada.\n* `payment.pix.approve.failed` Falha na liberação de Pagamento de Pix.\n* `payment.pix.approve.error` Ocorreu um erro na liberação de Pagamento de Pix.\n* `payment.pix.reprove.requested` Rejeição de Pagamento de Pix solicitada.\n* `payment.pix.reprove.confirmed` Rejeição de Pagamento de Pix confirmada.\n* `payment.pix.reprove.failed` Falha na rejeição de Pagamento de Pix.\n* `payment.pix.reprove.error` Ocorreu um erro na rejeição de Pagamento de Pix.\n* `payment.pix.reschedule.requested` Reagendamento de Pagamento de Pix solicitado.\n* `payment.pix.reschedule.confirmed` Reagendamento de Pagamento de Pix confirmado.\n* `payment.pix.reschedule.failed` Falha no Reagendamento de Pagamento de Pix.\n* `payment.pix.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Pix.\n* `payment.pix.cancel.requested` Cancelamento de Pagamento de Pix solicitado.\n* `payment.pix.cancel.confirmed` Cancelamento de Pagamento de Pix confirmada.\n* `payment.pix.cancel.failed` Falha no cancelamento de Pagamento de Pix.\n* `payment.pix.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Pix.\n* `payment.pix.get.requested` Informação do Pagamento de Pix solicitada.\n* `payment.pix.get.confirmed` Informação do Pagamento de Pix confirmada.\n* `payment.pix.get.failed` Falha na informação do Pagamento de Pix.\n* `payment.pix.get.error` Ocorreu um erro na informação do Pagamento de Pix.\n* `payment.pix.sync.requested` Sincronização do Pagamento de Pix solicitada.\n* `payment.pix.sync.confirmed` Sincronização do Pagamento de Pix confirmada.\n* `payment.pix.sync.failed` Falha na sincronização do Pagamento de Pix.\n* `payment.pix.sync.error` Ocorreu um erro na sincronização do Pagamento de Pix.\n* `payment.tax.register.requested` Pagamento de Tributo solicitado.\n* `payment.tax.register.confirmed` Pagamento de Tributo confirmado.\n* `payment.tax.register.failed` Falha no envio do Pagamento de Tributo.\n* `payment.tax.register.error` Ocorreu um erro no envio de Pagamento de Tributo.\n* `payment.tax.approve.requested` Liberação de Pagamento de Tributo solicitada.\n* `payment.tax.approve.confirmed` Liberação de Pagamento de Tributo confirmada.\n* `payment.tax.approve.failed` Falha na liberação de Pagamento de Tributo.\n* `payment.tax.approve.error` Ocorreu um erro na liberação de Pagamento de Tributo.\n* `payment.tax.reprove.requested` Rejeição de Pagamento de Tributo solicitada.\n* `payment.tax.reprove.confirmed` Rejeição de Pagamento de Tributo confirmada.\n* `payment.tax.reprove.failed` Falha na rejeição de Pagamento de Tributo.\n* `payment.tax.reprove.error` Ocorreu um erro na rejeição de Pagamento de Tributo.\n* `payment.tax.reschedule.requested` Reagendamento de Pagamento de Tributo solicitado.\n* `payment.tax.reschedule.confirmed` Reagendamento de Pagamento de Tributo confirmado.\n* `payment.tax.reschedule.failed` Falha no Reagendamento de Pagamento de Tributo.\n* `payment.tax.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Tributo.\n* `payment.tax.cancel.requested` Cancelamento de Pagamento de Tributo solicitado.\n* `payment.tax.cancel.confirmed` Cancelamento de Pagamento de Tributo confirmada.\n* `payment.tax.cancel.failed` Falha no cancelamento de Pagamento de Tributo.\n* `payment.tax.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Tributo.\n* `payment.tax.get.requested` Informação do Pagamento de Tributo solicitada.\n* `payment.tax.get.confirmed` Informação do Pagamento de Tributo confirmada.\n* `payment.tax.get.failed` Falha na informação do Pagamento de Tributo.\n* `payment.tax.get.error` Ocorreu um erro na informação do Pagamento de Tributo.\n* `payment.tax.sync.requested` Sincronização do Pagamento de Tributo solicitada.\n* `payment.tax.sync.confirmed` Sincronização do Pagamento de Tributo confirmada.\n* `payment.tax.sync.failed` Falha na sincronização do Pagamento de Tributo.\n* `payment.tax.sync.error` Ocorreu um erro na sincronização do Pagamento de Tributo.\n* `payment.batch.db.created` Lote de Pagamento criado.\n* `payment.batch.db.updated` Lote de Pagamento atualizado.\n* `payment.batch.db.deleted` Lote de Pagamento excluído.\n* `payment.batch.awaiting_approval` Lote de pagamento aguardando liberação.\n* `payment.bank_billet_batch.awaiting_approval` Lote de Pagamento de Boleto aguardando liberação.\n* `payment.bank_billet_batch.get.requested` Informação do Lote de Pagamento de Boleto solicitada.\n* `payment.bank_billet_batch.get.confirmed` Informação do Lote de Pagamento de Boleto confirmada.\n* `payment.bank_billet_batch.get.failed` Falha na informação do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.sync.requested` Sincronização de Lote de Pagamento de Boleto solicitada.\n* `payment.bank_billet_batch.sync.confirmed` Sincronização de Lote de Pagamento de Boleto confirmada.\n* `payment.bank_billet_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.register.requested` Lote de Pagamento de Boleto solicitado.\n* `payment.bank_billet_batch.register.confirmed` Lote de Pagamento de Boleto confirmado.\n* `payment.bank_billet_batch.register.failed` Falha no envio do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.approve.requested` Liberação de Lote de Pagamento de Boleto solicitado.\n* `payment.bank_billet_batch.approve.confirmed` Liberação de Lote de Pagamento de Boleto confirmado.\n* `payment.bank_billet_batch.approve.failed` Falha na liberação de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.reprove.requested` Rejeição de Lote de Pagamento de Boleto solicitado.\n* `payment.bank_billet_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Boleto confirmado.\n* `payment.bank_billet_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.bank_billet_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.bank_billet_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.bank_billet_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.darf_batch.awaiting_approval` Lote de Pagamento de DARF aguardando liberação.\n* `payment.darf_batch.get.requested` Informação do Lote de Pagamento de DARF solicitada.\n* `payment.darf_batch.get.confirmed` Informação do Lote de Pagamento de DARF confirmada.\n* `payment.darf_batch.get.failed` Falha na informação do Lote de Pagamento de DARF.\n* `payment.darf_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de DARF.\n* `payment.darf_batch.sync.requested` Sincronização de Lote de Pagamento de DARF solicitada.\n* `payment.darf_batch.sync.confirmed` Sincronização de Lote de Pagamento de DARF confirmada.\n* `payment.darf_batch.sync.failed` Falha na sincronização de Lote de Pagamento de DARF.\n* `payment.darf_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de DARF.\n* `payment.darf_batch.register.requested` Lote de Pagamento de DARF solicitado.\n* `payment.darf_batch.register.confirmed` Lote de Pagamento de DARF confirmado.\n* `payment.darf_batch.register.failed` Falha no envio do Lote de Pagamento de DARF.\n* `payment.darf_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de DARF.\n* `payment.darf_batch.approve.requested` Liberação de Lote de Pagamento de DARF solicitado.\n* `payment.darf_batch.approve.confirmed` Liberação de Lote de Pagamento de DARF confirmado.\n* `payment.darf_batch.approve.failed` Falha na liberação de Lote de Pagamento de DARF.\n* `payment.darf_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de DARF.\n* `payment.darf_batch.reprove.requested` Rejeição de Lote de Pagamento de DARF solicitado.\n* `payment.darf_batch.reprove.confirmed` Rejeição de Lote de Pagamento de DARF confirmado.\n* `payment.darf_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de DARF.\n* `payment.darf_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de DARF.\n* `payment.darf_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.darf_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.darf_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.darf_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.utility_batch.awaiting_approval` Lote de Pagamento de Conta de Consumo aguardando liberação.\n* `payment.utility_batch.get.requested` Informação do Lote de Pagamento de Conta de Consumo solicitada.\n* `payment.utility_batch.get.confirmed` Informação do Lote de Pagamento de Conta de Consumo confirmada.\n* `payment.utility_batch.get.failed` Falha na informação do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.sync.requested` Sincronização de Lote de Pagamento de Conta de Consumo solicitada.\n* `payment.utility_batch.sync.confirmed` Sincronização de Lote de Pagamento de Conta de Consumo confirmada.\n* `payment.utility_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.register.requested` Lote de Pagamento de Conta de Consumo solicitado.\n* `payment.utility_batch.register.confirmed` Lote de Pagamento de Conta de Consumo confirmado.\n* `payment.utility_batch.register.failed` Falha no envio do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.approve.requested` Liberação de Lote de Pagamento de Conta de Consumo solicitado.\n* `payment.utility_batch.approve.confirmed` Liberação de Lote de Pagamento de Conta de Consumo confirmado.\n* `payment.utility_batch.approve.failed` Falha na liberação de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.reprove.requested` Rejeição de Lote de Pagamento de Conta de Consumo solicitado.\n* `payment.utility_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Conta de Consumo confirmado.\n* `payment.utility_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.utility_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.utility_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.utility_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.gru_batch.awaiting_approval` Lote de Pagamento de GRU aguardando liberação.\n* `payment.gru_batch.get.requested` Informação do Lote de Pagamento de GRU solicitada.\n* `payment.gru_batch.get.confirmed` Informação do Lote de Pagamento de GRU confirmada.\n* `payment.gru_batch.get.failed` Falha na informação do Lote de Pagamento de GRU.\n* `payment.gru_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de GRU.\n* `payment.gru_batch.sync.requested` Sincronização de Lote de Pagamento de GRU solicitada.\n* `payment.gru_batch.sync.confirmed` Sincronização de Lote de Pagamento de GRU confirmada.\n* `payment.gru_batch.sync.failed` Falha na sincronização de Lote de Pagamento de GRU.\n* `payment.gru_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de GRU.\n* `payment.gru_batch.register.requested` Lote de Pagamento de GRU solicitado.\n* `payment.gru_batch.register.confirmed` Lote de Pagamento de GRU confirmado.\n* `payment.gru_batch.register.failed` Falha no envio do Lote de Pagamento de GRU.\n* `payment.gru_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de GRU.\n* `payment.gru_batch.approve.requested` Liberação de Lote de Pagamento de GRU solicitado.\n* `payment.gru_batch.approve.confirmed` Liberação de Lote de Pagamento de GRU confirmado.\n* `payment.gru_batch.approve.failed` Falha na liberação de Lote de Pagamento de GRU.\n* `payment.gru_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de GRU.\n* `payment.gru_batch.reprove.requested` Rejeição de Lote de Pagamento de GRU solicitado.\n* `payment.gru_batch.reprove.confirmed` Rejeição de Lote de Pagamento de GRU confirmado.\n* `payment.gru_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de GRU.\n* `payment.gru_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de GRU.\n* `payment.gru_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.gru_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.gru_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.gru_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.pix_batch.awaiting_approval` Lote de Pagamento de Pix aguardando liberação.\n* `payment.pix_batch.get.requested` Informação do Lote de Pagamento de Pix solicitada.\n* `payment.pix_batch.get.confirmed` Informação do Lote de Pagamento de Pix confirmada.\n* `payment.pix_batch.get.failed` Falha na informação do Lote de Pagamento de Pix.\n* `payment.pix_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Pix.\n* `payment.pix_batch.sync.requested` Sincronização de Lote de Pagamento de Pix solicitada.\n* `payment.pix_batch.sync.confirmed` Sincronização de Lote de Pagamento de Pix confirmada.\n* `payment.pix_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Pix.\n* `payment.pix_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Pix.\n* `payment.pix_batch.register.requested` Lote de Pagamento de Pix solicitado.\n* `payment.pix_batch.register.confirmed` Lote de Pagamento de Pix confirmado.\n* `payment.pix_batch.register.failed` Falha no envio do Lote de Pagamento de Pix.\n* `payment.pix_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Pix.\n* `payment.pix_batch.approve.requested` Liberação de Lote de Pagamento de Pix solicitado.\n* `payment.pix_batch.approve.confirmed` Liberação de Lote de Pagamento de Pix confirmado.\n* `payment.pix_batch.approve.failed` Falha na liberação de Lote de Pagamento de Pix.\n* `payment.pix_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Pix.\n* `payment.pix_batch.reprove.requested` Rejeição de Lote de Pagamento de Pix solicitado.\n* `payment.pix_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Pix confirmado.\n* `payment.pix_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Pix.\n* `payment.pix_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Pix.\n* `payment.pix_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.pix_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.pix_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.pix_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.tax_batch.awaiting_approval` Lote de Pagamento de Tributo aguardando liberação.\n* `payment.tax_batch.get.requested` Informação do Lote de Pagamento de Tributo solicitada.\n* `payment.tax_batch.get.confirmed` Informação do Lote de Pagamento de Tributo confirmada.\n* `payment.tax_batch.get.failed` Falha na informação do Lote de Pagamento de Tributo.\n* `payment.tax_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Tributo.\n* `payment.tax_batch.sync.requested` Sincronização de Lote de Pagamento de Tributo solicitada.\n* `payment.tax_batch.sync.confirmed` Sincronização de Lote de Pagamento de Tributo confirmada.\n* `payment.tax_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Tributo.\n* `payment.tax_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Tributo.\n* `payment.tax_batch.register.requested` Lote de Pagamento de Tributo solicitado.\n* `payment.tax_batch.register.confirmed` Lote de Pagamento de Tributo confirmado.\n* `payment.tax_batch.register.failed` Falha no envio do Lote de Pagamento de Tributo.\n* `payment.tax_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Tributo.\n* `payment.tax_batch.approve.requested` Liberação de Lote de Pagamento de Tributo solicitado.\n* `payment.tax_batch.approve.confirmed` Liberação de Lote de Pagamento de Tributo confirmado.\n* `payment.tax_batch.approve.failed` Falha na liberação de Lote de Pagamento de Tributo.\n* `payment.tax_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Tributo.\n* `payment.tax_batch.reprove.requested` Rejeição de Lote de Pagamento de Tributo solicitado.\n* `payment.tax_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Tributo confirmado.\n* `payment.tax_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Tributo.\n* `payment.tax_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Tributo.\n* `payment.tax_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.tax_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.tax_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.tax_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.dda.account.db.created` Conta de DDA criada\n* `payment.dda.account.register.requested` Conta de DDA solicitada.\n* `payment.dda.account.register.failed` Falha na criação da conta DDA.\n* `payment.dda.account.register.error` Ocorreu um erro no registro da conta DDA.\n* `payment.dda.account.register.confirmed` Conta de DDA confirmada.\n* `payment.dda.account.bank_billets_sync.requested` Sincronização de Boletos solicitada.\n* `payment.dda.account.bank_billets_sync.failed` Falha na sincronização de Boleto.\n* `payment.dda.account.bank_billets_sync.error` Ocorreu um erro na sincronização de Boletos.\n* `payment.dda.account.bank_billets_sync.confirmed` Sincronização de Boletos confirmada.\n* `payment.dda.account.unregister.requested` Descadastramento da conta DDA solicitado.\n* `payment.dda.account.unregister.failed` Falha no descadastramento da conta DDA.\n* `payment.dda.account.unregister.error` Ocorreu um erro no descadastramento da conta DDA.\n* `payment.dda.account.unregister.confirmed` Descadastramento da conta DDA confirmado.\n* `payment.dda.bank_billet.db.created` Boleto DDA criado\n* `payment.dda.bank_billet.db.updated` Boleto DDA atualizado.\n* `payment.dda.bank_billet.external_status_changed` Status externo do Boleto DDA alterado.\n* `payment.dda.bank_billet.get.requested` Informação do Boleto solicitada.\n* `payment.dda.bank_billet.get.confirmed` Informação do Boleto confirmada.\n* `payment.dda.bank_billet.get.failed` Falha na informação do Boleto.\n* `payment.dda.bank_billet.get.error` Ocorreu um erro na informação do Boleto.\n* `payment.dda.bank_billet.sync.requested` Sincronização do Boleto solicitada.\n* `payment.dda.bank_billet.sync.confirmed` Sincronização do Boleto confirmada.\n* `payment.dda.bank_billet.sync.failed` Falha na sincronização do Boleto.\n* `payment.dda.bank_billet.sync.error` Ocorreu um erro na sincronização do Boleto.\n* `payment.dda.account.db.updated` Conta de DDA atualizada.\n* `payment.dda.account.db.deleted` Conta de DDA excluída.\n* `payment.dda.account.letter.pending` Carta DDA gerada.\n* `payment.dda.account.letter.waiting_signatures` Carta DDA aguardando assinaturas.\n* `payment.dda.account.letter.signed` Carta DDA assinada.\n* `payment.dda.account.letter.failed` Falha no processo de assinatura da carta DDA.\n* `payment.dda.account.confirmed` Assinatura da conta DDA aprovada.\n* `payment.dda.account.rejected` Assinatura da conta DDA rejeitada.\n* `payment.dda.account.failed` Falha na conta DDA.\n* `payment.dda.account.disabled` Conta DDA desabilitada.\n* `payment.dda.account.enabled` Conta DDA reabilitada.\n* `credit.restriction.add.requested` Inclusão da restrição de crédito solicitada.\n* `credit.restriction.add.failed` Falha na inclusão da restrição de crédito.\n* `credit.restriction.add.error` Ocorreu um erro na inclusão da restrição de crédito.\n* `credit.restriction.add.confirmed` Inclusão da restrição de crédito confirmada.\n* `credit.restriction.remove.requested` Remoção da restrição de crédito solicitada.\n* `credit.restriction.remove.confirmed` Remoção da restrição de crédito confirmada.\n* `credit.restriction.remove.failed` Falha na remoção da restrição de crédito.\n* `credit.restriction.remove.error` Ocorreu um erro na remoção da restrição de crédito.\n* `charge.automatic_pix.account.db.created` Conta de Pix Automático criada.\n* `charge.automatic_pix.account.db.updated` Conta de Pix Automático atualizada.\n* `charge.automatic_pix.account.db.deleted` Conta de Pix Automático excluída.\n* `charge.automatic_pix.recurrence.db.created` Recorrência de Pix Automático criada.\n* `charge.automatic_pix.recurrence.db.updated` Recorrência de Pix Automático atualizada.\n* `charge.automatic_pix.recurrence.db.deleted` Recorrência de Pix Automático excluída.\n* `charge.automatic_pix.recurrence.cancel.requested` Cancelamento da Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.recurrence.cancel.confirmed` Cancelamento da Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.recurrence.cancel.failed` Falha no cancelamento da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.cancel.error` Ocorreu um erro no cancelamento da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.register.requested` Registro da Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.recurrence.register.confirmed` Registro da Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.recurrence.register.failed` Falha no registro da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.register.error` Ocorreu um erro no registro da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.update.requested` Atualização da Recorrência de Pix Automático solicitada.\n* `charge.automatic_pix.recurrence.update.confirmed` Atualização da Recorrência de Pix Automático confirmada.\n* `charge.automatic_pix.recurrence.update.failed` Falha na atualização da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.update.error` Ocorreu um erro na atualização da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.pending` Recorrência de Pix Automático pendente.\n* `charge.automatic_pix.recurrence.created` Recorrência de Pix Automático criada no provedor financeiro.\n* `charge.automatic_pix.recurrence.approved` Recorrência de Pix Automático aprovada.\n* `charge.automatic_pix.recurrence.rejected` Recorrência de Pix Automático rejeitada.\n* `charge.automatic_pix.recurrence.expired` Recorrência de Pix Automático expirada.\n* `charge.automatic_pix.recurrence.canceled` Recorrência de Pix Automático cancelada.\n* `charge.automatic_pix.request.db.created` Solicitações de Recorrência de Pix Automático criada.\n* `charge.automatic_pix.request.db.updated` Solicitações de Recorrência de Pix Automático atualizada.\n* `charge.automatic_pix.request.db.deleted` Solicitações de Recorrência de Pix Automático excluída.\n* `charge.automatic_pix.request.cancel.requested` Cancelamento da Solicitação de Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.request.cancel.confirmed` Cancelamento da Solicitação de Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.request.cancel.failed` Falha no cancelamento da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.cancel.error` Ocorreu um erro no cancelamento da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.register.requested` Registro da Solicitação de Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.request.register.confirmed` Registro da Solicitação de Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.request.register.failed` Falha no registro da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.register.error` Ocorreu um erro no registro da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.pending` Solicitação de Recorrência de Pix Automático pendente.\n* `charge.automatic_pix.request.created` Solicitação de Recorrência de Pix Automático criada no provedor financeiro.\n* `charge.automatic_pix.request.sent` Solicitação de Recorrência de Pix Automático enviada ao pagador.\n* `charge.automatic_pix.request.received` Solicitação de Recorrência de Pix Automático recebida pelo pagador.\n* `charge.automatic_pix.request.rejected` Solicitação de Recorrência de Pix Automático rejeitada.\n* `charge.automatic_pix.request.accepted` Solicitação de Recorrência de Pix Automático aceita.\n* `charge.automatic_pix.request.expired` Solicitação de Recorrência de Pix Automático expirada.\n* `charge.automatic_pix.request.canceled` Solicitação de Recorrência de Pix Automático cancelada.\n* `charge.automatic_pix.pix.db.created` Cobrança de Pix Automático criada.\n* `charge.automatic_pix.pix.db.updated` Cobrança de Pix Automático atualizada.\n* `charge.automatic_pix.pix.db.deleted` Cobrança de Pix Automático excluída.\n* `charge.automatic_pix.pix.cancel.requested` Cancelamento da Cobrança de Pix Automático solicitado.\n* `charge.automatic_pix.pix.cancel.confirmed` Cancelamento da Cobrança de Pix Automático confirmado.\n* `charge.automatic_pix.pix.cancel.failed` Falha no cancelamento da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.cancel.error` Ocorreu um erro no cancelamento da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.register.requested` Registro da Cobrança de Pix Automático solicitado.\n* `charge.automatic_pix.pix.register.confirmed` Registro da Cobrança de Pix Automático confirmado.\n* `charge.automatic_pix.pix.register.failed` Falha no registro da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.register.error` Ocorreu um erro no registro da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.update.requested` Atualização da Cobrança de Pix Automático solicitada.\n* `charge.automatic_pix.pix.update.confirmed` Atualização da Cobrança de Pix Automático confirmada.\n* `charge.automatic_pix.pix.update.failed` Falha na atualização da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.update.error` Ocorreu um erro na atualização da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.pending` Cobrança de Pix Automático pendente.\n* `charge.automatic_pix.pix.created` Cobrança de Pix Automático criada no provedor financeiro.\n* `charge.automatic_pix.pix.active` Cobrança de Pix Automático ativa.\n* `charge.automatic_pix.pix.paid` Cobrança de Pix Automático paga.\n* `charge.automatic_pix.pix.expired` Cobrança de Pix Automático expirada.\n* `charge.automatic_pix.pix.rejected` Cobrança de Pix Automático rejeitada.\n* `charge.automatic_pix.pix.canceled` Cobrança de Pix Automático cancelada.\n* `charge.automatic_pix.location.db.created` Localização de Pix Automático criada.\n* `charge.automatic_pix.location.db.updated` Localização de Pix Automático atualizada.\n* `charge.automatic_pix.location.db.deleted` Localização de Pix Automático excluída.\n* `charge.automatic_pix.location.register.requested` Registro da Localização de Pix Automático solicitado.\n* `charge.automatic_pix.location.register.confirmed` Registro da Localização de Pix Automático confirmado.\n* `charge.automatic_pix.location.register.failed` Falha no registro da Localização de Pix Automático.\n* `charge.automatic_pix.location.register.error` Ocorreu um erro no registro da Localização de Pix Automático.\n* `charge.payment.db.created` Recebimento de cobrança criado.\n* `charge.payment.db.updated` Recebimento de cobrança atualizado.\n* `charge.payment.db.deleted` Recebimento de cobrança excluído.\n* `charge.payment.notified` Recebimento notificado.\n* `charge.payment.canceled` Recebimento cancelado.\n* `charge.payment.confirmed` Recebimento confirmado.\n* `charge.payment.duplicated` Recebimento duplicado.\n* `charge.bank_billet.payment.notified` Baixa operacional de boleto notificada.\n* `charge.bank_billet.payment.canceled` Baixa operacional de boleto cancelada.\n* `charge.bank_billet.payment.confirmed` Baixa operacional de boleto liquidada.\n* `data.bank_billet_query.success` Consulta de boleto realizada com sucesso.\n* `data.bank_billet_query.error` Consulta de boleto com erro.\n* `data.bank_billet_query.db.created` Consulta de boleto criada.\n* `data.bank_billet_query.db.updated` Consulta de boleto atualizada.\n* `data.bank_billet_query.db.deleted` Consulta de boleto excluída.\n* `data.pix_qrcode_query.success` Consulta de Pix via QR Code realizada com sucesso.\n* `data.pix_qrcode_query.error` Consulta de Pix via QR Code com erro.\n* `data.pix_qrcode_query.db.created` Consulta de Pix via QR Code criada.\n* `data.pix_qrcode_query.db.updated` Consulta de Pix via QR Code atualizada.\n* `data.pix_qrcode_query.db.deleted` Consulta de Pix via QR Code excluída.\n* `mailbox.entry.db.created` Caixa Postal criado.\n* `mailbox.entry.db.updated` Caixa Postal atualizado.\n* `mailbox.entry.db.deleted` Caixa Postal excluída.\n* `mailbox.entry.file.received` Arquivo recebido na caixa de entrada.\n* `mailbox.entry.file.sent` Arquivo enviado para a caixa de saída.\n* `mailbox.file.db.created` Arquivo criado.\n* `mailbox.file.db.updated` Arquivo atualizado.\n* `mailbox.file.db.deleted` Arquivo excluído.\n* `mailbox.channel.s3.db.created` Canal S3 criado.\n* `mailbox.channel.s3.db.updated` Canal S3 atualizado.\n* `mailbox.channel.s3.db.deleted` Canal S3 excluído.\n* `mailbox.channel.s3.fetch_all` Arquivo obtido do canal S3.\n* `mailbox.channel.email.db.created` Canal de Email criado.\n* `mailbox.channel.email.db.updated` Canal de Email atualizado.\n* `mailbox.channel.email.db.deleted` Canal de Email excluído.\n* `mailbox.channel.whatsapp.db.created` Canal WhatsApp criado.\n* `mailbox.channel.whatsapp.db.updated` Canal WhatsApp atualizado.\n* `mailbox.channel.whatsapp.db.deleted` Canal WhatsApp excluído.\n* `mailbox.channel.sftp.db.created` Canal SFTP criado.\n* `mailbox.channel.sftp.db.updated` Canal SFTP atualizado.\n* `mailbox.channel.sftp.db.deleted` Canal SFTP excluído.\n* `mailbox.channel.sftp.fetch_all` Arquivo obtido do canal SFTP.\n* `mailbox.channel.syncthing.db.created` Canal Syncthing criado.\n* `mailbox.channel.syncthing.db.updated` Canal Syncthing atualizado.\n* `mailbox.channel.syncthing.db.deleted` Canal Syncthing excluído.\n* `email_account.db.created` Conta de e-mail criada.\n* `email_account.db.updated` Conta de e-mail atualizada.\n* `email_account.db.deleted` Conta de e-mail excluída.\n* `email_account.identity.pending` Aguardando identidade\n* `email_account.identity.created` Identidade criada\n* `email_account.identity.error` Identidade já existente\n* `email_account.identity.failure` Falha da identidade\n* `email_account.dns.not_ready` DNS não pronto\n* `email_account.dns.awaiting` Aguardando validação DNS\n* `email_account.dns.validated` DNS validado\n* `email_account.dns.error` Falha na validação do DNS\n* `email_account.dns.failure` Falha na tentativa do DNS\n* `integration.connection.db.created` Conexão criada.\n* `integration.connection.db.updated` Conexão atualizada.\n* `integration.connection.db.deleted` Conexão excluída.\n* `webhook.db.created` Webhook criado.\n* `webhook.db.updated` Webhook atualizado.\n* `webhook.db.deleted` Webhook excluído.\n* `enotas.nfe.generated` Enotas: nota fiscal gerada\n\n**📖 Documentação completa:** Consulte [Referência de Eventos](/docs/guides/events/event-codes-reference.md) para lista completa e exemplos." }, "data": { "type": "object", "description": "Mais informações relativas ao evento. Ver possíveis valores em [Payloads](/reference/payloads)" }, "bank_billet_account_id": { "type": "integer", "readOnly": true, "nullable": true, "description": "ID da Carteira de Cobrança", "example": null }, "resource_owner_id": { "type": "integer", "nullable": true, "description": "ID do Objeto associado ao evento", "example": null }, "occurred_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de quando o evento ocorreu." }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do evento" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de atualização do evento" } } }, "v2_email_delivery": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do e-mail enviado" }, "uid": { "type": "string", "maxLength": 36, "description": "UID usado no cabeçalho da requisição" }, "delivered_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora que a entrega foi realizada" }, "failed_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora que a entrega falhou" }, "event_code": { "type": "string", "maxLength": 255, "example": "bank_billet.created", "description": "Código do evento.\n* `ping` Ping\n* `access_token.db.created` Token de Acesso criado.\n* `access_token.db.updated` Token de Acesso atualizado.\n* `access_token.db.deleted` Token de Acesso excluído.\n* `access_token.reminder` Lembrete de expiração do Token de Acesso.\n* `access_token.expired` Token de Acesso expirou.\n* `account.updated` Conta atualizada.\n* `account.blocked` Conta bloqueada.\n* `account.bank_billet_creation_blocked` Emissão de boletos bloqueada.\n* `bank_billet.created` Boleto criado.\n* `bank_billet.updated` Boleto atualizado.\n* `bank_billet.generated` PDF do Boleto Gerado ou Atualizado.\n* `bank_billet.canceled` Boleto cancelado.\n* `bank_billet.blocked` Boleto foi bloqueado.\n* `bank_billet.overdue` Boleto ficou vencido.\n* `bank_billet.paid` Boleto foi pago.\n* `bank_billet.due_date` Notifica boleto com 15, 7, 3 e 1 dias antes do vencimento.\n* `bank_billet.rejected` Boleto rejeitado.\n* `bank_billet.cancel.requested` Cancelamento do Boleto solicitado.\n* `bank_billet.cancel.confirmed` Cancelamento do Boleto confirmado.\n* `bank_billet.cancel.failed` Falha no cancelamento do Boleto.\n* `bank_billet.cancel.error` Ocorreu um erro no cancelamento do Boleto.\n* `bank_billet.register.requested` Registro do Boleto solicitado.\n* `bank_billet.register.confirmed` Registro do Boleto confirmado.\n* `bank_billet.register.failed` Falha no registro do Boleto.\n* `bank_billet.register.error` Ocorreu um erro no registro do Boleto.\n* `bank_billet.update.requested` Atualização do Boleto solicitada.\n* `bank_billet.update.confirmed` Atualização do Boleto confirmada.\n* `bank_billet.update.failed` Falha na atualização do Boleto.\n* `bank_billet.update.error` Ocorreu um erro na atualização do Boleto.\n* `bank_billet.registered` Boleto registrado.\n* `bank_billet.deleted` Boleto excluído.\n* `bank_billet.sync.requested` Sincronização do Boleto solicitada.\n* `bank_billet.sync.confirmed` Sincronização do Boleto confirmada.\n* `bank_billet.sync.failed` Falha na sincronização do Boleto.\n* `bank_billet.sync.error` Ocorreu um erro na sincronização do Boleto.\n* `bank_billet.get.requested` Informação do Boleto solicitada.\n* `bank_billet.get.confirmed` Informação do Boleto confirmada.\n* `bank_billet.get.failed` Falha na informação do Boleto.\n* `bank_billet.get.error` Ocorreu um erro na informação do Boleto.\n* `bank_billet.get_child.requested` Informação do Boleto filho solicitada.\n* `bank_billet.get_child.confirmed` Informação do Boleto filho confirmada.\n* `bank_billet.get_child.failed` Falha na informação do Boleto filho.\n* `bank_billet.get_child.error` Ocorreu um erro na informação do Boleto filho.\n* `bank_billet.find.requested` Busca de Boleto solicitada.\n* `bank_billet.find.confirmed` Busca de Boleto confirmada.\n* `bank_billet.find.failed` Falha na busca de Boleto.\n* `bank_billet.find.error` Ocorreu um erro na busca de Boleto.\n* `bank_billet.add_pix.requested` Adição do Pix ao Boleto solicitada.\n* `bank_billet.add_pix.confirmed` Adição do Pix ao Boleto confirmada.\n* `bank_billet.add_pix.failed` Falha na adição do Pix ao Boleto.\n* `bank_billet.add_pix.error` Ocorreu um erro na adição do Pix ao Boleto.\n* `bank_billet.get_pix.requested` Consulta do Pix do Boleto solicitada.\n* `bank_billet.get_pix.confirmed` Consulta do Pix do Boleto confirmada.\n* `bank_billet.get_pix.failed` Falha na consulta do Pix do Boleto.\n* `bank_billet.get_pix.error` Ocorreu um erro na consulta do Pix do Boleto.\n* `bank_billet.protest.requested` Protesto do Boleto solicitado.\n* `bank_billet.protest.confirmed` Protesto do Boleto confirmado.\n* `bank_billet.protest.failed` Falha no protesto do Boleto.\n* `bank_billet.protest.error` Ocorreu um erro no protesto do Boleto.\n* `bank_billet_discharge.created` Registro de retorno criado.\n* `bank_billet_discharge.updated` Registro de retorno atualizado.\n* `bank_billet_discharge.deleted` Registro de retorno excluído.\n* `bank_billet_remittance.created` Registro de remessa criado.\n* `bank_billet_remittance.updated` Registro de remessa atualizado.\n* `bank_billet_remittance.deleted` Registro de remessa excluído.\n* `bank_billet_registration.created` Registro de Boleto criado.\n* `bank_billet_registration.updated` Registro de Boleto atualizado.\n* `bank_billet_registration.deleted` Registro de Boleto excluído.\n* `bank_billet_payment.created` Recebimento criado.\n* `bank_billet_payment.updated` Recebimento atualizado.\n* `bank_billet_payment.deleted` Recebimento excluído.\n* `customer.created` Cliente criado.\n* `customer.updated` Cliente atualizado.\n* `customer.portal_password_updated` Senha do portal do cliente atualizada.\n* `customer.deleted` Cliente excluído.\n* `transaction.created` Transação criada.\n* `transaction.updated` Transação atualizada.\n* `transaction.processed` Transação processada.\n* `withdrawal.transferred` Saque transferido.\n* `withdrawal.requested` Saque solicitado.\n* `addon.activated` Addon ativado.\n* `addon.removed` Addon removido.\n* `plan_subscription.activated` Plano ativado.\n* `plan_subscription.removed` Plano removido.\n* `plan_subscription.fee` Cobrança do plano.\n* `plan_subscription.updated` Plano atualizado.\n* `user.created` Usuário criado.\n* `user.updated` Usuário atualizado.\n* `user.deleted` Usuário excluído.\n* `remittance.created` Remessa criada.\n* `remittance.processed` Remessa processada.\n* `remittance.downloaded` Download de Remessa realizado.\n* `remittance.sent` Remessa enviada.\n* `remittance.deleted` Remessa excluída.\n* `remittance.line.db.created` Linha de Remessa criada.\n* `remittance.line.db.updated` Linha de Remessa atualizada.\n* `remittance.line.db.deleted` Linha de Remessa excluída.\n* `discharge.created` Retorno criado.\n* `discharge.processed` Retorno processado.\n* `discharge.deleted` Retorno excluído.\n* `bank_billet_account.created` Conta de Cobrança criada.\n* `bank_billet_account.homologated` Conta de Cobrança enviada para homologação.\n* `bank_billet_account.homologation_failed` Falha na homologação da Conta de Cobrança.\n* `bank_billet_account.homologation_started` Conta de Cobrança enviada para homologação.\n* `bank_billet_account.validated` Conta de Cobrança homologada.\n* `bank_billet_account.validation_released` Conta de Cobrança homologada.\n* `bank_billet_account.activated` Conta de Cobrança ativada.\n* `bank_billet_account.updated` Conta de Cobrança atualizada.\n* `bank_billet_account.deleted` Conta de Cobrança excluída.\n* `edi.remittance_line.created` Linha de Remessa criada.\n* `edi.remittance_line.updated` Linha de Remessa atualizada.\n* `edi.remittance_line.deleted` Linha de Remessa excluída.\n* `edi.edi_box.activated` EDI ativado.\n* `edi.edi_box.db.created` EDI criado.\n* `edi.edi_box.db.deleted` EDI excluído.\n* `edi.edi_box.db.updated` EDI atualizado.\n* `edi.edi_box.generated` Carta Gerada\n* `edi.edi_box.demand_received` Demanda recepcionada\n* `edi.edi_box.confirming_at_bank` Aguardando confirmação do banco\n* `edi.edi_box.testing_by_customer` Aguardando teste do cliente\n* `edi.edi_box.waiting_for_validations` Aguardando validações\n* `customer_subscription.created` Assinatura criada.\n* `customer_subscription.updated` Assinatura atualizada.\n* `customer_subscription.deleted` Assinatura excluída.\n* `installment.created` Carnê criado.\n* `installment.processed` Carnê processado.\n* `installment.generated` Carnê gerado.\n* `installment.deleted` Carnê excluído.\n* `import.created` Importação criada.\n* `import.processed` Importação processada.\n* `import.deleted` Importação excluída.\n* `export.db.created` Exportação criada.\n* `export.db.updated` Exportação atualizada.\n* `export.db.deleted` Exportação excluída.\n* `pix.db.created` Pix criado.\n* `pix.db.updated` Pix atualizado.\n* `pix.db.deleted` Pix excluído.\n* `pix.register.requested` Registro do Pix solicitado.\n* `pix.register.confirmed` Registro do Pix confirmado.\n* `pix.register.failed` Falha no registro do Pix.\n* `pix.register.error` Ocorreu um erro no registro do Pix.\n* `pix.update.requested` Atualização do Pix solicitada.\n* `pix.update.confirmed` Atualização do Pix confirmada.\n* `pix.update.failed` Falha na atualização do Pix.\n* `pix.update.error` Ocorreu um erro na atualização do Pix.\n* `pix.paid` Pix pago.\n* `pix.overdue` Pix vencido (somente Pix Cobrança).\n* `pix.cancel.requested` Cancelamento do Pix solicitado.\n* `pix.cancel.confirmed` Cancelamento do Pix confirmado.\n* `pix.cancel.failed` Falha no cancelamento do Pix.\n* `pix.cancel.error` Ocorreu um erro no cancelamento do Pix.\n* `pix.sync.requested` Sincronização do Pix solicitada.\n* `pix.sync.confirmed` Sincronização do Pix confirmada.\n* `pix.sync.failed` Falha na sincronização do Pix.\n* `pix.sync.error` Ocorreu um erro na sincronização do Pix.\n* `pix.get.requested` Informação do Pix solicitada.\n* `pix.get.confirmed` Informação do Pix confirmada.\n* `pix.get.failed` Falha na informação do Pix.\n* `pix.get.error` Ocorreu um erro na informação do Pix.\n* `financial.account.balance_sync.requested` Sincronização do Saldo solicitada.\n* `financial.account.balance_sync.confirmed` Sincronização do Saldo confirmada.\n* `financial.account.balance_sync.failed` Falha na sincronização do Saldo.\n* `financial.account.balance_sync.error` Ocorreu um erro na sincronização do Saldo.\n* `financial.account.statement_sync.requested` Sincronização do Extrato solicitada.\n* `financial.account.statement_sync.confirmed` Sincronização do Extrato confirmada.\n* `financial.account.statement_sync.failed` Falha na sincronização do Extrato.\n* `financial.account.statement_sync.error` Ocorreu um erro na sincronização do Extrato.\n* `financial.account.db.created` Conta Financeira criada.\n* `financial.account.db.updated` Conta Financeira atualizada.\n* `financial.account.db.deleted` Conta Financeira excluída.\n* `financial.account.statement.updated` Extrato atualizado.\n* `financial.account.balance.updated` Saldo da conta financeira atualizado.\n* `financial.account_balance.db.created` Saldo criado.\n* `transfer.batch.db.created` Lote de transferência criado.\n* `transfer.batch.db.updated` Lote de transferência atualizado.\n* `transfer.batch.db.deleted` Lote de transferência excluído.\n* `transfer.batch.awaiting_approval` Lote de transferência aguardando liberação.\n* `transfer.pix_batch.awaiting_approval` Lote de Transferência Pix aguardando liberação.\n* `transfer.pix_batch.get.requested` Informação do Lote de Transferência Pix solicitada.\n* `transfer.pix_batch.get.confirmed` Informação do Lote de Transferência Pix confirmada.\n* `transfer.pix_batch.get.failed` Falha na informação do Lote de Transferência Pix.\n* `transfer.pix_batch.get.error` Ocorreu um erro na informação do Lote de Transferência Pix.\n* `transfer.pix_batch.sync.requested` Sincronização de Lote de transferência Pix solicitada.\n* `transfer.pix_batch.sync.confirmed` Sincronização de Lote de transferência Pix confirmada.\n* `transfer.pix_batch.sync.failed` Falha na sincronização de Lote de transferência Pix.\n* `transfer.pix_batch.sync.error` Ocorreu um erro na sincronização de Lote de transferência Pix.\n* `transfer.pix_batch.register.requested` Lote de Transferência Pix solicitado.\n* `transfer.pix_batch.register.confirmed` Lote de Transferência Pix confirmado.\n* `transfer.pix_batch.register.failed` Falha no envio de Lote de Transferência Pix.\n* `transfer.pix_batch.register.error` Ocorreu um erro no envio de Lote de Transferência Pix.\n* `transfer.pix_batch.approve.requested` Liberação de Lote de Transferência Pix solicitada.\n* `transfer.pix_batch.approve.confirmed` Liberação de Lote de Transferência Pix confirmada.\n* `transfer.pix_batch.approve.failed` Falha na liberação de Lote de Transferência Pix.\n* `transfer.pix_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência Pix.\n* `transfer.pix_batch.reprove.requested` Rejeição de Lote de Transferência Pix solicitada.\n* `transfer.pix_batch.reprove.confirmed` Rejeição de Lote de transferência Pix confirmada.\n* `transfer.pix_batch.reprove.failed` Falha na rejeição de Lote de Transferência Pix.\n* `transfer.pix_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência Pix.\n* `transfer.pix_batch.cancel.requested` Cancelamento de Lote de Transferência Pix solicitado.\n* `transfer.pix_batch.cancel.confirmed` Cancelamento de Lote de Transferência Pix confirmado.\n* `transfer.pix_batch.cancel.failed` Falha no cancelamento de Lote de Transferência Pix.\n* `transfer.pix_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Transferência Pix.\n* `transfer.ted_batch.awaiting_approval` Lote de Transferência TED aguardando liberação.\n* `transfer.ted_batch.get.requested` Informação do Lote de Transferência TED solicitada.\n* `transfer.ted_batch.get.confirmed` Informação do Lote de Transferência TED confirmada.\n* `transfer.ted_batch.get.failed` Falha na informação do Lote de Transferência TED.\n* `transfer.ted_batch.get.error` Ocorreu um erro na informação do Lote de Transferência TED.\n* `transfer.ted_batch.sync.requested` Sincronização de Lote de transferência TED solicitada.\n* `transfer.ted_batch.sync.confirmed` Sincronização de Lote de transferência TED confirmada.\n* `transfer.ted_batch.sync.failed` Falha na sincronização de Lote de transferência TED.\n* `transfer.ted_batch.sync.error` Ocorreu um erro na sincronização de Lote de transferência TED.\n* `transfer.ted_batch.register.requested` Lote de Transferência TED solicitado.\n* `transfer.ted_batch.register.confirmed` Lote de Transferência TED confirmado.\n* `transfer.ted_batch.register.failed` Falha no envio de Lote de Transferência TED.\n* `transfer.ted_batch.register.error` Ocorreu um erro no envio de Lote de Transferência TED.\n* `transfer.ted_batch.approve.requested` Liberação de Lote de Transferência TED solicitada.\n* `transfer.ted_batch.approve.confirmed` Liberação de Lote de Transferência TED confirmada.\n* `transfer.ted_batch.approve.failed` Falha na liberação de Lote de Transferência TED.\n* `transfer.ted_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência TED.\n* `transfer.ted_batch.reprove.requested` Rejeição de Lote de Transferência TED solicitada.\n* `transfer.ted_batch.reprove.confirmed` Rejeição de Lote de transferência TED confirmada.\n* `transfer.ted_batch.reprove.failed` Falha na rejeição de Lote de Transferência TED.\n* `transfer.ted_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência TED.\n* `transfer.ted_batch.cancel.requested` Cancelamento de Lote de Transferência TED solicitado.\n* `transfer.ted_batch.cancel.confirmed` Cancelamento de Lote de Transferência TED confirmado.\n* `transfer.ted_batch.cancel.failed` Falha no cancelamento de Lote de Transferência TED.\n* `transfer.ted_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Transferência TED.\n* `transfer.internal_batch.awaiting_approval` Lote de Transferência Entre Contas do Mesmo Banco aguardando liberação.\n* `transfer.internal_batch.get.requested` Informação do Lote de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.get.confirmed` Informação do Lote de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.get.failed` Falha na informação do Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.get.error` Ocorreu um erro na informação do Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.sync.requested` Sincronização de Lote de transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.sync.confirmed` Sincronização de Lote de transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.sync.failed` Falha na sincronização de Lote de transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.sync.error` Ocorreu um erro na sincronização de Lote de transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.register.requested` Lote de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal_batch.register.confirmed` Lote de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal_batch.register.failed` Falha no envio de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.register.error` Ocorreu um erro no envio de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.approve.requested` Liberação de Lote de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.approve.confirmed` Liberação de Lote de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.approve.failed` Falha na liberação de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.reprove.requested` Rejeição de Lote de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal_batch.reprove.confirmed` Rejeição de Lote de transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal_batch.reprove.failed` Falha na rejeição de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.cancel.requested` Cancelamento de Lote de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal_batch.cancel.confirmed` Cancelamento de Lote de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal_batch.cancel.failed` Falha no cancelamento de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Transferência Entre Contas do Mesmo Banco.\n* `transfer.db.created` Transferência criada.\n* `transfer.db.updated` Transferência atualizada.\n* `transfer.db.deleted` Transferência excluída.\n* `transfer.pix.register.requested` Transferência Pix solicitada.\n* `transfer.pix.register.confirmed` Transferência Pix confirmada.\n* `transfer.pix.register.failed` Falha no envio da Transferência Pix.\n* `transfer.pix.register.error` Ocorreu um erro no envio da Transferência Pix.\n* `transfer.pix.reschedule.requested` Reagendamento de Transferência Pix solicitado.\n* `transfer.pix.reschedule.confirmed` Reagendamento de Transferência Pix confirmado.\n* `transfer.pix.reschedule.failed` Falha no reagendamento da Transferência Pix.\n* `transfer.pix.reschedule.error` Ocorreu um erro no reagendamento da Transferência Pix.\n* `transfer.pix.approve.requested` Liberação de Transferência Pix solicitada.\n* `transfer.pix.approve.confirmed` Liberação de Transferência Pix confirmada.\n* `transfer.pix.approve.failed` Falha na liberação da transferência Pix.\n* `transfer.pix.approve.error` Ocorreu um erro na liberação da Transferência Pix.\n* `transfer.pix.reprove.requested` Rejeição de Transferência Pix solicitada.\n* `transfer.pix.reprove.confirmed` Rejeição de Transferência Pix confirmada.\n* `transfer.pix.reprove.failed` Falha na rejeição da transferência Pix.\n* `transfer.pix.reprove.error` Ocorreu um erro na rejeição da Transferência Pix.\n* `transfer.pix.cancel.requested` Cancelamento de Transferência Pix solicitado.\n* `transfer.pix.cancel.confirmed` Cancelamento de Transferência Pix confirmado.\n* `transfer.pix.cancel.failed` Falha no cancelamento da Transferência Pix.\n* `transfer.pix.cancel.error` Ocorreu um erro no cancelamento da Transferência Pix.\n* `transfer.pix.get.requested` Informação da Transferência Pix solicitada.\n* `transfer.pix.get.confirmed` Informação da Transferência Pix confirmada.\n* `transfer.pix.get.failed` Falha na informação da Transferência Pix.\n* `transfer.pix.get.error` Ocorreu um erro na informação da Transferência Pix.\n* `transfer.pix.sync.requested` Sincronização da Transferência Pix solicitada.\n* `transfer.pix.sync.confirmed` Sincronização da Transferência Pix confirmada.\n* `transfer.pix.sync.failed` Falha na sincronização da Transferência Pix.\n* `transfer.pix.sync.error` Ocorreu um erro na sincronização da Transferência Pix.\n* `transfer.ted.register.requested` Transferência TED solicitada.\n* `transfer.ted.register.confirmed` Transferência TED confirmada.\n* `transfer.ted.register.failed` Falha no envio da Transferência TED.\n* `transfer.ted.register.error` Ocorreu um erro no envio da Transferência TED.\n* `transfer.ted.reschedule.requested` Reagendamento de Transferência TED solicitado.\n* `transfer.ted.reschedule.confirmed` Reagendamento de Transferência TED confirmado.\n* `transfer.ted.reschedule.failed` Falha no Reagendamento de Transferência TED.\n* `transfer.ted.reschedule.error` Ocorreu um erro no Reagendamento de Transferência TED.\n* `transfer.ted.approve.requested` Liberação de Transferência TED solicitada.\n* `transfer.ted.approve.confirmed` Liberação de Transferência TED confirmada.\n* `transfer.ted.approve.failed` Falha na liberação da transferência TED.\n* `transfer.ted.approve.error` Ocorreu um erro na liberação da Transferência TED.\n* `transfer.ted.reprove.requested` Rejeição de Transferência TED solicitada.\n* `transfer.ted.reprove.confirmed` Rejeição de Transferência TED confirmada.\n* `transfer.ted.reprove.failed` Falha na rejeição da transferência TED.\n* `transfer.ted.reprove.error` Ocorreu um erro na rejeição da Transferência TED.\n* `transfer.ted.cancel.requested` Cancelamento de Transferência TED solicitado.\n* `transfer.ted.cancel.confirmed` Cancelamento de Transferência TED confirmado.\n* `transfer.ted.cancel.failed` Falha no cancelamento de Transferência TED.\n* `transfer.ted.cancel.error` Ocorreu um erro no cancelamento de Transferência TED.\n* `transfer.ted.get.requested` Informação da Transferência TED solicitada.\n* `transfer.ted.get.confirmed` Informação da Transferência TED confirmada.\n* `transfer.ted.get.failed` Falha na informação da Transferência TED.\n* `transfer.ted.get.error` Ocorreu um erro na informação da Transferência TED.\n* `transfer.ted.sync.requested` Sincronização da Transferência TED solicitada.\n* `transfer.ted.sync.confirmed` Sincronização da Transferência TED confirmada.\n* `transfer.ted.sync.failed` Falha na sincronização da Transferência TED.\n* `transfer.ted.sync.error` Ocorreu um erro na sincronização da Transferência TED.\n* `transfer.internal.register.requested` Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.register.confirmed` Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.register.failed` Falha no envio da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.register.error` Ocorreu um erro no envio da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reschedule.requested` Reagendamento de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal.reschedule.confirmed` Reagendamento de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal.reschedule.failed` Falha no Reagendamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reschedule.error` Ocorreu um erro no Reagendamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.approve.requested` Liberação de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.approve.confirmed` Liberação de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.approve.failed` Falha na liberação da transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.approve.error` Ocorreu um erro na liberação da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reprove.requested` Rejeição de Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.reprove.confirmed` Rejeição de Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.reprove.failed` Falha na rejeição da transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.reprove.error` Ocorreu um erro na rejeição da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.cancel.requested` Cancelamento de Transferência Entre Contas do Mesmo Banco solicitado.\n* `transfer.internal.cancel.confirmed` Cancelamento de Transferência Entre Contas do Mesmo Banco confirmado.\n* `transfer.internal.cancel.failed` Falha no cancelamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.cancel.error` Ocorreu um erro no cancelamento de Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.get.requested` Informação da Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.get.confirmed` Informação da Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.get.failed` Falha na informação da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.get.error` Ocorreu um erro na informação da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.sync.requested` Sincronização da Transferência Entre Contas do Mesmo Banco solicitada.\n* `transfer.internal.sync.confirmed` Sincronização da Transferência Entre Contas do Mesmo Banco confirmada.\n* `transfer.internal.sync.failed` Falha na sincronização da Transferência Entre Contas do Mesmo Banco.\n* `transfer.internal.sync.error` Ocorreu um erro na sincronização da Transferência Entre Contas do Mesmo Banco.\n* `payment.db.created` Pagamento criado.\n* `payment.db.updated` Pagamento atualizado.\n* `payment.db.deleted` Pagamento excluído.\n* `payment.bank_billet.register.requested` Pagamento de Boleto solicitado.\n* `payment.bank_billet.register.confirmed` Pagamento de Boleto confirmado.\n* `payment.bank_billet.register.failed` Falha no envio do Pagamento de Boleto.\n* `payment.bank_billet.register.error` Ocorreu um erro no envio de Pagamento de Boleto.\n* `payment.bank_billet.approve.requested` Liberação de Pagamento de Boleto solicitada.\n* `payment.bank_billet.approve.confirmed` Liberação de Pagamento de Boleto confirmada.\n* `payment.bank_billet.approve.failed` Falha na liberação de Pagamento de Boleto.\n* `payment.bank_billet.approve.error` Ocorreu um erro na liberação de Pagamento de Boleto.\n* `payment.bank_billet.reprove.requested` Rejeição de Pagamento de Boleto solicitada.\n* `payment.bank_billet.reprove.confirmed` Rejeição de Pagamento de Boleto confirmada.\n* `payment.bank_billet.reprove.failed` Falha na rejeição de Pagamento de Boleto.\n* `payment.bank_billet.reprove.error` Ocorreu um erro na rejeição de Pagamento de Boleto.\n* `payment.bank_billet.reschedule.requested` Reagendamento de Pagamento de Boleto solicitado.\n* `payment.bank_billet.reschedule.confirmed` Reagendamento de Pagamento de Boleto confirmado.\n* `payment.bank_billet.reschedule.failed` Falha no Reagendamento de Pagamento de Boleto.\n* `payment.bank_billet.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Boleto.\n* `payment.bank_billet.cancel.requested` Cancelamento de Pagamento de Boleto solicitado.\n* `payment.bank_billet.cancel.confirmed` Cancelamento de Pagamento de Boleto confirmada.\n* `payment.bank_billet.cancel.failed` Falha no cancelamento de Pagamento de Boleto.\n* `payment.bank_billet.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Boleto.\n* `payment.bank_billet.get.requested` Informação do Pagamento de Boleto solicitada.\n* `payment.bank_billet.get.confirmed` Informação do Pagamento de Boleto confirmada.\n* `payment.bank_billet.get.failed` Falha na informação do Pagamento de Boleto.\n* `payment.bank_billet.get.error` Ocorreu um erro na informação do Pagamento de Boleto.\n* `payment.bank_billet.sync.requested` Sincronização do Pagamento de Boleto solicitada.\n* `payment.bank_billet.sync.confirmed` Sincronização do Pagamento de Boleto confirmada.\n* `payment.bank_billet.sync.failed` Falha na sincronização do Pagamento de Boleto.\n* `payment.bank_billet.sync.error` Ocorreu um erro na sincronização do Pagamento de Boleto.\n* `payment.darf.register.requested` Pagamento de DARF solicitado.\n* `payment.darf.register.confirmed` Pagamento de DARF confirmado.\n* `payment.darf.register.failed` Falha no envio do Pagamento de DARF.\n* `payment.darf.register.error` Ocorreu um erro no envio de Pagamento de DARF.\n* `payment.darf.approve.requested` Liberação de Pagamento de DARF solicitada.\n* `payment.darf.approve.confirmed` Liberação de Pagamento de DARF confirmada.\n* `payment.darf.approve.failed` Falha na liberação de Pagamento de DARF.\n* `payment.darf.approve.error` Ocorreu um erro na liberação de Pagamento de DARF.\n* `payment.darf.reprove.requested` Rejeição de Pagamento de DARF solicitada.\n* `payment.darf.reprove.confirmed` Rejeição de Pagamento de DARF confirmada.\n* `payment.darf.reprove.failed` Falha na rejeição de Pagamento de DARF.\n* `payment.darf.reprove.error` Ocorreu um erro na rejeição de Pagamento de DARF.\n* `payment.darf.reschedule.requested` Reagendamento de Pagamento de DARF solicitado.\n* `payment.darf.reschedule.confirmed` Reagendamento de Pagamento de DARF confirmado.\n* `payment.darf.reschedule.failed` Falha no Reagendamento de Pagamento de DARF.\n* `payment.darf.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de DARF.\n* `payment.darf.cancel.requested` Cancelamento de Pagamento de DARF solicitado.\n* `payment.darf.cancel.confirmed` Cancelamento de Pagamento de DARF confirmada.\n* `payment.darf.cancel.failed` Falha no cancelamento de Pagamento de DARF.\n* `payment.darf.cancel.error` Ocorreu um erro no cancelamento de Pagamento de DARF.\n* `payment.darf.get.requested` Informação do Pagamento de DARF solicitada.\n* `payment.darf.get.confirmed` Informação do Pagamento de DARF confirmada.\n* `payment.darf.get.failed` Falha na informação do Pagamento de DARF.\n* `payment.darf.get.error` Ocorreu um erro na informação do Pagamento de DARF.\n* `payment.darf.sync.requested` Sincronização do Pagamento de DARF solicitada.\n* `payment.darf.sync.confirmed` Sincronização do Pagamento de DARF confirmada.\n* `payment.darf.sync.failed` Falha na sincronização do Pagamento de DARF.\n* `payment.darf.sync.error` Ocorreu um erro na sincronização do Pagamento de DARF.\n* `payment.utility.register.requested` Pagamento de Conta de Consumo solicitado.\n* `payment.utility.register.confirmed` Pagamento de Conta de Consumo confirmado.\n* `payment.utility.register.failed` Falha no envio do Pagamento de Conta de Consumo.\n* `payment.utility.register.error` Ocorreu um erro no envio de Pagamento de Conta de Consumo.\n* `payment.utility.approve.requested` Liberação de Pagamento de Conta de Consumo solicitada.\n* `payment.utility.approve.confirmed` Liberação de Pagamento de Conta de Consumo confirmada.\n* `payment.utility.approve.failed` Falha na liberação de Pagamento de Conta de Consumo.\n* `payment.utility.approve.error` Ocorreu um erro na liberação de Pagamento de Conta de Consumo.\n* `payment.utility.reprove.requested` Rejeição de Pagamento de Conta de Consumo solicitada.\n* `payment.utility.reprove.confirmed` Rejeição de Pagamento de Conta de Consumo confirmada.\n* `payment.utility.reprove.failed` Falha na rejeição de Pagamento de Conta de Consumo.\n* `payment.utility.reprove.error` Ocorreu um erro na rejeição de Pagamento de Conta de Consumo.\n* `payment.utility.reschedule.requested` Reagendamento de Pagamento de Conta de Consumo solicitado.\n* `payment.utility.reschedule.confirmed` Reagendamento de Pagamento de Conta de Consumo confirmado.\n* `payment.utility.reschedule.failed` Falha no Reagendamento de Pagamento de Conta de Consumo.\n* `payment.utility.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Conta de Consumo.\n* `payment.utility.cancel.requested` Cancelamento de Pagamento de Conta de Consumo solicitado.\n* `payment.utility.cancel.confirmed` Cancelamento de Pagamento de Conta de Consumo confirmada.\n* `payment.utility.cancel.failed` Falha no cancelamento de Pagamento de Conta de Consumo.\n* `payment.utility.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Conta de Consumo.\n* `payment.utility.get.requested` Informação do Pagamento de Conta de Consumo solicitada.\n* `payment.utility.get.confirmed` Informação do Pagamento de Conta de Consumo confirmada.\n* `payment.utility.get.failed` Falha na informação do Pagamento de Conta de Consumo.\n* `payment.utility.get.error` Ocorreu um erro na informação do Pagamento de Conta de Consumo.\n* `payment.utility.sync.requested` Sincronização do Pagamento de Conta de Consumo solicitada.\n* `payment.utility.sync.confirmed` Sincronização do Pagamento de Conta de Consumo confirmada.\n* `payment.utility.sync.failed` Falha na sincronização do Pagamento de Conta de Consumo.\n* `payment.utility.sync.error` Ocorreu um erro na sincronização do Pagamento de Conta de Consumo.\n* `payment.gru.register.requested` Pagamento de GRU solicitado.\n* `payment.gru.register.confirmed` Pagamento de GRU confirmado.\n* `payment.gru.register.failed` Falha no envio do Pagamento de GRU.\n* `payment.gru.register.error` Ocorreu um erro no envio de Pagamento de GRU.\n* `payment.gru.approve.requested` Liberação de Pagamento de GRU solicitada.\n* `payment.gru.approve.confirmed` Liberação de Pagamento de GRU confirmada.\n* `payment.gru.approve.failed` Falha na liberação de Pagamento de GRU.\n* `payment.gru.approve.error` Ocorreu um erro na liberação de Pagamento de GRU.\n* `payment.gru.reprove.requested` Rejeição de Pagamento de GRU solicitada.\n* `payment.gru.reprove.confirmed` Rejeição de Pagamento de GRU confirmada.\n* `payment.gru.reprove.failed` Falha na rejeição de Pagamento de GRU.\n* `payment.gru.reprove.error` Ocorreu um erro na rejeição de Pagamento de GRU.\n* `payment.gru.reschedule.requested` Reagendamento de Pagamento de GRU solicitado.\n* `payment.gru.reschedule.confirmed` Reagendamento de Pagamento de GRU confirmado.\n* `payment.gru.reschedule.failed` Falha no Reagendamento de Pagamento de GRU.\n* `payment.gru.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de GRU.\n* `payment.gru.cancel.requested` Cancelamento de Pagamento de GRU solicitado.\n* `payment.gru.cancel.confirmed` Cancelamento de Pagamento de GRU confirmada.\n* `payment.gru.cancel.failed` Falha no cancelamento de Pagamento de GRU.\n* `payment.gru.cancel.error` Ocorreu um erro no cancelamento de Pagamento de GRU.\n* `payment.gru.get.requested` Informação do Pagamento de GRU solicitada.\n* `payment.gru.get.confirmed` Informação do Pagamento de GRU confirmada.\n* `payment.gru.get.failed` Falha na informação do Pagamento de GRU.\n* `payment.gru.get.error` Ocorreu um erro na informação do Pagamento de GRU.\n* `payment.gru.sync.requested` Sincronização do Pagamento de GRU solicitada.\n* `payment.gru.sync.confirmed` Sincronização do Pagamento de GRU confirmada.\n* `payment.gru.sync.failed` Falha na sincronização do Pagamento de GRU.\n* `payment.gru.sync.error` Ocorreu um erro na sincronização do Pagamento de GRU.\n* `payment.pix.register.requested` Pagamento de Pix solicitado.\n* `payment.pix.register.confirmed` Pagamento de Pix confirmado.\n* `payment.pix.register.failed` Falha no envio do Pagamento de Pix.\n* `payment.pix.register.error` Ocorreu um erro no envio de Pagamento de Pix.\n* `payment.pix.approve.requested` Liberação de Pagamento de Pix solicitada.\n* `payment.pix.approve.confirmed` Liberação de Pagamento de Pix confirmada.\n* `payment.pix.approve.failed` Falha na liberação de Pagamento de Pix.\n* `payment.pix.approve.error` Ocorreu um erro na liberação de Pagamento de Pix.\n* `payment.pix.reprove.requested` Rejeição de Pagamento de Pix solicitada.\n* `payment.pix.reprove.confirmed` Rejeição de Pagamento de Pix confirmada.\n* `payment.pix.reprove.failed` Falha na rejeição de Pagamento de Pix.\n* `payment.pix.reprove.error` Ocorreu um erro na rejeição de Pagamento de Pix.\n* `payment.pix.reschedule.requested` Reagendamento de Pagamento de Pix solicitado.\n* `payment.pix.reschedule.confirmed` Reagendamento de Pagamento de Pix confirmado.\n* `payment.pix.reschedule.failed` Falha no Reagendamento de Pagamento de Pix.\n* `payment.pix.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Pix.\n* `payment.pix.cancel.requested` Cancelamento de Pagamento de Pix solicitado.\n* `payment.pix.cancel.confirmed` Cancelamento de Pagamento de Pix confirmada.\n* `payment.pix.cancel.failed` Falha no cancelamento de Pagamento de Pix.\n* `payment.pix.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Pix.\n* `payment.pix.get.requested` Informação do Pagamento de Pix solicitada.\n* `payment.pix.get.confirmed` Informação do Pagamento de Pix confirmada.\n* `payment.pix.get.failed` Falha na informação do Pagamento de Pix.\n* `payment.pix.get.error` Ocorreu um erro na informação do Pagamento de Pix.\n* `payment.pix.sync.requested` Sincronização do Pagamento de Pix solicitada.\n* `payment.pix.sync.confirmed` Sincronização do Pagamento de Pix confirmada.\n* `payment.pix.sync.failed` Falha na sincronização do Pagamento de Pix.\n* `payment.pix.sync.error` Ocorreu um erro na sincronização do Pagamento de Pix.\n* `payment.tax.register.requested` Pagamento de Tributo solicitado.\n* `payment.tax.register.confirmed` Pagamento de Tributo confirmado.\n* `payment.tax.register.failed` Falha no envio do Pagamento de Tributo.\n* `payment.tax.register.error` Ocorreu um erro no envio de Pagamento de Tributo.\n* `payment.tax.approve.requested` Liberação de Pagamento de Tributo solicitada.\n* `payment.tax.approve.confirmed` Liberação de Pagamento de Tributo confirmada.\n* `payment.tax.approve.failed` Falha na liberação de Pagamento de Tributo.\n* `payment.tax.approve.error` Ocorreu um erro na liberação de Pagamento de Tributo.\n* `payment.tax.reprove.requested` Rejeição de Pagamento de Tributo solicitada.\n* `payment.tax.reprove.confirmed` Rejeição de Pagamento de Tributo confirmada.\n* `payment.tax.reprove.failed` Falha na rejeição de Pagamento de Tributo.\n* `payment.tax.reprove.error` Ocorreu um erro na rejeição de Pagamento de Tributo.\n* `payment.tax.reschedule.requested` Reagendamento de Pagamento de Tributo solicitado.\n* `payment.tax.reschedule.confirmed` Reagendamento de Pagamento de Tributo confirmado.\n* `payment.tax.reschedule.failed` Falha no Reagendamento de Pagamento de Tributo.\n* `payment.tax.reschedule.error` Ocorreu um erro no Reagendamento de Pagamento de Tributo.\n* `payment.tax.cancel.requested` Cancelamento de Pagamento de Tributo solicitado.\n* `payment.tax.cancel.confirmed` Cancelamento de Pagamento de Tributo confirmada.\n* `payment.tax.cancel.failed` Falha no cancelamento de Pagamento de Tributo.\n* `payment.tax.cancel.error` Ocorreu um erro no cancelamento de Pagamento de Tributo.\n* `payment.tax.get.requested` Informação do Pagamento de Tributo solicitada.\n* `payment.tax.get.confirmed` Informação do Pagamento de Tributo confirmada.\n* `payment.tax.get.failed` Falha na informação do Pagamento de Tributo.\n* `payment.tax.get.error` Ocorreu um erro na informação do Pagamento de Tributo.\n* `payment.tax.sync.requested` Sincronização do Pagamento de Tributo solicitada.\n* `payment.tax.sync.confirmed` Sincronização do Pagamento de Tributo confirmada.\n* `payment.tax.sync.failed` Falha na sincronização do Pagamento de Tributo.\n* `payment.tax.sync.error` Ocorreu um erro na sincronização do Pagamento de Tributo.\n* `payment.batch.db.created` Lote de Pagamento criado.\n* `payment.batch.db.updated` Lote de Pagamento atualizado.\n* `payment.batch.db.deleted` Lote de Pagamento excluído.\n* `payment.batch.awaiting_approval` Lote de pagamento aguardando liberação.\n* `payment.bank_billet_batch.awaiting_approval` Lote de Pagamento de Boleto aguardando liberação.\n* `payment.bank_billet_batch.get.requested` Informação do Lote de Pagamento de Boleto solicitada.\n* `payment.bank_billet_batch.get.confirmed` Informação do Lote de Pagamento de Boleto confirmada.\n* `payment.bank_billet_batch.get.failed` Falha na informação do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.sync.requested` Sincronização de Lote de Pagamento de Boleto solicitada.\n* `payment.bank_billet_batch.sync.confirmed` Sincronização de Lote de Pagamento de Boleto confirmada.\n* `payment.bank_billet_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.register.requested` Lote de Pagamento de Boleto solicitado.\n* `payment.bank_billet_batch.register.confirmed` Lote de Pagamento de Boleto confirmado.\n* `payment.bank_billet_batch.register.failed` Falha no envio do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.approve.requested` Liberação de Lote de Pagamento de Boleto solicitado.\n* `payment.bank_billet_batch.approve.confirmed` Liberação de Lote de Pagamento de Boleto confirmado.\n* `payment.bank_billet_batch.approve.failed` Falha na liberação de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.reprove.requested` Rejeição de Lote de Pagamento de Boleto solicitado.\n* `payment.bank_billet_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Boleto confirmado.\n* `payment.bank_billet_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Boleto.\n* `payment.bank_billet_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.bank_billet_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.bank_billet_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.bank_billet_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.darf_batch.awaiting_approval` Lote de Pagamento de DARF aguardando liberação.\n* `payment.darf_batch.get.requested` Informação do Lote de Pagamento de DARF solicitada.\n* `payment.darf_batch.get.confirmed` Informação do Lote de Pagamento de DARF confirmada.\n* `payment.darf_batch.get.failed` Falha na informação do Lote de Pagamento de DARF.\n* `payment.darf_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de DARF.\n* `payment.darf_batch.sync.requested` Sincronização de Lote de Pagamento de DARF solicitada.\n* `payment.darf_batch.sync.confirmed` Sincronização de Lote de Pagamento de DARF confirmada.\n* `payment.darf_batch.sync.failed` Falha na sincronização de Lote de Pagamento de DARF.\n* `payment.darf_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de DARF.\n* `payment.darf_batch.register.requested` Lote de Pagamento de DARF solicitado.\n* `payment.darf_batch.register.confirmed` Lote de Pagamento de DARF confirmado.\n* `payment.darf_batch.register.failed` Falha no envio do Lote de Pagamento de DARF.\n* `payment.darf_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de DARF.\n* `payment.darf_batch.approve.requested` Liberação de Lote de Pagamento de DARF solicitado.\n* `payment.darf_batch.approve.confirmed` Liberação de Lote de Pagamento de DARF confirmado.\n* `payment.darf_batch.approve.failed` Falha na liberação de Lote de Pagamento de DARF.\n* `payment.darf_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de DARF.\n* `payment.darf_batch.reprove.requested` Rejeição de Lote de Pagamento de DARF solicitado.\n* `payment.darf_batch.reprove.confirmed` Rejeição de Lote de Pagamento de DARF confirmado.\n* `payment.darf_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de DARF.\n* `payment.darf_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de DARF.\n* `payment.darf_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.darf_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.darf_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.darf_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.utility_batch.awaiting_approval` Lote de Pagamento de Conta de Consumo aguardando liberação.\n* `payment.utility_batch.get.requested` Informação do Lote de Pagamento de Conta de Consumo solicitada.\n* `payment.utility_batch.get.confirmed` Informação do Lote de Pagamento de Conta de Consumo confirmada.\n* `payment.utility_batch.get.failed` Falha na informação do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.sync.requested` Sincronização de Lote de Pagamento de Conta de Consumo solicitada.\n* `payment.utility_batch.sync.confirmed` Sincronização de Lote de Pagamento de Conta de Consumo confirmada.\n* `payment.utility_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.register.requested` Lote de Pagamento de Conta de Consumo solicitado.\n* `payment.utility_batch.register.confirmed` Lote de Pagamento de Conta de Consumo confirmado.\n* `payment.utility_batch.register.failed` Falha no envio do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.approve.requested` Liberação de Lote de Pagamento de Conta de Consumo solicitado.\n* `payment.utility_batch.approve.confirmed` Liberação de Lote de Pagamento de Conta de Consumo confirmado.\n* `payment.utility_batch.approve.failed` Falha na liberação de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.reprove.requested` Rejeição de Lote de Pagamento de Conta de Consumo solicitado.\n* `payment.utility_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Conta de Consumo confirmado.\n* `payment.utility_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Conta de Consumo.\n* `payment.utility_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.utility_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.utility_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.utility_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.gru_batch.awaiting_approval` Lote de Pagamento de GRU aguardando liberação.\n* `payment.gru_batch.get.requested` Informação do Lote de Pagamento de GRU solicitada.\n* `payment.gru_batch.get.confirmed` Informação do Lote de Pagamento de GRU confirmada.\n* `payment.gru_batch.get.failed` Falha na informação do Lote de Pagamento de GRU.\n* `payment.gru_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de GRU.\n* `payment.gru_batch.sync.requested` Sincronização de Lote de Pagamento de GRU solicitada.\n* `payment.gru_batch.sync.confirmed` Sincronização de Lote de Pagamento de GRU confirmada.\n* `payment.gru_batch.sync.failed` Falha na sincronização de Lote de Pagamento de GRU.\n* `payment.gru_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de GRU.\n* `payment.gru_batch.register.requested` Lote de Pagamento de GRU solicitado.\n* `payment.gru_batch.register.confirmed` Lote de Pagamento de GRU confirmado.\n* `payment.gru_batch.register.failed` Falha no envio do Lote de Pagamento de GRU.\n* `payment.gru_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de GRU.\n* `payment.gru_batch.approve.requested` Liberação de Lote de Pagamento de GRU solicitado.\n* `payment.gru_batch.approve.confirmed` Liberação de Lote de Pagamento de GRU confirmado.\n* `payment.gru_batch.approve.failed` Falha na liberação de Lote de Pagamento de GRU.\n* `payment.gru_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de GRU.\n* `payment.gru_batch.reprove.requested` Rejeição de Lote de Pagamento de GRU solicitado.\n* `payment.gru_batch.reprove.confirmed` Rejeição de Lote de Pagamento de GRU confirmado.\n* `payment.gru_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de GRU.\n* `payment.gru_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de GRU.\n* `payment.gru_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.gru_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.gru_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.gru_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.pix_batch.awaiting_approval` Lote de Pagamento de Pix aguardando liberação.\n* `payment.pix_batch.get.requested` Informação do Lote de Pagamento de Pix solicitada.\n* `payment.pix_batch.get.confirmed` Informação do Lote de Pagamento de Pix confirmada.\n* `payment.pix_batch.get.failed` Falha na informação do Lote de Pagamento de Pix.\n* `payment.pix_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Pix.\n* `payment.pix_batch.sync.requested` Sincronização de Lote de Pagamento de Pix solicitada.\n* `payment.pix_batch.sync.confirmed` Sincronização de Lote de Pagamento de Pix confirmada.\n* `payment.pix_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Pix.\n* `payment.pix_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Pix.\n* `payment.pix_batch.register.requested` Lote de Pagamento de Pix solicitado.\n* `payment.pix_batch.register.confirmed` Lote de Pagamento de Pix confirmado.\n* `payment.pix_batch.register.failed` Falha no envio do Lote de Pagamento de Pix.\n* `payment.pix_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Pix.\n* `payment.pix_batch.approve.requested` Liberação de Lote de Pagamento de Pix solicitado.\n* `payment.pix_batch.approve.confirmed` Liberação de Lote de Pagamento de Pix confirmado.\n* `payment.pix_batch.approve.failed` Falha na liberação de Lote de Pagamento de Pix.\n* `payment.pix_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Pix.\n* `payment.pix_batch.reprove.requested` Rejeição de Lote de Pagamento de Pix solicitado.\n* `payment.pix_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Pix confirmado.\n* `payment.pix_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Pix.\n* `payment.pix_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Pix.\n* `payment.pix_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.pix_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.pix_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.pix_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.tax_batch.awaiting_approval` Lote de Pagamento de Tributo aguardando liberação.\n* `payment.tax_batch.get.requested` Informação do Lote de Pagamento de Tributo solicitada.\n* `payment.tax_batch.get.confirmed` Informação do Lote de Pagamento de Tributo confirmada.\n* `payment.tax_batch.get.failed` Falha na informação do Lote de Pagamento de Tributo.\n* `payment.tax_batch.get.error` Ocorreu um erro na informação do Lote de Pagamento de Tributo.\n* `payment.tax_batch.sync.requested` Sincronização de Lote de Pagamento de Tributo solicitada.\n* `payment.tax_batch.sync.confirmed` Sincronização de Lote de Pagamento de Tributo confirmada.\n* `payment.tax_batch.sync.failed` Falha na sincronização de Lote de Pagamento de Tributo.\n* `payment.tax_batch.sync.error` Ocorreu um erro na sincronização de Lote de Pagamento de Tributo.\n* `payment.tax_batch.register.requested` Lote de Pagamento de Tributo solicitado.\n* `payment.tax_batch.register.confirmed` Lote de Pagamento de Tributo confirmado.\n* `payment.tax_batch.register.failed` Falha no envio do Lote de Pagamento de Tributo.\n* `payment.tax_batch.register.error` Ocorreu um erro no cancelamento do Lote de Pagamento de Tributo.\n* `payment.tax_batch.approve.requested` Liberação de Lote de Pagamento de Tributo solicitado.\n* `payment.tax_batch.approve.confirmed` Liberação de Lote de Pagamento de Tributo confirmado.\n* `payment.tax_batch.approve.failed` Falha na liberação de Lote de Pagamento de Tributo.\n* `payment.tax_batch.approve.error` Ocorreu um erro na liberação de Lote de Pagamento de Tributo.\n* `payment.tax_batch.reprove.requested` Rejeição de Lote de Pagamento de Tributo solicitado.\n* `payment.tax_batch.reprove.confirmed` Rejeição de Lote de Pagamento de Tributo confirmado.\n* `payment.tax_batch.reprove.failed` Falha na rejeição de Lote de Pagamento de Tributo.\n* `payment.tax_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Pagamento de Tributo.\n* `payment.tax_batch.cancel.requested` Cancelamento de Lote de Pagamento solicitado.\n* `payment.tax_batch.cancel.confirmed` Cancelamento de Lote de Pagamento confirmado.\n* `payment.tax_batch.cancel.failed` Falha no cancelamento de Lote de Pagamento.\n* `payment.tax_batch.cancel.error` Ocorreu um erro no cancelamento de Lote de Pagamento.\n* `payment.dda.account.db.created` Conta de DDA criada\n* `payment.dda.account.register.requested` Conta de DDA solicitada.\n* `payment.dda.account.register.failed` Falha na criação da conta DDA.\n* `payment.dda.account.register.error` Ocorreu um erro no registro da conta DDA.\n* `payment.dda.account.register.confirmed` Conta de DDA confirmada.\n* `payment.dda.account.bank_billets_sync.requested` Sincronização de Boletos solicitada.\n* `payment.dda.account.bank_billets_sync.failed` Falha na sincronização de Boleto.\n* `payment.dda.account.bank_billets_sync.error` Ocorreu um erro na sincronização de Boletos.\n* `payment.dda.account.bank_billets_sync.confirmed` Sincronização de Boletos confirmada.\n* `payment.dda.account.unregister.requested` Descadastramento da conta DDA solicitado.\n* `payment.dda.account.unregister.failed` Falha no descadastramento da conta DDA.\n* `payment.dda.account.unregister.error` Ocorreu um erro no descadastramento da conta DDA.\n* `payment.dda.account.unregister.confirmed` Descadastramento da conta DDA confirmado.\n* `payment.dda.bank_billet.db.created` Boleto DDA criado\n* `payment.dda.bank_billet.db.updated` Boleto DDA atualizado.\n* `payment.dda.bank_billet.external_status_changed` Status externo do Boleto DDA alterado.\n* `payment.dda.bank_billet.get.requested` Informação do Boleto solicitada.\n* `payment.dda.bank_billet.get.confirmed` Informação do Boleto confirmada.\n* `payment.dda.bank_billet.get.failed` Falha na informação do Boleto.\n* `payment.dda.bank_billet.get.error` Ocorreu um erro na informação do Boleto.\n* `payment.dda.bank_billet.sync.requested` Sincronização do Boleto solicitada.\n* `payment.dda.bank_billet.sync.confirmed` Sincronização do Boleto confirmada.\n* `payment.dda.bank_billet.sync.failed` Falha na sincronização do Boleto.\n* `payment.dda.bank_billet.sync.error` Ocorreu um erro na sincronização do Boleto.\n* `payment.dda.account.db.updated` Conta de DDA atualizada.\n* `payment.dda.account.db.deleted` Conta de DDA excluída.\n* `payment.dda.account.letter.pending` Carta DDA gerada.\n* `payment.dda.account.letter.waiting_signatures` Carta DDA aguardando assinaturas.\n* `payment.dda.account.letter.signed` Carta DDA assinada.\n* `payment.dda.account.letter.failed` Falha no processo de assinatura da carta DDA.\n* `payment.dda.account.confirmed` Assinatura da conta DDA aprovada.\n* `payment.dda.account.rejected` Assinatura da conta DDA rejeitada.\n* `payment.dda.account.failed` Falha na conta DDA.\n* `payment.dda.account.disabled` Conta DDA desabilitada.\n* `payment.dda.account.enabled` Conta DDA reabilitada.\n* `credit.restriction.add.requested` Inclusão da restrição de crédito solicitada.\n* `credit.restriction.add.failed` Falha na inclusão da restrição de crédito.\n* `credit.restriction.add.error` Ocorreu um erro na inclusão da restrição de crédito.\n* `credit.restriction.add.confirmed` Inclusão da restrição de crédito confirmada.\n* `credit.restriction.remove.requested` Remoção da restrição de crédito solicitada.\n* `credit.restriction.remove.confirmed` Remoção da restrição de crédito confirmada.\n* `credit.restriction.remove.failed` Falha na remoção da restrição de crédito.\n* `credit.restriction.remove.error` Ocorreu um erro na remoção da restrição de crédito.\n* `charge.automatic_pix.account.db.created` Conta de Pix Automático criada.\n* `charge.automatic_pix.account.db.updated` Conta de Pix Automático atualizada.\n* `charge.automatic_pix.account.db.deleted` Conta de Pix Automático excluída.\n* `charge.automatic_pix.recurrence.db.created` Recorrência de Pix Automático criada.\n* `charge.automatic_pix.recurrence.db.updated` Recorrência de Pix Automático atualizada.\n* `charge.automatic_pix.recurrence.db.deleted` Recorrência de Pix Automático excluída.\n* `charge.automatic_pix.recurrence.cancel.requested` Cancelamento da Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.recurrence.cancel.confirmed` Cancelamento da Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.recurrence.cancel.failed` Falha no cancelamento da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.cancel.error` Ocorreu um erro no cancelamento da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.register.requested` Registro da Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.recurrence.register.confirmed` Registro da Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.recurrence.register.failed` Falha no registro da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.register.error` Ocorreu um erro no registro da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.update.requested` Atualização da Recorrência de Pix Automático solicitada.\n* `charge.automatic_pix.recurrence.update.confirmed` Atualização da Recorrência de Pix Automático confirmada.\n* `charge.automatic_pix.recurrence.update.failed` Falha na atualização da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.update.error` Ocorreu um erro na atualização da Recorrência de Pix Automático.\n* `charge.automatic_pix.recurrence.pending` Recorrência de Pix Automático pendente.\n* `charge.automatic_pix.recurrence.created` Recorrência de Pix Automático criada no provedor financeiro.\n* `charge.automatic_pix.recurrence.approved` Recorrência de Pix Automático aprovada.\n* `charge.automatic_pix.recurrence.rejected` Recorrência de Pix Automático rejeitada.\n* `charge.automatic_pix.recurrence.expired` Recorrência de Pix Automático expirada.\n* `charge.automatic_pix.recurrence.canceled` Recorrência de Pix Automático cancelada.\n* `charge.automatic_pix.request.db.created` Solicitações de Recorrência de Pix Automático criada.\n* `charge.automatic_pix.request.db.updated` Solicitações de Recorrência de Pix Automático atualizada.\n* `charge.automatic_pix.request.db.deleted` Solicitações de Recorrência de Pix Automático excluída.\n* `charge.automatic_pix.request.cancel.requested` Cancelamento da Solicitação de Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.request.cancel.confirmed` Cancelamento da Solicitação de Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.request.cancel.failed` Falha no cancelamento da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.cancel.error` Ocorreu um erro no cancelamento da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.register.requested` Registro da Solicitação de Recorrência de Pix Automático solicitado.\n* `charge.automatic_pix.request.register.confirmed` Registro da Solicitação de Recorrência de Pix Automático confirmado.\n* `charge.automatic_pix.request.register.failed` Falha no registro da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.register.error` Ocorreu um erro no registro da Solicitação de Recorrência de Pix Automático.\n* `charge.automatic_pix.request.pending` Solicitação de Recorrência de Pix Automático pendente.\n* `charge.automatic_pix.request.created` Solicitação de Recorrência de Pix Automático criada no provedor financeiro.\n* `charge.automatic_pix.request.sent` Solicitação de Recorrência de Pix Automático enviada ao pagador.\n* `charge.automatic_pix.request.received` Solicitação de Recorrência de Pix Automático recebida pelo pagador.\n* `charge.automatic_pix.request.rejected` Solicitação de Recorrência de Pix Automático rejeitada.\n* `charge.automatic_pix.request.accepted` Solicitação de Recorrência de Pix Automático aceita.\n* `charge.automatic_pix.request.expired` Solicitação de Recorrência de Pix Automático expirada.\n* `charge.automatic_pix.request.canceled` Solicitação de Recorrência de Pix Automático cancelada.\n* `charge.automatic_pix.pix.db.created` Cobrança de Pix Automático criada.\n* `charge.automatic_pix.pix.db.updated` Cobrança de Pix Automático atualizada.\n* `charge.automatic_pix.pix.db.deleted` Cobrança de Pix Automático excluída.\n* `charge.automatic_pix.pix.cancel.requested` Cancelamento da Cobrança de Pix Automático solicitado.\n* `charge.automatic_pix.pix.cancel.confirmed` Cancelamento da Cobrança de Pix Automático confirmado.\n* `charge.automatic_pix.pix.cancel.failed` Falha no cancelamento da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.cancel.error` Ocorreu um erro no cancelamento da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.register.requested` Registro da Cobrança de Pix Automático solicitado.\n* `charge.automatic_pix.pix.register.confirmed` Registro da Cobrança de Pix Automático confirmado.\n* `charge.automatic_pix.pix.register.failed` Falha no registro da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.register.error` Ocorreu um erro no registro da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.update.requested` Atualização da Cobrança de Pix Automático solicitada.\n* `charge.automatic_pix.pix.update.confirmed` Atualização da Cobrança de Pix Automático confirmada.\n* `charge.automatic_pix.pix.update.failed` Falha na atualização da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.update.error` Ocorreu um erro na atualização da Cobrança de Pix Automático.\n* `charge.automatic_pix.pix.pending` Cobrança de Pix Automático pendente.\n* `charge.automatic_pix.pix.created` Cobrança de Pix Automático criada no provedor financeiro.\n* `charge.automatic_pix.pix.active` Cobrança de Pix Automático ativa.\n* `charge.automatic_pix.pix.paid` Cobrança de Pix Automático paga.\n* `charge.automatic_pix.pix.expired` Cobrança de Pix Automático expirada.\n* `charge.automatic_pix.pix.rejected` Cobrança de Pix Automático rejeitada.\n* `charge.automatic_pix.pix.canceled` Cobrança de Pix Automático cancelada.\n* `charge.automatic_pix.location.db.created` Localização de Pix Automático criada.\n* `charge.automatic_pix.location.db.updated` Localização de Pix Automático atualizada.\n* `charge.automatic_pix.location.db.deleted` Localização de Pix Automático excluída.\n* `charge.automatic_pix.location.register.requested` Registro da Localização de Pix Automático solicitado.\n* `charge.automatic_pix.location.register.confirmed` Registro da Localização de Pix Automático confirmado.\n* `charge.automatic_pix.location.register.failed` Falha no registro da Localização de Pix Automático.\n* `charge.automatic_pix.location.register.error` Ocorreu um erro no registro da Localização de Pix Automático.\n* `charge.payment.db.created` Recebimento de cobrança criado.\n* `charge.payment.db.updated` Recebimento de cobrança atualizado.\n* `charge.payment.db.deleted` Recebimento de cobrança excluído.\n* `charge.payment.notified` Recebimento notificado.\n* `charge.payment.canceled` Recebimento cancelado.\n* `charge.payment.confirmed` Recebimento confirmado.\n* `charge.payment.duplicated` Recebimento duplicado.\n* `charge.bank_billet.payment.notified` Baixa operacional de boleto notificada.\n* `charge.bank_billet.payment.canceled` Baixa operacional de boleto cancelada.\n* `charge.bank_billet.payment.confirmed` Baixa operacional de boleto liquidada.\n* `data.bank_billet_query.success` Consulta de boleto realizada com sucesso.\n* `data.bank_billet_query.error` Consulta de boleto com erro.\n* `data.bank_billet_query.db.created` Consulta de boleto criada.\n* `data.bank_billet_query.db.updated` Consulta de boleto atualizada.\n* `data.bank_billet_query.db.deleted` Consulta de boleto excluída.\n* `data.pix_qrcode_query.success` Consulta de Pix via QR Code realizada com sucesso.\n* `data.pix_qrcode_query.error` Consulta de Pix via QR Code com erro.\n* `data.pix_qrcode_query.db.created` Consulta de Pix via QR Code criada.\n* `data.pix_qrcode_query.db.updated` Consulta de Pix via QR Code atualizada.\n* `data.pix_qrcode_query.db.deleted` Consulta de Pix via QR Code excluída.\n* `mailbox.entry.db.created` Caixa Postal criado.\n* `mailbox.entry.db.updated` Caixa Postal atualizado.\n* `mailbox.entry.db.deleted` Caixa Postal excluída.\n* `mailbox.entry.file.received` Arquivo recebido na caixa de entrada.\n* `mailbox.entry.file.sent` Arquivo enviado para a caixa de saída.\n* `mailbox.file.db.created` Arquivo criado.\n* `mailbox.file.db.updated` Arquivo atualizado.\n* `mailbox.file.db.deleted` Arquivo excluído.\n* `mailbox.channel.s3.db.created` Canal S3 criado.\n* `mailbox.channel.s3.db.updated` Canal S3 atualizado.\n* `mailbox.channel.s3.db.deleted` Canal S3 excluído.\n* `mailbox.channel.s3.fetch_all` Arquivo obtido do canal S3.\n* `mailbox.channel.email.db.created` Canal de Email criado.\n* `mailbox.channel.email.db.updated` Canal de Email atualizado.\n* `mailbox.channel.email.db.deleted` Canal de Email excluído.\n* `mailbox.channel.whatsapp.db.created` Canal WhatsApp criado.\n* `mailbox.channel.whatsapp.db.updated` Canal WhatsApp atualizado.\n* `mailbox.channel.whatsapp.db.deleted` Canal WhatsApp excluído.\n* `mailbox.channel.sftp.db.created` Canal SFTP criado.\n* `mailbox.channel.sftp.db.updated` Canal SFTP atualizado.\n* `mailbox.channel.sftp.db.deleted` Canal SFTP excluído.\n* `mailbox.channel.sftp.fetch_all` Arquivo obtido do canal SFTP.\n* `mailbox.channel.syncthing.db.created` Canal Syncthing criado.\n* `mailbox.channel.syncthing.db.updated` Canal Syncthing atualizado.\n* `mailbox.channel.syncthing.db.deleted` Canal Syncthing excluído.\n* `email_account.db.created` Conta de e-mail criada.\n* `email_account.db.updated` Conta de e-mail atualizada.\n* `email_account.db.deleted` Conta de e-mail excluída.\n* `email_account.identity.pending` Aguardando identidade\n* `email_account.identity.created` Identidade criada\n* `email_account.identity.error` Identidade já existente\n* `email_account.identity.failure` Falha da identidade\n* `email_account.dns.not_ready` DNS não pronto\n* `email_account.dns.awaiting` Aguardando validação DNS\n* `email_account.dns.validated` DNS validado\n* `email_account.dns.error` Falha na validação do DNS\n* `email_account.dns.failure` Falha na tentativa do DNS\n* `integration.connection.db.created` Conexão criada.\n* `integration.connection.db.updated` Conexão atualizada.\n* `integration.connection.db.deleted` Conexão excluída.\n* `webhook.db.created` Webhook criado.\n* `webhook.db.updated` Webhook atualizado.\n* `webhook.db.deleted` Webhook excluído.\n* `enotas.nfe.generated` Enotas: nota fiscal gerada" }, "sent_error": { "type": "string", "nullable": true, "maxLength": 255, "description": "Erro ocorrido no envio" }, "email_notification_id": { "type": "integer", "nullable": true, "description": "ID da Notificação", "example": null }, "bank_billet_account_id": { "type": "integer", "nullable": true, "description": "ID da Carteira de Cobrança", "example": null }, "resource_owner_id": { "type": "integer", "nullable": true, "description": "ID do Objeto", "example": null }, "status": { "type": "string", "readOnly": true, "description": "Situação:\n* `pending` Pendente\n* `submitted` Enviado para o Servidor de E-mail\n* `failed` Falha no Envio para o Servidor de E-mail\n* `read` Lido pelo Destinatário\n* `clicked` Link Acessado pelo Destinatário", "enum": [ "pending", "submitted", "failed", "read", "clicked" ] }, "status_occurred_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora que o status ocorreu." }, "last_clicked_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora que foi clicado pela última vez." }, "last_read_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora que foi lido pela última vez." }, "clicked_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora que foi clicado." }, "click_count": { "type": "integer", "description": "Quantidade que foi clicado." }, "read_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora que foi lido." }, "read_count": { "type": "integer", "description": "Quantidade que foi lido." }, "subject": { "type": "string", "nullable": true, "description": "Assunto do email" }, "email_account_id": { "type": "integer", "nullable": true, "description": "ID da conta de e-email" }, "email_template_id": { "type": "integer", "nullable": true, "description": "ID template de e-email" }, "bank_billet_in_pdf": { "type": "boolean", "description": "Indicativo se boleto em pdf" }, "bcc": { "type": "string", "nullable": true, "description": "Lista do destinatários das cópias ocultas" }, "cc": { "type": "string", "nullable": true, "description": "Lista do destinatários" }, "from_address": { "type": "string", "nullable": true, "description": "Endereço do remetente" }, "reply_to_address": { "type": "string", "nullable": true, "description": "Endereço de resposta" } } }, "v2_webhook": { "type": "object", "required": [ "url", "events" ], "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do webhook" }, "uid": { "type": "string", "readOnly": true, "description": "UID do webhook" }, "name": { "type": "string", "maxLength": 255, "nullable": true, "description": "Nome de identificação do webhook" }, "url": { "type": "string", "maxLength": 255, "description": "Endereço onde as requisições serão realizadas" }, "content_type": { "type": "string", "maxLength": 255, "nullable": true, "description": "Content-type da requisição que será realizada. Valores válidos `application/json` (valor padrão) ou `application/x-www-form-urlencoded`." }, "events": { "type": "array", "description": "Eventos que devem gerar notificações para o webhook. Escolha um ou mais eventos.", "items": { "type": "string", "enum": [ "ping", "access_token.db.created", "access_token.db.updated", "access_token.db.deleted", "access_token.reminder", "access_token.expired", "account.updated", "account.blocked", "account.bank_billet_creation_blocked", "bank_billet.created", "bank_billet.updated", "bank_billet.generated", "bank_billet.canceled", "bank_billet.blocked", "bank_billet.overdue", "bank_billet.paid", "bank_billet.due_date", "bank_billet.rejected", "bank_billet.cancel.requested", "bank_billet.cancel.confirmed", "bank_billet.cancel.failed", "bank_billet.cancel.error", "bank_billet.register.requested", "bank_billet.register.confirmed", "bank_billet.register.failed", "bank_billet.register.error", "bank_billet.update.requested", "bank_billet.update.confirmed", "bank_billet.update.failed", "bank_billet.update.error", "bank_billet.registered", "bank_billet.deleted", "bank_billet.sync.requested", "bank_billet.sync.confirmed", "bank_billet.sync.failed", "bank_billet.sync.error", "bank_billet.get.requested", "bank_billet.get.confirmed", "bank_billet.get.failed", "bank_billet.get.error", "bank_billet.get_child.requested", "bank_billet.get_child.confirmed", "bank_billet.get_child.failed", "bank_billet.get_child.error", "bank_billet.find.requested", "bank_billet.find.confirmed", "bank_billet.find.failed", "bank_billet.find.error", "bank_billet.add_pix.requested", "bank_billet.add_pix.confirmed", "bank_billet.add_pix.failed", "bank_billet.add_pix.error", "bank_billet.get_pix.requested", "bank_billet.get_pix.confirmed", "bank_billet.get_pix.failed", "bank_billet.get_pix.error", "bank_billet.protest.requested", "bank_billet.protest.confirmed", "bank_billet.protest.failed", "bank_billet.protest.error", "bank_billet_discharge.created", "bank_billet_discharge.updated", "bank_billet_discharge.deleted", "bank_billet_remittance.created", "bank_billet_remittance.updated", "bank_billet_remittance.deleted", "bank_billet_registration.created", "bank_billet_registration.updated", "bank_billet_registration.deleted", "bank_billet_payment.created", "bank_billet_payment.updated", "bank_billet_payment.deleted", "customer.created", "customer.updated", "customer.portal_password_updated", "customer.deleted", "transaction.created", "transaction.updated", "transaction.processed", "withdrawal.transferred", "withdrawal.requested", "addon.activated", "addon.removed", "plan_subscription.activated", "plan_subscription.removed", "plan_subscription.fee", "plan_subscription.updated", "user.created", "user.updated", "user.deleted", "remittance.created", "remittance.processed", "remittance.downloaded", "remittance.sent", "remittance.deleted", "remittance.line.db.created", "remittance.line.db.updated", "remittance.line.db.deleted", "discharge.created", "discharge.processed", "discharge.deleted", "bank_billet_account.created", "bank_billet_account.homologated", "bank_billet_account.homologation_failed", "bank_billet_account.homologation_started", "bank_billet_account.validated", "bank_billet_account.validation_released", "bank_billet_account.activated", "bank_billet_account.updated", "bank_billet_account.deleted", "edi.remittance_line.created", "edi.remittance_line.updated", "edi.remittance_line.deleted", "edi.edi_box.activated", "edi.edi_box.db.created", "edi.edi_box.db.deleted", "edi.edi_box.db.updated", "edi.edi_box.generated", "edi.edi_box.demand_received", "edi.edi_box.confirming_at_bank", "edi.edi_box.testing_by_customer", "edi.edi_box.waiting_for_validations", "customer_subscription.created", "customer_subscription.updated", "customer_subscription.deleted", "installment.created", "installment.processed", "installment.generated", "installment.deleted", "import.created", "import.processed", "import.deleted", "export.db.created", "export.db.updated", "export.db.deleted", "pix.db.created", "pix.db.updated", "pix.db.deleted", "pix.register.requested", "pix.register.confirmed", "pix.register.failed", "pix.register.error", "pix.update.requested", "pix.update.confirmed", "pix.update.failed", "pix.update.error", "pix.paid", "pix.overdue", "pix.cancel.requested", "pix.cancel.confirmed", "pix.cancel.failed", "pix.cancel.error", "pix.sync.requested", "pix.sync.confirmed", "pix.sync.failed", "pix.sync.error", "pix.get.requested", "pix.get.confirmed", "pix.get.failed", "pix.get.error", "financial.account.balance_sync.requested", "financial.account.balance_sync.confirmed", "financial.account.balance_sync.failed", "financial.account.balance_sync.error", "financial.account.statement_sync.requested", "financial.account.statement_sync.confirmed", "financial.account.statement_sync.failed", "financial.account.statement_sync.error", "financial.account.db.created", "financial.account.db.updated", "financial.account.db.deleted", "financial.account.statement.updated", "financial.account.balance.updated", "financial.account_balance.db.created", "transfer.batch.db.created", "transfer.batch.db.updated", "transfer.batch.db.deleted", "transfer.batch.awaiting_approval", "transfer.pix_batch.awaiting_approval", "transfer.pix_batch.get.requested", "transfer.pix_batch.get.confirmed", "transfer.pix_batch.get.failed", "transfer.pix_batch.get.error", "transfer.pix_batch.sync.requested", "transfer.pix_batch.sync.confirmed", "transfer.pix_batch.sync.failed", "transfer.pix_batch.sync.error", "transfer.pix_batch.register.requested", "transfer.pix_batch.register.confirmed", "transfer.pix_batch.register.failed", "transfer.pix_batch.register.error", "transfer.pix_batch.approve.requested", "transfer.pix_batch.approve.confirmed", "transfer.pix_batch.approve.failed", "transfer.pix_batch.approve.error", "transfer.pix_batch.reprove.requested", "transfer.pix_batch.reprove.confirmed", "transfer.pix_batch.reprove.failed", "transfer.pix_batch.reprove.error", "transfer.pix_batch.cancel.requested", "transfer.pix_batch.cancel.confirmed", "transfer.pix_batch.cancel.failed", "transfer.pix_batch.cancel.error", "transfer.ted_batch.awaiting_approval", "transfer.ted_batch.get.requested", "transfer.ted_batch.get.confirmed", "transfer.ted_batch.get.failed", "transfer.ted_batch.get.error", "transfer.ted_batch.sync.requested", "transfer.ted_batch.sync.confirmed", "transfer.ted_batch.sync.failed", "transfer.ted_batch.sync.error", "transfer.ted_batch.register.requested", "transfer.ted_batch.register.confirmed", "transfer.ted_batch.register.failed", "transfer.ted_batch.register.error", "transfer.ted_batch.approve.requested", "transfer.ted_batch.approve.confirmed", "transfer.ted_batch.approve.failed", "transfer.ted_batch.approve.error", "transfer.ted_batch.reprove.requested", "transfer.ted_batch.reprove.confirmed", "transfer.ted_batch.reprove.failed", "transfer.ted_batch.reprove.error", "transfer.ted_batch.cancel.requested", "transfer.ted_batch.cancel.confirmed", "transfer.ted_batch.cancel.failed", "transfer.ted_batch.cancel.error", "transfer.internal_batch.awaiting_approval", "transfer.internal_batch.get.requested", "transfer.internal_batch.get.confirmed", "transfer.internal_batch.get.failed", "transfer.internal_batch.get.error", "transfer.internal_batch.sync.requested", "transfer.internal_batch.sync.confirmed", "transfer.internal_batch.sync.failed", "transfer.internal_batch.sync.error", "transfer.internal_batch.register.requested", "transfer.internal_batch.register.confirmed", "transfer.internal_batch.register.failed", "transfer.internal_batch.register.error", "transfer.internal_batch.approve.requested", "transfer.internal_batch.approve.confirmed", "transfer.internal_batch.approve.failed", "transfer.internal_batch.approve.error", "transfer.internal_batch.reprove.requested", "transfer.internal_batch.reprove.confirmed", "transfer.internal_batch.reprove.failed", "transfer.internal_batch.reprove.error", "transfer.internal_batch.cancel.requested", "transfer.internal_batch.cancel.confirmed", "transfer.internal_batch.cancel.failed", "transfer.internal_batch.cancel.error", "transfer.db.created", "transfer.db.updated", "transfer.db.deleted", "transfer.pix.register.requested", "transfer.pix.register.confirmed", "transfer.pix.register.failed", "transfer.pix.register.error", "transfer.pix.reschedule.requested", "transfer.pix.reschedule.confirmed", "transfer.pix.reschedule.failed", "transfer.pix.reschedule.error", "transfer.pix.approve.requested", "transfer.pix.approve.confirmed", "transfer.pix.approve.failed", "transfer.pix.approve.error", "transfer.pix.reprove.requested", "transfer.pix.reprove.confirmed", "transfer.pix.reprove.failed", "transfer.pix.reprove.error", "transfer.pix.cancel.requested", "transfer.pix.cancel.confirmed", "transfer.pix.cancel.failed", "transfer.pix.cancel.error", "transfer.pix.get.requested", "transfer.pix.get.confirmed", "transfer.pix.get.failed", "transfer.pix.get.error", "transfer.pix.sync.requested", "transfer.pix.sync.confirmed", "transfer.pix.sync.failed", "transfer.pix.sync.error", "transfer.ted.register.requested", "transfer.ted.register.confirmed", "transfer.ted.register.failed", "transfer.ted.register.error", "transfer.ted.reschedule.requested", "transfer.ted.reschedule.confirmed", "transfer.ted.reschedule.failed", "transfer.ted.reschedule.error", "transfer.ted.approve.requested", "transfer.ted.approve.confirmed", "transfer.ted.approve.failed", "transfer.ted.approve.error", "transfer.ted.reprove.requested", "transfer.ted.reprove.confirmed", "transfer.ted.reprove.failed", "transfer.ted.reprove.error", "transfer.ted.cancel.requested", "transfer.ted.cancel.confirmed", "transfer.ted.cancel.failed", "transfer.ted.cancel.error", "transfer.ted.get.requested", "transfer.ted.get.confirmed", "transfer.ted.get.failed", "transfer.ted.get.error", "transfer.ted.sync.requested", "transfer.ted.sync.confirmed", "transfer.ted.sync.failed", "transfer.ted.sync.error", "transfer.internal.register.requested", "transfer.internal.register.confirmed", "transfer.internal.register.failed", "transfer.internal.register.error", "transfer.internal.reschedule.requested", "transfer.internal.reschedule.confirmed", "transfer.internal.reschedule.failed", "transfer.internal.reschedule.error", "transfer.internal.approve.requested", "transfer.internal.approve.confirmed", "transfer.internal.approve.failed", "transfer.internal.approve.error", "transfer.internal.reprove.requested", "transfer.internal.reprove.confirmed", "transfer.internal.reprove.failed", "transfer.internal.reprove.error", "transfer.internal.cancel.requested", "transfer.internal.cancel.confirmed", "transfer.internal.cancel.failed", "transfer.internal.cancel.error", "transfer.internal.get.requested", "transfer.internal.get.confirmed", "transfer.internal.get.failed", "transfer.internal.get.error", "transfer.internal.sync.requested", "transfer.internal.sync.confirmed", "transfer.internal.sync.failed", "transfer.internal.sync.error", "payment.db.created", "payment.db.updated", "payment.db.deleted", "payment.bank_billet.register.requested", "payment.bank_billet.register.confirmed", "payment.bank_billet.register.failed", "payment.bank_billet.register.error", "payment.bank_billet.approve.requested", "payment.bank_billet.approve.confirmed", "payment.bank_billet.approve.failed", "payment.bank_billet.approve.error", "payment.bank_billet.reprove.requested", "payment.bank_billet.reprove.confirmed", "payment.bank_billet.reprove.failed", "payment.bank_billet.reprove.error", "payment.bank_billet.reschedule.requested", "payment.bank_billet.reschedule.confirmed", "payment.bank_billet.reschedule.failed", "payment.bank_billet.reschedule.error", "payment.bank_billet.cancel.requested", "payment.bank_billet.cancel.confirmed", "payment.bank_billet.cancel.failed", "payment.bank_billet.cancel.error", "payment.bank_billet.get.requested", "payment.bank_billet.get.confirmed", "payment.bank_billet.get.failed", "payment.bank_billet.get.error", "payment.bank_billet.sync.requested", "payment.bank_billet.sync.confirmed", "payment.bank_billet.sync.failed", "payment.bank_billet.sync.error", "payment.darf.register.requested", "payment.darf.register.confirmed", "payment.darf.register.failed", "payment.darf.register.error", "payment.darf.approve.requested", "payment.darf.approve.confirmed", "payment.darf.approve.failed", "payment.darf.approve.error", "payment.darf.reprove.requested", "payment.darf.reprove.confirmed", "payment.darf.reprove.failed", "payment.darf.reprove.error", "payment.darf.reschedule.requested", "payment.darf.reschedule.confirmed", "payment.darf.reschedule.failed", "payment.darf.reschedule.error", "payment.darf.cancel.requested", "payment.darf.cancel.confirmed", "payment.darf.cancel.failed", "payment.darf.cancel.error", "payment.darf.get.requested", "payment.darf.get.confirmed", "payment.darf.get.failed", "payment.darf.get.error", "payment.darf.sync.requested", "payment.darf.sync.confirmed", "payment.darf.sync.failed", "payment.darf.sync.error", "payment.utility.register.requested", "payment.utility.register.confirmed", "payment.utility.register.failed", "payment.utility.register.error", "payment.utility.approve.requested", "payment.utility.approve.confirmed", "payment.utility.approve.failed", "payment.utility.approve.error", "payment.utility.reprove.requested", "payment.utility.reprove.confirmed", "payment.utility.reprove.failed", "payment.utility.reprove.error", "payment.utility.reschedule.requested", "payment.utility.reschedule.confirmed", "payment.utility.reschedule.failed", "payment.utility.reschedule.error", "payment.utility.cancel.requested", "payment.utility.cancel.confirmed", "payment.utility.cancel.failed", "payment.utility.cancel.error", "payment.utility.get.requested", "payment.utility.get.confirmed", "payment.utility.get.failed", "payment.utility.get.error", "payment.utility.sync.requested", "payment.utility.sync.confirmed", "payment.utility.sync.failed", "payment.utility.sync.error", "payment.gru.register.requested", "payment.gru.register.confirmed", "payment.gru.register.failed", "payment.gru.register.error", "payment.gru.approve.requested", "payment.gru.approve.confirmed", "payment.gru.approve.failed", "payment.gru.approve.error", "payment.gru.reprove.requested", "payment.gru.reprove.confirmed", "payment.gru.reprove.failed", "payment.gru.reprove.error", "payment.gru.reschedule.requested", "payment.gru.reschedule.confirmed", "payment.gru.reschedule.failed", "payment.gru.reschedule.error", "payment.gru.cancel.requested", "payment.gru.cancel.confirmed", "payment.gru.cancel.failed", "payment.gru.cancel.error", "payment.gru.get.requested", "payment.gru.get.confirmed", "payment.gru.get.failed", "payment.gru.get.error", "payment.gru.sync.requested", "payment.gru.sync.confirmed", "payment.gru.sync.failed", "payment.gru.sync.error", "payment.pix.register.requested", "payment.pix.register.confirmed", "payment.pix.register.failed", "payment.pix.register.error", "payment.pix.approve.requested", "payment.pix.approve.confirmed", "payment.pix.approve.failed", "payment.pix.approve.error", "payment.pix.reprove.requested", "payment.pix.reprove.confirmed", "payment.pix.reprove.failed", "payment.pix.reprove.error", "payment.pix.reschedule.requested", "payment.pix.reschedule.confirmed", "payment.pix.reschedule.failed", "payment.pix.reschedule.error", "payment.pix.cancel.requested", "payment.pix.cancel.confirmed", "payment.pix.cancel.failed", "payment.pix.cancel.error", "payment.pix.get.requested", "payment.pix.get.confirmed", "payment.pix.get.failed", "payment.pix.get.error", "payment.pix.sync.requested", "payment.pix.sync.confirmed", "payment.pix.sync.failed", "payment.pix.sync.error", "payment.tax.register.requested", "payment.tax.register.confirmed", "payment.tax.register.failed", "payment.tax.register.error", "payment.tax.approve.requested", "payment.tax.approve.confirmed", "payment.tax.approve.failed", "payment.tax.approve.error", "payment.tax.reprove.requested", "payment.tax.reprove.confirmed", "payment.tax.reprove.failed", "payment.tax.reprove.error", "payment.tax.reschedule.requested", "payment.tax.reschedule.confirmed", "payment.tax.reschedule.failed", "payment.tax.reschedule.error", "payment.tax.cancel.requested", "payment.tax.cancel.confirmed", "payment.tax.cancel.failed", "payment.tax.cancel.error", "payment.tax.get.requested", "payment.tax.get.confirmed", "payment.tax.get.failed", "payment.tax.get.error", "payment.tax.sync.requested", "payment.tax.sync.confirmed", "payment.tax.sync.failed", "payment.tax.sync.error", "payment.batch.db.created", "payment.batch.db.updated", "payment.batch.db.deleted", "payment.batch.awaiting_approval", "payment.bank_billet_batch.awaiting_approval", "payment.bank_billet_batch.get.requested", "payment.bank_billet_batch.get.confirmed", "payment.bank_billet_batch.get.failed", "payment.bank_billet_batch.get.error", "payment.bank_billet_batch.sync.requested", "payment.bank_billet_batch.sync.confirmed", "payment.bank_billet_batch.sync.failed", "payment.bank_billet_batch.sync.error", "payment.bank_billet_batch.register.requested", "payment.bank_billet_batch.register.confirmed", "payment.bank_billet_batch.register.failed", "payment.bank_billet_batch.register.error", "payment.bank_billet_batch.approve.requested", "payment.bank_billet_batch.approve.confirmed", "payment.bank_billet_batch.approve.failed", "payment.bank_billet_batch.approve.error", "payment.bank_billet_batch.reprove.requested", "payment.bank_billet_batch.reprove.confirmed", "payment.bank_billet_batch.reprove.failed", "payment.bank_billet_batch.reprove.error", "payment.bank_billet_batch.cancel.requested", "payment.bank_billet_batch.cancel.confirmed", "payment.bank_billet_batch.cancel.failed", "payment.bank_billet_batch.cancel.error", "payment.darf_batch.awaiting_approval", "payment.darf_batch.get.requested", "payment.darf_batch.get.confirmed", "payment.darf_batch.get.failed", "payment.darf_batch.get.error", "payment.darf_batch.sync.requested", "payment.darf_batch.sync.confirmed", "payment.darf_batch.sync.failed", "payment.darf_batch.sync.error", "payment.darf_batch.register.requested", "payment.darf_batch.register.confirmed", "payment.darf_batch.register.failed", "payment.darf_batch.register.error", "payment.darf_batch.approve.requested", "payment.darf_batch.approve.confirmed", "payment.darf_batch.approve.failed", "payment.darf_batch.approve.error", "payment.darf_batch.reprove.requested", "payment.darf_batch.reprove.confirmed", "payment.darf_batch.reprove.failed", "payment.darf_batch.reprove.error", "payment.darf_batch.cancel.requested", "payment.darf_batch.cancel.confirmed", "payment.darf_batch.cancel.failed", "payment.darf_batch.cancel.error", "payment.utility_batch.awaiting_approval", "payment.utility_batch.get.requested", "payment.utility_batch.get.confirmed", "payment.utility_batch.get.failed", "payment.utility_batch.get.error", "payment.utility_batch.sync.requested", "payment.utility_batch.sync.confirmed", "payment.utility_batch.sync.failed", "payment.utility_batch.sync.error", "payment.utility_batch.register.requested", "payment.utility_batch.register.confirmed", "payment.utility_batch.register.failed", "payment.utility_batch.register.error", "payment.utility_batch.approve.requested", "payment.utility_batch.approve.confirmed", "payment.utility_batch.approve.failed", "payment.utility_batch.approve.error", "payment.utility_batch.reprove.requested", "payment.utility_batch.reprove.confirmed", "payment.utility_batch.reprove.failed", "payment.utility_batch.reprove.error", "payment.utility_batch.cancel.requested", "payment.utility_batch.cancel.confirmed", "payment.utility_batch.cancel.failed", "payment.utility_batch.cancel.error", "payment.gru_batch.awaiting_approval", "payment.gru_batch.get.requested", "payment.gru_batch.get.confirmed", "payment.gru_batch.get.failed", "payment.gru_batch.get.error", "payment.gru_batch.sync.requested", "payment.gru_batch.sync.confirmed", "payment.gru_batch.sync.failed", "payment.gru_batch.sync.error", "payment.gru_batch.register.requested", "payment.gru_batch.register.confirmed", "payment.gru_batch.register.failed", "payment.gru_batch.register.error", "payment.gru_batch.approve.requested", "payment.gru_batch.approve.confirmed", "payment.gru_batch.approve.failed", "payment.gru_batch.approve.error", "payment.gru_batch.reprove.requested", "payment.gru_batch.reprove.confirmed", "payment.gru_batch.reprove.failed", "payment.gru_batch.reprove.error", "payment.gru_batch.cancel.requested", "payment.gru_batch.cancel.confirmed", "payment.gru_batch.cancel.failed", "payment.gru_batch.cancel.error", "payment.pix_batch.awaiting_approval", "payment.pix_batch.get.requested", "payment.pix_batch.get.confirmed", "payment.pix_batch.get.failed", "payment.pix_batch.get.error", "payment.pix_batch.sync.requested", "payment.pix_batch.sync.confirmed", "payment.pix_batch.sync.failed", "payment.pix_batch.sync.error", "payment.pix_batch.register.requested", "payment.pix_batch.register.confirmed", "payment.pix_batch.register.failed", "payment.pix_batch.register.error", "payment.pix_batch.approve.requested", "payment.pix_batch.approve.confirmed", "payment.pix_batch.approve.failed", "payment.pix_batch.approve.error", "payment.pix_batch.reprove.requested", "payment.pix_batch.reprove.confirmed", "payment.pix_batch.reprove.failed", "payment.pix_batch.reprove.error", "payment.pix_batch.cancel.requested", "payment.pix_batch.cancel.confirmed", "payment.pix_batch.cancel.failed", "payment.pix_batch.cancel.error", "payment.tax_batch.awaiting_approval", "payment.tax_batch.get.requested", "payment.tax_batch.get.confirmed", "payment.tax_batch.get.failed", "payment.tax_batch.get.error", "payment.tax_batch.sync.requested", "payment.tax_batch.sync.confirmed", "payment.tax_batch.sync.failed", "payment.tax_batch.sync.error", "payment.tax_batch.register.requested", "payment.tax_batch.register.confirmed", "payment.tax_batch.register.failed", "payment.tax_batch.register.error", "payment.tax_batch.approve.requested", "payment.tax_batch.approve.confirmed", "payment.tax_batch.approve.failed", "payment.tax_batch.approve.error", "payment.tax_batch.reprove.requested", "payment.tax_batch.reprove.confirmed", "payment.tax_batch.reprove.failed", "payment.tax_batch.reprove.error", "payment.tax_batch.cancel.requested", "payment.tax_batch.cancel.confirmed", "payment.tax_batch.cancel.failed", "payment.tax_batch.cancel.error", "payment.dda.account.db.created", "payment.dda.account.register.requested", "payment.dda.account.register.failed", "payment.dda.account.register.error", "payment.dda.account.register.confirmed", "payment.dda.account.bank_billets_sync.requested", "payment.dda.account.bank_billets_sync.failed", "payment.dda.account.bank_billets_sync.error", "payment.dda.account.bank_billets_sync.confirmed", "payment.dda.account.unregister.requested", "payment.dda.account.unregister.failed", "payment.dda.account.unregister.error", "payment.dda.account.unregister.confirmed", "payment.dda.bank_billet.db.created", "payment.dda.bank_billet.db.updated", "payment.dda.bank_billet.external_status_changed", "payment.dda.bank_billet.get.requested", "payment.dda.bank_billet.get.confirmed", "payment.dda.bank_billet.get.failed", "payment.dda.bank_billet.get.error", "payment.dda.bank_billet.sync.requested", "payment.dda.bank_billet.sync.confirmed", "payment.dda.bank_billet.sync.failed", "payment.dda.bank_billet.sync.error", "payment.dda.account.db.updated", "payment.dda.account.db.deleted", "payment.dda.account.letter.pending", "payment.dda.account.letter.waiting_signatures", "payment.dda.account.letter.signed", "payment.dda.account.letter.failed", "payment.dda.account.confirmed", "payment.dda.account.rejected", "payment.dda.account.failed", "payment.dda.account.disabled", "payment.dda.account.enabled", "credit.restriction.add.requested", "credit.restriction.add.failed", "credit.restriction.add.error", "credit.restriction.add.confirmed", "credit.restriction.remove.requested", "credit.restriction.remove.confirmed", "credit.restriction.remove.failed", "credit.restriction.remove.error", "charge.automatic_pix.account.db.created", "charge.automatic_pix.account.db.updated", "charge.automatic_pix.account.db.deleted", "charge.automatic_pix.recurrence.db.created", "charge.automatic_pix.recurrence.db.updated", "charge.automatic_pix.recurrence.db.deleted", "charge.automatic_pix.recurrence.cancel.requested", "charge.automatic_pix.recurrence.cancel.confirmed", "charge.automatic_pix.recurrence.cancel.failed", "charge.automatic_pix.recurrence.cancel.error", "charge.automatic_pix.recurrence.register.requested", "charge.automatic_pix.recurrence.register.confirmed", "charge.automatic_pix.recurrence.register.failed", "charge.automatic_pix.recurrence.register.error", "charge.automatic_pix.recurrence.update.requested", "charge.automatic_pix.recurrence.update.confirmed", "charge.automatic_pix.recurrence.update.failed", "charge.automatic_pix.recurrence.update.error", "charge.automatic_pix.recurrence.pending", "charge.automatic_pix.recurrence.created", "charge.automatic_pix.recurrence.approved", "charge.automatic_pix.recurrence.rejected", "charge.automatic_pix.recurrence.expired", "charge.automatic_pix.recurrence.canceled", "charge.automatic_pix.request.db.created", "charge.automatic_pix.request.db.updated", "charge.automatic_pix.request.db.deleted", "charge.automatic_pix.request.cancel.requested", "charge.automatic_pix.request.cancel.confirmed", "charge.automatic_pix.request.cancel.failed", "charge.automatic_pix.request.cancel.error", "charge.automatic_pix.request.register.requested", "charge.automatic_pix.request.register.confirmed", "charge.automatic_pix.request.register.failed", "charge.automatic_pix.request.register.error", "charge.automatic_pix.request.pending", "charge.automatic_pix.request.created", "charge.automatic_pix.request.sent", "charge.automatic_pix.request.received", "charge.automatic_pix.request.rejected", "charge.automatic_pix.request.accepted", "charge.automatic_pix.request.expired", "charge.automatic_pix.request.canceled", "charge.automatic_pix.pix.db.created", "charge.automatic_pix.pix.db.updated", "charge.automatic_pix.pix.db.deleted", "charge.automatic_pix.pix.cancel.requested", "charge.automatic_pix.pix.cancel.confirmed", "charge.automatic_pix.pix.cancel.failed", "charge.automatic_pix.pix.cancel.error", "charge.automatic_pix.pix.register.requested", "charge.automatic_pix.pix.register.confirmed", "charge.automatic_pix.pix.register.failed", "charge.automatic_pix.pix.register.error", "charge.automatic_pix.pix.update.requested", "charge.automatic_pix.pix.update.confirmed", "charge.automatic_pix.pix.update.failed", "charge.automatic_pix.pix.update.error", "charge.automatic_pix.pix.pending", "charge.automatic_pix.pix.created", "charge.automatic_pix.pix.active", "charge.automatic_pix.pix.paid", "charge.automatic_pix.pix.expired", "charge.automatic_pix.pix.rejected", "charge.automatic_pix.pix.canceled", "charge.automatic_pix.location.db.created", "charge.automatic_pix.location.db.updated", "charge.automatic_pix.location.db.deleted", "charge.automatic_pix.location.register.requested", "charge.automatic_pix.location.register.confirmed", "charge.automatic_pix.location.register.failed", "charge.automatic_pix.location.register.error", "charge.payment.db.created", "charge.payment.db.updated", "charge.payment.db.deleted", "charge.payment.notified", "charge.payment.canceled", "charge.payment.confirmed", "charge.payment.duplicated", "charge.bank_billet.payment.notified", "charge.bank_billet.payment.canceled", "charge.bank_billet.payment.confirmed", "data.bank_billet_query.success", "data.bank_billet_query.error", "data.bank_billet_query.db.created", "data.bank_billet_query.db.updated", "data.bank_billet_query.db.deleted", "data.pix_qrcode_query.success", "data.pix_qrcode_query.error", "data.pix_qrcode_query.db.created", "data.pix_qrcode_query.db.updated", "data.pix_qrcode_query.db.deleted", "mailbox.entry.db.created", "mailbox.entry.db.updated", "mailbox.entry.db.deleted", "mailbox.entry.file.received", "mailbox.entry.file.sent", "mailbox.file.db.created", "mailbox.file.db.updated", "mailbox.file.db.deleted", "mailbox.channel.s3.db.created", "mailbox.channel.s3.db.updated", "mailbox.channel.s3.db.deleted", "mailbox.channel.s3.fetch_all", "mailbox.channel.email.db.created", "mailbox.channel.email.db.updated", "mailbox.channel.email.db.deleted", "mailbox.channel.whatsapp.db.created", "mailbox.channel.whatsapp.db.updated", "mailbox.channel.whatsapp.db.deleted", "mailbox.channel.sftp.db.created", "mailbox.channel.sftp.db.updated", "mailbox.channel.sftp.db.deleted", "mailbox.channel.sftp.fetch_all", "mailbox.channel.syncthing.db.created", "mailbox.channel.syncthing.db.updated", "mailbox.channel.syncthing.db.deleted", "email_account.db.created", "email_account.db.updated", "email_account.db.deleted", "email_account.identity.pending", "email_account.identity.created", "email_account.identity.error", "email_account.identity.failure", "email_account.dns.not_ready", "email_account.dns.awaiting", "email_account.dns.validated", "email_account.dns.error", "email_account.dns.failure", "integration.connection.db.created", "integration.connection.db.updated", "integration.connection.db.deleted", "webhook.db.created", "webhook.db.updated", "webhook.db.deleted", "enotas.nfe.generated" ] } }, "active": { "type": "boolean", "nullable": true, "description": "Define se o webhook estará ativo, recebendo notificações. O valor padrão é `true`.", "example": null }, "ssl_verification_enabled": { "type": "boolean", "nullable": true, "description": "Define se a verificação SSL está habilitada no webhook.", "example": null }, "bank_billet_account_id": { "type": "integer", "nullable": true, "description": "ID da [Carteira de Cobrança](/reference/post_v1-bank-billet-accounts). Se informado, o webhook apenas receberá notificações de eventos relacionados à carteira indicada.", "example": null, "deprecated": true }, "auth_kind": { "type": "string", "nullable": true, "enum": [ "none", "basic_auth", "bearer", "api_key" ], "readOnly": true, "description": "Tipo de autenticação configurado. Retornado nas respostas. Para configurar, envie o objeto `auth` no body." }, "auth": { "type": "object", "nullable": true, "writeOnly": true, "description": "Configuração de autenticação do endpoint receptor. Apenas para criação/atualização — não retornado nas respostas.", "properties": { "kind": { "type": "string", "enum": [ "none", "basic_auth", "bearer", "api_key" ], "description": "Tipo de autenticação: `none`, `basic_auth`, `bearer` ou `api_key`." }, "username": { "type": "string", "nullable": true, "description": "Usuário (somente `basic_auth`)." }, "password": { "type": "string", "nullable": true, "description": "Senha (somente `basic_auth`). Deixe em branco para manter a senha atual." }, "token": { "type": "string", "nullable": true, "description": "Token (somente `bearer`). Deixe em branco para manter o token atual." }, "header_name": { "type": "string", "nullable": true, "description": "Nome do header (somente `api_key`). Ex: `X-API-Key`." }, "header_value": { "type": "string", "nullable": true, "description": "Valor do header (somente `api_key`). Deixe em branco para manter o valor atual." } } } } }, "v2_bank_billet_query": { "type": "object", "properties": { "uid": { "type": "string", "readOnly": true, "description": "ID único do registro no formato UUID" }, "status": { "type": "string", "readOnly": true, "description": "Situação da consulta:\n* `pending` Pendente (somente quando configurado para não processar automaticamente)\n* `success` Realizada com sucesso\n* `error` Falha na consulta", "enum": [ "pending", "success", "error" ] }, "error_message": { "type": "string", "nullable": true, "readOnly": true, "description": "Mensagem de erro quando a consulta é processada mas os dados não são retornados." }, "line_or_barcode": { "type": "string", "required": true, "writeOnly": true, "description": "Linha Digitável ou Código de Barras, nos formatos:\nLinha Digitável: 34191.79001 01043.510047 91020.150008 7 75870000001000\nCódigo de Barras: 34197758700000010001790010104351004791020150" }, "line": { "type": "string", "readOnly": true, "description": "Linha Digitável", "example": "34191.79001 01043.510047 91020.150008 7 75870000001000" }, "barcode": { "type": "string", "readOnly": true, "description": "Código de Barras", "example": "34197758700000010001790010104351004791020150" }, "expire_at": { "type": "string", "nullable": true, "format": "date", "readOnly": true, "description": "Data de Vencimento", "example": "2023-10-10" }, "pay_due_date": { "type": "string", "nullable": true, "format": "date", "readOnly": true, "description": "Data-limite para pagamento (prazo de tolerância), quando informada pela origem", "example": "2023-10-20" }, "amount": { "type": "number", "format": "float", "nullable": true, "readOnly": true, "description": "Valor a pagar", "example": 30.0 }, "minimum_amount": { "type": "number", "format": "float", "nullable": true, "readOnly": true, "description": "Valor mínimo", "example": 20.0 }, "maximum_amount": { "type": "number", "format": "float", "nullable": true, "readOnly": true, "description": "Valor máximo", "example": 50.0 }, "original_amount": { "type": "number", "format": "float", "nullable": true, "readOnly": true, "description": "Valor original", "example": 25.0 }, "valid_for_payment": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se o boleto está apto para pagamento no momento da consulta", "example": true }, "payment_status_reason": { "type": "string", "nullable": true, "readOnly": true, "description": "Motivo retornado quando o boleto não está apto para pagamento", "example": "boleto not valid for payment" }, "allow_change_value": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se o valor do pagamento pode ser alterado dentro dos limites retornados", "example": false }, "allow_partial_payment": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se a origem permite pagamento parcial", "example": false }, "issue_bank": { "type": "object", "readOnly": true, "nullable": true, "description": "Banco emissor do boleto", "properties": { "code": { "type": "integer", "nullable": true, "description": "Código do banco emissor", "example": 1 }, "ispb": { "type": "string", "nullable": true, "description": "ISPB do banco emissor", "example": "00000000" }, "name": { "type": "string", "nullable": true, "description": "Nome do banco emissor", "example": "BANCO DO BRASIL" } } }, "beneficiary": { "type": "object", "readOnly": true, "nullable": true, "description": "Dados do Beneficiário", "properties": { "document_number": { "type": "string", "nullable": true, "description": "Número do Documento (CPF ou CNPJ)", "example": "111.321.322-09" }, "name": { "type": "string", "nullable": true, "description": "Nome Completo ou Razão Social", "example": "João da Silva" } } }, "guarantor": { "type": "object", "readOnly": true, "nullable": true, "description": "Dados do Beneficiário Final", "properties": { "document_number": { "type": "string", "nullable": false, "description": "Número do Documento (CPF ou CNPJ)", "example": "111.321.322-09" }, "name": { "type": "string", "nullable": false, "description": "Nome Completo ou Razão Social", "example": "João da Silva" } } }, "guarantor_drawer": { "type": "object", "readOnly": true, "nullable": true, "description": "Dados do Sacador Avalista", "properties": { "document_number": { "type": "string", "nullable": false, "description": "Número do Documento (CPF ou CNPJ)", "example": "111.321.322-09" }, "name": { "type": "string", "nullable": false, "description": "Nome Completo ou Razão Social", "example": "João da Silva" } } }, "payer": { "type": "object", "readOnly": true, "nullable": true, "description": "Dados do Pagador", "properties": { "document_number": { "type": "string", "nullable": false, "description": "Número do Documento (CPF ou CNPJ)", "example": "111.321.322-09" }, "name": { "type": "string", "nullable": false, "description": "Nome Completo ou Razão Social", "example": "João da Silva" } } }, "fine": { "type": "object", "nullable": true, "readOnly": true, "description": "Multa. Retornado como `{\"value\": }`, com o valor em reais (decimal), não em centavos.", "example": "{\"value\": 28.15}" }, "interest": { "type": "object", "nullable": true, "readOnly": true, "description": "Juros. Retornado como `{\"value\": }`, com o valor em reais (decimal), não em centavos.", "example": "{\"value\": 26.32}" }, "discount": { "type": "object", "nullable": true, "readOnly": true, "description": "Desconto. Retornado como `{\"value\": }`, com o valor em reais (decimal), não em centavos.", "example": "{\"value\": 190.3}" }, "external_id": { "type": "string", "nullable": true, "description": "ID no seu sistema. Opcional para controle interno." }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas", "example": null, "items": { "type": "string" } }, "created_via_api": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se o registro foi criado por API" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do registro" } } }, "v2_pix_qrcode_query": { "type": "object", "properties": { "uid": { "type": "string", "readOnly": true, "description": "ID único do registro no formato UUID" }, "qrcode": { "type": "string", "required": true, "writeOnly": true, "description": "QR Code Pix para decodificação", "example": "00020126330014br.gov.bcb.pix0111123456789005204000053039865802BR5913EXAMPLE NAME6008BRASILIA62190515ABCDEF123456789630461D0" }, "pix_key": { "type": "string", "readOnly": true, "nullable": true, "description": "Chave Pix do beneficiário", "example": "user@example.com" }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data de expiração do QR Code", "example": "2024-12-31T23:59:59Z" }, "finality": { "type": "string", "nullable": true, "readOnly": true, "description": "Finalidade do pagamento (pagamento, saque, troco)", "example": "payment" }, "amount": { "type": "number", "format": "float", "nullable": true, "readOnly": true, "description": "Valor principal", "example": 100.0 }, "amount_change": { "type": "number", "format": "float", "nullable": true, "readOnly": true, "description": "Valor do troco", "example": 5.0 }, "interest": { "type": "number", "format": "float", "nullable": true, "readOnly": true, "description": "Valor dos juros", "example": 2.0 }, "fine": { "type": "number", "format": "float", "nullable": true, "readOnly": true, "description": "Valor da multa", "example": 3.0 }, "discount": { "type": "number", "format": "float", "nullable": true, "readOnly": true, "description": "Valor do desconto", "example": 1.0 }, "total_amount": { "type": "number", "format": "float", "nullable": true, "readOnly": true, "description": "Valor total a pagar", "example": 104.0 }, "beneficiary": { "type": "object", "readOnly": true, "nullable": true, "description": "Dados do Beneficiário/Recebedor", "properties": { "document_type": { "type": "string", "nullable": false, "description": "Tipo do documento (cpf ou cnpj)", "example": "cnpj", "enum": [ "cpf", "cnpj" ] }, "document_number": { "type": "string", "nullable": false, "description": "Número do Documento (CPF ou CNPJ)", "example": "12345678000190" }, "name": { "type": "string", "nullable": false, "description": "Nome Completo ou Razão Social", "example": "Empresa Exemplo LTDA" } } }, "debtor": { "type": "object", "readOnly": true, "nullable": true, "description": "Dados do Devedor", "properties": { "document_type": { "type": "string", "nullable": true, "description": "Tipo do documento (cpf ou cnpj)", "example": "cpf", "enum": [ "cpf", "cnpj" ] }, "document_number": { "type": "string", "nullable": true, "description": "Número do Documento (CPF ou CNPJ)", "example": "12345678901" }, "name": { "type": "string", "nullable": false, "description": "Nome Completo ou Razão Social", "example": "João da Silva" } } }, "description": { "type": "string", "nullable": true, "readOnly": true, "description": "Mensagem ao pagador", "example": "Pagamento de serviços" }, "can_be_paid": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se o QR Code pode ser pago", "example": true }, "can_be_paid_with_different_value": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Indica se pode ser pago com valor diferente", "example": false }, "cannot_be_paid_reason": { "type": "string", "nullable": true, "readOnly": true, "description": "Motivo pelo qual não pode ser pago", "example": "QR Code expirado" }, "external_id": { "type": "string", "nullable": true, "description": "ID no seu sistema. Opcional para controle interno.", "example": "EXT-123456" }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "tags": { "type": "array", "nullable": true, "description": "Tags associadas para categorização", "example": [ "payment", "pix", "qrcode" ], "items": { "type": "string" } }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do registro" } } }, "v2_edi_box": { "create": { "type": "object", "required": [ "resource", "account_owner", "letter_owner" ], "properties": { "resource": { "type": "object", "description": "Recurso associado à caixa postal", "required": [ "type", "uid" ], "example": { "type": "financial.account", "uid": "01948afe-3014-7e81-9a88-badcfc1fd4d6" }, "properties": { "type": { "type": "string", "example": "financial.account", "description": "Tipo do Recurso\n\n`charge.bank_billet_account`: Carteira de Cobrança\n`financial.account`: Conta Financeira\n" }, "uid": { "type": "string", "description": "UID do recurso", "example": "01948afe-3014-7e81-9a88-badcfc1fd4d6" } } }, "name": { "type": "string", "nullable": true, "description": "Nome de identificação da caixa postal" }, "operation": { "type": "string", "enum": [ "charge", "statement", "payment" ], "description": "Tipo de operação que será trafegada na caixa postal\n\n`charge`: Cobrança\n`statement`: Extrato\n`payment`: Pagamento\n\nAlterar este campo (ou `resource`) via `PUT` só é permitido quando a caixa\npostal está marcada como `editable: true`; caso contrário, retorna 422.\n" }, "kind": { "type": "string", "enum": [ "cnab400", "cnab240", "cnab200" ], "description": "Formato do arquivo CNAB que será trafegado na caixa postal\n\n`cnab400`: CNAB 400\n`cnab240`: CNAB 240\n`cnab200`: CNAB 200\n" }, "account_owner": { "type": "object", "description": "Proprietário da conta", "example": { "name": "Margret Santos Contas", "document_number": "16.974.923/0001-84", "phone_number": "2130030386", "email": "conta@example.com" }, "properties": { "name": { "type": "string", "required": true, "description": "Nome", "example": "Margret Santos Contas" }, "document_number": { "type": "string", "required": true, "description": "Número do documento", "example": "16.974.923/0001-84" }, "phone_number": { "type": "string", "required": true, "writeOnly": true, "description": "Número de telefone (com DDD)", "example": "2130030386" }, "email": { "type": "string", "required": true, "writeOnly": true, "description": "E-mail", "example": "nome@example.com" } } }, "bank_manager": { "type": "object", "description": "Gerente do banco", "example": { "name": "Margret Santos Bancos", "email": "banco@example.com", "phone_number": "11988888888" }, "properties": { "name": { "type": "string", "required": true, "description": "Nome", "example": "Margret Santos Bancos" }, "phone_number": { "type": "string", "required": true, "writeOnly": true, "description": "Número de telefone (com DDD)", "example": "2130030386" }, "email": { "type": "string", "required": true, "writeOnly": true, "description": "E-mail", "example": "nome@example.com" } } }, "letter_owner": { "type": "object", "description": "Responsável pela carta", "nullable": true, "example": { "name": "Margret Santos Cartas", "phone_number": "2130030386", "email": "carta@example.com" }, "properties": { "name": { "type": "string", "required": true, "description": "Nome", "example": "Margret Santos Cartas" }, "phone_number": { "type": "string", "required": true, "writeOnly": true, "description": "Número de telefone (com DDD)", "example": "2130030386" }, "email": { "type": "string", "required": true, "writeOnly": true, "description": "E-mail", "example": "nome@example.com" } } }, "business_logo": { "type": "string", "format": "base64", "description": "Logo da Empresa. A imagem deve ser menor que 500KB ter 150x150 pixels e estar no formato base64 JPG ou PNG.", "example": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAFwF..." }, "letter_pdf": { "type": "string", "nullable": true, "readOnly": true, "description": "URL para download do PDF da carta" }, "letter_creation_errors": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true, "description": "Erros de validação na geração da carta EDI (ex: campos obrigatórios ausentes)" }, "letter_status": { "type": "string", "readOnly": true, "description": "Status do PDF da carta na Kobana:\n* `not_created` Não criada\n* `creating` Criando\n* `created` Criada" }, "status": { "type": "string", "nullable": true, "readOnly": true, "description": "Status da caixa postal:\n* `generated` Carta gerada\n* `demand_received` Demanda recepcionada\n* `confirming_at_bank` Aguardando confirmação do banco\n* `testing_by_customer` Aguardando teste do cliente\n* `waiting_for_validations` Aguardando validações\n* `activated` Caixa postal ativada" }, "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID da caixa postal", "example": "012ab34c-d567-8901-234e-5fghi6j789k0" }, "enabled_at": { "type": "string", "nullable": true, "format": "date-time", "readOnly": true, "description": "Data e hora de habilitação da caixa postal" }, "validated_at": { "type": "string", "nullable": true, "format": "date-time", "readOnly": true, "description": "Data e hora de validação da caixa postal" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do registro" } } }, "update": { "type": "object", "required": [], "properties": { "resource": { "type": "object", "description": "Recurso associado à caixa postal", "required": [ "type", "uid" ], "example": { "type": "financial.account", "uid": "01948afe-3014-7e81-9a88-badcfc1fd4d6" }, "properties": { "type": { "type": "string", "example": "financial.account", "description": "Tipo do Recurso\n\n`charge.bank_billet_account`: Carteira de Cobrança\n`financial.account`: Conta Financeira\n" }, "uid": { "type": "string", "description": "UID do recurso", "example": "01948afe-3014-7e81-9a88-badcfc1fd4d6" } } }, "name": { "type": "string", "nullable": true, "description": "Nome de identificação da caixa postal" }, "operation": { "type": "string", "enum": [ "charge", "statement", "payment" ], "description": "Tipo de operação que será trafegada na caixa postal\n\n`charge`: Cobrança\n`statement`: Extrato\n`payment`: Pagamento\n\nAlterar este campo (ou `resource`) via `PUT` só é permitido quando a caixa\npostal está marcada como `editable: true`; caso contrário, retorna 422.\n" }, "kind": { "type": "string", "enum": [ "cnab400", "cnab240", "cnab200" ], "description": "Formato do arquivo CNAB que será trafegado na caixa postal\n\n`cnab400`: CNAB 400\n`cnab240`: CNAB 240\n`cnab200`: CNAB 200\n" }, "account_owner": { "type": "object", "description": "Proprietário da conta", "example": { "name": "Margret Santos Contas", "document_number": "16.974.923/0001-84", "phone_number": "2130030386", "email": "conta@example.com" }, "properties": { "name": { "type": "string", "required": true, "description": "Nome", "example": "Margret Santos Contas" }, "document_number": { "type": "string", "required": true, "description": "Número do documento", "example": "16.974.923/0001-84" }, "phone_number": { "type": "string", "required": true, "writeOnly": true, "description": "Número de telefone (com DDD)", "example": "2130030386" }, "email": { "type": "string", "required": true, "writeOnly": true, "description": "E-mail", "example": "nome@example.com" } } }, "bank_manager": { "type": "object", "description": "Gerente do banco", "example": { "name": "Margret Santos Bancos", "email": "banco@example.com", "phone_number": "11988888888" }, "properties": { "name": { "type": "string", "required": true, "description": "Nome", "example": "Margret Santos Bancos" }, "phone_number": { "type": "string", "required": true, "writeOnly": true, "description": "Número de telefone (com DDD)", "example": "2130030386" }, "email": { "type": "string", "required": true, "writeOnly": true, "description": "E-mail", "example": "nome@example.com" } } }, "letter_owner": { "type": "object", "description": "Responsável pela carta", "nullable": true, "example": { "name": "Margret Santos Cartas", "phone_number": "2130030386", "email": "carta@example.com" }, "properties": { "name": { "type": "string", "required": true, "description": "Nome", "example": "Margret Santos Cartas" }, "phone_number": { "type": "string", "required": true, "writeOnly": true, "description": "Número de telefone (com DDD)", "example": "2130030386" }, "email": { "type": "string", "required": true, "writeOnly": true, "description": "E-mail", "example": "nome@example.com" } } }, "business_logo": { "type": "string", "format": "base64", "description": "Logo da Empresa. A imagem deve ser menor que 500KB ter 150x150 pixels e estar no formato base64 JPG ou PNG.", "example": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAFwF..." }, "letter_pdf": { "type": "string", "nullable": true, "readOnly": true, "description": "URL para download do PDF da carta" }, "letter_creation_errors": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true, "description": "Erros de validação na geração da carta EDI (ex: campos obrigatórios ausentes)" }, "letter_status": { "type": "string", "readOnly": true, "description": "Status do PDF da carta na Kobana:\n* `not_created` Não criada\n* `creating` Criando\n* `created` Criada" }, "status": { "type": "string", "nullable": true, "readOnly": true, "description": "Status da caixa postal:\n* `generated` Carta gerada\n* `demand_received` Demanda recepcionada\n* `confirming_at_bank` Aguardando confirmação do banco\n* `testing_by_customer` Aguardando teste do cliente\n* `waiting_for_validations` Aguardando validações\n* `activated` Caixa postal ativada" }, "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID da caixa postal", "example": "012ab34c-d567-8901-234e-5fghi6j789k0" }, "enabled_at": { "type": "string", "nullable": true, "format": "date-time", "readOnly": true, "description": "Data e hora de habilitação da caixa postal" }, "validated_at": { "type": "string", "nullable": true, "format": "date-time", "readOnly": true, "description": "Data e hora de validação da caixa postal" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do registro" } } }, "data": { "type": "object", "required": [], "properties": { "resource": { "type": "object", "description": "Recurso associado à caixa postal", "required": [ "type", "uid" ], "example": { "type": "financial.account", "uid": "01948afe-3014-7e81-9a88-badcfc1fd4d6" }, "properties": { "type": { "type": "string", "example": "financial.account", "description": "Tipo do Recurso\n\n`charge.bank_billet_account`: Carteira de Cobrança\n`financial.account`: Conta Financeira\n" }, "uid": { "type": "string", "description": "UID do recurso", "example": "01948afe-3014-7e81-9a88-badcfc1fd4d6" } } }, "name": { "type": "string", "nullable": true, "description": "Nome de identificação da caixa postal" }, "operation": { "type": "string", "enum": [ "charge", "statement", "payment" ], "description": "Tipo de operação que será trafegada na caixa postal\n\n`charge`: Cobrança\n`statement`: Extrato\n`payment`: Pagamento\n\nAlterar este campo (ou `resource`) via `PUT` só é permitido quando a caixa\npostal está marcada como `editable: true`; caso contrário, retorna 422.\n" }, "kind": { "type": "string", "enum": [ "cnab400", "cnab240", "cnab200" ], "description": "Formato do arquivo CNAB que será trafegado na caixa postal\n\n`cnab400`: CNAB 400\n`cnab240`: CNAB 240\n`cnab200`: CNAB 200\n" }, "account_owner": { "type": "object", "description": "Proprietário da conta", "example": { "name": "Margret Santos Contas", "document_number": "16.974.923/0001-84", "phone_number": "2130030386", "email": "conta@example.com" }, "properties": { "name": { "type": "string", "required": true, "description": "Nome", "example": "Margret Santos Contas" }, "document_number": { "type": "string", "required": true, "description": "Número do documento", "example": "16.974.923/0001-84" }, "phone_number": { "type": "string", "required": true, "writeOnly": true, "description": "Número de telefone (com DDD)", "example": "2130030386" }, "email": { "type": "string", "required": true, "writeOnly": true, "description": "E-mail", "example": "nome@example.com" } } }, "bank_manager": { "type": "object", "description": "Gerente do banco", "example": { "name": "Margret Santos Bancos", "email": "banco@example.com", "phone_number": "11988888888" }, "properties": { "name": { "type": "string", "required": true, "description": "Nome", "example": "Margret Santos Bancos" }, "phone_number": { "type": "string", "required": true, "writeOnly": true, "description": "Número de telefone (com DDD)", "example": "2130030386" }, "email": { "type": "string", "required": true, "writeOnly": true, "description": "E-mail", "example": "nome@example.com" } } }, "letter_owner": { "type": "object", "description": "Responsável pela carta", "nullable": true, "example": { "name": "Margret Santos Cartas", "phone_number": "2130030386", "email": "carta@example.com" }, "properties": { "name": { "type": "string", "required": true, "description": "Nome", "example": "Margret Santos Cartas" }, "phone_number": { "type": "string", "required": true, "writeOnly": true, "description": "Número de telefone (com DDD)", "example": "2130030386" }, "email": { "type": "string", "required": true, "writeOnly": true, "description": "E-mail", "example": "nome@example.com" } } }, "business_logo": { "type": "string", "format": "base64", "description": "Logo da Empresa. A imagem deve ser menor que 500KB ter 150x150 pixels e estar no formato base64 JPG ou PNG.", "example": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAFwF..." }, "letter_pdf": { "type": "string", "nullable": true, "readOnly": true, "description": "URL para download do PDF da carta" }, "letter_creation_errors": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true, "description": "Erros de validação na geração da carta EDI (ex: campos obrigatórios ausentes)" }, "letter_status": { "type": "string", "readOnly": true, "description": "Status do PDF da carta na Kobana:\n* `not_created` Não criada\n* `creating` Criando\n* `created` Criada" }, "status": { "type": "string", "nullable": true, "readOnly": true, "description": "Status da caixa postal:\n* `generated` Carta gerada\n* `demand_received` Demanda recepcionada\n* `confirming_at_bank` Aguardando confirmação do banco\n* `testing_by_customer` Aguardando teste do cliente\n* `waiting_for_validations` Aguardando validações\n* `activated` Caixa postal ativada" }, "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID da caixa postal", "example": "012ab34c-d567-8901-234e-5fghi6j789k0" }, "enabled_at": { "type": "string", "nullable": true, "format": "date-time", "readOnly": true, "description": "Data e hora de habilitação da caixa postal" }, "validated_at": { "type": "string", "nullable": true, "format": "date-time", "readOnly": true, "description": "Data e hora de validação da caixa postal" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação do registro" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização do registro" } } } }, "v2_access_token": { "type": "object", "properties": { "uid": { "type": "string", "description": "UID público do token", "example": "acc_1234567890" }, "external_id": { "type": [ "string", "null" ], "description": "ID externo do token", "example": "ext_1234567890" }, "description": { "type": [ "string", "null" ], "description": "Descrição do token", "example": "My API Token" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "Escopos de acesso do token", "example": [ "all", "read" ] }, "source": { "type": "string", "description": "Origem do token (system, user, api)", "example": "user" }, "purpose": { "type": [ "string", "null" ], "description": "Propósito do token", "example": "general" }, "expires_in": { "type": "integer", "description": "Tempo de expiração em segundos", "example": 15552000 }, "expires_at": { "type": "string", "format": "date", "description": "Data de expiração", "example": "2024-12-31" }, "version": { "type": "integer", "description": "Versão do token", "example": 2 }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags do token", "example": [ "production", "api" ] }, "custom_data": { "type": [ "object", "null" ], "description": "Dados customizados" }, "warning_flags": { "type": "array", "items": { "type": "string" }, "description": "Flags de aviso" }, "reminder_emails": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "tech@example.com" }, "label": { "type": "string", "example": "Tech Team" } } }, "description": "E-mails para notificações de expiração" }, "created_at": { "type": "string", "format": "date", "description": "Data de criação", "example": "2024-01-01" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "description": "Usuário que criou" }, "updated_at": { "type": "string", "format": "date", "description": "Data de atualização" }, "updated_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "description": "Usuário que atualizou" }, "enabled_at": { "type": [ "string", "null" ], "format": "date", "description": "Data de habilitação" }, "enabled_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "description": "Usuário que habilitou" }, "disabled_at": { "type": [ "string", "null" ], "format": "date", "description": "Data de desabilitação" }, "disabled_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "description": "Usuário que desabilitou" }, "revoked_at": { "type": [ "string", "null" ], "format": "date", "description": "Data de revogação" }, "revoked_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "description": "Usuário que revogou" }, "last_used_at": { "type": [ "string", "null" ], "format": "date", "description": "Data do último uso" } } }, "v2_access_token_with_token": { "type": "object", "properties": { "uid": { "type": "string", "description": "UID público do token", "example": "acc_1234567890" }, "external_id": { "type": [ "string", "null" ], "description": "ID externo do token", "example": "ext_1234567890" }, "description": { "type": [ "string", "null" ], "description": "Descrição do token", "example": "My API Token" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "Escopos de acesso do token", "example": [ "all", "read" ] }, "source": { "type": "string", "description": "Origem do token (system, user, api)", "example": "user" }, "purpose": { "type": [ "string", "null" ], "description": "Propósito do token", "example": "general" }, "expires_in": { "type": "integer", "description": "Tempo de expiração em segundos", "example": 15552000 }, "expires_at": { "type": "string", "format": "date", "description": "Data de expiração", "example": "2024-12-31" }, "version": { "type": "integer", "description": "Versão do token", "example": 2 }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags do token", "example": [ "production", "api" ] }, "custom_data": { "type": [ "object", "null" ], "description": "Dados customizados" }, "warning_flags": { "type": "array", "items": { "type": "string" }, "description": "Flags de aviso" }, "reminder_emails": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "tech@example.com" }, "label": { "type": "string", "example": "Tech Team" } } }, "description": "E-mails para notificações de expiração" }, "created_at": { "type": "string", "format": "date", "description": "Data de criação", "example": "2024-01-01" }, "created_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "description": "Usuário que criou" }, "updated_at": { "type": "string", "format": "date", "description": "Data de atualização" }, "updated_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "description": "Usuário que atualizou" }, "enabled_at": { "type": [ "string", "null" ], "format": "date", "description": "Data de habilitação" }, "enabled_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "description": "Usuário que habilitou" }, "disabled_at": { "type": [ "string", "null" ], "format": "date", "description": "Data de desabilitação" }, "disabled_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "description": "Usuário que desabilitou" }, "revoked_at": { "type": [ "string", "null" ], "format": "date", "description": "Data de revogação" }, "revoked_by": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "description": "Usuário que revogou" }, "last_used_at": { "type": [ "string", "null" ], "format": "date", "description": "Data do último uso" }, "token": { "type": "string", "description": "Token de acesso (apenas retornado em create e renew)", "example": "sk_live_1234567890abcdef" } } }, "v2_access_token_create": { "type": "object", "properties": { "external_id": { "type": "string", "description": "ID externo do token", "example": "ext_1234567890" }, "description": { "type": "string", "description": "Descrição do token", "example": "My API Token", "maxLength": 100 }, "scope_type": { "type": "string", "description": "Tipo de escopo: Todos (all) ou Limitado (limited)", "example": "all", "enum": [ "all", "limited" ] }, "limited_scopes": { "type": "array", "description": "Escopos disponíveis (quando scope_type = limited). Selecione um ou mais valores:\n\n| Escopo | Descrição |\n|--------|-----------|\n| `admin.subaccounts` | Gerenciar subcontas da conta principal |\n| `admin.users` | Gerenciar usuários e permissões |\n| `automation.email_accounts` | Gerenciar contas de e-mail para automação |\n| `automation.email_deliveries` | Visualizar e gerenciar envios de e-mail |\n| `automation.sms_accounts` | Gerenciar contas de SMS |\n| `automation.sms_deliveries` | Visualizar e gerenciar envios de SMS |\n| `automation.webhook_deliveries` | Visualizar e gerenciar entregas de webhooks |\n| `automation.webhooks` | Gerenciar webhooks e notificações automatizadas |\n| `billing.transactions` | Visualizar transações de cobrança e faturamento |\n| `charge.automatic_pix.locations` | Gerenciar localizações de Pix automático |\n| `charge.automatic_pix.pix` | Gerenciar cobranças Pix automáticas |\n| `charge.automatic_pix.recurrences` | Gerenciar recorrências de Pix automático |\n| `charge.automatic_pix.requests` | Gerenciar solicitações de Pix automático |\n| `charge.bank_billet_accounts` | Gerenciar contas de boletos bancários |\n| `charge.bank_billet_payments` | Visualizar e registrar pagamentos de boletos |\n| `charge.bank_billet_registrations` | Gerenciar registros de boletos nos bancos |\n| `charge.bank_billets` | Gerenciar boletos bancários |\n| `charge.customer_subscriptions` | Gerenciar assinaturas de clientes |\n| `charge.installments` | Gerenciar parcelamentos |\n| `charge.payments` | Visualizar e gerenciar pagamentos recebidos |\n| `charge.pix` | Gerenciar cobranças Pix |\n| `charge.pix_accounts` | Gerenciar contas Pix |\n| `core.providers` | Visualizar provedores disponíveis |\n| `crm.customers` | Gerenciar clientes e informações comerciais |\n| `crm.people` | Gerenciar pessoas e contatos |\n| `data.bank_billet_queries` | Consultar informações de boletos bancários |\n| `financial.accounts` | Gerenciar contas financeiras |\n| `financial.balances` | Visualizar saldos e movimentações financeiras |\n| `financial.providers` | Gerenciar provedores financeiros e integrações bancárias |\n| `financial.statement_transactions` | Visualizar transações e extratos financeiros |\n| `integration.certificates` | Gerenciar certificados digitais para integrações |\n| `integration.connections` | Gerenciar conexões com bancos e provedores |\n| `integration.discharges` | Gerenciar arquivos de retorno bancário (baixas) |\n| `integration.edi_boxes` | Gerenciar caixas postais EDI para troca de arquivos |\n| `integration.remittances` | Gerenciar arquivos de remessa bancária |\n| `mailbox.entries` | Gerenciar caixas postais para recebimento de arquivos |\n| `mailbox.files` | Visualizar e gerenciar arquivos nas caixas postais |\n| `partner.bank_contracts` | Gerenciar contratos bancários com parceiros |\n| `payment.accounts` | Gerenciar contas de pagamento (incluindo habilitação de remessa EDI) |\n| `payment.bank_billets` | Efetuar pagamentos de boletos bancários |\n| `payment.batches` | Gerenciar lotes de pagamentos |\n| `payment.dda_accounts` | Gerenciar contas DDA |\n| `payment.dda.bank_billets` | Gerenciar boletos DDA |\n| `payment.darfs` | Efetuar pagamentos de DARFs (tributos federais) |\n| `payment.payments` | Gerenciar todos os tipos de pagamentos através da API |\n| `payment.pix` | Efetuar pagamentos via Pix |\n| `payment.taxes` | Efetuar pagamentos de impostos e taxas |\n| `payment.utilities` | Efetuar pagamentos de contas de consumo (água, luz, etc) |\n| `security.access_tokens` | Gerenciar tokens de acesso e autenticação |\n| `system.events` | Visualizar eventos e logs do sistema |\n| `system.imports` | Gerenciar importações de dados |\n| `system.reports` | Gerar e visualizar relatórios do sistema |\n| `transfer.accounts` | Gerenciar contas de transferência (incluindo habilitação de remessa EDI) |\n| `transfer.batches` | Gerenciar lotes de transferências |\n| `transfer.internal` | Realizar transferências internas entre contas |\n| `transfer.pix` | Realizar transferências via Pix |\n| `transfer.ted` | Realizar transferências TED |\n| `transfer.transfers` | Gerenciar todos os tipos de transferências (Pix, TED, Internas) via endpoint unificado |\n", "example": [ "charge.bank_billets", "charge.pix" ], "items": { "type": "string", "enum": [ "admin.subaccounts", "admin.users", "automation.email_accounts", "automation.email_deliveries", "automation.sms_accounts", "automation.sms_deliveries", "automation.webhook_deliveries", "automation.webhooks", "billing.transactions", "charge.automatic_pix.locations", "charge.automatic_pix.pix", "charge.automatic_pix.recurrences", "charge.automatic_pix.requests", "charge.bank_billet_accounts", "charge.bank_billet_payments", "charge.bank_billet_registrations", "charge.bank_billets", "charge.customer_subscriptions", "charge.installments", "charge.payments", "charge.pix", "charge.pix_accounts", "core.providers", "crm.customers", "crm.people", "data.bank_billet_queries", "financial.accounts", "financial.balances", "financial.providers", "financial.statement_transactions", "integration.certificates", "integration.connections", "integration.discharges", "integration.edi_boxes", "integration.remittances", "mailbox.entries", "mailbox.files", "partner.bank_contracts", "payment.accounts", "payment.bank_billets", "payment.batches", "payment.dda_accounts", "payment.dda.bank_billets", "payment.darfs", "payment.payments", "payment.pix", "payment.taxes", "payment.utilities", "security.access_tokens", "system.events", "system.imports", "system.reports", "transfer.accounts", "transfer.batches", "transfer.internal", "transfer.pix", "transfer.ted", "transfer.transfers" ] } }, "access_type": { "type": "string", "description": "Tipo de acesso: Leitura (read) ou Leitura e escrita (write)", "example": "read", "enum": [ "read", "write" ] }, "expires_at": { "type": "string", "format": "date", "description": "Data de expiração (máximo 1 ano). Obrigatório quando access_type = write", "example": "2024-12-31" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags do token", "example": [ "production", "api" ] }, "custom_data": { "type": "object", "description": "Dados customizados", "example": { "key": "value" } }, "reminder_emails": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "tech@example.com" }, "label": { "type": "string", "example": "Tech Team" } } }, "description": "E-mails para notificações de expiração. Obrigatório quando expires_at é definido." } } }, "v2_access_token_update": { "type": "object", "properties": { "external_id": { "type": "string", "description": "ID externo do token", "example": "ext_1234567890" }, "description": { "type": "string", "description": "Descrição do token", "example": "Updated Token", "maxLength": 100 }, "scope_type": { "type": "string", "description": "Tipo de escopo (all ou limited)", "example": "all", "enum": [ "all", "limited" ] }, "limited_scopes": { "type": "array", "description": "Escopos disponíveis (quando scope_type = limited). Selecione um ou mais valores:\n\n| Escopo | Descrição |\n|--------|-----------|\n| `admin.subaccounts` | Gerenciar subcontas da conta principal |\n| `admin.users` | Gerenciar usuários e permissões |\n| `automation.email_accounts` | Gerenciar contas de e-mail para automação |\n| `automation.email_deliveries` | Visualizar e gerenciar envios de e-mail |\n| `automation.sms_accounts` | Gerenciar contas de SMS |\n| `automation.sms_deliveries` | Visualizar e gerenciar envios de SMS |\n| `automation.webhook_deliveries` | Visualizar e gerenciar entregas de webhooks |\n| `automation.webhooks` | Gerenciar webhooks e notificações automatizadas |\n| `billing.transactions` | Visualizar transações de cobrança e faturamento |\n| `charge.automatic_pix.locations` | Gerenciar localizações de Pix automático |\n| `charge.automatic_pix.pix` | Gerenciar cobranças Pix automáticas |\n| `charge.automatic_pix.recurrences` | Gerenciar recorrências de Pix automático |\n| `charge.automatic_pix.requests` | Gerenciar solicitações de Pix automático |\n| `charge.bank_billet_accounts` | Gerenciar contas de boletos bancários |\n| `charge.bank_billet_payments` | Visualizar e registrar pagamentos de boletos |\n| `charge.bank_billet_registrations` | Gerenciar registros de boletos nos bancos |\n| `charge.bank_billets` | Gerenciar boletos bancários |\n| `charge.customer_subscriptions` | Gerenciar assinaturas de clientes |\n| `charge.installments` | Gerenciar parcelamentos |\n| `charge.payments` | Visualizar e gerenciar pagamentos recebidos |\n| `charge.pix` | Gerenciar cobranças Pix |\n| `charge.pix_accounts` | Gerenciar contas Pix |\n| `core.providers` | Visualizar provedores disponíveis |\n| `crm.customers` | Gerenciar clientes e informações comerciais |\n| `crm.people` | Gerenciar pessoas e contatos |\n| `data.bank_billet_queries` | Consultar informações de boletos bancários |\n| `financial.accounts` | Gerenciar contas financeiras |\n| `financial.balances` | Visualizar saldos e movimentações financeiras |\n| `financial.providers` | Gerenciar provedores financeiros e integrações bancárias |\n| `financial.statement_transactions` | Visualizar transações e extratos financeiros |\n| `integration.certificates` | Gerenciar certificados digitais para integrações |\n| `integration.connections` | Gerenciar conexões com bancos e provedores |\n| `integration.discharges` | Gerenciar arquivos de retorno bancário (baixas) |\n| `integration.edi_boxes` | Gerenciar caixas postais EDI para troca de arquivos |\n| `integration.remittances` | Gerenciar arquivos de remessa bancária |\n| `mailbox.entries` | Gerenciar caixas postais para recebimento de arquivos |\n| `mailbox.files` | Visualizar e gerenciar arquivos nas caixas postais |\n| `partner.bank_contracts` | Gerenciar contratos bancários com parceiros |\n| `payment.accounts` | Gerenciar contas de pagamento (incluindo habilitação de remessa EDI) |\n| `payment.bank_billets` | Efetuar pagamentos de boletos bancários |\n| `payment.batches` | Gerenciar lotes de pagamentos |\n| `payment.dda_accounts` | Gerenciar contas DDA |\n| `payment.dda.bank_billets` | Gerenciar boletos DDA |\n| `payment.darfs` | Efetuar pagamentos de DARFs (tributos federais) |\n| `payment.payments` | Gerenciar todos os tipos de pagamentos através da API |\n| `payment.pix` | Efetuar pagamentos via Pix |\n| `payment.taxes` | Efetuar pagamentos de impostos e taxas |\n| `payment.utilities` | Efetuar pagamentos de contas de consumo (água, luz, etc) |\n| `security.access_tokens` | Gerenciar tokens de acesso e autenticação |\n| `system.events` | Visualizar eventos e logs do sistema |\n| `system.imports` | Gerenciar importações de dados |\n| `system.reports` | Gerar e visualizar relatórios do sistema |\n| `transfer.accounts` | Gerenciar contas de transferência (incluindo habilitação de remessa EDI) |\n| `transfer.batches` | Gerenciar lotes de transferências |\n| `transfer.internal` | Realizar transferências internas entre contas |\n| `transfer.pix` | Realizar transferências via Pix |\n| `transfer.ted` | Realizar transferências TED |\n| `transfer.transfers` | Gerenciar todos os tipos de transferências (Pix, TED, Internas) via endpoint unificado |\n", "example": [ "charge.bank_billets", "charge.pix" ], "items": { "type": "string", "enum": [ "admin.subaccounts", "admin.users", "automation.email_accounts", "automation.email_deliveries", "automation.sms_accounts", "automation.sms_deliveries", "automation.webhook_deliveries", "automation.webhooks", "billing.transactions", "charge.automatic_pix.locations", "charge.automatic_pix.pix", "charge.automatic_pix.recurrences", "charge.automatic_pix.requests", "charge.bank_billet_accounts", "charge.bank_billet_payments", "charge.bank_billet_registrations", "charge.bank_billets", "charge.customer_subscriptions", "charge.installments", "charge.payments", "charge.pix", "charge.pix_accounts", "core.providers", "crm.customers", "crm.people", "data.bank_billet_queries", "financial.accounts", "financial.balances", "financial.providers", "financial.statement_transactions", "integration.certificates", "integration.connections", "integration.discharges", "integration.edi_boxes", "integration.remittances", "mailbox.entries", "mailbox.files", "partner.bank_contracts", "payment.accounts", "payment.bank_billets", "payment.batches", "payment.dda_accounts", "payment.dda.bank_billets", "payment.darfs", "payment.payments", "payment.pix", "payment.taxes", "payment.utilities", "security.access_tokens", "system.events", "system.imports", "system.reports", "transfer.accounts", "transfer.batches", "transfer.internal", "transfer.pix", "transfer.ted", "transfer.transfers" ] } }, "access_type": { "type": "string", "description": "Tipo de acesso", "example": "read", "enum": [ "read", "write" ] }, "expires_at": { "type": "string", "format": "date", "description": "Data de expiração (máximo 1 ano). **Atenção:** Só pode ser definida se ainda não estava definida. Uma vez definida, não pode mais ser alterada.", "example": "2024-12-31" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags do token", "example": [ "production", "api" ] }, "custom_data": { "type": "object", "description": "Dados customizados", "example": { "key": "value" } }, "reminder_emails": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "example": "tech@example.com" }, "label": { "type": "string", "example": "Tech Team" } } }, "description": "E-mails para notificações de expiração" } } }, "v2_mailbox_entry": { "data": { "type": "object", "required": [], "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID único da entrada de mailbox", "example": "012ab34c-d567-8901-234e-5fghi6j789k0" }, "slug": { "type": "string", "description": "Identificador único amigável da entrada", "example": "minha-caixa-postal" }, "name": { "type": "string", "description": "Nome de exibição da entrada", "example": "Minha Caixa Postal" }, "kind": { "type": "string", "enum": [ "document", "import_export", "edi_cnab" ], "description": "Tipo da entrada de mailbox:\n`document`: Documentos\n`import_export`: Importação/Exportação\n`edi_cnab`: EDI/CNAB" }, "send_encrypted": { "type": "boolean", "description": "Se os arquivos enviados devem ser criptografados" }, "send_encryption_public_key": { "type": "string", "nullable": true, "description": "Chave pública PEM para criptografia de envio" }, "receive_encrypted": { "type": "boolean", "description": "Se os arquivos recebidos estão criptografados" }, "receive_encryption_keypair_id": { "type": "string", "nullable": true, "description": "UID do keypair para descriptografia de recebimento" }, "active_channels": { "type": "array", "items": { "type": "string" }, "readOnly": true, "description": "Lista de canais ativos (api, email, s3, sftp, whatsapp, syncthing)" }, "channels": { "type": "object", "readOnly": true, "description": "Configurações dos canais ativos" }, "processed": { "type": "array", "items": { "type": "string" }, "readOnly": true, "description": "Lista de tipos de processamento configurados" }, "external_id": { "type": "string", "nullable": true, "description": "Identificador externo para integração" }, "custom_data": { "type": "object", "nullable": true, "description": "Dados customizados em formato JSON" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags para categorização" }, "created_via_api": { "type": "boolean", "readOnly": true, "description": "Se o registro foi criado via API" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização" } } }, "create": { "type": "object", "required": [ "kind", "name" ], "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID único da entrada de mailbox", "example": "012ab34c-d567-8901-234e-5fghi6j789k0" }, "slug": { "type": "string", "description": "Identificador único amigável da entrada", "example": "minha-caixa-postal" }, "name": { "type": "string", "description": "Nome de exibição da entrada", "example": "Minha Caixa Postal" }, "kind": { "type": "string", "enum": [ "document", "import_export", "edi_cnab" ], "description": "Tipo da entrada de mailbox:\n`document`: Documentos\n`import_export`: Importação/Exportação\n`edi_cnab`: EDI/CNAB" }, "send_encrypted": { "type": "boolean", "description": "Se os arquivos enviados devem ser criptografados" }, "send_encryption_public_key": { "type": "string", "nullable": true, "description": "Chave pública PEM para criptografia de envio" }, "receive_encrypted": { "type": "boolean", "description": "Se os arquivos recebidos estão criptografados" }, "receive_encryption_keypair_id": { "type": "string", "nullable": true, "description": "UID do keypair para descriptografia de recebimento" }, "active_channels": { "type": "array", "items": { "type": "string" }, "readOnly": true, "description": "Lista de canais ativos (api, email, s3, sftp, whatsapp, syncthing)" }, "channels": { "type": "object", "readOnly": true, "description": "Configurações dos canais ativos" }, "external_id": { "type": "string", "nullable": true, "description": "Identificador externo para integração" }, "custom_data": { "type": "object", "nullable": true, "description": "Dados customizados em formato JSON" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags para categorização" }, "created_via_api": { "type": "boolean", "readOnly": true, "description": "Se o registro foi criado via API" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização" } } }, "update": { "type": "object", "required": [], "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID único da entrada de mailbox", "example": "012ab34c-d567-8901-234e-5fghi6j789k0" }, "slug": { "type": "string", "description": "Identificador único amigável da entrada", "example": "minha-caixa-postal" }, "name": { "type": "string", "description": "Nome de exibição da entrada", "example": "Minha Caixa Postal" }, "kind": { "type": "string", "enum": [ "document", "import_export", "edi_cnab" ], "description": "Tipo da entrada de mailbox:\n`document`: Documentos\n`import_export`: Importação/Exportação\n`edi_cnab`: EDI/CNAB" }, "send_encrypted": { "type": "boolean", "description": "Se os arquivos enviados devem ser criptografados" }, "send_encryption_public_key": { "type": "string", "nullable": true, "description": "Chave pública PEM para criptografia de envio" }, "receive_encrypted": { "type": "boolean", "description": "Se os arquivos recebidos estão criptografados" }, "receive_encryption_keypair_id": { "type": "string", "nullable": true, "description": "UID do keypair para descriptografia de recebimento" }, "active_channels": { "type": "array", "items": { "type": "string" }, "readOnly": true, "description": "Lista de canais ativos (api, email, s3, sftp, whatsapp, syncthing)" }, "channels": { "type": "object", "readOnly": true, "description": "Configurações dos canais ativos" }, "external_id": { "type": "string", "nullable": true, "description": "Identificador externo para integração" }, "custom_data": { "type": "object", "nullable": true, "description": "Dados customizados em formato JSON" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags para categorização" }, "created_via_api": { "type": "boolean", "readOnly": true, "description": "Se o registro foi criado via API" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização" } } } }, "v2_mailbox_file": { "data": { "type": "object", "required": [], "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID único do arquivo", "example": "012ab34c-d567-8901-234e-5fghi6j789k0" }, "mailbox_entry_id": { "type": "string", "nullable": true, "readOnly": true, "description": "UID da entrada de mailbox associada" }, "kind": { "type": "string", "readOnly": true, "enum": [ "received", "sent" ], "description": "Direção do arquivo:\n`received`: Arquivo recebido (inbox)\n`sent`: Arquivo enviado (outbox)" }, "name": { "type": "string", "description": "Nome do arquivo", "example": "remessa.txt" }, "size": { "type": "integer", "nullable": true, "readOnly": true, "description": "Tamanho do arquivo em bytes" }, "mime_type": { "type": "string", "nullable": true, "readOnly": true, "description": "Tipo MIME do arquivo" }, "external_id": { "type": "string", "nullable": true, "description": "Identificador externo para integração" }, "custom_data": { "type": "object", "nullable": true, "description": "Dados customizados em formato JSON" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags para categorização" }, "created_via_api": { "type": "boolean", "readOnly": true, "description": "Se o registro foi criado via API" }, "uploaded_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de upload do arquivo" }, "processed_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de processamento do arquivo" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização" } } }, "create": { "type": "object", "required": [ "name" ], "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID único do arquivo", "example": "012ab34c-d567-8901-234e-5fghi6j789k0" }, "mailbox_entry_id": { "type": "string", "nullable": true, "readOnly": true, "description": "UID da entrada de mailbox associada" }, "kind": { "type": "string", "readOnly": true, "enum": [ "received", "sent" ], "description": "Direção do arquivo:\n`received`: Arquivo recebido (inbox)\n`sent`: Arquivo enviado (outbox)" }, "content_base64": { "type": "string", "description": "Conteúdo do arquivo codificado em Base64" }, "content_filename": { "type": "string", "description": "Nome do arquivo para o conteúdo enviado em Base64", "example": "remessa.txt" }, "content_type": { "type": "string", "description": "Tipo MIME do conteúdo enviado em Base64", "example": "text/plain" }, "name": { "type": "string", "description": "Nome do arquivo", "example": "remessa.txt" }, "size": { "type": "integer", "nullable": true, "readOnly": true, "description": "Tamanho do arquivo em bytes" }, "mime_type": { "type": "string", "nullable": true, "readOnly": true, "description": "Tipo MIME do arquivo" }, "external_id": { "type": "string", "nullable": true, "description": "Identificador externo para integração" }, "custom_data": { "type": "object", "nullable": true, "description": "Dados customizados em formato JSON" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags para categorização" }, "created_via_api": { "type": "boolean", "readOnly": true, "description": "Se o registro foi criado via API" }, "uploaded_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de upload do arquivo" }, "processed_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de processamento do arquivo" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização" } } }, "update": { "type": "object", "required": [], "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID único do arquivo", "example": "012ab34c-d567-8901-234e-5fghi6j789k0" }, "mailbox_entry_id": { "type": "string", "nullable": true, "readOnly": true, "description": "UID da entrada de mailbox associada" }, "kind": { "type": "string", "readOnly": true, "enum": [ "received", "sent" ], "description": "Direção do arquivo:\n`received`: Arquivo recebido (inbox)\n`sent`: Arquivo enviado (outbox)" }, "name": { "type": "string", "description": "Nome do arquivo", "example": "remessa.txt" }, "size": { "type": "integer", "nullable": true, "readOnly": true, "description": "Tamanho do arquivo em bytes" }, "mime_type": { "type": "string", "nullable": true, "readOnly": true, "description": "Tipo MIME do arquivo" }, "external_id": { "type": "string", "nullable": true, "description": "Identificador externo para integração" }, "custom_data": { "type": "object", "nullable": true, "description": "Dados customizados em formato JSON" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags para categorização" }, "created_via_api": { "type": "boolean", "readOnly": true, "description": "Se o registro foi criado via API" }, "uploaded_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de upload do arquivo" }, "processed_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de processamento do arquivo" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização" } } } }, "v2_mailbox_email_channel": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID único do canal", "example": "012ab34c-d567-8901-234e-5fghi6j789k0" }, "mailbox_entry": { "type": "object", "nullable": true, "readOnly": true, "description": "Entrada de mailbox associada ao canal" }, "status": { "type": "string", "readOnly": true, "description": "Status do canal" }, "external_id": { "type": "string", "nullable": true, "description": "Identificador externo para integração" }, "custom_data": { "type": "object", "nullable": true, "description": "Dados customizados em formato JSON" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags para categorização" }, "created_via_api": { "type": "boolean", "readOnly": true, "description": "Se o registro foi criado via API" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização" }, "inbox_emails": { "type": "array", "readOnly": true, "description": "Lista de endereços de e-mail de entrada", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Endereço de e-mail", "example": "entrada@empresa.com" }, "label": { "type": "string", "nullable": true, "description": "Rótulo do endereço" } } } }, "outbox_emails": { "type": "array", "readOnly": true, "description": "Lista de endereços de e-mail de saída", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Endereço de e-mail", "example": "saida@empresa.com" }, "label": { "type": "string", "nullable": true, "description": "Rótulo do endereço" } } } } } }, "v2_mailbox_s3_channel": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID único do canal", "example": "012ab34c-d567-8901-234e-5fghi6j789k0" }, "mailbox_entry": { "type": "object", "nullable": true, "readOnly": true, "description": "Entrada de mailbox associada ao canal" }, "status": { "type": "string", "readOnly": true, "description": "Status do canal" }, "external_id": { "type": "string", "nullable": true, "description": "Identificador externo para integração" }, "custom_data": { "type": "object", "nullable": true, "description": "Dados customizados em formato JSON" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags para categorização" }, "created_via_api": { "type": "boolean", "readOnly": true, "description": "Se o registro foi criado via API" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização" }, "connection": { "type": "object", "readOnly": true, "description": "Dados de conexão ao S3 via Cognito", "properties": { "identity_pool_id": { "type": "string", "description": "ID do Identity Pool do Cognito" }, "user_pool_id": { "type": "string", "description": "ID do User Pool do Cognito" }, "client_id": { "type": "string", "description": "Client ID do Cognito" }, "username": { "type": "string", "nullable": true, "description": "Nome de usuário no Cognito" }, "region": { "type": "string", "description": "Região AWS do bucket S3" }, "bucket": { "type": "string", "description": "Nome do bucket S3" }, "inbox_path": { "type": "string", "nullable": true, "description": "Caminho da pasta de entrada no bucket S3" }, "outbox_path": { "type": "string", "nullable": true, "description": "Caminho da pasta de saída no bucket S3" } } } } }, "v2_mailbox_sftp_channel": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID único do canal", "example": "012ab34c-d567-8901-234e-5fghi6j789k0" }, "mailbox_entry": { "type": "object", "nullable": true, "readOnly": true, "description": "Entrada de mailbox associada ao canal" }, "status": { "type": "string", "readOnly": true, "description": "Status do canal" }, "external_id": { "type": "string", "nullable": true, "description": "Identificador externo para integração" }, "custom_data": { "type": "object", "nullable": true, "description": "Dados customizados em formato JSON" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags para categorização" }, "created_via_api": { "type": "boolean", "readOnly": true, "description": "Se o registro foi criado via API" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização" }, "key": { "type": "string", "nullable": true, "writeOnly": true, "description": "Chave privada SSH (write-only, nunca retornada na resposta)" }, "username": { "type": "string", "nullable": true, "description": "Nome de usuário SFTP" }, "host": { "type": "string", "nullable": true, "description": "Endereço do servidor SFTP" }, "port": { "type": "integer", "nullable": true, "description": "Porta do servidor SFTP" }, "inbox_path": { "type": "string", "nullable": true, "description": "Caminho da pasta de entrada no servidor SFTP" }, "outbox_path": { "type": "string", "nullable": true, "description": "Caminho da pasta de saída no servidor SFTP" } } }, "v2_mailbox_whatsapp_channel": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID único do canal", "example": "012ab34c-d567-8901-234e-5fghi6j789k0" }, "mailbox_entry": { "type": "object", "nullable": true, "readOnly": true, "description": "Entrada de mailbox associada ao canal" }, "status": { "type": "string", "readOnly": true, "description": "Status do canal" }, "external_id": { "type": "string", "nullable": true, "description": "Identificador externo para integração" }, "custom_data": { "type": "object", "nullable": true, "description": "Dados customizados em formato JSON" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags para categorização" }, "created_via_api": { "type": "boolean", "readOnly": true, "description": "Se o registro foi criado via API" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização" }, "inbox_phones": { "type": "array", "readOnly": true, "description": "Lista de telefones de entrada (WhatsApp)", "items": { "type": "object", "properties": { "country_code": { "type": "string", "description": "Código do país", "example": "55" }, "local_code": { "type": "string", "description": "Código de área (DDD)", "example": "21" }, "number": { "type": "string", "description": "Número do telefone", "example": "999999999" }, "complete": { "type": "string", "readOnly": true, "description": "Número completo formatado", "example": "+5521999999999" } } } }, "outbox_phones": { "type": "array", "readOnly": true, "description": "Lista de telefones de saída (WhatsApp)", "items": { "type": "object", "properties": { "country_code": { "type": "string", "description": "Código do país", "example": "55" }, "local_code": { "type": "string", "description": "Código de área (DDD)", "example": "21" }, "number": { "type": "string", "description": "Número do telefone", "example": "999999999" }, "complete": { "type": "string", "readOnly": true, "description": "Número completo formatado", "example": "+5521999999999" } } } }, "activation_token": { "type": "string", "nullable": true, "readOnly": true, "description": "Token de ativação (retornado apenas quando o canal está sendo ativado)" } } }, "v2_mailbox_syncthing_channel": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID único do canal", "example": "012ab34c-d567-8901-234e-5fghi6j789k0" }, "mailbox_entry": { "type": "object", "nullable": true, "readOnly": true, "description": "Entrada de mailbox associada ao canal" }, "status": { "type": "string", "readOnly": true, "description": "Status do canal" }, "external_id": { "type": "string", "nullable": true, "description": "Identificador externo para integração" }, "custom_data": { "type": "object", "nullable": true, "description": "Dados customizados em formato JSON" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags para categorização" }, "created_via_api": { "type": "boolean", "readOnly": true, "description": "Se o registro foi criado via API" }, "created_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora de criação" }, "updated_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true, "description": "Data e hora da última atualização" }, "name": { "type": "string", "nullable": true, "description": "Nome do dispositivo Syncthing" }, "device_id": { "type": "string", "nullable": true, "description": "Identificador do dispositivo Syncthing" }, "inbox_folder_id": { "type": "string", "nullable": true, "description": "ID da pasta de entrada no Syncthing" }, "outbox_folder_id": { "type": "string", "nullable": true, "description": "ID da pasta de saída no Syncthing" }, "server_status": { "type": "string", "readOnly": true, "enum": [ "connected", "disconnected", "updating", "error" ], "description": "Status do servidor Syncthing:\n`connected`: Conectado\n`disconnected`: Desconectado\n`updating`: Atualizando\n`error`: Erro" }, "error_message": { "type": "string", "nullable": true, "readOnly": true, "description": "Mensagem de erro quando o status é error" } } }, "v2_account": { "type": "object", "properties": { "id": { "type": "integer", "deprecated": true, "description": "ID da conta (deprecated, use uid)", "example": 123 }, "uid": { "type": "string", "description": "UID público da conta", "example": "acc_1234567890" }, "intercom_id": { "type": "integer", "description": "ID da conta usado para identificação no Intercom", "example": 123 }, "email": { "type": [ "string", "null" ], "format": "email", "description": "E-mail da conta", "example": "conta@example.com" }, "account_type": { "type": [ "string", "null" ], "description": "Tipo da conta", "example": "business" }, "gender": { "type": [ "string", "null" ], "description": "Gênero", "example": "male" }, "cpf": { "type": [ "string", "null" ], "description": "CPF", "example": "123.456.789-00" }, "business_name": { "type": [ "string", "null" ], "description": "Nome fantasia", "example": "Empresa LTDA" }, "business_legal_name": { "type": [ "string", "null" ], "description": "Razão social", "example": "Empresa LTDA ME" }, "business_cnpj": { "type": [ "string", "null" ], "description": "CNPJ", "example": "12.345.678/0001-90" }, "full_name": { "type": [ "string", "null" ], "description": "Nome completo", "example": "João Silva Santos" }, "nickname": { "type": [ "string", "null" ], "description": "Apelido da conta", "example": "Conta Principal" }, "parent_id": { "type": [ "integer", "null" ], "deprecated": true, "description": "ID da conta principal (deprecated, use parent_uid)", "example": 123 }, "parent_uid": { "type": [ "string", "null" ], "format": "uuid", "description": "UID da conta principal", "example": "acc_1234567890" }, "feature_flags": { "type": "array", "description": "Feature flags habilitadas para a conta", "items": { "type": "string" }, "example": [ "feature_1", "feature_2" ] } } } }, "securitySchemes": { "v1_bearerAuth": { "type": "http", "scheme": "bearer" }, "v2_bearerAuth": { "type": "http", "scheme": "bearer" } }, "parameters": { "v1_page": { "name": "page", "in": "query", "description": "number of page to start", "required": false, "schema": { "type": "integer", "format": "int32" } }, "v1_per_page": { "name": "per_page", "in": "query", "description": "max records to return", "required": false, "schema": { "type": "integer", "format": "int32" } } }, "responses": {} }, "tags": [ { "name": "Arquivos de Mailbox", "description": "Gerenciar Arquivos de Mailbox" }, { "name": "Assinaturas", "description": "Gerenciar assinaturas" }, { "name": "Boletos", "description": "Gerenciar boletos" }, { "name": "CNAB (Retorno)", "description": "CNAB (Retorno)" }, { "name": "Caixas Postais", "description": "Gerenciar Caixas Postais" }, { "name": "Canal Email", "description": "Gerenciar Canal de E-mail" }, { "name": "Canal S3", "description": "Gerenciar Canal S3" }, { "name": "Canal SFTP", "description": "Gerenciar Canal SFTP" }, { "name": "Canal Syncthing", "description": "Gerenciar Canal Syncthing" }, { "name": "Canal WhatsApp", "description": "Gerenciar Canal WhatsApp" }, { "name": "Carnês", "description": "Gerenciar carnês" }, { "name": "Carteiras de Cobrança", "description": "Gerenciar carteiras" }, { "name": "Certificado", "description": "Gerenciar Certificados" }, { "name": "Clientes", "description": "Gerenciar clientes" }, { "name": "Comando", "description": "Consulta de Comandos" }, { "name": "Conexões", "description": "Gerenciar Conexões" }, { "name": "Conta Pix", "description": "Gerenciar contas Pix" }, { "name": "Eventos", "description": "Eventos" }, { "name": "Histórico de SMS", "description": "Histórico de SMS" }, { "name": "Histórico de e-mails", "description": "Histórico de e-mails" }, { "name": "Histórico de webhooks", "description": "Histórico de webhooks" }, { "name": "Informações do Usuário", "description": "Obter informações do usuário autenticado" }, { "name": "Pix", "description": "Gerenciar cobranças via Pix" }, { "name": "Pix Automático - Cobrança", "description": "Gerenciar cobranças do Pix Automático" }, { "name": "Pix Automático - Conta", "description": "Gerenciar contas do Pix Automático" }, { "name": "Pix Automático - Location", "description": "Gerenciar locations do Pix Automático" }, { "name": "Pix Automático - Recorrência", "description": "Gerenciar recorrências do Pix Automático" }, { "name": "Pix Automático - Solicitação", "description": "Gerenciar solicitações do Pix Automático" }, { "name": "Recebimentos", "description": "Gerenciar pagamentos recebidos" }, { "name": "Subcontas", "description": "Gerenciar Subcontas" }, { "name": "Usuário", "description": "Usuário" }, { "name": "Usuário", "description": "Gerenciar Usuários" }, { "name": "Webhooks", "description": "Webhooks" }, { "name": "access_tokens", "description": "Gerenciar Tokens de Acesso" }, { "name": "contas-financeiras", "description": "Gerenciar Contas" }, { "name": "edi", "description": "Gerenciar EDI" }, { "name": "pagamentos", "description": "Gerenciar Pagamentos" }, { "name": "person", "description": "Gerenciar Pessoas" }, { "name": "transferencias", "description": "Gerenciar Transferências" } ] }