{ "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", "content": { "application/json": { "example": { "id": 2173, "uid": "01981b12-b790-7ca6-8521-38c3bdd41a0c", "bank_contract_slug": "bb-bs-18-19-7", "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 Instituição de Pagamento 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": "Bancoob/Sicoob 01 CC: 00003666-8 0229385", "kind": "cnab400", "beneficiary_address_street": "Av. Presidente Vargas", "remittance_disabled_at": "2025-07-18T09:07:48+08: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": "2025-07-18T09:07:49+08:00", "bolepix": { "pix_mode": 1, "pix_account_id": 796, "pix_account": { "id": 796, "uid": "01981b12-b7f8-7819-9b4e-1a566a6b80fa", "custom_name": "Bancoob/BB 01 CC: 00003666-8 0229385", "enabled_at": "2025-07-18T09:07:48+08:00", "financial_provider_slug": "bb", "key": "pix_key@email.com", "status": "pending", "default": false, "beneficiary": { "document_number": null, "name": "Kobana Instituição de Pagamento Ltda.", "address": { "zip_code": "20071004", "street": "Av. Presidente Vargas", "number": "633", "complement": "sala 1716", "neighborhood": "Centro", "city_name": "Rio de Janeiro", "state": "RJ" } }, "created_at": "2025-07-18T09:07:49+08:00", "updated_at": "2025-07-18T09:07:49+08:00" }, "pix_billing_options": null }, "bolepix_key": null, "allow_expiration_on_weekends": false, "created_at": "2025-07-18T09:07:49+08:00", "updated_at": "2025-07-18T09:07:49+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 2174, "uid": "01981b12-c2ec-78b3-bd3b-e94a1ea35ab3", "bank_contract_slug": "sicoob-01", "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": "123456789", "payment_place": "Pagável em qualquer banco até a data de vencimento.", "contract": "1", "contract_type": "1", "beneficiary_name": "Kobana Instituição de Pagamento Ltda.", "beneficiary_cnpj_cpf": "05.813.794/0001-26", "beneficiary_address": "Av. Presidente Vargas, 633, sala 1716, Centro, Rio de Janeiro, RJ, 20071004", "name": "Bancoob/Sicoob 01 CC: 3666-8 229385", "status": "pending", "bank_contract": { "bank": { "code": "sicoob", "name": "Bancoob/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": "Bancoob/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": 2, "pix_account_id": null, "pix_account": {}, "pix_billing_options": null }, "bolepix_key": null, "allow_expiration_on_weekends": false, "created_at": "2025-07-18T09:07:51+08:00", "updated_at": "2025-07-18T09:07:51+08:00" }, { "id": 2175, "uid": "01981b12-c32e-7237-ad9d-bc4e8f08b452", "bank_contract_slug": "sicoob-01", "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": "123456789", "payment_place": "Pagável em qualquer banco até a data de vencimento.", "contract": "1", "contract_type": "1", "beneficiary_name": "Kobana Instituição de Pagamento Ltda.", "beneficiary_cnpj_cpf": "05.813.794/0001-26", "beneficiary_address": "Av. Presidente Vargas, 633, sala 1716, Centro, Rio de Janeiro, RJ, 20071004", "name": "Bancoob/Sicoob 01 CC: 3666-8 229385", "status": "pending", "bank_contract": { "bank": { "code": "sicoob", "name": "Bancoob/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": "Bancoob/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": 2, "pix_account_id": null, "pix_account": {}, "pix_billing_options": null }, "bolepix_key": null, "allow_expiration_on_weekends": false, "created_at": "2025-07-18T09:07:51+08:00", "updated_at": "2025-07-18T09:07:51+08:00" }, { "id": 2176, "uid": "01981b12-c349-7893-be4a-e178f07e4c63", "bank_contract_slug": "sicoob-01", "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": "123456789", "payment_place": "Pagável em qualquer banco até a data de vencimento.", "contract": "1", "contract_type": "1", "beneficiary_name": "Kobana Instituição de Pagamento Ltda.", "beneficiary_cnpj_cpf": "05.813.794/0001-26", "beneficiary_address": "Av. Presidente Vargas, 633, sala 1716, Centro, Rio de Janeiro, RJ, 20071004", "name": "Bancoob/Sicoob 01 CC: 3666-8 229385", "status": "pending", "bank_contract": { "bank": { "code": "sicoob", "name": "Bancoob/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": "Bancoob/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": 2, "pix_account_id": null, "pix_account": {}, "pix_billing_options": null }, "bolepix_key": null, "allow_expiration_on_weekends": false, "created_at": "2025-07-18T09:07:51+08:00", "updated_at": "2025-07-18T09:07:51+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 2177, "uid": "01981b12-c604-76af-9f85-69caf7b85c42", "bank_contract_slug": "sicoob-01", "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": "123456789", "payment_place": "Pagável em qualquer banco até a data de vencimento.", "contract": "1", "contract_type": "1", "beneficiary_name": "Kobana Instituição de Pagamento Ltda.", "beneficiary_cnpj_cpf": "05.813.794/0001-26", "beneficiary_address": "Av. Presidente Vargas, 633, sala 1716, Centro, Rio de Janeiro, RJ, 20071004", "name": "Bancoob/Sicoob 01 CC: 3666-8 229385", "status": "active", "bank_contract": { "bank": { "code": "sicoob", "name": "Bancoob/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": "Bancoob/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": "2025-07-18T09:07:51+08:00", "bolepix": { "pix_mode": 1, "pix_account_id": null, "pix_account": {}, "pix_billing_options": null }, "bolepix_key": null, "allow_expiration_on_weekends": false, "created_at": "2025-07-18T09:07:51+08:00", "updated_at": "2025-07-18T09:07:51+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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" } } }, "/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": 2180, "uid": "01981b12-cd9d-785e-9eb1-066b1132a176", "bank_contract_slug": "sicoob-01", "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": "123456789", "payment_place": "Pagável em qualquer banco até a data de vencimento.", "contract": "1", "contract_type": "1", "beneficiary_name": "Kobana Instituição de Pagamento Ltda.", "beneficiary_cnpj_cpf": "05.813.794/0001-26", "beneficiary_address": "Av. Presidente Vargas, 633, sala 1716, Centro, Rio de Janeiro, RJ, 20071004", "name": "Bancoob/Sicoob 01 CC: 3666-8 229385", "status": "validating", "bank_contract": { "bank": { "code": "sicoob", "name": "Bancoob/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": "Bancoob/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": "2025-07-18T09:07:53+08:00", "bolepix": { "pix_mode": 1, "pix_account_id": null, "pix_account": {}, "pix_billing_options": null }, "bolepix_key": null, "allow_expiration_on_weekends": false, "created_at": "2025-07-18T09:07:53+08:00", "updated_at": "2025-07-18T09:07:54+08: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_entity" } ] }, "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_entity" } ] }, "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_entity" } ] }, "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": 1684, "uid": "01981b12-db9e-738c-8155-d02ee9430b54", "expire_at": "2025-10-06", "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://boleto.test:5001/2/vvrx", "formats": { "default": "http://boleto.test:5001/2/vvrx", "png": "http://boleto.test:5001/2/vvrx.png", "pdf": "http://boleto.test:5001/2/vvrx.pdf", "boleto_hibrido": "http://boleto.test:5001/2/vvrx/boleto_hibrido", "boleto_pix": "http://boleto.test:5001/2/vvrx/boleto_pix", "barcode": "http://boleto.test:5001/2/vvrx/barcode", "envelope": "http://boleto.test:5001/2/vvrx/envelope", "letter": "http://boleto.test:5001/2/vvrx/letter", "line": "http://boleto.test:5001/2/vvrx/line", "recibo": "http://boleto.test:5001/2/vvrx/recibo", "pix_qrcode": "http://boleto.test:5001/2/vvrx/pix_qrcode" }, "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": "2025-10-04", "discount_value": null, "discount_percentage": 10.0, "days_for_revoke": 30, "notes": "Observações", "payment_count": 4, "bank_billet_account_id": 2187, "beneficiary_name": "Kobana Instituição de Pagamento 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 5 12260000003456", "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": "2025-07-18T09:07:57+08:00", "updated_at": "2025-07-18T09:07:57+08: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": "75695122600000034561432701022938500000024002", "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": 2, "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_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, "dispatch_type": 1, "charge_type": 1, "custom_data": { "bank_billet_number": "123_456" }, "issued_at": "2025-07-18T09:07:57+08:00", "shorten_url": "http://boleto.test:5001/2/vvrx", "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": "vvrx", "financial_provider_external_id": null, "days_for_sue_type": 0, "credit_bureau": 0, "after_create": [ "sync" ], "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": "Boleto 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" ], "expire_at": [ "não pode ficar em branco", "não é uma data válida" ], "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 1687, "uid": "01981b12-df73-76de-baed-60d73cada20b", "expire_at": "2025-07-21", "paid_at": null, "description": "Serviço de criação de site\\r\\nExpira em: 21/07/2025", "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://boleto.test:5001/2/moge", "formats": { "default": "http://boleto.test:5001/2/moge", "png": "http://boleto.test:5001/2/moge.png", "pdf": "http://boleto.test:5001/2/moge.pdf", "boleto_hibrido": "http://boleto.test:5001/2/moge/boleto_hibrido", "boleto_pix": "http://boleto.test:5001/2/moge/boleto_pix", "barcode": "http://boleto.test:5001/2/moge/barcode", "envelope": "http://boleto.test:5001/2/moge/envelope", "letter": "http://boleto.test:5001/2/moge/letter", "line": "http://boleto.test:5001/2/moge/line", "recibo": "http://boleto.test:5001/2/moge/recibo", "pix_qrcode": "http://boleto.test:5001/2/moge/pix_qrcode" }, "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": 2189, "beneficiary_name": "Kobana Instituição de Pagamento 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": "00446339", "processed_our_number_raw": "00446339", "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 04463.390015 1 11490000005000", "our_number": "44633", "customer_subscription_id": null, "installment_total": null, "installment_number": null, "installment_id": null, "carne_url": null, "bank_billet_layout_id": null, "created_at": "2025-07-18T09:07:58+08:00", "updated_at": "2025-07-18T09:07:58+08: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": "75691114900000050001432701022938500446339001", "registered_at": null, "prevent_registration": false, "customer_id": 2594, "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, "dispatch_type": 1, "charge_type": 1, "custom_data": null, "issued_at": "2025-07-18T09:07:58+08:00", "shorten_url": "http://boleto.test:5001/2/moge", "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": "moge", "financial_provider_external_id": null, "days_for_sue_type": null, "credit_bureau": null, "after_create": [], "bank_billet_discharges": [], "bank_billet_remittances": [], "bank_billet_payments": [], "bank_billet_registrations": [], "bank_billet_split_accounts": [], "pix": [] }, { "id": 1686, "uid": "01981b12-df58-70e8-8b8a-e9cdf2870a24", "expire_at": "2025-07-21", "paid_at": null, "description": "Serviço de criação de site\\r\\nExpira em: 21/07/2025", "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://boleto.test:5001/2/nkdw", "formats": { "default": "http://boleto.test:5001/2/nkdw", "png": "http://boleto.test:5001/2/nkdw.png", "pdf": "http://boleto.test:5001/2/nkdw.pdf", "boleto_hibrido": "http://boleto.test:5001/2/nkdw/boleto_hibrido", "boleto_pix": "http://boleto.test:5001/2/nkdw/boleto_pix", "barcode": "http://boleto.test:5001/2/nkdw/barcode", "envelope": "http://boleto.test:5001/2/nkdw/envelope", "letter": "http://boleto.test:5001/2/nkdw/letter", "line": "http://boleto.test:5001/2/nkdw/line", "recibo": "http://boleto.test:5001/2/nkdw/recibo", "pix_qrcode": "http://boleto.test:5001/2/nkdw/pix_qrcode" }, "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": 2189, "beneficiary_name": "Kobana Instituição de Pagamento 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": "00319845", "processed_our_number_raw": "00319845", "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 03198.450011 5 11490000005000", "our_number": "31984", "customer_subscription_id": null, "installment_total": null, "installment_number": null, "installment_id": null, "carne_url": null, "bank_billet_layout_id": null, "created_at": "2025-07-18T09:07:58+08:00", "updated_at": "2025-07-18T09:07:58+08: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": "75695114900000050001432701022938500319845001", "registered_at": null, "prevent_registration": false, "customer_id": 2593, "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, "dispatch_type": 1, "charge_type": 1, "custom_data": null, "issued_at": "2025-07-18T09:07:58+08:00", "shorten_url": "http://boleto.test:5001/2/nkdw", "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": "nkdw", "financial_provider_external_id": null, "days_for_sue_type": null, "credit_bureau": null, "after_create": [], "bank_billet_discharges": [], "bank_billet_remittances": [], "bank_billet_payments": [], "bank_billet_registrations": [], "bank_billet_split_accounts": [], "pix": [] }, { "id": 1685, "uid": "01981b12-df3c-7a55-bf9d-3c9f03521cbf", "expire_at": "2025-07-21", "paid_at": null, "description": "Serviço de criação de site\\r\\nExpira em: 21/07/2025", "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://boleto.test:5001/2/kgye", "formats": { "default": "http://boleto.test:5001/2/kgye", "png": "http://boleto.test:5001/2/kgye.png", "pdf": "http://boleto.test:5001/2/kgye.pdf", "boleto_hibrido": "http://boleto.test:5001/2/kgye/boleto_hibrido", "boleto_pix": "http://boleto.test:5001/2/kgye/boleto_pix", "barcode": "http://boleto.test:5001/2/kgye/barcode", "envelope": "http://boleto.test:5001/2/kgye/envelope", "letter": "http://boleto.test:5001/2/kgye/letter", "line": "http://boleto.test:5001/2/kgye/line", "recibo": "http://boleto.test:5001/2/kgye/recibo", "pix_qrcode": "http://boleto.test:5001/2/kgye/pix_qrcode" }, "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": 2189, "beneficiary_name": "Kobana Instituição de Pagamento 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": "00110575", "processed_our_number_raw": "00110575", "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 01105.750010 7 11490000005000", "our_number": "11057", "customer_subscription_id": null, "installment_total": null, "installment_number": null, "installment_id": null, "carne_url": null, "bank_billet_layout_id": null, "created_at": "2025-07-18T09:07:58+08:00", "updated_at": "2025-07-18T09:07:58+08: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": "75697114900000050001432701022938500110575001", "registered_at": null, "prevent_registration": false, "customer_id": 2592, "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, "dispatch_type": 1, "charge_type": 1, "custom_data": null, "issued_at": "2025-07-18T09:07:58+08:00", "shorten_url": "http://boleto.test:5001/2/kgye", "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": "kgye", "financial_provider_external_id": null, "days_for_sue_type": null, "credit_bureau": null, "after_create": [], "bank_billet_discharges": [], "bank_billet_remittances": [], "bank_billet_payments": [], "bank_billet_registrations": [], "bank_billet_split_accounts": [], "pix": [] } ], "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 1688, "uid": "01981b12-e224-7778-804b-650bb8972179", "expire_at": "2025-07-21", "paid_at": null, "description": "Serviço de criação de site\\r\\nExpira em: 21/07/2025", "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://boleto.test:5001/2/bjnj", "formats": { "default": "http://boleto.test:5001/2/bjnj", "png": "http://boleto.test:5001/2/bjnj.png", "pdf": "http://boleto.test:5001/2/bjnj.pdf", "boleto_hibrido": "http://boleto.test:5001/2/bjnj/boleto_hibrido", "boleto_pix": "http://boleto.test:5001/2/bjnj/boleto_pix", "barcode": "http://boleto.test:5001/2/bjnj/barcode", "envelope": "http://boleto.test:5001/2/bjnj/envelope", "letter": "http://boleto.test:5001/2/bjnj/letter", "line": "http://boleto.test:5001/2/bjnj/line", "recibo": "http://boleto.test:5001/2/bjnj/recibo", "pix_qrcode": "http://boleto.test:5001/2/bjnj/pix_qrcode" }, "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": 2190, "beneficiary_name": "Kobana Instituição de Pagamento 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": "00649188", "processed_our_number_raw": "00649188", "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 06491.880016 4 11490000005000", "our_number": "64918", "customer_subscription_id": null, "installment_total": null, "installment_number": null, "installment_id": null, "carne_url": null, "bank_billet_layout_id": null, "created_at": "2025-07-18T09:07:59+08:00", "updated_at": "2025-07-18T09:07:59+08: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": "75694114900000050001432701022938500649188001", "registered_at": null, "prevent_registration": false, "customer_id": 2595, "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, "dispatch_type": 1, "charge_type": 1, "custom_data": null, "issued_at": "2025-07-18T09:07:59+08:00", "shorten_url": "http://boleto.test:5001/2/bjnj", "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": "bjnj", "financial_provider_external_id": null, "days_for_sue_type": null, "credit_bureau": null, "after_create": [], "bank_billet_discharges": [], "bank_billet_remittances": [], "bank_billet_payments": [], "bank_billet_registrations": [], "bank_billet_split_accounts": [], "pix": [] }, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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_entity" } ] }, "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": 1694, "uid": "01981b12-ee29-74dd-92de-766b7293e3b7", "expire_at": "2025-07-25", "paid_at": null, "description": "Serviço de criação de site\\r\\nExpira em: 25/07/2025", "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://boleto.test:5001/2/onkm", "formats": { "default": "http://boleto.test:5001/2/onkm", "png": "http://boleto.test:5001/2/onkm.png", "pdf": "http://boleto.test:5001/2/onkm.pdf", "boleto_hibrido": "http://boleto.test:5001/2/onkm/boleto_hibrido", "boleto_pix": "http://boleto.test:5001/2/onkm/boleto_pix", "barcode": "http://boleto.test:5001/2/onkm/barcode", "envelope": "http://boleto.test:5001/2/onkm/envelope", "letter": "http://boleto.test:5001/2/onkm/letter", "line": "http://boleto.test:5001/2/onkm/line", "recibo": "http://boleto.test:5001/2/onkm/recibo", "pix_qrcode": "http://boleto.test:5001/2/onkm/pix_qrcode" }, "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": 2196, "beneficiary_name": "Kobana Instituição de Pagamento 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 4 11530000134556", "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": "2025-07-18T09:08:02+08:00", "updated_at": "2025-07-18T09:08:02+08: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": "75694115300001345561432701022938500000024001", "registered_at": null, "prevent_registration": false, "customer_id": 2600, "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, "dispatch_type": 1, "charge_type": 1, "custom_data": null, "issued_at": "2025-07-18T09:08:02+08:00", "shorten_url": "http://boleto.test:5001/2/onkm", "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": "onkm", "financial_provider_external_id": null, "days_for_sue_type": null, "credit_bureau": null, "after_create": [], "bank_billet_discharges": [], "bank_billet_remittances": [], "bank_billet_payments": [], "bank_billet_registrations": [], "bank_billet_split_accounts": [], "pix": [] }, "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}/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_entity" } ] }, "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": 142, "uid": "01981b12-fb29-760f-a4cf-c6bd5a10d20c", "amount": 34.56, "cycle": "monthly", "next_billing": "2025-08-18", "end_at": null, "instructions": null, "customer_id": 2614, "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": "2025-07-18T09:08:05+08:00", "updated_at": "2025-07-18T09:08:05+08:00", "created_via_api": true, "days_in_advance": 7, "bank_billet_account_id": 2206, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": "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": 143, "uid": "01981b12-ff3c-7ab0-96a8-ee9d22c2d610", "amount": 150.0, "cycle": "monthly", "next_billing": "2025-08-18", "end_at": null, "instructions": "Não receber após o vencimento", "customer_id": 2615, "customer_person_name": "Margret Santos Filgueiras", "customer_cnpj_cpf": "135.341.913-40", "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": "ty@murphy-crooks.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": "2025-07-18T09:08:06+08:00", "updated_at": "2025-07-18T09:08:06+08:00", "created_via_api": false, "days_in_advance": 7, "bank_billet_account_id": 2208, "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": 144, "uid": "01981b12-ff5d-7d51-a7da-e40c1c215ce8", "amount": 150.0, "cycle": "monthly", "next_billing": "2025-08-18", "end_at": null, "instructions": "Não receber após o vencimento", "customer_id": 2616, "customer_person_name": "Margret Santos Filgueiras", "customer_cnpj_cpf": "051.846.839-92", "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": "douglass@nitzsche.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": "2025-07-18T09:08:06+08:00", "updated_at": "2025-07-18T09:08:06+08:00", "created_via_api": false, "days_in_advance": 7, "bank_billet_account_id": 2208, "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": 145, "uid": "01981b12-ff82-71d9-ba10-e4886d1adf7b", "amount": 150.0, "cycle": "monthly", "next_billing": "2025-08-18", "end_at": null, "instructions": "Não receber após o vencimento", "customer_id": 2617, "customer_person_name": "Margret Santos Filgueiras", "customer_cnpj_cpf": "712.606.465-99", "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": "elwood@mayert.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": "2025-07-18T09:08:06+08:00", "updated_at": "2025-07-18T09:08:06+08:00", "created_via_api": false, "days_in_advance": 7, "bank_billet_account_id": 2208, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 146, "uid": "01981b13-01a2-72b0-ad53-b595af343482", "amount": 150.0, "cycle": "monthly", "next_billing": "2025-08-18", "end_at": null, "instructions": "Não receber após o vencimento", "customer_id": 2618, "customer_person_name": "Margret Santos Filgueiras", "customer_cnpj_cpf": "424.578.534-94", "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": "anibal@williamson-hudson.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": "2025-07-18T09:08:07+08:00", "updated_at": "2025-07-18T09:08:07+08:00", "created_via_api": false, "days_in_advance": 7, "bank_billet_account_id": 2209, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": "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": { "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": "Duplica assinatura permitindo alterar informações do novo assinatura e ou cancelar o assinatura 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 Assinatura", "example": 999, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Próxima cobrança gerada", "content": { "application/json": { "example": { "id": 149, "uid": "01981b13-0a1d-741d-9205-b0624d4a08d7", "amount": 150.0, "cycle": "monthly", "next_billing": "2025-09-18", "end_at": null, "instructions": "Não receber após o vencimento", "customer_id": 2621, "customer_person_name": "Margret Santos Filgueiras", "customer_cnpj_cpf": "410.854.168-52", "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": "elroy@gottlieb-koepp.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": "2025-07-18T09:08:09+08:00", "updated_at": "2025-07-18T09:08:09+08:00", "created_via_api": false, "days_in_advance": 7, "bank_billet_account_id": 2212, "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": [ 1708 ], "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 2622, "uid": "01981b13-0d34-736b-8c2a-37a91c4f3f1e", "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": "2025-07-18T09:08:10+08:00", "updated_at": "2025-07-18T09:08:10+08: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": "LBRYeiCY", "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 2624, "uid": "01981b13-1055-706c-bed6-3c2e87a80bd8", "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": "169.374.199-70", "email": "luke.jacobs@mante.test", "neighborhood": "São Francisco", "phone_number": "2199999999", "zipcode": "24360440", "mobile_local_code": null, "notes": null, "state": "RJ", "created_via_api": false, "created_at": "2025-07-18T09:08:10+08:00", "updated_at": "2025-07-18T09:08:10+08: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": [ "est", "tempora", "non" ], "tag_list": "est,tempora,non", "custom_data": { "numero_cliente": 63126 }, "portal_password": "UmotvGjM", "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": 2625, "uid": "01981b13-105c-7e51-99d5-e8e382250c12", "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": "905.318.297-74", "email": "berry.orn@kihn.example", "neighborhood": "São Francisco", "phone_number": "2199999999", "zipcode": "24360440", "mobile_local_code": null, "notes": null, "state": "RJ", "created_via_api": false, "created_at": "2025-07-18T09:08:10+08:00", "updated_at": "2025-07-18T09:08:10+08: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": [ "qui", "totam", "illo" ], "tag_list": "qui,totam,illo", "custom_data": { "numero_cliente": 63126 }, "portal_password": "Oo3wpCRS", "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": 2626, "uid": "01981b13-1063-7287-8c22-7e490d34df75", "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": "861.836.298-04", "email": "hobert_steuber@heller.test", "neighborhood": "São Francisco", "phone_number": "2199999999", "zipcode": "24360440", "mobile_local_code": null, "notes": null, "state": "RJ", "created_via_api": false, "created_at": "2025-07-18T09:08:10+08:00", "updated_at": "2025-07-18T09:08:10+08: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": [ "quasi", "odio", "ad" ], "tag_list": "quasi,odio,ad", "custom_data": { "numero_cliente": 63126 }, "portal_password": "WKUp3G4r", "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 2627, "uid": "01981b13-1232-7ecb-a906-8f6bac7706fc", "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": "710.642.795-03", "email": "justin@armstrong-quigley.test", "neighborhood": "São Francisco", "phone_number": "2199999999", "zipcode": "24360440", "mobile_local_code": null, "notes": null, "state": "RJ", "created_via_api": false, "created_at": "2025-07-18T09:08:11+08:00", "updated_at": "2025-07-18T09:08:11+08: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": [ "deserunt", "culpa", "perferendis" ], "tag_list": "deserunt,culpa,perferendis", "custom_data": { "numero_cliente": 63126 }, "portal_password": "r6Wij90f", "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 2629, "uid": "01981b13-16e9-7182-8741-57c42411e0b6", "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": "twyla@abbott.test", "neighborhood": "São Francisco", "phone_number": "2199999999", "zipcode": "24360440", "mobile_local_code": null, "notes": null, "state": "RJ", "created_via_api": false, "created_at": "2025-07-18T09:08:12+08:00", "updated_at": "2025-07-18T09:08:12+08: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", "ut", "est" ], "tag_list": "vel,ut,est", "custom_data": { "numero_cliente": 63126 }, "portal_password": "RJv5THXr", "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 2630, "uid": "01981b13-19a8-796e-9b1e-6664eede7a40", "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": "387.831.453-11", "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": "2025-07-18T09:08:13+08:00", "updated_at": "2025-07-18T09:08:13+08: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": [ "voluptas", "sequi", "minima" ], "tag_list": "voluptas,sequi,minima", "custom_data": { "numero_cliente": 63126 }, "portal_password": "S7T0pH4n", "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 159, "uid": "01981b13-1e1d-7ad0-a9a5-a44c6fb2a695", "amount": 133.54, "cycle": "monthly", "start_at": "2025-07-18", "end_at": "2026-06-18", "instructions": null, "customer_id": 2635, "description": "Cliente especial", "created_at": "2025-07-18T09:08:14+08:00", "updated_at": "2025-07-18T09:08:14+08:00", "customer_person_name": "Margret Santos Filgueiras", "customer_cnpj_cpf": "575.378.529-87", "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": "magdalena@ondricka.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": 2213, "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": 158, "uid": "01981b13-1dfd-7aa6-be90-d535326aafb1", "amount": 133.54, "cycle": "monthly", "start_at": "2025-07-18", "end_at": "2026-06-18", "instructions": null, "customer_id": 2634, "description": "Cliente especial", "created_at": "2025-07-18T09:08:14+08:00", "updated_at": "2025-07-18T09:08:14+08:00", "customer_person_name": "Margret Santos Filgueiras", "customer_cnpj_cpf": "433.743.375-97", "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": "isaac_bartell@trantow.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": 2213, "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": 157, "uid": "01981b13-1ddb-771b-9099-53816200e245", "amount": 133.54, "cycle": "monthly", "start_at": "2025-07-18", "end_at": "2026-06-18", "instructions": null, "customer_id": 2633, "description": "Cliente especial", "created_at": "2025-07-18T09:08:14+08:00", "updated_at": "2025-07-18T09:08:14+08:00", "customer_person_name": "Margret Santos Filgueiras", "customer_cnpj_cpf": "560.914.229-60", "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": "elias_hilll@weimann.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": 2213, "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": 156, "uid": "01981b13-1d9d-7d7f-9f2a-5554d5183c9e", "amount": 133.54, "cycle": "monthly", "start_at": "2025-07-18", "end_at": "2026-06-18", "instructions": null, "customer_id": 2632, "description": "Cliente especial", "created_at": "2025-07-18T09:08:14+08:00", "updated_at": "2025-07-18T09:08:14+08:00", "customer_person_name": "Margret Santos Filgueiras", "customer_cnpj_cpf": "372.540.968-47", "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": "jonah_kreiger@towne-cummerata.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": 2213, "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": 155, "uid": "01981b13-1d4f-7978-b208-097a106c0167", "amount": 133.54, "cycle": "monthly", "start_at": "2025-07-18", "end_at": "2026-06-18", "instructions": null, "customer_id": 2631, "description": "Cliente especial", "created_at": "2025-07-18T09:08:14+08:00", "updated_at": "2025-07-18T09:08:14+08:00", "customer_person_name": "Margret Santos Filgueiras", "customer_cnpj_cpf": "057.690.033-83", "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": "raul_stiedemann@murphy.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": 2213, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 160, "uid": "01981b13-2083-721c-921d-fd0a59573254", "amount": 133.54, "cycle": "biweekly", "start_at": "2025-07-22", "end_at": "2026-01-03", "instructions": null, "customer_id": null, "description": "Serviços prestados", "created_at": "2025-07-18T09:08:15+08:00", "updated_at": "2025-07-18T09:08:15+08: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": 2214, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 161, "uid": "01981b13-2352-727c-87bc-9ee6497b551f", "amount": 133.54, "cycle": "monthly", "start_at": "2025-07-18", "end_at": "2026-06-18", "instructions": null, "customer_id": 2636, "description": "Cliente especial", "created_at": "2025-07-18T09:08:15+08:00", "updated_at": "2025-07-18T09:08:15+08:00", "customer_person_name": "Margret Santos Filgueiras", "customer_cnpj_cpf": "617.866.395-13", "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": "hans@reichel.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": 2216, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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", "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.add_pix.requested", "bank_billet.add_pix.confirmed", "bank_billet.add_pix.failed", "bank_billet.add_pix.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", "statement_transaction.db.created", "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", "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.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.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.ted_batch.awaiting_approval", "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.internal_batch.awaiting_approval", "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.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.cancel.requested", "transfer.pix.cancel.confirmed", "transfer.pix.cancel.failed", "transfer.pix.cancel.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.cancel.requested", "transfer.ted.cancel.confirmed", "transfer.ted.cancel.failed", "transfer.ted.cancel.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.cancel.requested", "transfer.internal.cancel.confirmed", "transfer.internal.cancel.failed", "transfer.internal.cancel.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.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.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.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.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.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.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.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.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.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.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.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.darf_batch.awaiting_approval", "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.utility_batch.awaiting_approval", "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.gru_batch.awaiting_approval", "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.pix_batch.awaiting_approval", "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.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.bank_billet.db.created", "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", "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.payment.db.created", "charge.payment.db.updated", "charge.payment.db.deleted", "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", "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", "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": 142, "uid": "01981b13-2abb-74a4-bb5b-66f4c9002ed7", "event_code": "bank_billet.created", "sent_error": null, "delivered_at": null, "failed_at": null, "resource_owner_id": 1713, "status": "pending", "bank_billet_account_id": null, "status_occurred_at": null, "email_notification_id": 132, "last_clicked_at": null, "last_read_at": null, "clicked_at": null, "click_count": 0, "read_at": null, "read_count": 0, "to": "cliente@example.com,heriberto@rippin-johnson.example", "subject": "Assunto de email", "email_account_id": 234, "email_template_id": 273, "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": "2025-07-18T09:08:17+08:00", "updated_at": "2025-07-18T09:08:17+08:00", "resource_owner": { "id": 1713, "type": "bank_billet" }, "resource_base": { "id": 1713, "type": "bank_billet" } }, { "id": 141, "uid": "01981b13-2a5c-7eee-81ce-6b9e7e68e939", "event_code": "bank_billet.created", "sent_error": null, "delivered_at": null, "failed_at": null, "resource_owner_id": 1712, "status": "pending", "bank_billet_account_id": null, "status_occurred_at": null, "email_notification_id": 131, "last_clicked_at": null, "last_read_at": null, "clicked_at": null, "click_count": 0, "read_at": null, "read_count": 0, "to": "cliente@example.com,fredric@ratke-brown.example", "subject": "Assunto de email", "email_account_id": 233, "email_template_id": 271, "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": "2025-07-18T09:08:17+08:00", "updated_at": "2025-07-18T09:08:17+08:00", "resource_owner": { "id": 1712, "type": "bank_billet" }, "resource_base": { "id": 1712, "type": "bank_billet" } }, { "id": 140, "uid": "01981b13-2a02-7fad-9cf5-655de1844213", "event_code": "bank_billet.created", "sent_error": null, "delivered_at": null, "failed_at": null, "resource_owner_id": 1711, "status": "pending", "bank_billet_account_id": null, "status_occurred_at": null, "email_notification_id": 130, "last_clicked_at": null, "last_read_at": null, "clicked_at": null, "click_count": 0, "read_at": null, "read_count": 0, "to": "cliente@example.com,cherelle@pfannerstill.test", "subject": "Assunto de email", "email_account_id": 232, "email_template_id": 269, "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": "2025-07-18T09:08:17+08:00", "updated_at": "2025-07-18T09:08:17+08:00", "resource_owner": { "id": 1711, "type": "bank_billet" }, "resource_base": { "id": 1711, "type": "bank_billet" } }, { "id": 139, "uid": "01981b13-29a5-7a78-b3db-80ba90772430", "event_code": "bank_billet.created", "sent_error": null, "delivered_at": null, "failed_at": null, "resource_owner_id": 1710, "status": "pending", "bank_billet_account_id": null, "status_occurred_at": null, "email_notification_id": 129, "last_clicked_at": null, "last_read_at": null, "clicked_at": null, "click_count": 0, "read_at": null, "read_count": 0, "to": "cliente@example.com,marti_green@runolfsson.test", "subject": "Assunto de email", "email_account_id": 231, "email_template_id": 267, "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": "2025-07-18T09:08:17+08:00", "updated_at": "2025-07-18T09:08:17+08:00", "resource_owner": { "id": 1710, "type": "bank_billet" }, "resource_base": { "id": 1710, "type": "bank_billet" } }, { "id": 138, "uid": "01981b13-28e1-7a3c-a122-ee7247858b91", "event_code": "bank_billet.created", "sent_error": null, "delivered_at": null, "failed_at": null, "resource_owner_id": 1709, "status": "pending", "bank_billet_account_id": null, "status_occurred_at": null, "email_notification_id": 128, "last_clicked_at": null, "last_read_at": null, "clicked_at": null, "click_count": 0, "read_at": null, "read_count": 0, "to": "cliente@example.com,caleb@hayes.example", "subject": "Assunto de email", "email_account_id": 230, "email_template_id": 265, "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": "2025-07-18T09:08:17+08:00", "updated_at": "2025-07-18T09:08:17+08:00", "resource_owner": { "id": 1709, "type": "bank_billet" }, "resource_base": { "id": 1709, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 143, "uid": "01981b13-2dee-73d5-b051-d543a53c16a1", "event_code": "bank_billet.created", "sent_error": null, "delivered_at": null, "failed_at": null, "resource_owner_id": 1714, "status": "pending", "bank_billet_account_id": null, "status_occurred_at": null, "email_notification_id": 133, "last_clicked_at": null, "last_read_at": null, "clicked_at": null, "click_count": 0, "read_at": null, "read_count": 0, "to": "cliente@example.com,carmelita@miller.test", "subject": "Assunto de email", "email_account_id": 235, "email_template_id": 275, "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": "2025-07-18T09:08:18+08:00", "updated_at": "2025-07-18T09:08:18+08:00", "resource_owner": { "id": 1714, "type": "bank_billet" }, "resource_base": { "id": 1714, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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", "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.add_pix.requested", "bank_billet.add_pix.confirmed", "bank_billet.add_pix.failed", "bank_billet.add_pix.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", "statement_transaction.db.created", "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", "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.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.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.ted_batch.awaiting_approval", "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.internal_batch.awaiting_approval", "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.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.cancel.requested", "transfer.pix.cancel.confirmed", "transfer.pix.cancel.failed", "transfer.pix.cancel.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.cancel.requested", "transfer.ted.cancel.confirmed", "transfer.ted.cancel.failed", "transfer.ted.cancel.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.cancel.requested", "transfer.internal.cancel.confirmed", "transfer.internal.cancel.failed", "transfer.internal.cancel.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.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.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.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.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.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.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.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.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.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.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.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.darf_batch.awaiting_approval", "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.utility_batch.awaiting_approval", "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.gru_batch.awaiting_approval", "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.pix_batch.awaiting_approval", "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.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.bank_billet.db.created", "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", "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.payment.db.created", "charge.payment.db.updated", "charge.payment.db.deleted", "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", "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", "enotas.nfe.generated" ] } }, { "name": "occurred_at_from", "in": "query", "description": "Início da data de ocorrência do evento", "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.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Sucesso na listagem dos eventos", "content": { "application/json": { "example": [ { "resource_owner": { "id": 1720, "type": "bank_billet" }, "resource_base": { "id": 1720, "type": "bank_billet" }, "id": 486, "uid": "01981b13-3610-7cab-9475-ef78d202150f", "code": "bank_billet.created", "data": { "object": { "id": 1720, "uid": "01981b13-35f7-7bb9-af59-e12a462ba1a2", "expire_at": "2025-07-21", "paid_at": null, "description": "Serviço de criação de site\\r\\nExpira em: 21/07/2025", "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": false, "customer_city_name": "Rio de Janeiro", "paid_amount": null, "amount": 50.0, "url": "http://boleto.test:5001/2/bjzl", "formats": { "default": "http://boleto.test:5001/2/bjzl", "png": "http://boleto.test:5001/2/bjzl.png", "pdf": "http://boleto.test:5001/2/bjzl.pdf", "boleto_hibrido": "http://boleto.test:5001/2/bjzl/boleto_hibrido", "boleto_pix": "http://boleto.test:5001/2/bjzl/boleto_pix", "barcode": "http://boleto.test:5001/2/bjzl/barcode", "envelope": "http://boleto.test:5001/2/bjzl/envelope", "letter": "http://boleto.test:5001/2/bjzl/letter", "line": "http://boleto.test:5001/2/bjzl/line", "recibo": "http://boleto.test:5001/2/bjzl/recibo", "pix_qrcode": "http://boleto.test:5001/2/bjzl/pix_qrcode" }, "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": 2229, "beneficiary_name": "Kobana Instituição de Pagamento 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": "00538180", "processed_our_number_raw": "00538180", "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 05381.800019 8 11490000005000", "our_number": "53818", "customer_subscription_id": null, "installment_total": null, "installment_number": null, "installment_id": null, "carne_url": null, "bank_billet_layout_id": null, "created_at": "2025-07-18T09:08:20+08:00", "updated_at": "2025-07-18T09:08:20+08: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": "75698114900000050001432701022938500538180001", "registered_at": null, "prevent_registration": false, "customer_id": 2649, "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, "dispatch_type": 1, "charge_type": 1, "custom_data": null, "issued_at": "2025-07-18T09:08:20+08:00", "shorten_url": "http://boleto.test:5001/2/bjzl", "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": "bjzl", "financial_provider_external_id": null, "days_for_sue_type": null, "credit_bureau": null, "after_create": [], "bank_billet_discharges": [], "bank_billet_remittances": [], "bank_billet_payments": [], "bank_billet_registrations": [], "bank_billet_split_accounts": [], "pix": [] } }, "occurred_at": "2015-02-16T16:40:27+08:00", "bank_billet_account_id": null, "resource_owner_id": 1720, "created_at": "2025-07-18T09:08:20+08:00", "updated_at": "2025-07-18T09:08:20+08:00" }, { "resource_owner": { "id": 1719, "type": "bank_billet" }, "resource_base": { "id": 1719, "type": "bank_billet" }, "id": 485, "uid": "01981b13-35b9-7480-b5dd-73704805bbf4", "code": "bank_billet.created", "data": { "object": { "id": 1719, "uid": "01981b13-35a2-7b30-803a-a7d0306736c8", "expire_at": "2025-07-21", "paid_at": null, "description": "Serviço de criação de site\\r\\nExpira em: 21/07/2025", "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": false, "customer_city_name": "Rio de Janeiro", "paid_amount": null, "amount": 50.0, "url": "http://boleto.test:5001/2/moyq", "formats": { "default": "http://boleto.test:5001/2/moyq", "png": "http://boleto.test:5001/2/moyq.png", "pdf": "http://boleto.test:5001/2/moyq.pdf", "boleto_hibrido": "http://boleto.test:5001/2/moyq/boleto_hibrido", "boleto_pix": "http://boleto.test:5001/2/moyq/boleto_pix", "barcode": "http://boleto.test:5001/2/moyq/barcode", "envelope": "http://boleto.test:5001/2/moyq/envelope", "letter": "http://boleto.test:5001/2/moyq/letter", "line": "http://boleto.test:5001/2/moyq/line", "recibo": "http://boleto.test:5001/2/moyq/recibo", "pix_qrcode": "http://boleto.test:5001/2/moyq/pix_qrcode" }, "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": 2228, "beneficiary_name": "Kobana Instituição de Pagamento 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": "00859816", "processed_our_number_raw": "00859816", "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 08598.160011 5 11490000005000", "our_number": "85981", "customer_subscription_id": null, "installment_total": null, "installment_number": null, "installment_id": null, "carne_url": null, "bank_billet_layout_id": null, "created_at": "2025-07-18T09:08:20+08:00", "updated_at": "2025-07-18T09:08:20+08: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": "75695114900000050001432701022938500859816001", "registered_at": null, "prevent_registration": false, "customer_id": 2648, "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, "dispatch_type": 1, "charge_type": 1, "custom_data": null, "issued_at": "2025-07-18T09:08:20+08:00", "shorten_url": "http://boleto.test:5001/2/moyq", "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": "moyq", "financial_provider_external_id": null, "days_for_sue_type": null, "credit_bureau": null, "after_create": [], "bank_billet_discharges": [], "bank_billet_remittances": [], "bank_billet_payments": [], "bank_billet_registrations": [], "bank_billet_split_accounts": [], "pix": [] } }, "occurred_at": "2015-02-16T16:40:27+08:00", "bank_billet_account_id": null, "resource_owner_id": 1719, "created_at": "2025-07-18T09:08:20+08:00", "updated_at": "2025-07-18T09:08:20+08:00" }, { "resource_owner": { "id": 1718, "type": "bank_billet" }, "resource_base": { "id": 1718, "type": "bank_billet" }, "id": 484, "uid": "01981b13-3567-7dd2-8430-f08a0d7a7492", "code": "bank_billet.created", "data": { "object": { "id": 1718, "uid": "01981b13-354f-7a6a-a7f0-5f1198622b5b", "expire_at": "2025-07-21", "paid_at": null, "description": "Serviço de criação de site\\r\\nExpira em: 21/07/2025", "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": false, "customer_city_name": "Rio de Janeiro", "paid_amount": null, "amount": 50.0, "url": "http://boleto.test:5001/2/nkge", "formats": { "default": "http://boleto.test:5001/2/nkge", "png": "http://boleto.test:5001/2/nkge.png", "pdf": "http://boleto.test:5001/2/nkge.pdf", "boleto_hibrido": "http://boleto.test:5001/2/nkge/boleto_hibrido", "boleto_pix": "http://boleto.test:5001/2/nkge/boleto_pix", "barcode": "http://boleto.test:5001/2/nkge/barcode", "envelope": "http://boleto.test:5001/2/nkge/envelope", "letter": "http://boleto.test:5001/2/nkge/letter", "line": "http://boleto.test:5001/2/nkge/line", "recibo": "http://boleto.test:5001/2/nkge/recibo", "pix_qrcode": "http://boleto.test:5001/2/nkge/pix_qrcode" }, "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": 2227, "beneficiary_name": "Kobana Instituição de Pagamento 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": "00267452", "processed_our_number_raw": "00267452", "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 02674.520016 4 11490000005000", "our_number": "26745", "customer_subscription_id": null, "installment_total": null, "installment_number": null, "installment_id": null, "carne_url": null, "bank_billet_layout_id": null, "created_at": "2025-07-18T09:08:20+08:00", "updated_at": "2025-07-18T09:08:20+08: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": "75694114900000050001432701022938500267452001", "registered_at": null, "prevent_registration": false, "customer_id": 2647, "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, "dispatch_type": 1, "charge_type": 1, "custom_data": null, "issued_at": "2025-07-18T09:08:20+08:00", "shorten_url": "http://boleto.test:5001/2/nkge", "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": "nkge", "financial_provider_external_id": null, "days_for_sue_type": null, "credit_bureau": null, "after_create": [], "bank_billet_discharges": [], "bank_billet_remittances": [], "bank_billet_payments": [], "bank_billet_registrations": [], "bank_billet_split_accounts": [], "pix": [] } }, "occurred_at": "2015-02-16T16:40:27+08:00", "bank_billet_account_id": null, "resource_owner_id": 1718, "created_at": "2025-07-18T09:08:20+08:00", "updated_at": "2025-07-18T09:08:20+08:00" }, { "resource_owner": { "id": 1717, "type": "bank_billet" }, "resource_base": { "id": 1717, "type": "bank_billet" }, "id": 483, "uid": "01981b13-3503-7ba1-8774-35b33bd09e4d", "code": "bank_billet.created", "data": { "object": { "id": 1717, "uid": "01981b13-34e9-75fd-a5e9-7ba5ec30e1d2", "expire_at": "2025-07-21", "paid_at": null, "description": "Serviço de criação de site\\r\\nExpira em: 21/07/2025", "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": false, "customer_city_name": "Rio de Janeiro", "paid_amount": null, "amount": 50.0, "url": "http://boleto.test:5001/2/kgxv", "formats": { "default": "http://boleto.test:5001/2/kgxv", "png": "http://boleto.test:5001/2/kgxv.png", "pdf": "http://boleto.test:5001/2/kgxv.pdf", "boleto_hibrido": "http://boleto.test:5001/2/kgxv/boleto_hibrido", "boleto_pix": "http://boleto.test:5001/2/kgxv/boleto_pix", "barcode": "http://boleto.test:5001/2/kgxv/barcode", "envelope": "http://boleto.test:5001/2/kgxv/envelope", "letter": "http://boleto.test:5001/2/kgxv/letter", "line": "http://boleto.test:5001/2/kgxv/line", "recibo": "http://boleto.test:5001/2/kgxv/recibo", "pix_qrcode": "http://boleto.test:5001/2/kgxv/pix_qrcode" }, "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": 2226, "beneficiary_name": "Kobana Instituição de Pagamento 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": "00498771", "processed_our_number_raw": "00498771", "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 04987.710011 3 11490000005000", "our_number": "49877", "customer_subscription_id": null, "installment_total": null, "installment_number": null, "installment_id": null, "carne_url": null, "bank_billet_layout_id": null, "created_at": "2025-07-18T09:08:20+08:00", "updated_at": "2025-07-18T09:08:20+08: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": "75693114900000050001432701022938500498771001", "registered_at": null, "prevent_registration": false, "customer_id": 2646, "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, "dispatch_type": 1, "charge_type": 1, "custom_data": null, "issued_at": "2025-07-18T09:08:20+08:00", "shorten_url": "http://boleto.test:5001/2/kgxv", "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": "kgxv", "financial_provider_external_id": null, "days_for_sue_type": null, "credit_bureau": null, "after_create": [], "bank_billet_discharges": [], "bank_billet_remittances": [], "bank_billet_payments": [], "bank_billet_registrations": [], "bank_billet_split_accounts": [], "pix": [] } }, "occurred_at": "2015-02-16T16:40:27+08:00", "bank_billet_account_id": null, "resource_owner_id": 1717, "created_at": "2025-07-18T09:08:20+08:00", "updated_at": "2025-07-18T09:08:20+08:00" }, { "resource_owner": { "id": 1716, "type": "bank_billet" }, "resource_base": { "id": 1716, "type": "bank_billet" }, "id": 482, "uid": "01981b13-3417-7ed9-8527-53d6126c5c47", "code": "bank_billet.created", "data": { "object": { "id": 1716, "uid": "01981b13-3401-7d9e-8d89-e0aeef1a8413", "expire_at": "2025-07-21", "paid_at": null, "description": "Serviço de criação de site\\r\\nExpira em: 21/07/2025", "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": false, "customer_city_name": "Rio de Janeiro", "paid_amount": null, "amount": 50.0, "url": "http://boleto.test:5001/2/vvdg", "formats": { "default": "http://boleto.test:5001/2/vvdg", "png": "http://boleto.test:5001/2/vvdg.png", "pdf": "http://boleto.test:5001/2/vvdg.pdf", "boleto_hibrido": "http://boleto.test:5001/2/vvdg/boleto_hibrido", "boleto_pix": "http://boleto.test:5001/2/vvdg/boleto_pix", "barcode": "http://boleto.test:5001/2/vvdg/barcode", "envelope": "http://boleto.test:5001/2/vvdg/envelope", "letter": "http://boleto.test:5001/2/vvdg/letter", "line": "http://boleto.test:5001/2/vvdg/line", "recibo": "http://boleto.test:5001/2/vvdg/recibo", "pix_qrcode": "http://boleto.test:5001/2/vvdg/pix_qrcode" }, "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": 2225, "beneficiary_name": "Kobana Instituição de Pagamento 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": "00809881", "processed_our_number_raw": "00809881", "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 08098.810016 1 11490000005000", "our_number": "80988", "customer_subscription_id": null, "installment_total": null, "installment_number": null, "installment_id": null, "carne_url": null, "bank_billet_layout_id": null, "created_at": "2025-07-18T09:08:20+08:00", "updated_at": "2025-07-18T09:08:20+08: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": "75691114900000050001432701022938500809881001", "registered_at": null, "prevent_registration": false, "customer_id": 2645, "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, "dispatch_type": 1, "charge_type": 1, "custom_data": null, "issued_at": "2025-07-18T09:08:20+08:00", "shorten_url": "http://boleto.test:5001/2/vvdg", "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": "vvdg", "financial_provider_external_id": null, "days_for_sue_type": null, "credit_bureau": null, "after_create": [], "bank_billet_discharges": [], "bank_billet_remittances": [], "bank_billet_payments": [], "bank_billet_registrations": [], "bank_billet_split_accounts": [], "pix": [] } }, "occurred_at": "2015-02-16T16:40:27+08:00", "bank_billet_account_id": null, "resource_owner_id": 1716, "created_at": "2025-07-18T09:08:20+08:00", "updated_at": "2025-07-18T09:08:20+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/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": "ID do Evento", "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Evento encontrado com sucesso", "content": { "application/json": { "example": { "resource_owner": { "id": 1721, "type": "bank_billet" }, "resource_base": { "id": 1721, "type": "bank_billet" }, "id": 487, "uid": "01981b13-3844-743a-ba40-ae12a2369140", "code": "bank_billet.created", "data": { "object": { "id": 1721, "uid": "01981b13-3828-7ad3-abea-3dc68a164ef6", "expire_at": "2025-07-21", "paid_at": null, "description": "Serviço de criação de site\\r\\nExpira em: 21/07/2025", "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": false, "customer_city_name": "Rio de Janeiro", "paid_amount": null, "amount": 50.0, "url": "http://boleto.test:5001/2/zxzq", "formats": { "default": "http://boleto.test:5001/2/zxzq", "png": "http://boleto.test:5001/2/zxzq.png", "pdf": "http://boleto.test:5001/2/zxzq.pdf", "boleto_hibrido": "http://boleto.test:5001/2/zxzq/boleto_hibrido", "boleto_pix": "http://boleto.test:5001/2/zxzq/boleto_pix", "barcode": "http://boleto.test:5001/2/zxzq/barcode", "envelope": "http://boleto.test:5001/2/zxzq/envelope", "letter": "http://boleto.test:5001/2/zxzq/letter", "line": "http://boleto.test:5001/2/zxzq/line", "recibo": "http://boleto.test:5001/2/zxzq/recibo", "pix_qrcode": "http://boleto.test:5001/2/zxzq/pix_qrcode" }, "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": 2230, "beneficiary_name": "Kobana Instituição de Pagamento 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": "00491328", "processed_our_number_raw": "00491328", "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 04913.280014 5 11490000005000", "our_number": "49132", "customer_subscription_id": null, "installment_total": null, "installment_number": null, "installment_id": null, "carne_url": null, "bank_billet_layout_id": null, "created_at": "2025-07-18T09:08:21+08:00", "updated_at": "2025-07-18T09:08:21+08: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": "75695114900000050001432701022938500491328001", "registered_at": null, "prevent_registration": false, "customer_id": 2650, "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, "dispatch_type": 1, "charge_type": 1, "custom_data": null, "issued_at": "2025-07-18T09:08:21+08:00", "shorten_url": "http://boleto.test:5001/2/zxzq", "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": "zxzq", "financial_provider_external_id": null, "days_for_sue_type": null, "credit_bureau": null, "after_create": [], "bank_billet_discharges": [], "bank_billet_remittances": [], "bank_billet_payments": [], "bank_billet_registrations": [], "bank_billet_split_accounts": [], "pix": [] } }, "occurred_at": "2015-02-16T16:40:27+08:00", "bank_billet_account_id": null, "resource_owner_id": 1721, "created_at": "2025-07-18T09:08:21+08:00", "updated_at": "2025-07-18T09:08:21+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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", "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.add_pix.requested", "bank_billet.add_pix.confirmed", "bank_billet.add_pix.failed", "bank_billet.add_pix.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", "statement_transaction.db.created", "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", "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.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.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.ted_batch.awaiting_approval", "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.internal_batch.awaiting_approval", "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.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.cancel.requested", "transfer.pix.cancel.confirmed", "transfer.pix.cancel.failed", "transfer.pix.cancel.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.cancel.requested", "transfer.ted.cancel.confirmed", "transfer.ted.cancel.failed", "transfer.ted.cancel.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.cancel.requested", "transfer.internal.cancel.confirmed", "transfer.internal.cancel.failed", "transfer.internal.cancel.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.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.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.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.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.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.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.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.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.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.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.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.darf_batch.awaiting_approval", "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.utility_batch.awaiting_approval", "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.gru_batch.awaiting_approval", "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.pix_batch.awaiting_approval", "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.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.bank_billet.db.created", "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", "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.payment.db.created", "charge.payment.db.updated", "charge.payment.db.deleted", "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", "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", "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": 83, "uid": "01981b13-3ca6-7fe6-8034-275fabeffbe3", "event_code": "bank_billet.created", "message": "MyText", "phone_to": "+5522987654321", "sent_error": null, "delivered_at": null, "failed_at": null, "resource_owner_id": 1726, "status": "pending", "bank_billet_account_id": null, "sms_notification_id": 83, "customer_id": 2655, "customer_external_code": null, "created_at": "2025-07-18T09:08:22+08:00", "updated_at": "2025-07-18T09:08:22+08:00", "resource_owner": { "id": 1726, "type": "bank_billet" }, "resource_base": { "id": 1726, "type": "bank_billet" } }, { "id": 82, "uid": "01981b13-3c5b-786c-a70c-a74f44acef73", "event_code": "bank_billet.created", "message": "MyText", "phone_to": "+5522987654321", "sent_error": null, "delivered_at": null, "failed_at": null, "resource_owner_id": 1725, "status": "pending", "bank_billet_account_id": null, "sms_notification_id": 82, "customer_id": 2654, "customer_external_code": null, "created_at": "2025-07-18T09:08:22+08:00", "updated_at": "2025-07-18T09:08:22+08:00", "resource_owner": { "id": 1725, "type": "bank_billet" }, "resource_base": { "id": 1725, "type": "bank_billet" } }, { "id": 81, "uid": "01981b13-3c0d-7685-a413-3ca4bb0c4b9f", "event_code": "bank_billet.created", "message": "MyText", "phone_to": "+5522987654321", "sent_error": null, "delivered_at": null, "failed_at": null, "resource_owner_id": 1724, "status": "pending", "bank_billet_account_id": null, "sms_notification_id": 81, "customer_id": 2653, "customer_external_code": null, "created_at": "2025-07-18T09:08:22+08:00", "updated_at": "2025-07-18T09:08:22+08:00", "resource_owner": { "id": 1724, "type": "bank_billet" }, "resource_base": { "id": 1724, "type": "bank_billet" } }, { "id": 80, "uid": "01981b13-3bc3-7133-a4e7-66bac0baa3c7", "event_code": "bank_billet.created", "message": "MyText", "phone_to": "+5522987654321", "sent_error": null, "delivered_at": null, "failed_at": null, "resource_owner_id": 1723, "status": "pending", "bank_billet_account_id": null, "sms_notification_id": 80, "customer_id": 2652, "customer_external_code": null, "created_at": "2025-07-18T09:08:22+08:00", "updated_at": "2025-07-18T09:08:22+08:00", "resource_owner": { "id": 1723, "type": "bank_billet" }, "resource_base": { "id": 1723, "type": "bank_billet" } }, { "id": 79, "uid": "01981b13-3b5d-7f79-a5fb-af56fcba3064", "event_code": "bank_billet.created", "message": "MyText", "phone_to": "+5522987654321", "sent_error": null, "delivered_at": null, "failed_at": null, "resource_owner_id": 1722, "status": "pending", "bank_billet_account_id": null, "sms_notification_id": 79, "customer_id": 2651, "customer_external_code": null, "created_at": "2025-07-18T09:08:22+08:00", "updated_at": "2025-07-18T09:08:22+08:00", "resource_owner": { "id": 1722, "type": "bank_billet" }, "resource_base": { "id": 1722, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 84, "uid": "01981b13-3ee1-76e1-b0bd-7d78181cc7fc", "event_code": "bank_billet.created", "message": "MyText", "phone_to": "+5522987654321", "sent_error": null, "delivered_at": null, "failed_at": null, "resource_owner_id": 1727, "status": "pending", "bank_billet_account_id": null, "sms_notification_id": 84, "customer_id": 2656, "customer_external_code": null, "created_at": "2025-07-18T09:08:22+08:00", "updated_at": "2025-07-18T09:08:22+08:00", "resource_owner": { "id": 1727, "type": "bank_billet" }, "resource_base": { "id": 1727, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_error" } } } } } } }, "/v1/userinfo": { "get": { "summary": "Informações do Usuário", "tags": [ "Usuário Autenticado" ], "security": [ { "bearerAuth": [] } ], "description": "Consulta informações específicas de um usuário.\n\nQuando acessado através do [OAuth2](/reference/oauth2), as informações retornadas variam de acordo com as [permissões](/reference/permissões) concedidas pelo usuário conforme a tabela abaixo:\n\nQuando acessado através do [Token de Acesso](/reference/token-de-acesso), todass as informações são retornadas.\n\n| **Escopo** | **Campos Retornados** |\n|---|---|\n| **email** | [:email] |\n| **profile** | [:account_type, :first_name, :middle_name, :last_name, :full_name, :cpf, :date_of_birth, :mother_name, :father_name, :account_level] |\n| **address** | [:address_street_name, :address_number, :address_complement, :address_neighborhood, :address_postal_code, :address_city_name, :address_state] |\n| **phone** | [:phone_number] |\n| **business** | [:business_name, :business_cnpj, :business_legal_name] |\n| **balance** | [:balance_cents] |", "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": 7720, "email": "d15129cefd1770422eb002a83221d719@lakin-beahan.example", "business_name": null, "business_cnpj": null, "business_legal_name": null, "simple_opting": false }, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"login email profile phone address business balance checkout subscription\".", "code": "forbidden" } ] }, "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", "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.add_pix.requested", "bank_billet.add_pix.confirmed", "bank_billet.add_pix.failed", "bank_billet.add_pix.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", "statement_transaction.db.created", "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", "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.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.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.ted_batch.awaiting_approval", "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.internal_batch.awaiting_approval", "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.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.cancel.requested", "transfer.pix.cancel.confirmed", "transfer.pix.cancel.failed", "transfer.pix.cancel.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.cancel.requested", "transfer.ted.cancel.confirmed", "transfer.ted.cancel.failed", "transfer.ted.cancel.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.cancel.requested", "transfer.internal.cancel.confirmed", "transfer.internal.cancel.failed", "transfer.internal.cancel.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.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.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.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.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.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.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.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.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.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.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.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.darf_batch.awaiting_approval", "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.utility_batch.awaiting_approval", "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.gru_batch.awaiting_approval", "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.pix_batch.awaiting_approval", "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.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.bank_billet.db.created", "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", "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.payment.db.created", "charge.payment.db.updated", "charge.payment.db.deleted", "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", "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", "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": 166, "uid": "58fcf71f-9059-4c54-9002-9e59129e9fcc", "url": null, "duration": null, "request_headers": null, "request_payload": { "event_code": "bank_billet.created", "webhook": { "id": 320, "url": "http://dev.bole.to:5001", "first_try": "2025-07-18T09:08:25+08: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": 320, "event_code": "bank_billet.created", "resource_owner_id": 1733, "created_at": "2025-07-18T09:08:25+08:00", "updated_at": "2025-07-18T09:08:25+08:00", "resource_owner": { "id": 1733, "type": "bank_billet" }, "resource_base": { "id": 1733, "type": "bank_billet" } }, { "id": 165, "uid": "dd7aef2c-cc66-4a94-b28b-6fac4ad7c2c5", "url": null, "duration": null, "request_headers": null, "request_payload": { "event_code": "bank_billet.created", "webhook": { "id": 319, "url": "http://dev.bole.to:5001", "first_try": "2025-07-18T09:08:25+08: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": 319, "event_code": "bank_billet.created", "resource_owner_id": 1732, "created_at": "2025-07-18T09:08:25+08:00", "updated_at": "2025-07-18T09:08:25+08:00", "resource_owner": { "id": 1732, "type": "bank_billet" }, "resource_base": { "id": 1732, "type": "bank_billet" } }, { "id": 164, "uid": "93201244-d623-4666-8799-8968f52e2cab", "url": null, "duration": null, "request_headers": null, "request_payload": { "event_code": "bank_billet.created", "webhook": { "id": 318, "url": "http://dev.bole.to:5001", "first_try": "2025-07-18T09:08:25+08: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": 318, "event_code": "bank_billet.created", "resource_owner_id": 1731, "created_at": "2025-07-18T09:08:25+08:00", "updated_at": "2025-07-18T09:08:25+08:00", "resource_owner": { "id": 1731, "type": "bank_billet" }, "resource_base": { "id": 1731, "type": "bank_billet" } }, { "id": 163, "uid": "83a377a0-d36d-4dd4-baa9-078d90506c42", "url": null, "duration": null, "request_headers": null, "request_payload": { "event_code": "bank_billet.created", "webhook": { "id": 317, "url": "http://dev.bole.to:5001", "first_try": "2025-07-18T09:08:25+08: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": 317, "event_code": "bank_billet.created", "resource_owner_id": 1730, "created_at": "2025-07-18T09:08:25+08:00", "updated_at": "2025-07-18T09:08:25+08:00", "resource_owner": { "id": 1730, "type": "bank_billet" }, "resource_base": { "id": 1730, "type": "bank_billet" } }, { "id": 162, "uid": "b1906da5-d0a2-4db8-bb1d-78e1391a7451", "url": null, "duration": null, "request_headers": null, "request_payload": { "event_code": "bank_billet.created", "webhook": { "id": 316, "url": "http://dev.bole.to:5001", "first_try": "2025-07-18T09:08:25+08: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": 316, "event_code": "bank_billet.created", "resource_owner_id": 1729, "created_at": "2025-07-18T09:08:25+08:00", "updated_at": "2025-07-18T09:08:25+08:00", "resource_owner": { "id": 1729, "type": "bank_billet" }, "resource_base": { "id": 1729, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 167, "uid": "85ab28a6-868a-48d2-b566-269bef67e32d", "url": null, "duration": null, "request_headers": null, "request_payload": { "event_code": "bank_billet.created", "webhook": { "id": 321, "url": "http://dev.bole.to:5001", "first_try": "2025-07-18T09:08:26+08: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": 321, "event_code": "bank_billet.created", "resource_owner_id": 1734, "created_at": "2025-07-18T09:08:26+08:00", "updated_at": "2025-07-18T09:08:26+08:00", "resource_owner": { "id": 1734, "type": "bank_billet" }, "resource_base": { "id": 1734, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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", "content": { "application/json": { "example": { "id": 327, "uid": "01981b13-513f-7415-afd2-da43ab29590f", "name": null, "url": "http://example.com/new", "content_type": "application/x-www-form-urlencoded", "events": [ "bank_billet.created" ], "ssl_verification_enabled": true, "active": false, "concurrency_limit": 2, "subaccounts": false, "created_at": "2025-07-18T09:08:27+08:00", "updated_at": "2025-07-18T09:08:27+08:00", "secret_key": "d85934352c97f96c86e80a27df5136fe2a77b6da1200801c3afdbcb96a384195" }, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 332, "uid": "01981b13-5408-7c78-860d-cdadbccc7c58", "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, "created_at": "2025-07-18T09:08:28+08:00", "updated_at": "2025-07-18T09:08:28+08:00" }, { "id": 331, "uid": "01981b13-53ff-7885-b688-44e7b4336e9f", "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, "created_at": "2025-07-18T09:08:28+08:00", "updated_at": "2025-07-18T09:08:28+08:00" }, { "id": 330, "uid": "01981b13-53f8-7f3e-a759-a00247cd6425", "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, "created_at": "2025-07-18T09:08:28+08:00", "updated_at": "2025-07-18T09:08:28+08:00" }, { "id": 329, "uid": "01981b13-53f2-7344-96d9-0b584cc4690a", "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, "created_at": "2025-07-18T09:08:28+08:00", "updated_at": "2025-07-18T09:08:28+08:00" }, { "id": 328, "uid": "01981b13-53ec-7b8a-9ad1-0002aa768e0a", "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, "created_at": "2025-07-18T09:08:28+08:00", "updated_at": "2025-07-18T09:08:28+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 333, "uid": "01981b13-55bb-7ce0-a15e-0342218275eb", "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, "created_at": "2025-07-18T09:08:28+08:00", "updated_at": "2025-07-18T09:08:28+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": "Webhook atualizado" }, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 125, "uid": "01981b13-6152-748e-9f4e-e7cfa7e8f8dd", "created_at": "2025-07-18T09:08:31+08:00", "updated_at": "2025-07-18T09:08:31+08:00", "name": "Lote de Boletos", "bank_billet_ids": [ 1744, 1745 ] }, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 128, "uid": "01981b13-6491-778b-9131-d4241a531d20", "created_at": "2025-07-18T09:08:32+08:00", "updated_at": "2025-07-18T09:08:32+08:00", "name": "Lote", "bank_billet_ids": [ 1750, 1751 ] }, { "id": 127, "uid": "01981b13-6420-78d3-8f1a-d3cab81f8f9d", "created_at": "2025-07-18T09:08:32+08:00", "updated_at": "2025-07-18T09:08:32+08:00", "name": "Lote", "bank_billet_ids": [ 1748, 1749 ] }, { "id": 126, "uid": "01981b13-6399-7af8-9da5-8d2a166b2e99", "created_at": "2025-07-18T09:08:32+08:00", "updated_at": "2025-07-18T09:08:32+08:00", "name": "Lote", "bank_billet_ids": [ 1746, 1747 ] } ], "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 129, "uid": "01981b13-66af-77fc-93a1-440bc5f5df09", "created_at": "2025-07-18T09:08:33+08:00", "updated_at": "2025-07-18T09:08:33+08:00", "name": "Lote", "bank_billet_ids": [ 1752, 1753 ] }, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 41, "account_id": 7766, "bank_billet_batch_id": 134, "created_at": "2025-07-18T09:08:36+08:00", "file_format": "zip", "output_url": null, "processed_at": null, "public_id": "01981b13-731f-76d0-a096-46556febabc0", "status": "enqueued", "updated_at": "2025-07-18T09:08:36+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 42, "account_id": 7769, "bank_billet_batch_id": 135, "created_at": "2025-07-18T09:08:36+08:00", "file_format": "pdf", "output_url": null, "processed_at": null, "public_id": "01981b13-75cc-7f30-9124-ce3324012ddb", "status": "enqueued", "updated_at": "2025-07-18T09:08:36+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 81, "uid": "01981b13-79e2-7d4a-a7bd-f9bb32b70b08", "occurrence": "03", "date_of_occurrence": "2014-03-08", "discharge_id": 273, "bank_billet_id": 1767, "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": "2025-07-18T09:08:37+08:00", "updated_at": "2025-07-18T09:08:37+08:00", "kind": "400" }, { "id": 80, "uid": "01981b13-7990-7401-bb4c-1cd9cf2e5551", "occurrence": "03", "date_of_occurrence": "2014-03-08", "discharge_id": 272, "bank_billet_id": 1766, "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": "2025-07-18T09:08:37+08:00", "updated_at": "2025-07-18T09:08:37+08:00", "kind": "400" }, { "id": 79, "uid": "01981b13-792e-7369-a878-b2b04db64c85", "occurrence": "03", "date_of_occurrence": "2014-03-08", "discharge_id": 271, "bank_billet_id": 1765, "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": "2025-07-18T09:08:37+08:00", "updated_at": "2025-07-18T09:08:37+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 82, "uid": "01981b13-7c44-72c2-a86a-fb98db075be9", "occurrence": "03", "date_of_occurrence": "2014-03-08", "discharge_id": 274, "bank_billet_id": 1768, "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": "2025-07-18T09:08:38+08:00", "updated_at": "2025-07-18T09:08:38+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 96, "bank_billet_id": 1769, "bank_billet_account_id": 2274, "discharge_id": null, "paid_at": "2017-03-13", "paid_amount": 40.01, "bank_rate": 4.02, "paid_bank": "001", "paid_agency": "00001", "created_at": "2025-07-18T09:08:39+08: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": "01981b13-7f31-72f8-8b8a-9f2ab3e2f87f", "pix_id": null, "document_number": null, "our_number": "30266", "customer_person_name": "José da Silva", "expire_at": "2025-07-21", "amount": 50.0, "updated_at": "2025-07-18T09:08:39+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 97, "bank_billet_id": 1770, "bank_billet_account_id": 2275, "discharge_id": null, "paid_at": "2025-07-20", "paid_amount": 50.0, "bank_rate": 1.5, "paid_bank": "001", "paid_agency": "0001", "created_at": "2025-07-18T09:08:40+08: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": "01981b13-81d1-74fa-aff5-ce06b2b8cd3b", "pix_id": null, "document_number": null, "our_number": "48095", "customer_person_name": "José da Silva", "expire_at": "2025-07-21", "amount": 50.0, "updated_at": "2025-07-18T09:08:40+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 98, "bank_billet_id": 1771, "bank_billet_account_id": 2276, "discharge_id": null, "paid_at": "2025-07-20", "paid_amount": 50.0, "bank_rate": 1.5, "paid_bank": "001", "paid_agency": "0001", "created_at": "2025-07-18T09:08:40+08: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": "01981b13-83fb-7a33-bd4d-9f807587a7c8", "pix_id": null, "document_number": null, "our_number": "28337", "customer_person_name": "José da Silva", "expire_at": "2025-07-21", "amount": 50.0, "updated_at": "2025-07-18T09:08:40+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 81, "uid": "01981b13-895a-7530-a739-7b729d7caac6", "bank_billet_id": 1774, "bank_billet_account_id": 2279, "created_at": "2025-07-18T09:08:41+08:00", "error_message": null, "failed_at": null, "fails_count": 0, "registered_at": null, "status": "1", "updated_at": "2025-07-18T09:08:41+08:00", "retry_blocked": false }, { "id": 80, "uid": "01981b13-891b-74f3-9e61-1b7c977701b6", "bank_billet_id": 1773, "bank_billet_account_id": 2278, "created_at": "2025-07-18T09:08:41+08:00", "error_message": null, "failed_at": null, "fails_count": 0, "registered_at": null, "status": "1", "updated_at": "2025-07-18T09:08:41+08:00", "retry_blocked": false }, { "id": 79, "uid": "01981b13-88de-73a4-8720-df4261c5b4c6", "bank_billet_id": 1772, "bank_billet_account_id": 2277, "created_at": "2025-07-18T09:08:41+08:00", "error_message": null, "failed_at": null, "fails_count": 0, "registered_at": null, "status": "1", "updated_at": "2025-07-18T09:08:41+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 82, "uid": "01981b13-8b42-7885-9057-7bfd43468369", "bank_billet_id": 1775, "bank_billet_account_id": 2280, "created_at": "2025-07-18T09:08:42+08:00", "error_message": null, "failed_at": null, "fails_count": 0, "registered_at": null, "status": "1", "updated_at": "2025-07-18T09:08:42+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 286, "uid": "01981b13-8e4f-7e88-acf7-8200ecd2206f", "our_code": "1001", "occurrence": "01", "remittance_id": null, "bank_billet_id": 1778, "bank_billet_account_id": 2283, "processed_at": null, "occurrence_detail": "Entrada de Título", "created_at": "2025-07-18T09:08:43+08:00", "updated_at": "2025-07-18T09:08:43+08:00" }, { "id": 285, "uid": "01981b13-8e0c-7380-b8d5-ce861a7b4fa0", "our_code": "1001", "occurrence": "01", "remittance_id": null, "bank_billet_id": 1777, "bank_billet_account_id": 2282, "processed_at": null, "occurrence_detail": "Entrada de Título", "created_at": "2025-07-18T09:08:43+08:00", "updated_at": "2025-07-18T09:08:43+08:00" }, { "id": 284, "uid": "01981b13-8dcc-7dc5-bbcb-fee680d570ba", "our_code": "1001", "occurrence": "01", "remittance_id": null, "bank_billet_id": 1776, "bank_billet_account_id": 2281, "processed_at": null, "occurrence_detail": "Entrada de Título", "created_at": "2025-07-18T09:08:43+08:00", "updated_at": "2025-07-18T09:08:43+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 289, "uid": "01981b13-914e-73dd-8462-ece08ed12434", "our_code": "1001", "occurrence": "01", "remittance_id": null, "bank_billet_id": 1781, "bank_billet_account_id": 2286, "processed_at": null, "occurrence_detail": "Entrada de Título", "created_at": "2025-07-18T09:08:43+08:00", "updated_at": "2025-07-18T09:08:43+08:00" }, { "id": 288, "uid": "01981b13-9100-7ccd-996a-f78a32dd9ced", "our_code": "1001", "occurrence": "01", "remittance_id": null, "bank_billet_id": 1780, "bank_billet_account_id": 2285, "processed_at": null, "occurrence_detail": "Entrada de Título", "created_at": "2025-07-18T09:08:43+08:00", "updated_at": "2025-07-18T09:08:43+08:00" }, { "id": 287, "uid": "01981b13-909e-77a9-835c-71705e302840", "our_code": "1001", "occurrence": "01", "remittance_id": null, "bank_billet_id": 1779, "bank_billet_account_id": 2284, "processed_at": null, "occurrence_detail": "Entrada de Título", "created_at": "2025-07-18T09:08:43+08:00", "updated_at": "2025-07-18T09:08:43+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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 1782 - 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_entity" } ] }, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 291, "uid": "01981b13-9881-7434-a97b-8a0460691dc2", "our_code": "1001", "occurrence": "01", "remittance_id": null, "bank_billet_id": 1785, "bank_billet_account_id": 2290, "processed_at": null, "occurrence_detail": "Entrada de Título", "created_at": "2025-07-18T09:08:45+08:00", "updated_at": "2025-07-18T09:08:45+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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", "content": { "application/json": { "example": { "id": 275, "uid": "01981b13-9b95-71d9-a38d-4a9249d306a8", "filename": null, "processed_at": null, "created_via_api": true, "status": "unprocessed", "bank_billet_account_id": null, "created_via_integration": null, "created_at": "2025-07-18T09:08:46+08:00", "updated_at": "2025-07-18T09:08:46+08:00", "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": "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": 281, "uid": "01981b13-9f10-7d52-b27b-1b3bbb592829", "filename": null, "processed_at": null, "created_via_api": false, "status": "unprocessed", "bank_billet_account_id": 2291, "created_via_integration": null, "created_at": "2025-07-18T09:08:47+08:00", "updated_at": "2025-07-18T09:08:47+08:00", "bank_billet_discharges": [] }, { "id": 280, "uid": "01981b13-9efc-7952-9d85-2e781c632541", "filename": null, "processed_at": null, "created_via_api": false, "status": "unprocessed", "bank_billet_account_id": 2291, "created_via_integration": null, "created_at": "2025-07-18T09:08:47+08:00", "updated_at": "2025-07-18T09:08:47+08:00", "bank_billet_discharges": [] }, { "id": 279, "uid": "01981b13-9ee1-793f-b279-683a1ae4e47d", "filename": null, "processed_at": null, "created_via_api": false, "status": "unprocessed", "bank_billet_account_id": 2291, "created_via_integration": null, "created_at": "2025-07-18T09:08:47+08:00", "updated_at": "2025-07-18T09:08:47+08:00", "bank_billet_discharges": [] }, { "id": 278, "uid": "01981b13-9ed2-7780-a4cb-0ed22f6b537f", "filename": null, "processed_at": null, "created_via_api": false, "status": "unprocessed", "bank_billet_account_id": 2291, "created_via_integration": null, "created_at": "2025-07-18T09:08:47+08:00", "updated_at": "2025-07-18T09:08:47+08:00", "bank_billet_discharges": [] }, { "id": 277, "uid": "01981b13-9ec1-73ef-9c9f-1ab0a32352c6", "filename": null, "processed_at": null, "created_via_api": false, "status": "unprocessed", "bank_billet_account_id": 2291, "created_via_integration": null, "created_at": "2025-07-18T09:08:47+08:00", "updated_at": "2025-07-18T09:08:47+08:00", "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 282, "uid": "01981b13-a0fd-7977-b9bc-58fe9edf96a3", "filename": null, "processed_at": null, "created_via_api": false, "status": "unprocessed", "bank_billet_account_id": 2292, "created_via_integration": null, "created_at": "2025-07-18T09:08:47+08:00", "updated_at": "2025-07-18T09:08:48+08:00", "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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://developers.kobana.com.br/reference/token-de-acesso" } ] } }, "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 do scope \"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": 176, "uid": "01981b13-ad5b-7410-a055-4f6d8804e46f", "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": "2025-07-18T09:08:51+08:00", "updated_at": "2025-07-18T09:08:51+08:00" }, { "id": 175, "uid": "01981b13-ac0c-733f-bf0e-5f9fa810d7a6", "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": "2025-07-18T09:08:50+08:00", "updated_at": "2025-07-18T09:08:50+08: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[block:callout]\n{\n \"type\": \"info\",\n \"body\": \"Este endpoint é processado assincronamente.\",\n \"title\": \"Processamento Assíncrono\"\n}\n[/block]\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": 177, "uid": "01981b13-aeb7-723a-b3e1-3b73501053d6", "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": "2025-07-18T09:08:51+08:00", "updated_at": "2025-07-18T09:08:51+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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": 178, "uid": "01981b13-b1a3-708a-ada1-4b4a1bc43caf", "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": "2025-07-18T09:08:52+08:00", "updated_at": "2025-07-18T09:08:52+08: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", "content": { "application/json": { "example": { "id": 153, "uid": "01981b13-b401-7483-b7c9-69ad0c22dba2", "filename": "2507181.REM", "created_via_api": true, "status": "unprocessed", "bank_billet_account_id": 2293, "created_at": "2025-07-18T09:08:52+08:00", "updated_at": "2025-07-18T09:08:52+08:00", "processed_at": null, "url": null, "bank_billet_ids": [ 1786 ], "remittance_number": null, "sent_via_integration": null, "generated_by": "kobana", "bank_billet_remittances": [ { "id": 292, "uid": "01981b13-b357-7c79-94f0-008de3a473a6", "our_code": "1001", "occurrence": "01", "remittance_id": 153, "bank_billet_id": 1786, "bank_billet_account_id": 2293, "processed_at": null, "occurrence_detail": "Entrada de Título", "created_at": "2025-07-18T09:08:52+08:00", "updated_at": "2025-07-18T09:08:52+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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 } ], "responses": { "200": { "description": "Sucesso na listagem de CNABs", "content": { "application/json": { "example": [ { "id": 156, "uid": "01981b13-b78e-7f18-a1ee-c10d9a6c660f", "filename": "2507183.REM", "created_via_api": false, "status": "unprocessed", "bank_billet_account_id": 2294, "created_at": "2025-07-18T09:08:53+08:00", "updated_at": "2025-07-18T09:08:53+08:00", "processed_at": null, "url": null, "bank_billet_ids": [ 1789 ], "remittance_number": null, "sent_via_integration": null, "generated_by": "kobana", "bank_billet_remittances": [ { "id": 295, "uid": "01981b13-b790-7329-900b-e07c1ff6fea7", "our_code": "1001", "occurrence": "01", "remittance_id": 156, "bank_billet_id": 1789, "bank_billet_account_id": 2294, "processed_at": null, "occurrence_detail": "Entrada de Título", "created_at": "2025-07-18T09:08:53+08:00", "updated_at": "2025-07-18T09:08:53+08:00" } ] }, { "id": 155, "uid": "01981b13-b74b-7dd6-b412-492deb6aec5a", "filename": "2507182.REM", "created_via_api": false, "status": "unprocessed", "bank_billet_account_id": 2294, "created_at": "2025-07-18T09:08:53+08:00", "updated_at": "2025-07-18T09:08:53+08:00", "processed_at": null, "url": null, "bank_billet_ids": [ 1788 ], "remittance_number": null, "sent_via_integration": null, "generated_by": "kobana", "bank_billet_remittances": [ { "id": 294, "uid": "01981b13-b74d-705d-acee-11bd37330a62", "our_code": "1001", "occurrence": "01", "remittance_id": 155, "bank_billet_id": 1788, "bank_billet_account_id": 2294, "processed_at": null, "occurrence_detail": "Entrada de Título", "created_at": "2025-07-18T09:08:53+08:00", "updated_at": "2025-07-18T09:08:53+08:00" } ] }, { "id": 154, "uid": "01981b13-b70a-78d7-9807-9a40ac3d4962", "filename": "2507181.REM", "created_via_api": false, "status": "unprocessed", "bank_billet_account_id": 2294, "created_at": "2025-07-18T09:08:53+08:00", "updated_at": "2025-07-18T09:08:53+08:00", "processed_at": null, "url": null, "bank_billet_ids": [ 1787 ], "remittance_number": null, "sent_via_integration": null, "generated_by": "kobana", "bank_billet_remittances": [ { "id": 293, "uid": "01981b13-b70b-7a35-b677-3392d43c492b", "our_code": "1001", "occurrence": "01", "remittance_id": 154, "bank_billet_id": 1787, "bank_billet_account_id": 2294, "processed_at": null, "occurrence_detail": "Entrada de Título", "created_at": "2025-07-18T09:08:53+08:00", "updated_at": "2025-07-18T09:08:53+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 157, "uid": "01981b13-b97e-7d4c-8d36-5a5224990f74", "filename": "2507181.REM", "created_via_api": false, "status": "unprocessed", "bank_billet_account_id": 2298, "created_at": "2025-07-18T09:08:54+08:00", "updated_at": "2025-07-18T09:08:54+08:00", "processed_at": null, "url": null, "bank_billet_ids": [ 1790 ], "remittance_number": null, "sent_via_integration": null, "generated_by": "kobana", "bank_billet_remittances": [ { "id": 296, "uid": "01981b13-b980-71b8-90e8-8f910d41d933", "our_code": "1001", "occurrence": "01", "remittance_id": 157, "bank_billet_id": 1790, "bank_billet_account_id": 2298, "processed_at": null, "occurrence_detail": "Entrada de Título", "created_at": "2025-07-18T09:08:54+08:00", "updated_at": "2025-07-18T09:08:54+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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://developers.kobana.com.br/reference/token-de-acesso" } ] } }, "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 do scope \"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": 161, "uid": "01981b13-c2cf-7f36-9e8f-34db8c102030", "filename": "2507181.REM", "created_via_api": true, "status": "unprocessed", "bank_billet_account_id": 2305, "created_at": "2025-07-18T09:08:56+08:00", "updated_at": "2025-07-18T09:08:56+08:00", "processed_at": null, "url": null, "bank_billet_ids": [ 1794, 1794 ], "remittance_number": null, "sent_via_integration": null, "generated_by": "kobana", "bank_billet_remittances": [ { "id": 300, "uid": "01981b13-c25f-7fb4-b335-1fa79e685070", "our_code": "1001", "occurrence": "01", "remittance_id": 161, "bank_billet_id": 1794, "bank_billet_account_id": 2305, "processed_at": null, "occurrence_detail": "Entrada de Título", "created_at": "2025-07-18T09:08:56+08:00", "updated_at": "2025-07-18T09:08:56+08:00" }, { "id": 301, "uid": "01981b13-c263-787a-9a8e-be844c522fae", "our_code": "1002", "occurrence": "02", "remittance_id": 161, "bank_billet_id": 1794, "bank_billet_account_id": 2305, "processed_at": null, "occurrence_detail": "Pedido de Baixa", "created_at": "2025-07-18T09:08:56+08:00", "updated_at": "2025-07-18T09:08:56+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 2306, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v1_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": 810, "uid": "01981b14-69cb-7a63-ae86-abb1ece4be90", "custom_name": "Banco Itaú - Chave 22987654321", "enabled_at": null, "financial_provider_slug": "blupay", "key": "+5522987654321", "status": "pending", "default": false, "beneficiary": { "document_number": "05.813.794/0001-26", "name": "Kobana", "address": { "zip_code": "12345678", "street": "Rua Exemplo", "number": "123", "complement": "Casa", "neighborhood": "Centro", "city_name": "São Paulo", "state": "SP" } }, "created_at": "2025-07-18T09:09:39+08:00", "updated_at": "2025-07-18T09:09:39+08:00" }, { "id": 809, "uid": "01981b14-69c1-72fc-b791-3c8db2d09d0c", "custom_name": "Banco Itaú - Chave 22987654321", "enabled_at": null, "financial_provider_slug": "blupay", "key": "+5522987654321", "status": "pending", "default": false, "beneficiary": { "document_number": "05.813.794/0001-26", "name": "Kobana", "address": { "zip_code": "12345678", "street": "Rua Exemplo", "number": "123", "complement": "Casa", "neighborhood": "Centro", "city_name": "São Paulo", "state": "SP" } }, "created_at": "2025-07-18T09:09:39+08:00", "updated_at": "2025-07-18T09:09:39+08:00" }, { "id": 808, "uid": "01981b14-698a-75b1-a791-b7bbe44f7ed4", "custom_name": "Banco Itaú - Chave 22987654321", "enabled_at": null, "financial_provider_slug": "blupay", "key": "+5522987654321", "status": "pending", "default": false, "beneficiary": { "document_number": "05.813.794/0001-26", "name": "Kobana", "address": { "zip_code": "12345678", "street": "Rua Exemplo", "number": "123", "complement": "Casa", "neighborhood": "Centro", "city_name": "São Paulo", "state": "SP" } }, "created_at": "2025-07-18T09:09:39+08:00", "updated_at": "2025-07-18T09:09:39+08:00" }, { "id": 807, "uid": "01981b14-697e-7dda-bd8b-b08a90d47811", "custom_name": "Banco Itaú - Chave 22987654321", "enabled_at": null, "financial_provider_slug": "blupay", "key": "+5522987654321", "status": "pending", "default": false, "beneficiary": { "document_number": "05.813.794/0001-26", "name": "Kobana", "address": { "zip_code": "12345678", "street": "Rua Exemplo", "number": "123", "complement": "Casa", "neighborhood": "Centro", "city_name": "São Paulo", "state": "SP" } }, "created_at": "2025-07-18T09:09:39+08:00", "updated_at": "2025-07-18T09:09:39+08:00" }, { "id": 806, "uid": "01981b14-6974-7fba-9ef2-b00ef9eee26f", "custom_name": "Banco Itaú - Chave 22987654321", "enabled_at": null, "financial_provider_slug": "blupay", "key": "+5522987654321", "status": "pending", "default": false, "beneficiary": { "document_number": "05.813.794/0001-26", "name": "Kobana", "address": { "zip_code": "12345678", "street": "Rua Exemplo", "number": "123", "complement": "Casa", "neighborhood": "Centro", "city_name": "São Paulo", "state": "SP" } }, "created_at": "2025-07-18T09:09:39+08:00", "updated_at": "2025-07-18T09:09:39+08:00" }, { "id": 805, "uid": "01981b14-6965-7ce7-85d0-3297459e2d05", "custom_name": "Banco Itaú - Chave 22987654321", "enabled_at": null, "financial_provider_slug": "blupay", "key": "+5522987654321", "status": "pending", "default": false, "beneficiary": { "document_number": "05.813.794/0001-26", "name": "Kobana", "address": { "zip_code": "12345678", "street": "Rua Exemplo", "number": "123", "complement": "Casa", "neighborhood": "Centro", "city_name": "São Paulo", "state": "SP" } }, "created_at": "2025-07-18T09:09:39+08:00", "updated_at": "2025-07-18T09:09:39+08:00" }, { "id": 804, "uid": "01981b14-6945-79a3-ac0c-29ebc1042db3", "custom_name": "Banco Itaú - Chave 22987654321", "enabled_at": null, "financial_provider_slug": "blupay", "key": "+5522987654321", "status": "pending", "default": false, "beneficiary": { "document_number": "05.813.794/0001-26", "name": "Kobana", "address": { "zip_code": "12345678", "street": "Rua Exemplo", "number": "123", "complement": "Casa", "neighborhood": "Centro", "city_name": "São Paulo", "state": "SP" } }, "created_at": "2025-07-18T09:09:39+08:00", "updated_at": "2025-07-18T09:09:39+08:00" }, { "id": 803, "uid": "01981b14-693b-787e-8a5c-ddc4fc53d6ef", "custom_name": "Banco Itaú - Chave 22987654321", "enabled_at": null, "financial_provider_slug": "blupay", "key": "+5522987654321", "status": "pending", "default": false, "beneficiary": { "document_number": "05.813.794/0001-26", "name": "Kobana", "address": { "zip_code": "12345678", "street": "Rua Exemplo", "number": "123", "complement": "Casa", "neighborhood": "Centro", "city_name": "São Paulo", "state": "SP" } }, "created_at": "2025-07-18T09:09:39+08:00", "updated_at": "2025-07-18T09:09:39+08:00" }, { "id": 802, "uid": "01981b14-6929-7c53-8a8b-ecc447073930", "custom_name": "Banco Itaú - Chave 22987654321", "enabled_at": null, "financial_provider_slug": "blupay", "key": "+5522987654321", "status": "pending", "default": false, "beneficiary": { "document_number": "05.813.794/0001-26", "name": "Kobana", "address": { "zip_code": "12345678", "street": "Rua Exemplo", "number": "123", "complement": "Casa", "neighborhood": "Centro", "city_name": "São Paulo", "state": "SP" } }, "created_at": "2025-07-18T09:09:39+08:00", "updated_at": "2025-07-18T09:09:39+08:00" }, { "id": 801, "uid": "01981b14-691c-7417-b7cd-019d77862c76", "custom_name": "Banco Itaú - Chave 22987654321", "enabled_at": null, "financial_provider_slug": "blupay", "key": "+5522987654321", "status": "pending", "default": false, "beneficiary": { "document_number": "05.813.794/0001-26", "name": "Kobana", "address": { "zip_code": "12345678", "street": "Rua Exemplo", "number": "123", "complement": "Casa", "neighborhood": "Centro", "city_name": "São Paulo", "state": "SP" } }, "created_at": "2025-07-18T09:09:39+08:00", "updated_at": "2025-07-18T09:09:39+08:00" } ], "pagination": { "prev_url": "/v2/charge/pix_accounts?per_page=20&page=", "next_url": "/v2/charge/pix_accounts?per_page=20&page=", "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": 811, "uid": "01981b14-6b01-73c5-9a10-ea0d718ed0f7", "custom_name": "Pix Account", "enabled_at": "2025-07-18T09:09:39+08:00", "financial_provider_slug": "example_bank", "key": "pix@email.com", "status": "pending", "default": true, "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Razão Social", "address": { "zip_code": "12345678", "street": "Rua Exemplo", "number": "123", "complement": "Apto 1", "neighborhood": "Centro", "city_name": "São Paulo", "state": "SP" } }, "created_at": "2025-07-18T09:09:39+08:00", "updated_at": "2025-07-18T09:09:39+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_pix_account" } } }, "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": 812, "uid": "01981b14-6d1d-7b6a-a536-d918e9adddc7", "custom_name": "Banco Itaú - Chave 22987654321", "enabled_at": null, "financial_provider_slug": "blupay", "key": "+5522987654321", "status": "pending", "default": false, "beneficiary": { "document_number": "05.813.794/0001-26", "name": "Kobana", "address": { "zip_code": "12345678", "street": "Rua Exemplo", "number": "123", "complement": "Casa", "neighborhood": "Centro", "city_name": "São Paulo", "state": "SP" } }, "created_at": "2025-07-18T09:09:40+08:00", "updated_at": "2025-07-18T09:09:40+08: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": 813, "uid": "01981b14-6ebd-728c-88d2-ed15c0f0c40b", "custom_name": "Pix Account", "enabled_at": "2025-07-18T09:09:40+08:00", "financial_provider_slug": "example_bank", "key": "pix@email.com", "status": "pending", "default": true, "beneficiary": { "document_number": "05.813.794/0001-26", "name": "Razão Social", "address": { "zip_code": "12345678", "street": "Rua Exemplo", "number": "123", "complement": "Apto 1", "neighborhood": "Centro", "city_name": "São Paulo", "state": "SP" } }, "created_at": "2025-07-18T09:09:40+08:00", "updated_at": "2025-07-18T09:09:40+08: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": "financial_provider_slug", "detail": "Provedor não está incluído na lista" }, { "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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" } } }, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 601, "uid": "01981b14-7b09-7719-b4ee-0b268bcb2871", "txid": null, "status": "opened", "registration_status": "pending", "pix_account_id": 849, "pix_account_uid": "01981b14-7afc-7390-af40-eeabf0566436", "kind": "instant", "created_at": "2025-07-18T09:09:43+08:00", "updated_at": "2025-07-18T09:09:43+08:00", "expire_at": "2025-07-21T00:00:00+08: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/LkEYTJP1FES1", "formats": { "default": { "html": "http://dev.kdoc.to:5001/1/LkEYTJP1FES1", "png": "http://dev.kdoc.to:5001/1/LkEYTJP1FES1.png", "pdf": "http://dev.kdoc.to:5001/1/LkEYTJP1FES1.pdf" }, "qrcode": { "html": "http://dev.kdoc.to:5001/1/LkEYTJP1FES1/qrcode", "png": "http://dev.kdoc.to:5001/1/LkEYTJP1FES1/qrcode.png", "pdf": "http://dev.kdoc.to:5001/1/LkEYTJP1FES1/qrcode.pdf" } }, "paid_amount": null, "paid_at": null, "end_to_end_id": null, "beneficiary": {}, "custom_data": 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, "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 }, { "id": 600, "uid": "01981b14-7ae3-7a9d-ae96-b660e7bccb02", "txid": null, "status": "opened", "registration_status": "pending", "pix_account_id": 848, "pix_account_uid": "01981b14-7ad6-7cb8-a20e-464b2375ca78", "kind": "instant", "created_at": "2025-07-18T09:09:43+08:00", "updated_at": "2025-07-18T09:09:43+08:00", "expire_at": "2025-07-21T00:00:00+08: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/RE58Y-rSmS9K", "formats": { "default": { "html": "http://dev.kdoc.to:5001/1/RE58Y-rSmS9K", "png": "http://dev.kdoc.to:5001/1/RE58Y-rSmS9K.png", "pdf": "http://dev.kdoc.to:5001/1/RE58Y-rSmS9K.pdf" }, "qrcode": { "html": "http://dev.kdoc.to:5001/1/RE58Y-rSmS9K/qrcode", "png": "http://dev.kdoc.to:5001/1/RE58Y-rSmS9K/qrcode.png", "pdf": "http://dev.kdoc.to:5001/1/RE58Y-rSmS9K/qrcode.pdf" } }, "paid_amount": null, "paid_at": null, "end_to_end_id": null, "beneficiary": {}, "custom_data": 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, "financial_provider_external_id": null, "tags": [ "tag 1", "tag 2", "tag 3" ], "tag_list": "tag 1,tag 2,tag 3", "revoke_days": null }, { "id": 598, "uid": "01981b14-7a87-7718-91c7-ffdc4c070b52", "txid": null, "status": "opened", "registration_status": "pending", "pix_account_id": 846, "pix_account_uid": "01981b14-7a79-73fe-a54d-f274d4d9b0e7", "kind": "instant", "created_at": "2025-07-18T09:09:43+08:00", "updated_at": "2025-07-18T09:09:43+08:00", "expire_at": "2025-07-21T00:00:00+08: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/Fpiq8Aa95fjX", "formats": { "default": { "html": "http://dev.kdoc.to:5001/1/Fpiq8Aa95fjX", "png": "http://dev.kdoc.to:5001/1/Fpiq8Aa95fjX.png", "pdf": "http://dev.kdoc.to:5001/1/Fpiq8Aa95fjX.pdf" }, "qrcode": { "html": "http://dev.kdoc.to:5001/1/Fpiq8Aa95fjX/qrcode", "png": "http://dev.kdoc.to:5001/1/Fpiq8Aa95fjX/qrcode.png", "pdf": "http://dev.kdoc.to:5001/1/Fpiq8Aa95fjX/qrcode.pdf" } }, "paid_amount": null, "paid_at": null, "end_to_end_id": null, "beneficiary": {}, "custom_data": 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, "financial_provider_external_id": null, "tags": [ "tag 1", "tag 3" ], "tag_list": "tag 1,tag 3", "revoke_days": null } ], "pagination": { "prev_url": "/v2/charge/pix?per_page=5&status=&tags=TAG+1+%2C+tag+3&page=", "next_url": "/v2/charge/pix?per_page=5&status=&tags=TAG+1+%2C+tag+3&page=", "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" } } } } } } } }, "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": 613, "uid": "01981b14-84b8-74da-be84-b3ea63b7e51c", "txid": null, "status": "opened", "registration_status": "pending", "pix_account_id": 856, "pix_account_uid": "01981b14-83f4-7caa-acdc-0e32ba589171", "kind": "instant", "created_at": "2025-07-18T09:09:46+08:00", "updated_at": "2025-07-18T09:09:46+08:00", "expire_at": "2025-07-28T09:09:46+08: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": "506.425.892-59", "name": "John Doe" }, "url": "http://dev.kdoc.to:5001/1/wNbGjWTTFkpx", "formats": { "default": { "html": "http://dev.kdoc.to:5001/1/wNbGjWTTFkpx", "png": "http://dev.kdoc.to:5001/1/wNbGjWTTFkpx.png", "pdf": "http://dev.kdoc.to:5001/1/wNbGjWTTFkpx.pdf" }, "qrcode": { "html": "http://dev.kdoc.to:5001/1/wNbGjWTTFkpx/qrcode", "png": "http://dev.kdoc.to:5001/1/wNbGjWTTFkpx/qrcode.png", "pdf": "http://dev.kdoc.to:5001/1/wNbGjWTTFkpx/qrcode.pdf" } }, "paid_amount": null, "paid_at": null, "end_to_end_id": null, "beneficiary": {}, "custom_data": 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, "financial_provider_external_id": null, "tags": [ "tag1", "tag2", "tag3" ], "tag_list": "tag1,tag2,tag3", "revoke_days": null } }, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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": 614, "uid": "01981b14-86d0-74a5-a84a-6b4aba6c6492", "txid": "TXID000001000001000001000001", "status": "opened", "registration_status": "pending", "pix_account_id": 859, "pix_account_uid": "01981b14-86c2-7e2b-b3b1-707e0ef8d0c0", "kind": "instant", "created_at": "2025-07-18T09:09:47+08:00", "updated_at": "2025-07-18T09:09:47+08:00", "expire_at": "2025-07-21T00:00:00+08: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/HaU-ck4H68Op", "formats": { "default": { "html": "http://dev.kdoc.to:5001/1/HaU-ck4H68Op", "png": "http://dev.kdoc.to:5001/1/HaU-ck4H68Op.png", "pdf": "http://dev.kdoc.to:5001/1/HaU-ck4H68Op.pdf" }, "qrcode": { "html": "http://dev.kdoc.to:5001/1/HaU-ck4H68Op/qrcode", "png": "http://dev.kdoc.to:5001/1/HaU-ck4H68Op/qrcode.png", "pdf": "http://dev.kdoc.to:5001/1/HaU-ck4H68Op/qrcode.pdf" } }, "paid_amount": null, "paid_at": null, "end_to_end_id": null, "beneficiary": {}, "custom_data": 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, "financial_provider_external_id": null, "tags": [], "tag_list": null, "revoke_days": null } }, "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[block:callout]\n{\n \"type\": \"info\",\n \"body\": \"Este endpoint é processado assincronamente e cria um comando de atualização para o PIX.\",\n \"title\": \"Processamento Assíncrono\"\n}\n[/block]\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[block:callout]\n{\n \"type\": \"warning\",\n \"body\": \"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.\",\n \"title\": \"Atenção ao payload de retorno\"\n}\n[/block]", "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": 946, "status": "pending", "operation": "update", "params": { "additional_info": { "chave": "valor" }, "expire_at": "2025-07-28T09:09:49+08:00", "fine_type": "amount", "interest_type": "daily_amount_calendar", "message": "Atualização de Pix 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" } }, "reduction_type": "amount", "revoke_days": 5, "amount": 100.2, "fine_amount": 10.0, "interest_amount": 3.0, "reduction_amount": 5.0 }, "payload": null, "created_at": "2025-07-18T09:09:49+08:00", "updated_at": "2025-07-18T09:09:49+08:00", "message": null, "error_message": null, "warning_message": null, "pix": { "id": 618, "uid": "01981b14-8f0f-702a-9cf1-cd4b3794ed74", "txid": "TXID0000000000000000000001", "status": "opened", "registration_status": "pending", "pix_account_id": 863, "pix_account_uid": "01981b14-8efd-7df5-85f7-e677624ad87a", "kind": "instant", "created_at": "2025-07-18T09:09:49+08:00", "updated_at": "2025-07-18T09:09:49+08:00", "expire_at": "2025-07-21T00:00:00+08:00", "canceled_at": null, "registered_at": null, "amount": 199.99, "additional_info": {}, "command_ids": [ 946 ], "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/WFfyeBztaMwe", "formats": { "default": { "html": "http://dev.kdoc.to:5001/1/WFfyeBztaMwe", "png": "http://dev.kdoc.to:5001/1/WFfyeBztaMwe.png", "pdf": "http://dev.kdoc.to:5001/1/WFfyeBztaMwe.pdf" }, "qrcode": { "html": "http://dev.kdoc.to:5001/1/WFfyeBztaMwe/qrcode", "png": "http://dev.kdoc.to:5001/1/WFfyeBztaMwe/qrcode.png", "pdf": "http://dev.kdoc.to:5001/1/WFfyeBztaMwe/qrcode.pdf" } }, "paid_amount": null, "paid_at": null, "end_to_end_id": null, "beneficiary": {}, "custom_data": 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, "financial_provider_external_id": null, "tags": [], "tag_list": null, "revoke_days": null } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_pix_command" } } } } } }, "422": { "description": "Parâmetros inválidos", "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" } } } } }, "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[block:callout]\n{\n \"type\": \"info\",\n \"body\": \"Este endpoint é processado assincronamente e cria um comando de cancelamento para o PIX.\",\n \"title\": \"Processamento Assíncrono\"\n}\n[/block]\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[block:callout]\n{\n \"type\": \"warning\",\n \"body\": \"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.\",\n \"title\": \"Atenção ao payload de retorno\"\n}\n[/block]", "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": 947, "status": "pending", "operation": "cancel", "params": {}, "payload": null, "created_at": "2025-07-18T09:09:52+08:00", "updated_at": "2025-07-18T09:09:52+08:00", "message": null, "error_message": null, "warning_message": null, "pix": { "id": 625, "uid": "01981b14-9a4b-7bd0-84b5-71778f2c6931", "txid": "TXID0000000000000000000001", "status": "opened", "registration_status": "pending", "pix_account_id": 870, "pix_account_uid": "01981b14-9a3a-7765-ae9f-d7ddb5e1ed9e", "kind": "instant", "created_at": "2025-07-18T09:09:51+08:00", "updated_at": "2025-07-18T09:09:51+08:00", "expire_at": "2025-07-21T00:00:00+08:00", "canceled_at": null, "registered_at": null, "amount": 199.99, "additional_info": {}, "command_ids": [ 947 ], "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/qG8izZDcROpx", "formats": { "default": { "html": "http://dev.kdoc.to:5001/1/qG8izZDcROpx", "png": "http://dev.kdoc.to:5001/1/qG8izZDcROpx.png", "pdf": "http://dev.kdoc.to:5001/1/qG8izZDcROpx.pdf" }, "qrcode": { "html": "http://dev.kdoc.to:5001/1/qG8izZDcROpx/qrcode", "png": "http://dev.kdoc.to:5001/1/qG8izZDcROpx/qrcode.png", "pdf": "http://dev.kdoc.to:5001/1/qG8izZDcROpx/qrcode.pdf" } }, "paid_amount": null, "paid_at": null, "end_to_end_id": null, "beneficiary": {}, "custom_data": 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, "financial_provider_external_id": null, "tags": [], "tag_list": null, "revoke_days": null } } }, "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": 948, "status": "pending", "operation": "update", "params": { "amount": 100.0, "expire_at": "2025-07-28T09:09:53+08:00" }, "payload": null, "created_at": "2025-07-18T09:09:53+08:00", "updated_at": "2025-07-18T09:09:53+08:00", "message": null, "error_message": null, "warning_message": null, "pix": { "id": 630, "uid": "01981b14-a29f-7d6b-a6fe-87924b86428c", "txid": null, "status": "opened", "registration_status": "pending", "pix_account_id": 875, "pix_account_uid": "01981b14-a28b-7f49-ab0e-2cf0138643f1", "kind": "instant", "created_at": "2025-07-18T09:09:53+08:00", "updated_at": "2025-07-18T09:09:53+08:00", "expire_at": "2025-07-21T00:00:00+08:00", "canceled_at": null, "registered_at": null, "amount": 25.0, "additional_info": {}, "command_ids": [ 948 ], "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/yqmzF8YMuE2j", "formats": { "default": { "html": "http://dev.kdoc.to:5001/1/yqmzF8YMuE2j", "png": "http://dev.kdoc.to:5001/1/yqmzF8YMuE2j.png", "pdf": "http://dev.kdoc.to:5001/1/yqmzF8YMuE2j.pdf" }, "qrcode": { "html": "http://dev.kdoc.to:5001/1/yqmzF8YMuE2j/qrcode", "png": "http://dev.kdoc.to:5001/1/yqmzF8YMuE2j/qrcode.png", "pdf": "http://dev.kdoc.to:5001/1/yqmzF8YMuE2j/qrcode.pdf" } }, "paid_amount": null, "paid_at": null, "end_to_end_id": null, "beneficiary": {}, "custom_data": 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, "financial_provider_external_id": null, "tags": [], "tag_list": null, "revoke_days": null } } ], "pagination": { "prev_url": "/v2/charge/pix/630/commands?page=&per_page=50", "next_url": "/v2/charge/pix/630/commands?page=&per_page=50", "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": 949, "status": "pending", "operation": "update", "params": { "amount": 100.0, "expire_at": "2025-07-28T09:09:54+08:00" }, "payload": null, "created_at": "2025-07-18T09:09:54+08:00", "updated_at": "2025-07-18T09:09:54+08:00", "message": null, "error_message": null, "warning_message": null, "pix": { "id": 631, "uid": "01981b14-a44a-7178-aef0-c5a62036a55a", "txid": null, "status": "opened", "registration_status": "pending", "pix_account_id": 876, "pix_account_uid": "01981b14-a439-7c72-b793-69810432b32f", "kind": "instant", "created_at": "2025-07-18T09:09:54+08:00", "updated_at": "2025-07-18T09:09:54+08:00", "expire_at": "2025-07-21T00:00:00+08:00", "canceled_at": null, "registered_at": null, "amount": 25.0, "additional_info": {}, "command_ids": [ 949 ], "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/EUUenDGHuI2s", "formats": { "default": { "html": "http://dev.kdoc.to:5001/1/EUUenDGHuI2s", "png": "http://dev.kdoc.to:5001/1/EUUenDGHuI2s.png", "pdf": "http://dev.kdoc.to:5001/1/EUUenDGHuI2s.pdf" }, "qrcode": { "html": "http://dev.kdoc.to:5001/1/EUUenDGHuI2s/qrcode", "png": "http://dev.kdoc.to:5001/1/EUUenDGHuI2s/qrcode.png", "pdf": "http://dev.kdoc.to:5001/1/EUUenDGHuI2s/qrcode.pdf" } }, "paid_amount": null, "paid_at": null, "end_to_end_id": null, "beneficiary": {}, "custom_data": 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, "financial_provider_external_id": null, "tags": [], "tag_list": null, "revoke_days": null } } }, "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": "01981b15-0c9e-7fe9-a877-e02c8bfba2e2", "capture_date": "2025-07-18T09:10:21+08:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2025-07-18T09:10:21+08:00", "external_id": "a3769199-1e06-438c-891c-49e39fff4758", "custom_data": null, "tags": [], "financial_account": { "uid": "01981b15-00cb-779f-a577-f3c4c607940a", "status": "complete", "bank": null, "account_number": "95087723", "account_digit": "3", "agency_number": "5300", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:18+08:00", "updated_at": "2025-07-18T09:10:18+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 95087723-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "asperiores", "quia", "quia" ], "emails": [ { "address": "renee.koepp@konopelski-feeney.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 }, "external_code": "000001", "classification": "person", "document_number": "754.198.417-54" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "24f1cfa7-c773-4ee6-a78a-4c0b56c8fa58" } }, { "uid": "01981b15-0c55-7c6f-b550-929493e9a1c9", "capture_date": "2025-07-18T09:10:21+08:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2025-07-18T09:10:21+08:00", "external_id": "28e97106-77ff-435a-8d1b-2a854478e793", "custom_data": null, "tags": [], "financial_account": { "uid": "01981b15-00cb-779f-a577-f3c4c607940a", "status": "complete", "bank": null, "account_number": "95087723", "account_digit": "3", "agency_number": "5300", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:18+08:00", "updated_at": "2025-07-18T09:10:18+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 95087723-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "asperiores", "quia", "quia" ], "emails": [ { "address": "renee.koepp@konopelski-feeney.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 }, "external_code": "000001", "classification": "person", "document_number": "754.198.417-54" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "24f1cfa7-c773-4ee6-a78a-4c0b56c8fa58" } }, { "uid": "01981b15-0c0e-745b-9a3c-6fe2a261bf9b", "capture_date": "2025-07-18T09:10:20+08:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2025-07-18T09:10:20+08:00", "external_id": "cae405c9-9b0e-4345-b6d9-160d508dbb05", "custom_data": null, "tags": [], "financial_account": { "uid": "01981b15-00cb-779f-a577-f3c4c607940a", "status": "complete", "bank": null, "account_number": "95087723", "account_digit": "3", "agency_number": "5300", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:18+08:00", "updated_at": "2025-07-18T09:10:18+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 95087723-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "asperiores", "quia", "quia" ], "emails": [ { "address": "renee.koepp@konopelski-feeney.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 }, "external_code": "000001", "classification": "person", "document_number": "754.198.417-54" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "24f1cfa7-c773-4ee6-a78a-4c0b56c8fa58" } }, { "uid": "01981b15-0bc6-76a5-9c0b-7b17d731abee", "capture_date": "2025-07-18T09:10:20+08:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2025-07-18T09:10:20+08:00", "external_id": "6173b560-7408-403d-97e3-92811b1eeba7", "custom_data": null, "tags": [], "financial_account": { "uid": "01981b15-00cb-779f-a577-f3c4c607940a", "status": "complete", "bank": null, "account_number": "95087723", "account_digit": "3", "agency_number": "5300", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:18+08:00", "updated_at": "2025-07-18T09:10:18+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 95087723-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "asperiores", "quia", "quia" ], "emails": [ { "address": "renee.koepp@konopelski-feeney.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 }, "external_code": "000001", "classification": "person", "document_number": "754.198.417-54" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "24f1cfa7-c773-4ee6-a78a-4c0b56c8fa58" } }, { "uid": "01981b15-0b7b-7069-90df-c83a7595fc62", "capture_date": "2025-07-18T09:10:20+08:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2025-07-18T09:10:20+08:00", "external_id": "981915f3-c0d6-44cd-ae71-4a946f765ce7", "custom_data": null, "tags": [], "financial_account": { "uid": "01981b15-00cb-779f-a577-f3c4c607940a", "status": "complete", "bank": null, "account_number": "95087723", "account_digit": "3", "agency_number": "5300", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:18+08:00", "updated_at": "2025-07-18T09:10:18+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 95087723-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "asperiores", "quia", "quia" ], "emails": [ { "address": "renee.koepp@konopelski-feeney.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 }, "external_code": "000001", "classification": "person", "document_number": "754.198.417-54" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "24f1cfa7-c773-4ee6-a78a-4c0b56c8fa58" } }, { "uid": "01981b15-0af9-761c-937b-72184b828c5b", "capture_date": "2025-07-18T09:10:20+08:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2025-07-18T09:10:20+08:00", "external_id": "155b0f46-9ebc-4099-bcab-37a01dd5858a", "custom_data": null, "tags": [], "financial_account": { "uid": "01981b15-00cb-779f-a577-f3c4c607940a", "status": "complete", "bank": null, "account_number": "95087723", "account_digit": "3", "agency_number": "5300", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:18+08:00", "updated_at": "2025-07-18T09:10:18+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 95087723-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "asperiores", "quia", "quia" ], "emails": [ { "address": "renee.koepp@konopelski-feeney.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 }, "external_code": "000001", "classification": "person", "document_number": "754.198.417-54" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "24f1cfa7-c773-4ee6-a78a-4c0b56c8fa58" } }, { "uid": "01981b15-0ab4-78bd-a65f-eed536021db0", "capture_date": "2025-07-18T09:10:20+08:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2025-07-18T09:10:20+08:00", "external_id": "83b37e2e-c41b-4edf-b617-26871603442b", "custom_data": null, "tags": [], "financial_account": { "uid": "01981b15-00cb-779f-a577-f3c4c607940a", "status": "complete", "bank": null, "account_number": "95087723", "account_digit": "3", "agency_number": "5300", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:18+08:00", "updated_at": "2025-07-18T09:10:18+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 95087723-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "asperiores", "quia", "quia" ], "emails": [ { "address": "renee.koepp@konopelski-feeney.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 }, "external_code": "000001", "classification": "person", "document_number": "754.198.417-54" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "24f1cfa7-c773-4ee6-a78a-4c0b56c8fa58" } }, { "uid": "01981b15-0a6e-7317-babd-72dd52c2bf68", "capture_date": "2025-07-18T09:10:20+08:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2025-07-18T09:10:20+08:00", "external_id": "661f4144-7af1-4a66-88bd-614755da7da8", "custom_data": null, "tags": [], "financial_account": { "uid": "01981b15-00cb-779f-a577-f3c4c607940a", "status": "complete", "bank": null, "account_number": "95087723", "account_digit": "3", "agency_number": "5300", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:18+08:00", "updated_at": "2025-07-18T09:10:18+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 95087723-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "asperiores", "quia", "quia" ], "emails": [ { "address": "renee.koepp@konopelski-feeney.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 }, "external_code": "000001", "classification": "person", "document_number": "754.198.417-54" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "24f1cfa7-c773-4ee6-a78a-4c0b56c8fa58" } }, { "uid": "01981b15-0a2a-75f1-b46e-63b542f721a5", "capture_date": "2025-07-18T09:10:20+08:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2025-07-18T09:10:20+08:00", "external_id": "2c40dcad-2bd2-4563-91a5-5eff163d1c35", "custom_data": null, "tags": [], "financial_account": { "uid": "01981b15-00cb-779f-a577-f3c4c607940a", "status": "complete", "bank": null, "account_number": "95087723", "account_digit": "3", "agency_number": "5300", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:18+08:00", "updated_at": "2025-07-18T09:10:18+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 95087723-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "asperiores", "quia", "quia" ], "emails": [ { "address": "renee.koepp@konopelski-feeney.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 }, "external_code": "000001", "classification": "person", "document_number": "754.198.417-54" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "24f1cfa7-c773-4ee6-a78a-4c0b56c8fa58" } }, { "uid": "01981b15-09e3-7b0e-ad56-9eaa5dfc9835", "capture_date": "2025-07-18T09:10:20+08:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2025-07-18T09:10:20+08:00", "external_id": "f53b057b-b5e9-4fcb-8ac5-239fc22c5f94", "custom_data": null, "tags": [], "financial_account": { "uid": "01981b15-00cb-779f-a577-f3c4c607940a", "status": "complete", "bank": null, "account_number": "95087723", "account_digit": "3", "agency_number": "5300", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:18+08:00", "updated_at": "2025-07-18T09:10:18+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 95087723-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "asperiores", "quia", "quia" ], "emails": [ { "address": "renee.koepp@konopelski-feeney.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 }, "external_code": "000001", "classification": "person", "document_number": "754.198.417-54" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "24f1cfa7-c773-4ee6-a78a-4c0b56c8fa58" } }, { "uid": "01981b15-099e-75cd-8dcd-5dc0dad8aa01", "capture_date": "2025-07-18T09:10:20+08:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2025-07-18T09:10:20+08:00", "external_id": "7425433d-fff1-4f45-8bb5-8e11fa1e1343", "custom_data": null, "tags": [], "financial_account": { "uid": "01981b15-00cb-779f-a577-f3c4c607940a", "status": "complete", "bank": null, "account_number": "95087723", "account_digit": "3", "agency_number": "5300", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:18+08:00", "updated_at": "2025-07-18T09:10:18+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 95087723-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "asperiores", "quia", "quia" ], "emails": [ { "address": "renee.koepp@konopelski-feeney.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 }, "external_code": "000001", "classification": "person", "document_number": "754.198.417-54" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "24f1cfa7-c773-4ee6-a78a-4c0b56c8fa58" } }, { "uid": "01981b15-095e-75be-86c0-d68a8ff77db0", "capture_date": "2025-07-18T09:10:20+08:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2025-07-18T09:10:20+08:00", "external_id": "da436167-9ce2-4ae5-98e5-33e552c52263", "custom_data": null, "tags": [], "financial_account": { "uid": "01981b15-00cb-779f-a577-f3c4c607940a", "status": "complete", "bank": null, "account_number": "95087723", "account_digit": "3", "agency_number": "5300", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:18+08:00", "updated_at": "2025-07-18T09:10:18+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 95087723-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "asperiores", "quia", "quia" ], "emails": [ { "address": "renee.koepp@konopelski-feeney.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 }, "external_code": "000001", "classification": "person", "document_number": "754.198.417-54" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "24f1cfa7-c773-4ee6-a78a-4c0b56c8fa58" } }, { "uid": "01981b15-0916-7b1b-83ab-7529edb14948", "capture_date": "2025-07-18T09:10:20+08:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2025-07-18T09:10:20+08:00", "external_id": "b7ebbd92-f2a9-441b-81bd-7df5ca5ae411", "custom_data": null, "tags": [], "financial_account": { "uid": "01981b15-00cb-779f-a577-f3c4c607940a", "status": "complete", "bank": null, "account_number": "95087723", "account_digit": "3", "agency_number": "5300", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:18+08:00", "updated_at": "2025-07-18T09:10:18+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 95087723-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "asperiores", "quia", "quia" ], "emails": [ { "address": "renee.koepp@konopelski-feeney.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 }, "external_code": "000001", "classification": "person", "document_number": "754.198.417-54" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "24f1cfa7-c773-4ee6-a78a-4c0b56c8fa58" } }, { "uid": "01981b15-08d3-7131-86db-04989484c911", "capture_date": "2025-07-18T09:10:20+08:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2025-07-18T09:10:20+08:00", "external_id": "c1c62347-90bf-4bf6-84fa-80c44bf69199", "custom_data": null, "tags": [], "financial_account": { "uid": "01981b15-00cb-779f-a577-f3c4c607940a", "status": "complete", "bank": null, "account_number": "95087723", "account_digit": "3", "agency_number": "5300", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:18+08:00", "updated_at": "2025-07-18T09:10:18+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 95087723-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "asperiores", "quia", "quia" ], "emails": [ { "address": "renee.koepp@konopelski-feeney.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 }, "external_code": "000001", "classification": "person", "document_number": "754.198.417-54" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "24f1cfa7-c773-4ee6-a78a-4c0b56c8fa58" } }, { "uid": "01981b15-087d-7ba4-ae1a-d69381f3359c", "capture_date": "2025-07-18T09:10:20+08:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2025-07-18T09:10:20+08:00", "external_id": "4326838e-450a-4baa-800c-40a694b5eddd", "custom_data": null, "tags": [], "financial_account": { "uid": "01981b15-00cb-779f-a577-f3c4c607940a", "status": "complete", "bank": null, "account_number": "95087723", "account_digit": "3", "agency_number": "5300", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:18+08:00", "updated_at": "2025-07-18T09:10:18+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 95087723-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "asperiores", "quia", "quia" ], "emails": [ { "address": "renee.koepp@konopelski-feeney.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 }, "external_code": "000001", "classification": "person", "document_number": "754.198.417-54" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "24f1cfa7-c773-4ee6-a78a-4c0b56c8fa58" } }, { "uid": "01981b15-0826-7b19-99ef-feb095a2ac97", "capture_date": "2025-07-18T09:10:19+08:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2025-07-18T09:10:19+08:00", "external_id": "8379b4f5-862a-4d90-b27d-1b307d3b2ae8", "custom_data": null, "tags": [], "financial_account": { "uid": "01981b15-00cb-779f-a577-f3c4c607940a", "status": "complete", "bank": null, "account_number": "95087723", "account_digit": "3", "agency_number": "5300", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:18+08:00", "updated_at": "2025-07-18T09:10:18+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 95087723-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "asperiores", "quia", "quia" ], "emails": [ { "address": "renee.koepp@konopelski-feeney.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 }, "external_code": "000001", "classification": "person", "document_number": "754.198.417-54" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "24f1cfa7-c773-4ee6-a78a-4c0b56c8fa58" } }, { "uid": "01981b15-07e1-7425-a4c4-e0c5f4dfbcbc", "capture_date": "2025-07-18T09:10:19+08:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2025-07-18T09:10:19+08:00", "external_id": "516d7557-ffd7-4e72-9b99-f5c424cd2edf", "custom_data": null, "tags": [], "financial_account": { "uid": "01981b15-00cb-779f-a577-f3c4c607940a", "status": "complete", "bank": null, "account_number": "95087723", "account_digit": "3", "agency_number": "5300", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:18+08:00", "updated_at": "2025-07-18T09:10:18+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 95087723-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "asperiores", "quia", "quia" ], "emails": [ { "address": "renee.koepp@konopelski-feeney.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 }, "external_code": "000001", "classification": "person", "document_number": "754.198.417-54" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "24f1cfa7-c773-4ee6-a78a-4c0b56c8fa58" } }, { "uid": "01981b15-0796-726d-bee2-043c91180058", "capture_date": "2025-07-18T09:10:19+08:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2025-07-18T09:10:19+08:00", "external_id": "c98429cb-0921-42a5-910a-e1bfff574eaf", "custom_data": null, "tags": [], "financial_account": { "uid": "01981b15-00cb-779f-a577-f3c4c607940a", "status": "complete", "bank": null, "account_number": "95087723", "account_digit": "3", "agency_number": "5300", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:18+08:00", "updated_at": "2025-07-18T09:10:18+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 95087723-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "asperiores", "quia", "quia" ], "emails": [ { "address": "renee.koepp@konopelski-feeney.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 }, "external_code": "000001", "classification": "person", "document_number": "754.198.417-54" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "24f1cfa7-c773-4ee6-a78a-4c0b56c8fa58" } }, { "uid": "01981b15-0758-7cf9-9898-77929cd1df06", "capture_date": "2025-07-18T09:10:19+08:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2025-07-18T09:10:19+08:00", "external_id": "8bf0434a-02b4-4af9-ba99-339e738efe50", "custom_data": null, "tags": [], "financial_account": { "uid": "01981b15-00cb-779f-a577-f3c4c607940a", "status": "complete", "bank": null, "account_number": "95087723", "account_digit": "3", "agency_number": "5300", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:18+08:00", "updated_at": "2025-07-18T09:10:18+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 95087723-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "asperiores", "quia", "quia" ], "emails": [ { "address": "renee.koepp@konopelski-feeney.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 }, "external_code": "000001", "classification": "person", "document_number": "754.198.417-54" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "24f1cfa7-c773-4ee6-a78a-4c0b56c8fa58" } }, { "uid": "01981b15-0719-7eb9-b40d-d2bbc93c019a", "capture_date": "2025-07-18T09:10:19+08:00", "amount": 1.0, "blocked_amount": 0.1, "automatically_invested_amount": 0.8, "created_at": "2025-07-18T09:10:19+08:00", "external_id": "4a035c6d-97f3-4403-86bc-101f3f474e3b", "custom_data": null, "tags": [], "financial_account": { "uid": "01981b15-00cb-779f-a577-f3c4c607940a", "status": "complete", "bank": null, "account_number": "95087723", "account_digit": "3", "agency_number": "5300", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:18+08:00", "updated_at": "2025-07-18T09:10:18+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 95087723-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "asperiores", "quia", "quia" ], "emails": [ { "address": "renee.koepp@konopelski-feeney.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 }, "external_code": "000001", "classification": "person", "document_number": "754.198.417-54" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "24f1cfa7-c773-4ee6-a78a-4c0b56c8fa58" } } ], "pagination": { "prev_url": "/v2/financial/accounts/01981b15-00cb-779f-a577-f3c4c607940a/balances?per_page=20&page=", "next_url": "/v2/financial/accounts/01981b15-00cb-779f-a577-f3c4c607940a/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": "01981b15-0e36-7b5c-8820-42bc9f3faa09", "capture_date": null, "amount": 500.99, "blocked_amount": 100.1, "automatically_invested_amount": 0.0, "created_at": "2025-07-18T09:10:21+08:00", "external_id": "120712704", "custom_data": { "client_rating": 5 }, "tags": [ "tag 1", "tag 2" ], "financial_account": { "uid": "01981b15-0dd4-7a20-b69c-9338b0f625ed", "status": "complete", "bank": null, "account_number": "59473001", "account_digit": "3", "agency_number": "8663", "agency_digit": "0", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:21+08:00", "updated_at": "2025-07-18T09:10:21+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 59473001-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "similique", "officia", "sit" ], "emails": [ { "address": "mayra@halvorson.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 }, "external_code": "000001", "classification": "person", "document_number": "669.537.268-30" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "de897709-e81c-428d-8078-a7646a846cfe" } } }, "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": "01981b15-0f31-7313-9702-30a9c693f1ac", "capture_date": "2025-07-18T09:10:21+08:00", "amount": 500.99, "blocked_amount": 100.1, "automatically_invested_amount": 0.0, "created_at": "2025-07-18T09:10:21+08:00", "external_id": "120712704", "custom_data": { "client_rating": 5 }, "tags": [ "tag 1", "tag 2" ], "financial_account": { "uid": "01981b15-0ee0-7afa-bed3-8ce5380acc6e", "status": "complete", "bank": null, "account_number": "00818902", "account_digit": "3", "agency_number": "5620", "agency_digit": "0", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:21+08:00", "updated_at": "2025-07-18T09:10:21+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 818902-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "maxime", "aut", "beatae" ], "emails": [ { "address": "julissa_hane@weissnat-torphy.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 }, "external_code": "000001", "classification": "person", "document_number": "448.664.534-00" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "b244ca5b-cc93-403f-b0b0-969cb96faf23" } } }, "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": 991, "status": "pending", "operation": "statement_sync", "params": {}, "payload": null, "created_at": "2025-07-18T09:10:22+08:00", "updated_at": "2025-07-18T09:10:22+08:00", "message": null, "error_message": null, "warning_message": null } ], "pagination": { "prev_url": "/v2/financial/accounts/01981b15-10a5-7635-a139-681dffbace13/commands?page=&per_page=50", "next_url": "/v2/financial/accounts/01981b15-10a5-7635-a139-681dffbace13/commands?page=&per_page=50", "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": 992, "status": "pending", "operation": "statement_sync", "params": {}, "payload": null, "created_at": "2025-07-18T09:10:22+08:00", "updated_at": "2025-07-18T09:10:22+08:00", "message": null, "error_message": null, "warning_message": 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": "01981b15-1d06-7aee-abf3-5df70fae0c5b", "status": "complete", "bank": null, "account_number": "49613859", "account_digit": "3", "agency_number": "8120", "agency_digit": "5", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:25+08:00", "updated_at": "2025-07-18T09:10:25+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 49613859-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "ea", "quia", "quidem" ], "emails": [ { "address": "antony@schmeler.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 }, "external_code": "000001", "classification": "person", "document_number": "436.808.628-73" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "feb9b818-20f7-4213-8743-7db58a487d2c", "balance": null }, { "uid": "01981b15-1ce1-7022-92e4-f00cc1847aa9", "status": "complete", "bank": null, "account_number": "25643286", "account_digit": "3", "agency_number": "3024", "agency_digit": "4", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:25+08:00", "updated_at": "2025-07-18T09:10:25+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 25643286-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "laborum", "neque", "sequi" ], "emails": [ { "address": "marquis@lakin.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 }, "external_code": "000001", "classification": "person", "document_number": "383.194.573-00" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "55872260-fc2f-4ec2-9b98-ab5a09ac664c", "balance": null }, { "uid": "01981b15-1cbc-703a-8dc7-54f5a9e8cac7", "status": "complete", "bank": null, "account_number": "20691574", "account_digit": "3", "agency_number": "2282", "agency_digit": "9", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:25+08:00", "updated_at": "2025-07-18T09:10:25+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 20691574-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "atque", "et", "debitis" ], "emails": [ { "address": "tomi@kuhn-hartmann.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 }, "external_code": "000001", "classification": "person", "document_number": "022.719.838-78" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "cae59295-6ee7-49f0-8dfa-b051e4343a0d", "balance": null }, { "uid": "01981b15-1c99-7540-a3bb-18679bf9796b", "status": "complete", "bank": null, "account_number": "88925522", "account_digit": "3", "agency_number": "8330", "agency_digit": "5", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:25+08:00", "updated_at": "2025-07-18T09:10:25+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 88925522-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "molestias", "aperiam", "itaque" ], "emails": [ { "address": "genna_carter@nolan-bergnaum.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 }, "external_code": "000001", "classification": "person", "document_number": "663.289.336-81" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "301bb37f-2e05-4d8d-9e44-6460fd9b5780", "balance": null }, { "uid": "01981b15-1c6d-7315-a941-9b29d21d53c8", "status": "complete", "bank": null, "account_number": "09660447", "account_digit": "3", "agency_number": "6477", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:25+08:00", "updated_at": "2025-07-18T09:10:25+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 9660447-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "dolor", "saepe", "quo" ], "emails": [ { "address": "kasey_buckridge@schoen.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 }, "external_code": "000001", "classification": "person", "document_number": "300.672.702-98" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "a3a94f4e-e038-415e-8e79-ba05ab8a08c9", "balance": null }, { "uid": "01981b15-1c46-7a16-afb4-5a34f8abd665", "status": "complete", "bank": null, "account_number": "64451884", "account_digit": "3", "agency_number": "9509", "agency_digit": "5", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:25+08:00", "updated_at": "2025-07-18T09:10:25+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 64451884-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "cupiditate", "ad", "perspiciatis" ], "emails": [ { "address": "shon@spinka.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 }, "external_code": "000001", "classification": "person", "document_number": "664.945.988-70" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "62a99c42-723b-4b6b-95f5-0d5751a33e34", "balance": null }, { "uid": "01981b15-1c18-733e-9dc8-a742a22a56eb", "status": "complete", "bank": null, "account_number": "51860648", "account_digit": "3", "agency_number": "7794", "agency_digit": "1", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:25+08:00", "updated_at": "2025-07-18T09:10:25+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 51860648-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "minus", "ullam", "tenetur" ], "emails": [ { "address": "pierre_zboncak@dach-gibson.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 }, "external_code": "000001", "classification": "person", "document_number": "973.853.589-18" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "6fe2336c-6532-455c-aee6-21beb70abed6", "balance": null }, { "uid": "01981b15-1beb-7771-b87a-709deef31817", "status": "complete", "bank": null, "account_number": "59809922", "account_digit": "3", "agency_number": "1240", "agency_digit": "8", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:25+08:00", "updated_at": "2025-07-18T09:10:25+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 59809922-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "corporis", "modi", "eum" ], "emails": [ { "address": "julieta@mante.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 }, "external_code": "000001", "classification": "person", "document_number": "708.845.872-15" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "331fa902-e3c2-4330-b3e1-5b9b619db9aa", "balance": null }, { "uid": "01981b15-1bc2-70b5-9450-71875b23ef83", "status": "complete", "bank": null, "account_number": "86691600", "account_digit": "3", "agency_number": "3750", "agency_digit": "8", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:24+08:00", "updated_at": "2025-07-18T09:10:24+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 86691600-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "at", "optio", "qui" ], "emails": [ { "address": "jeanna@kuvalis.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 }, "external_code": "000001", "classification": "person", "document_number": "791.386.772-88" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "11a72a1d-1c4f-4902-b202-e7a3d9b2fc31", "balance": null }, { "uid": "01981b15-1b95-76be-879e-4f69a1c9a5cc", "status": "complete", "bank": null, "account_number": "68856015", "account_digit": "3", "agency_number": "5311", "agency_digit": "2", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:24+08:00", "updated_at": "2025-07-18T09:10:24+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 68856015-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "et", "voluptatem", "aperiam" ], "emails": [ { "address": "anika_wilkinson@kulas.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 }, "external_code": "000001", "classification": "person", "document_number": "216.288.734-77" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "8f1dadef-8684-4ae5-ac00-8d8f4ed3b27a", "balance": null }, { "uid": "01981b15-1b6c-7666-bbc3-d9550b7e4849", "status": "complete", "bank": null, "account_number": "67555298", "account_digit": "3", "agency_number": "9243", "agency_digit": "6", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:24+08:00", "updated_at": "2025-07-18T09:10:24+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 67555298-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "sint", "odio", "sunt" ], "emails": [ { "address": "doug@sporer-schmidt.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 }, "external_code": "000001", "classification": "person", "document_number": "523.119.103-53" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "643b3d6d-b13f-43e5-b2f3-be992664390c", "balance": null }, { "uid": "01981b15-1b45-73ad-9b43-752cd4628063", "status": "complete", "bank": null, "account_number": "67333631", "account_digit": "3", "agency_number": "2322", "agency_digit": "1", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:24+08:00", "updated_at": "2025-07-18T09:10:24+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 67333631-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "architecto", "cupiditate", "vitae" ], "emails": [ { "address": "tomi_schumm@dooley-kautzer.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 }, "external_code": "000001", "classification": "person", "document_number": "315.854.457-11" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "b45652fd-9e97-463f-9d8f-7a48edfb3a0f", "balance": null }, { "uid": "01981b15-1b1b-701f-acf7-895662b25dfb", "status": "complete", "bank": null, "account_number": "65528022", "account_digit": "3", "agency_number": "3809", "agency_digit": "1", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:24+08:00", "updated_at": "2025-07-18T09:10:24+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 65528022-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "similique", "non", "consequatur" ], "emails": [ { "address": "yukiko@durgan-greenfelder.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 }, "external_code": "000001", "classification": "person", "document_number": "324.602.282-87" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "07807db0-2626-47d5-9473-d221284f0661", "balance": null }, { "uid": "01981b15-1af0-7070-b323-c266147fe6bf", "status": "complete", "bank": null, "account_number": "58795096", "account_digit": "3", "agency_number": "5927", "agency_digit": "7", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:24+08:00", "updated_at": "2025-07-18T09:10:24+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 58795096-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "neque", "quidem", "velit" ], "emails": [ { "address": "alejandro@heaney.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 }, "external_code": "000001", "classification": "person", "document_number": "297.875.745-01" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "79b1a9b6-79ec-45d6-a59c-94b1df1b1d19", "balance": null }, { "uid": "01981b15-1ac3-74b1-9cf1-d553024537ed", "status": "complete", "bank": null, "account_number": "89744790", "account_digit": "3", "agency_number": "3344", "agency_digit": "8", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:24+08:00", "updated_at": "2025-07-18T09:10:24+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 89744790-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "a", "et", "ut" ], "emails": [ { "address": "trina@wunsch.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 }, "external_code": "000001", "classification": "person", "document_number": "118.695.827-80" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "a901cf84-409d-433d-9212-16fdfe981d09", "balance": null }, { "uid": "01981b15-1a9c-7278-8bf5-7da2767584d7", "status": "complete", "bank": null, "account_number": "48874001", "account_digit": "3", "agency_number": "9764", "agency_digit": "0", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:24+08:00", "updated_at": "2025-07-18T09:10:24+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 48874001-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "ut", "expedita", "eveniet" ], "emails": [ { "address": "maryln@davis.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 }, "external_code": "000001", "classification": "person", "document_number": "212.207.402-76" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "524a90e3-3d63-4989-9397-929e9b2943cb", "balance": null }, { "uid": "01981b15-1a74-73ba-ab9d-819b02f2701e", "status": "complete", "bank": null, "account_number": "02420161", "account_digit": "3", "agency_number": "4063", "agency_digit": "0", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:24+08:00", "updated_at": "2025-07-18T09:10:24+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 2420161-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "eos", "dolor", "corrupti" ], "emails": [ { "address": "stewart@kemmer-koelpin.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 }, "external_code": "000001", "classification": "person", "document_number": "783.976.644-75" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "0698b0f8-5355-431d-bc33-9c2a9ad7dd4d", "balance": null }, { "uid": "01981b15-1a4b-739d-a28f-10903fc80437", "status": "complete", "bank": null, "account_number": "67011912", "account_digit": "3", "agency_number": "1144", "agency_digit": "4", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:24+08:00", "updated_at": "2025-07-18T09:10:24+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 67011912-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "asperiores", "veniam", "mollitia" ], "emails": [ { "address": "elenor_fritsch@leuschke.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 }, "external_code": "000001", "classification": "person", "document_number": "228.846.839-41" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "d2437df9-4a81-4f44-a7d5-84c4cc6f44a9", "balance": null }, { "uid": "01981b15-1a22-7dac-87ac-6e5a97d17f7a", "status": "complete", "bank": null, "account_number": "14206113", "account_digit": "3", "agency_number": "2103", "agency_digit": "2", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:24+08:00", "updated_at": "2025-07-18T09:10:24+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 14206113-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "rem", "voluptatem", "voluptatem" ], "emails": [ { "address": "alfonso@orn-sauer.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 }, "external_code": "000001", "classification": "person", "document_number": "318.319.394-95" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "4785920b-bf7c-4365-b11a-fef818b79bda", "balance": null }, { "uid": "01981b15-19f9-786e-8681-13dbacdbb8b5", "status": "complete", "bank": null, "account_number": "85829055", "account_digit": "3", "agency_number": "1301", "agency_digit": "3", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:24+08:00", "updated_at": "2025-07-18T09:10:24+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 85829055-3", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "dolorum", "pariatur", "quod" ], "emails": [ { "address": "luigi@howe-wintheiser.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 }, "external_code": "000001", "classification": "person", "document_number": "907.481.410-73" }, "tags": [], "tag_list": null, "custom_data": null, "external_id": "9962461a-a66b-468f-b1b2-84576c8c5b72", "balance": null } ], "pagination": { "prev_url": "/v2/financial/accounts?per_page=20&page=", "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": "01981b15-1e3e-7a44-805a-03f2021e2cec", "status": "complete", "bank": { "name": "Banco do Brasil", "bcb_name": "BANCO DO BRASIL S.A.", "number": "001" }, "account_number": "123456", "account_digit": "0", "agency_number": "1234", "agency_digit": "1", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:25+08:00", "updated_at": "2025-07-18T09:10:25+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 123456-0", "payment_agreement_code": null, "person_info": {}, "tags": [ "tag 1", "tag 2" ], "tag_list": "tag 1,tag 2", "custom_data": { "codigo": "123", "vip": true }, "external_id": "external id", "balance": null } }, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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": "01981b15-1fd4-71ee-9485-308f98a745d9", "status": "complete", "bank": { "name": "Banco do Brasil", "bcb_name": "BANCO DO BRASIL S.A.", "number": "001" }, "account_number": "123456", "account_digit": "0", "agency_number": "1234", "agency_digit": "1", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:26+08:00", "updated_at": "2025-07-18T09:10:26+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 123456-0", "payment_agreement_code": null, "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "molestiae", "atque", "sequi" ], "emails": [ { "address": "wanita@jones-kuhlman.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 }, "external_code": "000001", "classification": "person", "document_number": "258.302.221-08" }, "tags": [ "tag 1", "tag 2" ], "tag_list": "tag 1,tag 2", "custom_data": { "vip": true, "codigo": "123" }, "external_id": "external id", "balance": null } }, "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": "01981b15-2130-7d38-98f3-a503888cbe01", "status": "complete", "bank": { "name": "Banco do Brasil", "bcb_name": "BANCO DO BRASIL S.A.", "number": "001" }, "account_number": "123456", "account_digit": "0", "agency_number": "1234", "agency_digit": "1", "financial_provider_slug": "sicoob", "created_at": "2025-07-18T09:10:26+08:00", "updated_at": "2025-07-18T09:10:26+08:00", "kind": "checking", "custom_name": "Bancoob/Sicoob CC: 123456-0", "payment_agreement_code": "123123", "person_info": { "name": "Margret Santos Filgueiras", "tags": [ "iusto", "quidem", "sunt" ], "emails": [ { "address": "frieda.rogahn@casper.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 }, "external_code": "000001", "classification": "person", "document_number": "209.706.164-81" }, "tags": [ "tag 1", "tag 2" ], "tag_list": "tag 1,tag 2", "custom_data": { "vip": true, "codigo": "123" }, "external_id": "external id", "balance": null } }, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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/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": "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-9", "slug": "btg" }, { "kind": "bank", "name": "BV", "bcb_name": "BCO VOTORANTIM S.A.", "number": "655", "number_with_digit": "655-6", "slug": "bv" }, { "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": "Bancoob/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" } ] }, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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": "01981b15-3651-7e4e-b79c-5027574f3edb", "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": "2025-07-18T09:10:31+08:00", "updated_at": "2025-07-18T09:10:31+08:00" }, { "uid": "01981b15-343c-75eb-b771-70160f35d635", "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": "2025-07-18T09:10:31+08:00", "updated_at": "2025-07-18T09:10:31+08:00" }, { "uid": "01981b15-3235-72bd-bef4-1b986a92220b", "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": "2025-07-18T09:10:30+08:00", "updated_at": "2025-07-18T09:10:30+08:00" }, { "uid": "01981b15-302c-78f9-9261-b0c745dc288f", "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": "2025-07-18T09:10:30+08:00", "updated_at": "2025-07-18T09:10:30+08:00" }, { "uid": "01981b15-2e23-7fa4-b413-7ee742c6d11a", "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": "2025-07-18T09:10:29+08:00", "updated_at": "2025-07-18T09:10:29+08:00" } ], "pagination": { "prev_url": "/v2/financial/accounts/01981b15-2547-783e-8f42-1b88582d619b/statement_transactions/imports?per_page=5&status=&page=", "next_url": "/v2/financial/accounts/01981b15-2547-783e-8f42-1b88582d619b/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[block:callout]\n{\n \"type\": \"info\",\n \"body\": \"Este endpoint é processado assincronamente e cria um comando de atualização para a Conta Financeira.\",\n \"title\": \"Processamento Assíncrono\"\n}\n[/block]\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": "01981b15-3846-7f4e-8d85-17e96d5a7c00", "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": "2025-07-18T09:10:32+08:00", "updated_at": "2025-07-18T09:10:32+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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": "01981b15-3cc8-775c-8613-5fe20cb4e674", "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": "2025-07-18T09:10:33+08:00", "updated_at": "2025-07-18T09:10:33+08: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": { "get": { "summary": "Listar Transações", "tags": [ "Extrato" ], "security": [ { "bearerAuth": [] } ], "description": "Lista todas as transações do extrato de uma conta financeira. Permite filtrar por período através das datas de ocorrê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 } }, { "name": "occurrence_date_from", "in": "query", "description": "Data inicial do filtro de data de ocorrência.", "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.", "example": "2020-01-01", "required": false, "schema": { "type": "string", "format": "date" } }, { "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": 441, "financial_account_uid": "01981b15-3e22-7c64-aec4-7ba66721efe4", "amount": -100.0, "occurrence_date": "2025-07-18", "created_at": "2025-07-18T09:10:34+08:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "728.820.080-90" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "8b03f0b90039a766c2fbe50690d7b321", "hashed_content": "8b03f0b90039a766c2fbe50690d7b321", "updated_at": "2025-07-18T09:10:34+08:00", "financial_provider_external_id": "659b480c-bc44-4d1b-bc6e-df00b66a91b5" }, { "id": 440, "financial_account_uid": "01981b15-3e22-7c64-aec4-7ba66721efe4", "amount": -100.0, "occurrence_date": "2025-07-18", "created_at": "2025-07-18T09:10:34+08:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "606.795.636-52" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "e9f9a4c57e18669f79a0a1a4c749f55e", "hashed_content": "e9f9a4c57e18669f79a0a1a4c749f55e", "updated_at": "2025-07-18T09:10:34+08:00", "financial_provider_external_id": "3e9f6b9e-e3d8-4ecc-ab84-2c4c1f8cda0f" }, { "id": 439, "financial_account_uid": "01981b15-3e22-7c64-aec4-7ba66721efe4", "amount": -100.0, "occurrence_date": "2025-07-18", "created_at": "2025-07-18T09:10:34+08:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "826.718.402-33" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "a760b617bb4a0f313642f798368e09d8", "hashed_content": "a760b617bb4a0f313642f798368e09d8", "updated_at": "2025-07-18T09:10:34+08:00", "financial_provider_external_id": "2e7e4166-3fc4-4c95-ac0e-dc8de45e598c" }, { "id": 438, "financial_account_uid": "01981b15-3e22-7c64-aec4-7ba66721efe4", "amount": -100.0, "occurrence_date": "2025-07-18", "created_at": "2025-07-18T09:10:34+08:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "730.914.160-11" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "c474706ea64cb736bef9953f5d27365a", "hashed_content": "c474706ea64cb736bef9953f5d27365a", "updated_at": "2025-07-18T09:10:34+08:00", "financial_provider_external_id": "12a0ff59-4762-474e-93cb-9b2e6b0fde4d" }, { "id": 437, "financial_account_uid": "01981b15-3e22-7c64-aec4-7ba66721efe4", "amount": -100.0, "occurrence_date": "2025-07-18", "created_at": "2025-07-18T09:10:34+08:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "518.329.639-18" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "f51a4efdd0de1a82bc47a05f20d9a1da", "hashed_content": "f51a4efdd0de1a82bc47a05f20d9a1da", "updated_at": "2025-07-18T09:10:34+08:00", "financial_provider_external_id": "c06f5007-f844-4ffe-9e01-0f14ffe7ea88" }, { "id": 436, "financial_account_uid": "01981b15-3e22-7c64-aec4-7ba66721efe4", "amount": -100.0, "occurrence_date": "2025-07-18", "created_at": "2025-07-18T09:10:34+08:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "080.038.198-06" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "3a9a4e7dd1a2d1fee6ab22a169c24ce6", "hashed_content": "3a9a4e7dd1a2d1fee6ab22a169c24ce6", "updated_at": "2025-07-18T09:10:34+08:00", "financial_provider_external_id": "9ee5c963-fcb3-4266-8d27-83d64ad7fdb9" }, { "id": 435, "financial_account_uid": "01981b15-3e22-7c64-aec4-7ba66721efe4", "amount": -100.0, "occurrence_date": "2025-07-18", "created_at": "2025-07-18T09:10:34+08:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "606.094.661-51" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "a88e4539425ca3ddc37891d665c86f37", "hashed_content": "a88e4539425ca3ddc37891d665c86f37", "updated_at": "2025-07-18T09:10:34+08:00", "financial_provider_external_id": "d4cea3d9-ab4c-47cc-8944-2a08100dcc05" }, { "id": 434, "financial_account_uid": "01981b15-3e22-7c64-aec4-7ba66721efe4", "amount": -100.0, "occurrence_date": "2025-07-18", "created_at": "2025-07-18T09:10:34+08:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "237.911.347-52" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "64a64713173de6dbb65167cd219fabc4", "hashed_content": "64a64713173de6dbb65167cd219fabc4", "updated_at": "2025-07-18T09:10:34+08:00", "financial_provider_external_id": "16ad090b-0e0c-4b9a-96b4-e7965aeab822" }, { "id": 433, "financial_account_uid": "01981b15-3e22-7c64-aec4-7ba66721efe4", "amount": -100.0, "occurrence_date": "2025-07-18", "created_at": "2025-07-18T09:10:34+08:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "142.102.374-18" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "8a1a1d82b985b762a3a5a3d060c3f8b9", "hashed_content": "8a1a1d82b985b762a3a5a3d060c3f8b9", "updated_at": "2025-07-18T09:10:34+08:00", "financial_provider_external_id": "82a5da7e-e6c9-4446-ab14-7fc8d2013113" }, { "id": 432, "financial_account_uid": "01981b15-3e22-7c64-aec4-7ba66721efe4", "amount": -100.0, "occurrence_date": "2025-07-18", "created_at": "2025-07-18T09:10:34+08:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "449.839.268-01" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "a5ba8639fe44f51c7e6a63e9802c16a0", "hashed_content": "a5ba8639fe44f51c7e6a63e9802c16a0", "updated_at": "2025-07-18T09:10:34+08:00", "financial_provider_external_id": "52600a2a-8444-4bec-b295-782f84b81edc" }, { "id": 431, "financial_account_uid": "01981b15-3e22-7c64-aec4-7ba66721efe4", "amount": -100.0, "occurrence_date": "2025-07-18", "created_at": "2025-07-18T09:10:34+08:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "774.110.591-45" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "0e1f4350c85309c7ff17d884c0780c9f", "hashed_content": "0e1f4350c85309c7ff17d884c0780c9f", "updated_at": "2025-07-18T09:10:34+08:00", "financial_provider_external_id": "a1e6e966-c60e-4d3f-b9e1-c9868107327e" }, { "id": 430, "financial_account_uid": "01981b15-3e22-7c64-aec4-7ba66721efe4", "amount": -100.0, "occurrence_date": "2025-07-18", "created_at": "2025-07-18T09:10:34+08:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "139.269.662-38" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "3ed3e49b78a7e4d80bf01e323e84e08e", "hashed_content": "3ed3e49b78a7e4d80bf01e323e84e08e", "updated_at": "2025-07-18T09:10:34+08:00", "financial_provider_external_id": "8f88f3c9-dc18-405b-8721-04a9e3ce9a4b" }, { "id": 429, "financial_account_uid": "01981b15-3e22-7c64-aec4-7ba66721efe4", "amount": -100.0, "occurrence_date": "2025-07-18", "created_at": "2025-07-18T09:10:34+08:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "317.064.291-00" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "7db4557d4fd05e798c9686f6ad6f57bd", "hashed_content": "7db4557d4fd05e798c9686f6ad6f57bd", "updated_at": "2025-07-18T09:10:34+08:00", "financial_provider_external_id": "da8f3f3e-4b09-447a-87f9-3e8d79ec8b9d" }, { "id": 428, "financial_account_uid": "01981b15-3e22-7c64-aec4-7ba66721efe4", "amount": -100.0, "occurrence_date": "2025-07-18", "created_at": "2025-07-18T09:10:34+08:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "586.104.297-76" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "a1f9935e80bffa955910d8d3b6639d51", "hashed_content": "a1f9935e80bffa955910d8d3b6639d51", "updated_at": "2025-07-18T09:10:34+08:00", "financial_provider_external_id": "80df700f-2fba-41e6-83b5-b2f3017b5118" }, { "id": 427, "financial_account_uid": "01981b15-3e22-7c64-aec4-7ba66721efe4", "amount": -100.0, "occurrence_date": "2025-07-18", "created_at": "2025-07-18T09:10:34+08:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "338.370.034-85" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "2590d0ffa7b58d0343c2db8956de1c3e", "hashed_content": "2590d0ffa7b58d0343c2db8956de1c3e", "updated_at": "2025-07-18T09:10:34+08:00", "financial_provider_external_id": "df8238ef-f22b-4271-b4b5-f3f36bee804e" }, { "id": 426, "financial_account_uid": "01981b15-3e22-7c64-aec4-7ba66721efe4", "amount": -100.0, "occurrence_date": "2025-07-18", "created_at": "2025-07-18T09:10:34+08:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "196.332.424-28" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "bed667774f675549b7621b5a46071788", "hashed_content": "bed667774f675549b7621b5a46071788", "updated_at": "2025-07-18T09:10:34+08:00", "financial_provider_external_id": "77cd9aac-3007-4a26-8895-ef8ee6b2e92a" }, { "id": 425, "financial_account_uid": "01981b15-3e22-7c64-aec4-7ba66721efe4", "amount": -100.0, "occurrence_date": "2025-07-18", "created_at": "2025-07-18T09:10:34+08:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "538.402.352-00" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "fe529e585c30ca6527c12bf0a7e6ec07", "hashed_content": "fe529e585c30ca6527c12bf0a7e6ec07", "updated_at": "2025-07-18T09:10:34+08:00", "financial_provider_external_id": "e9b2b72e-8640-4ff3-8be6-e2dd9e6225ba" }, { "id": 424, "financial_account_uid": "01981b15-3e22-7c64-aec4-7ba66721efe4", "amount": -100.0, "occurrence_date": "2025-07-18", "created_at": "2025-07-18T09:10:34+08:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "175.905.194-21" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "c7f2b9039626598b9cda1ad5f147a1d3", "hashed_content": "c7f2b9039626598b9cda1ad5f147a1d3", "updated_at": "2025-07-18T09:10:34+08:00", "financial_provider_external_id": "d0f4f492-78d9-4118-aec9-b689173bc0a0" }, { "id": 423, "financial_account_uid": "01981b15-3e22-7c64-aec4-7ba66721efe4", "amount": -100.0, "occurrence_date": "2025-07-18", "created_at": "2025-07-18T09:10:34+08:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "490.808.565-09" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "544f8bbb621276262f89c3e7b7172a3f", "hashed_content": "544f8bbb621276262f89c3e7b7172a3f", "updated_at": "2025-07-18T09:10:34+08:00", "financial_provider_external_id": "ddd17403-99e1-46d8-a892-1c578484c2a9" }, { "id": 422, "financial_account_uid": "01981b15-3e22-7c64-aec4-7ba66721efe4", "amount": -100.0, "occurrence_date": "2025-07-18", "created_at": "2025-07-18T09:10:34+08:00", "description": "Transaction", "document_number": "12345", "person": { "document_number": "515.915.106-00" }, "kind": "debit", "category": 101, "category_description": "Débito Cheque Compensado", "hashed_id": "1bd1a0c3509aca2c5d44fdfc949175c0", "hashed_content": "1bd1a0c3509aca2c5d44fdfc949175c0", "updated_at": "2025-07-18T09:10:34+08:00", "financial_provider_external_id": "b2bafd94-0dca-4159-9413-11253d401c2a" } ], "pagination": { "prev_url": "/v2/financial/accounts/01981b15-3e22-7c64-aec4-7ba66721efe4/statement_transactions?per_page=20&occurrence_date_from=2025-07-16&occurrence_date_to=2025-07-19&page=", "next_url": "/v2/financial/accounts/01981b15-3e22-7c64-aec4-7ba66721efe4/statement_transactions?per_page=20&occurrence_date_from=2025-07-16&occurrence_date_to=2025-07-19&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" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } } } } }, "/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[block:callout]\n{\n \"type\": \"info\",\n \"body\": \"Este endpoint é processado assincronamente e cria um comando de sincronização de extrato para a Conta Financeira.\",\n \"title\": \"Processamento Assíncrono\"\n}\n[/block]\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## 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", "content": { "application/json": { "example": { "status": 201, "data": { "id": 1033, "status": "pending", "operation": "statement_sync", "params": null, "payload": null, "created_at": "2025-07-18T09:10:34+08:00", "updated_at": "2025-07-18T09:10:34+08:00", "message": null, "error_message": null, "warning_message": null } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_financial_account_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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } }, "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" } } } } } } }, "/v2/admin/certificates": { "post": { "summary": "Incluir um Certificado", "tags": [ "Certificado" ], "security": [ { "bearerAuth": [] } ], "description": "Incluir um certificado.\n[block:callout]\n{\n \"type\": \"info\",\n \"body\": \"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 \"title\": \"Tipo do Certificado\"\n}\n[/block]", "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": 2473, "uid": "01981b13-c89b-7d84-9708-2419ea5d7ba2", "account_id": 7849, "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": "2025-07-18T09:08:58+08:00", "updated_at": "2025-07-18T09:08:58+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 2475, "uid": "01981b13-cbb9-7493-a334-d1ae21a127d5", "account_id": 7853, "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": "2025-07-18T09:08:58+08:00", "updated_at": "2025-07-18T09:08:58+08:00", "expiration_date": "2122-09-16" }, { "id": 2474, "uid": "01981b13-cbae-7533-ae82-72d869d868d8", "account_id": 7853, "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": "2025-07-18T09:08:58+08:00", "updated_at": "2025-07-18T09:08:58+08:00", "expiration_date": "2122-09-16" } ], "pagination": { "prev_url": "/v2/admin/certificates?per_page=20&page=", "next_url": "/v2/admin/certificates?per_page=20&page=", "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"read write\".", "code": "forbidden" } ] }, "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": "01981b13-cda2-7540-9255-3b5b58e2f909", "certificate_uid": "01981b13-cd8c-7563-aa4a-bee6cf133629", "label": "Connection Name", "apis": [ "charge/pix" ], "provider_slug": "bradesco", "environment": "production", "created_at": "2025-07-18T09:08:59+08:00", "updated_at": "2025-07-18T09:08:59+08:00", "enabled_at": null, "validated_at": null, "associations": [ { "resource": { "slug": "charge.pix_account", "uid": "01981b13-ce04-7344-bd4b-37828ce3127c" } } ] } } } } }, "422": { "description": "Dados da associação inválidos", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "associations", "detail": "Serviços Associados [0] UUID fornecido não foi encontrado." } ] }, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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 ", "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", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01981b13-d459-7e7e-b21f-71265b9b1646", "certificate_uid": "01981b13-d3f5-7d85-9ac9-89bd762423f3", "label": "Conexão Bradesco", "apis": [ "charge/pix" ], "provider_slug": "bradesco", "environment": "production", "created_at": "2025-07-18T09:09:01+08:00", "updated_at": "2025-07-18T09:09:01+08:00", "enabled_at": "2025-07-18T09:09:01+08:00", "validated_at": "2025-07-18T09:09:01+08:00", "associations": [ { "resource": { "slug": "charge.pix_account", "uid": "01981b13-d3fd-7177-b87f-ffca9e1156f2" } } ] } }, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$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_banrisul_1" }, { "$ref": "#/components/schemas/v2_new_connection_bradesco_1" }, { "$ref": "#/components/schemas/v2_new_connection_bradesco_2" }, { "$ref": "#/components/schemas/v2_new_connection_bb_2" }, { "$ref": "#/components/schemas/v2_new_connection_bradesco_3" }, { "$ref": "#/components/schemas/v2_new_connection_btg_2" }, { "$ref": "#/components/schemas/v2_new_connection_bv_1" }, { "$ref": "#/components/schemas/v2_new_connection_btg_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_caixa_1" }, { "$ref": "#/components/schemas/v2_new_connection_inter_2" }, { "$ref": "#/components/schemas/v2_new_connection_itau_2" }, { "$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_sicoob_3" }, { "$ref": "#/components/schemas/v2_new_connection_sicredi_2" }, { "$ref": "#/components/schemas/v2_new_connection_sicredi_3" }, { "$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" } ] } } }, "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": "01981b13-da25-7a58-bc3c-009411dbeb22", "certificate_uid": null, "label": "Connection Name", "apis": [], "provider_slug": "digisac", "environment": "production", "created_at": "2025-07-18T09:09:02+08:00", "updated_at": "2025-07-18T09:09:02+08:00", "enabled_at": null, "validated_at": null, "associations": [] }, { "uid": "01981b13-da12-71a5-be05-f10cc0aab220", "certificate_uid": null, "label": "Connection Name", "apis": [], "provider_slug": "digisac", "environment": "production", "created_at": "2025-07-18T09:09:02+08:00", "updated_at": "2025-07-18T09:09:02+08:00", "enabled_at": null, "validated_at": null, "associations": [] } ], "pagination": { "prev_url": "/v2/admin/connections?per_page=20&page=", "next_url": "/v2/admin/connections?per_page=20&page=", "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"read\".", "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": "01981b13-dc14-7058-be46-e0f8ce7960fb", "certificate_uid": null, "label": "Connection Name", "apis": [], "provider_slug": "digisac", "environment": "production", "created_at": "2025-07-18T09:09:03+08:00", "updated_at": "2025-07-18T09:09:03+08:00", "enabled_at": null, "validated_at": null, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"read\".", "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": "01981b13-dea2-77bd-9462-5ed402f64ebf", "certificate_uid": null, "label": "Connection Name", "apis": [], "provider_slug": "digisac", "environment": "production", "created_at": "2025-07-18T09:09:03+08:00", "updated_at": "2025-07-18T09:09:03+08:00", "enabled_at": "2025-07-18T09:09:03+08:00", "validated_at": null, "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 do scope \"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": 7878, "uid": "01981b13-e2c2-7598-a0b2-f54fe3a5c39d", "email": "5e82d54d7e91ce40073a6e8badb315c3@hansen.example", "business_name": null, "business_legal_name": "Empresa LTDA", "nickname": "Empresa", "business_cnpj": "01.875.565/8180-80", "configuration": null, "parent_id": 7877, "created_via_api": true, "api_access_token": "ed-BvIHYGTPK1mNAZavYJ9PTgsVzrSyTUi6932SYjFY", "created_at": "2025-07-18T09:09:04+08:00", "updated_at": "2025-07-18T09:09:04+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 7903, "uid": "01981b13-eb49-7036-8b4a-ba6e647a659f", "email": "da19040417b2a58720d2c3f4ab9af567@murray.example", "business_name": null, "business_legal_name": "Sebastian Elias Publicidade LTDA.", "nickname": "Sebastian", "business_cnpj": "26.431.830/9941-11", "configuration": null, "parent_id": 7893, "created_via_api": false, "api_access_token": "Oswm6u_x3VQA4f1yMiiIOo-2mJFB98UeIadOBIY8iqg", "created_at": "2025-07-18T09:09:07+08:00", "updated_at": "2025-07-18T09:09:07+08:00", "external_id": null, "custom_data": null, "tags": [], "tag_list": null }, { "id": 7902, "uid": "01981b13-eaf8-76f1-a0fb-9403889c4bf0", "email": "42ccb97e9d79a5541035a9dc3c4062ae@swaniawski.example", "business_name": null, "business_legal_name": "Sebastian Elias Publicidade LTDA.", "nickname": "Sebastian", "business_cnpj": "47.816.638/7867-82", "configuration": null, "parent_id": 7893, "created_via_api": false, "api_access_token": "yC_0-p3DllJ2w48pYIemeKWXqLZh1LYaAM6P6D4HQyQ", "created_at": "2025-07-18T09:09:06+08:00", "updated_at": "2025-07-18T09:09:06+08:00", "external_id": null, "custom_data": null, "tags": [], "tag_list": null }, { "id": 7901, "uid": "01981b13-ea79-79eb-944c-31845ec7fd2c", "email": "90b9da84b23d8080a63cd7015bf2b34b@goyette.test", "business_name": null, "business_legal_name": "Sebastian Elias Publicidade LTDA.", "nickname": "Sebastian", "business_cnpj": "24.090.003/6687-00", "configuration": null, "parent_id": 7893, "created_via_api": false, "api_access_token": "t-bwfRAV9Jmfsk_swrZo6rBA9XlR-vwVovk7A79QenE", "created_at": "2025-07-18T09:09:06+08:00", "updated_at": "2025-07-18T09:09:06+08:00", "external_id": null, "custom_data": null, "tags": [], "tag_list": null }, { "id": 7900, "uid": "01981b13-ea26-7b86-be0f-fe1a1aa9f83a", "email": "f96d4c3e1d7130d5b17ee37b69baa109@cremin.example", "business_name": null, "business_legal_name": "Sebastian Elias Publicidade LTDA.", "nickname": "Sebastian", "business_cnpj": "37.927.788/9092-16", "configuration": null, "parent_id": 7893, "created_via_api": false, "api_access_token": "-ZkoUVAeYi-CsrvuebXJmiOTroyInBgco910nK1qLk8", "created_at": "2025-07-18T09:09:06+08:00", "updated_at": "2025-07-18T09:09:06+08:00", "external_id": null, "custom_data": null, "tags": [], "tag_list": null } ], "pagination": { "prev_url": "/v2/admin/subaccounts?per_page=4&page=", "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/admin/subaccounts/{id}": { "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": "id", "in": "path", "required": true, "description": "ID da Subconta", "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Subconta encontrada", "content": { "application/json": { "example": { "status": 200, "data": { "id": 7906, "uid": "01981b13-edd1-7c96-8f61-9f7e83842951", "email": "9d807b23f55035bd6a0c36584c13cbd0@white.example", "business_name": null, "business_legal_name": "Sebastian Elias Publicidade LTDA.", "nickname": "Sebastian", "business_cnpj": "63.349.466/3748-90", "configuration": null, "parent_id": 7905, "created_via_api": false, "api_access_token": "v6NPHZr3ZB4bo4cmAQwcl2L3Pbk8XO1tcdZOtM-h7aE", "created_at": "2025-07-18T09:09:07+08:00", "updated_at": "2025-07-18T09:09:07+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": "id", "in": "path", "required": true, "description": "ID da Subconta", "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Subconta alterada", "content": { "application/json": { "example": { "status": 200, "data": { "id": 7910, "uid": "01981b13-f07c-732a-9f7d-b8900465a4d7", "email": "1234567890example@example.com", "business_name": "HE:labs", "business_legal_name": "Disney", "nickname": "Sebastian", "business_cnpj": "48.320.060/1789-52", "configuration": null, "parent_id": 7909, "created_via_api": false, "api_access_token": "4E4Wdi6HnbN4Z_dKp8ZVNhsluOVjtvYWLABu2iQx22Q", "created_at": "2025-07-18T09:09:08+08:00", "updated_at": "2025-07-18T09:09:08+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 292, "uid": "01981b13-fa4c-7e44-aba5-f94861baedb5", "email": "13fe5f9fa2cb8c047e50589ffc104f01@torp-stamm.example", "first_name": "Jonh", "middle_name": "Silva", "last_name": "Doe", "full_name": "Jonh Silva Doe", "created_via_api": true, "permissions": [ "*" ], "created_at": "2025-07-18T09:09:10+08:00", "updated_at": "2025-07-18T09:09:10+08:00", "enabled_at": "2025-07-18T09:09:10+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": 313, "uid": "01981b13-fefd-7e7c-bfd4-b74c3793b98c", "email": "429ef65c7d58bc2f7289d7d8532bde2a@schultz.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": "2025-07-18T09:09:12+08:00", "updated_at": "2025-07-18T09:09:12+08:00", "enabled_at": "2025-07-18T09:09:12+08:00" }, { "id": 312, "uid": "01981b13-feea-7d99-a9d6-e52a98177c0a", "email": "45efc4febe3e9af7eb6c5d9d192dfdcb@bogisich.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": "2025-07-18T09:09:12+08:00", "updated_at": "2025-07-18T09:09:12+08:00", "enabled_at": "2025-07-18T09:09:12+08:00" }, { "id": 311, "uid": "01981b13-fed6-71d6-a9aa-7d1a5eac930e", "email": "87a910f44cb18cd902d5868d76d8ef2a@stark.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": "2025-07-18T09:09:12+08:00", "updated_at": "2025-07-18T09:09:12+08:00", "enabled_at": "2025-07-18T09:09:11+08:00" }, { "id": 310, "uid": "01981b13-feb0-77f2-a00b-d4d000fe1b5a", "email": "b993018ad909e388df0442a04c589ea9@moore.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": "2025-07-18T09:09:11+08:00", "updated_at": "2025-07-18T09:09:11+08:00", "enabled_at": "2025-07-18T09:09:11+08:00" } ], "pagination": { "prev_url": "/v2/admin/users?per_page=4&page=", "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"read write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/admin/users/{id}": { "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": "id", "in": "path", "required": true, "description": "ID do Usuário", "example": 999, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Usuário Alterado", "content": { "application/json": { "example": { "status": 200, "data": { "id": 314, "uid": "01981b14-00c3-7c8d-a277-da6e34435a34", "email": "b03f9ee29dcdcb1fc17312d9b6d7f941@hettinger.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": "2025-07-18T09:09:12+08:00", "updated_at": "2025-07-18T09:09:12+08:00", "enabled_at": "2025-07-18T09:09:12+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": "id", "in": "path", "required": true, "description": "ID do Usuário", "example": 999, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"write\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/transfer/batches": { "get": { "summary": "Listar Lotes de Transferência", "tags": [ "Todos" ], "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": "01981b15-7af1-76b4-8800-f7ab739d05ab", "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-7abc-7458-8e5e-bff8f87a0337", "transport_kind": "pix", "transfers": [ { "uid": "01981b15-7acc-7d2d-bc47-e26da7d17ed6", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-7abc-7458-8e5e-bff8f87a0337", "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": "2025-07-21T09:10:49+08:00" }, "transfer_kind": "pix" }, "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": "933907", "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:49+08:00", "updated_at": "2025-07-18T09:10:49+08:00" }, { "uid": "01981b15-7ad8-72f0-996a-02a65661dc9a", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-7abc-7458-8e5e-bff8f87a0337", "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": "2025-07-21T09:10:49+08:00" }, "transfer_kind": "pix" }, "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": "479706", "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:49+08:00", "updated_at": "2025-07-18T09:10:49+08:00" }, { "uid": "01981b15-7ae2-7609-acd2-263f1f703ce8", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-7abc-7458-8e5e-bff8f87a0337", "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": "2025-07-21T09:10:49+08:00" }, "transfer_kind": "pix" }, "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": "780018", "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:49+08:00", "updated_at": "2025-07-18T09:10:49+08:00" } ], "created_at": "2025-07-18T09:10:49+08:00", "updated_at": "2025-07-18T09:10:49+08:00" }, { "uid": "01981b15-7a7e-79fa-b532-072c59da4729", "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-7a46-7027-8701-03ccb047ef96", "transport_kind": "pix", "transfers": [ { "uid": "01981b15-7a58-7216-9326-aca18395deb0", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-7a46-7027-8701-03ccb047ef96", "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": "2025-07-21T09:10:49+08:00" }, "transfer_kind": "pix" }, "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": "679315", "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:49+08:00", "updated_at": "2025-07-18T09:10:49+08:00" }, { "uid": "01981b15-7a64-7902-9f88-c57e59804dcb", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-7a46-7027-8701-03ccb047ef96", "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": "2025-07-21T09:10:49+08:00" }, "transfer_kind": "pix" }, "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": "189414", "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:49+08:00", "updated_at": "2025-07-18T09:10:49+08:00" }, { "uid": "01981b15-7a6e-74d3-8df9-45d6e0fb37ea", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-7a46-7027-8701-03ccb047ef96", "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": "2025-07-21T09:10:49+08:00" }, "transfer_kind": "pix" }, "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": "357731", "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:49+08:00", "updated_at": "2025-07-18T09:10:49+08:00" } ], "created_at": "2025-07-18T09:10:49+08:00", "updated_at": "2025-07-18T09:10:49+08:00" }, { "uid": "01981b15-7a00-711b-99f1-88f14f1ade22", "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-79a3-7c92-a20e-a51db7e7c6eb", "transport_kind": "pix", "transfers": [ { "uid": "01981b15-79d5-7a31-82a8-e9b4d9cf795e", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-79a3-7c92-a20e-a51db7e7c6eb", "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": "2025-07-21T09:10:49+08:00" }, "transfer_kind": "pix" }, "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": "477179", "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:49+08:00", "updated_at": "2025-07-18T09:10:49+08:00" }, { "uid": "01981b15-79e3-774e-a92d-14314ef8a46b", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-79a3-7c92-a20e-a51db7e7c6eb", "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": "2025-07-21T09:10:49+08:00" }, "transfer_kind": "pix" }, "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": "267811", "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:49+08:00", "updated_at": "2025-07-18T09:10:49+08:00" }, { "uid": "01981b15-79f0-73dc-816f-e92dd47ba1e6", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-79a3-7c92-a20e-a51db7e7c6eb", "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": "2025-07-21T09:10:49+08:00" }, "transfer_kind": "pix" }, "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": "615328", "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:49+08:00", "updated_at": "2025-07-18T09:10:49+08:00" } ], "created_at": "2025-07-18T09:10:49+08:00", "updated_at": "2025-07-18T09:10:49+08:00" } ], "pagination": { "prev_url": "/v2/transfer/batches?page=&per_page=50", "next_url": "/v2/transfer/batches?page=&per_page=50", "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"read\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } } }, "/v2/transfer/batches/{uid}": { "get": { "summary": "Visualizar um Lote de Transferência", "tags": [ "Todos" ], "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": "01981b15-7d20-71d2-9b5b-2dfee2138e9f", "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-7cee-726b-b487-cea524a42767", "transport_kind": "pix", "transfers": [ { "uid": "01981b15-7cfe-7132-a6cd-4609340b048c", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-7cee-726b-b487-cea524a42767", "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": "2025-07-21T09:10:49+08:00" }, "transfer_kind": "pix" }, "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": "411089", "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:49+08:00", "updated_at": "2025-07-18T09:10:49+08:00" }, { "uid": "01981b15-7d09-7f9e-b4d5-84d11b26246c", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-7cee-726b-b487-cea524a42767", "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": "2025-07-21T09:10:49+08:00" }, "transfer_kind": "pix" }, "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": "236412", "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:49+08:00", "updated_at": "2025-07-18T09:10:49+08:00" }, { "uid": "01981b15-7d13-7d6d-9137-bb5dc6dd2236", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-7cee-726b-b487-cea524a42767", "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": "2025-07-21T09:10:49+08:00" }, "transfer_kind": "pix" }, "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": "941778", "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:49+08:00", "updated_at": "2025-07-18T09:10:49+08:00" } ], "created_at": "2025-07-18T09:10:49+08:00", "updated_at": "2025-07-18T09:10:49+08: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" ], "security": [ { "bearerAuth": [] } ], "description": "\n [block:callout]\n {\n \"type\": \"info\",\n \"body\": \"Este endpoint é processado assincronamente e cria um comando de aprovação para o Lote de Transferência.\",\n \"title\": \"Processamento Assíncrono\"\n }\n [/block]\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 [block:callout]\n {\n \"type\": \"warning\",\n \"body\": \"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\",\n \"title\": \"Atenção ao status Aprovado\"\n }\n [/block]", "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": 1036, "status": "pending", "operation": "approve", "params": null, "payload": null, "created_at": "2025-07-18T09:10:50+08:00", "updated_at": "2025-07-18T09:10:50+08:00", "message": null, "error_message": null, "warning_message": null, "financial_transfer_batch": { "uid": "01981b15-7ecc-75d6-bd0b-7b90813b0448", "status": "awaiting_approval", "registration_status": "confirmed", "financial_account_uid": "01981b15-7e8b-7ee6-b51b-47c84b93543a", "transport_kind": "pix", "transfers": [ { "uid": "01981b15-7e9c-7502-89e2-6dd456bc3896", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-7e8b-7ee6-b51b-47c84b93543a", "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": "2025-07-21T09:10:50+08:00" }, "transfer_kind": "pix" }, "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": "166000", "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:50+08:00", "updated_at": "2025-07-18T09:10:50+08:00" }, { "uid": "01981b15-7eaf-778d-848f-4525cc9d5502", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-7e8b-7ee6-b51b-47c84b93543a", "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": "2025-07-21T09:10:50+08:00" }, "transfer_kind": "pix" }, "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": "940053", "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:50+08:00", "updated_at": "2025-07-18T09:10:50+08:00" }, { "uid": "01981b15-7eba-7e8d-9e3a-31bdc8d812a9", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-7e8b-7ee6-b51b-47c84b93543a", "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": "2025-07-21T09:10:50+08:00" }, "transfer_kind": "pix" }, "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": "575347", "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:50+08:00", "updated_at": "2025-07-18T09:10:50+08:00" } ], "created_at": "2025-07-18T09:10:50+08:00", "updated_at": "2025-07-18T09:10:50+08: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_entity", "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" ], "security": [ { "bearerAuth": [] } ], "description": "\n [block:callout]\n {\n \"type\": \"info\",\n \"body\": \"Este endpoint é processado assincronamente e cria um comando de reprovação para o Lote de Transferência.\",\n \"title\": \"Processamento Assíncrono\"\n }\n [/block]\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 [block:callout]\n {\n \"type\": \"warning\",\n \"body\": \"O status de Reprovado é terminal. Quando a instituição financeira cancelar as transferências, os mesmos terão seus status alterados para Reprovado\",\n \"title\": \"Atenção ao status Reprovado\"\n }\n [/block]", "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": 1037, "status": "pending", "operation": "reprove", "params": null, "payload": null, "created_at": "2025-07-18T09:10:51+08:00", "updated_at": "2025-07-18T09:10:51+08:00", "message": null, "error_message": null, "warning_message": null, "financial_transfer_batch": { "uid": "01981b15-82a6-7839-8615-ff12ea036a34", "status": "awaiting_approval", "registration_status": "confirmed", "financial_account_uid": "01981b15-8269-7f25-b189-467501bb3e88", "transport_kind": "pix", "transfers": [ { "uid": "01981b15-827f-7b9b-8ba5-03ea8c5c3402", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-8269-7f25-b189-467501bb3e88", "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": "2025-07-21T09:10:51+08:00" }, "transfer_kind": "pix" }, "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": "448000", "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:51+08:00", "updated_at": "2025-07-18T09:10:51+08:00" }, { "uid": "01981b15-828b-728b-b179-f84ef347aff6", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-8269-7f25-b189-467501bb3e88", "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": "2025-07-21T09:10:51+08:00" }, "transfer_kind": "pix" }, "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": "949199", "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:51+08:00", "updated_at": "2025-07-18T09:10:51+08:00" }, { "uid": "01981b15-8297-7702-a862-051d7a45028d", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-8269-7f25-b189-467501bb3e88", "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": "2025-07-21T09:10:51+08:00" }, "transfer_kind": "pix" }, "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": "518558", "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:51+08:00", "updated_at": "2025-07-18T09:10:51+08:00" } ], "created_at": "2025-07-18T09:10:51+08:00", "updated_at": "2025-07-18T09:10:51+08: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_entity", "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/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 é necessário ter cadastrado uma Conta Financeira.\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": "01981b15-8608-73ee-a797-c6060ed2d3fa", "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-85a5-7bc9-9d2b-e1cc26829a15", "transport_kind": "internal", "transfers": [ { "uid": "01981b15-8603-72de-b3ee-b336a1df8673", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-85a5-7bc9-9d2b-e1cc26829a15", "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" }, "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:52+08:00", "updated_at": "2025-07-18T09:10:52+08:00" }, { "uid": "01981b15-8608-7c93-a779-c7b9b70d61ba", "status": "scheduled", "scheduled_to": "2025-08-18T09:10:52+08:00", "registration_status": "pending", "financial_account_uid": "01981b15-85a5-7bc9-9d2b-e1cc26829a15", "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" }, "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", "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "created_at": "2025-07-18T09:10:52+08:00", "updated_at": "2025-07-18T09:10:52+08:00" } ], "created_at": "2025-07-18T09:10:52+08:00", "updated_at": "2025-07-18T09:10:52+08: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", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "transfers.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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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": "01981b15-886b-7577-9de8-351c3f204918", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-885f-7bda-b634-e6b7e8d236cc", "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" }, "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:52+08:00", "updated_at": "2025-07-18T09:10:52+08:00" }, { "uid": "01981b15-882d-75cd-bdf7-313425952f12", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-881d-7ff0-aa20-ad062e57d7a9", "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" }, "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:52+08:00", "updated_at": "2025-07-18T09:10:52+08:00" }, { "uid": "01981b15-87ef-788d-b7a2-6de9ec2ecea5", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-87e1-75eb-b804-ea910b52c4ec", "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" }, "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:52+08:00", "updated_at": "2025-07-18T09:10:52+08:00" } ], "pagination": { "prev_url": "/v2/transfer/internal?per_page=20&page=", "next_url": "/v2/transfer/internal?per_page=20&page=", "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"read\".", "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 cadastrado uma Conta Financeira.\n\n## Eventos de Webhook\n\nO evento `transfer.db.created` é disparado nesta operação.\n\n[block:callout]\n{\n \"type\": \"info\",\n \"body\": \"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`.\",\n \"title\": \"Próximos passos\"\n}\n[/block]", "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": "01981b15-8ac9-7e6e-aa24-70d022186a25", "status": "scheduled", "scheduled_to": "2025-07-18T09:10:53+08:00", "registration_status": "pending", "financial_account_uid": "01981b15-8a74-794f-97ec-a85bad8765f1", "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" }, "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", "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "created_at": "2025-07-18T09:10:53+08:00", "updated_at": "2025-07-18T09:10:53+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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": "01981b15-8ce4-7a07-b29e-05dc18fe22d5", "status": "scheduled", "scheduled_to": "2025-07-19T09:10:53+08:00", "registration_status": "pending", "financial_account_uid": "01981b15-8cd6-73ae-bedf-2d19f1155e61", "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" }, "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:53+08:00", "updated_at": "2025-07-18T09:10:53+08: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/pix_batches": { "post": { "summary": "Criar um Lote de Transferência Pix", "tags": [ "Pix" ], "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 é necessário ter cadastrado uma Conta Financeira.\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": "01981b15-8e90-7735-a2eb-a060120935c1", "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-8e31-7bfe-90e9-ed6c48e85983", "transport_kind": "pix", "transfers": [ { "uid": "01981b15-8e8e-7d30-9054-eb304b7c05ba", "status": "scheduled", "scheduled_to": "2025-07-19T09:10:54+08:00", "registration_status": "pending", "financial_account_uid": "01981b15-8e31-7bfe-90e9-ed6c48e85983", "amount": 100.0, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 2038232, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "document_number": "80.815.210/0000-96", "account_type": "checkings" }, "internal": null, "pix": { "pix_type": "bank_account", "txid": null, "key": null, "key_type": null, "end_to_end_id": null }, "transfer_kind": "pix" }, "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:54+08:00", "updated_at": "2025-07-18T09:10:54+08:00" }, { "uid": "01981b15-8e8f-7d19-95cc-e3fcf648ea49", "status": "scheduled", "scheduled_to": "2025-07-19T09:10:54+08:00", "registration_status": "pending", "financial_account_uid": "01981b15-8e31-7bfe-90e9-ed6c48e85983", "amount": 100.0, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 2038232, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "document_number": "80.815.210/0000-96", "account_type": "checkings" }, "internal": null, "pix": { "pix_type": "bank_account", "txid": null, "key": null, "key_type": null, "end_to_end_id": null }, "transfer_kind": "pix" }, "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", "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "created_at": "2025-07-18T09:10:54+08:00", "updated_at": "2025-07-18T09:10:54+08:00" } ], "created_at": "2025-07-18T09:10:54+08:00", "updated_at": "2025-07-18T09:10:54+08: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", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "transfers.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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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" ], "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": "01981b15-9105-76e6-b0d5-857ab6ca912a", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-90f9-7f3c-bf9f-bf345e9e33e1", "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": "2025-07-21T09:10:54+08:00" }, "transfer_kind": "pix" }, "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:54+08:00", "updated_at": "2025-07-18T09:10:54+08:00" }, { "uid": "01981b15-90c7-7283-9c01-765c7e7ecd71", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-90ba-7232-87e0-19c9b25a537d", "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": "2025-07-21T09:10:54+08:00" }, "transfer_kind": "pix" }, "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:54+08:00", "updated_at": "2025-07-18T09:10:54+08:00" }, { "uid": "01981b15-9087-7dc5-b28c-0f2e8ee9d3cd", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-907b-75d1-bbf5-3e8faa9fd10d", "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": "2025-07-21T09:10:54+08:00" }, "transfer_kind": "pix" }, "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:54+08:00", "updated_at": "2025-07-18T09:10:54+08:00" } ], "pagination": { "prev_url": "/v2/transfer/pix?per_page=20&page=", "next_url": "/v2/transfer/pix?per_page=20&page=", "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"read\".", "code": "forbidden" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } } }, "post": { "summary": "Criar uma Transferência Pix", "tags": [ "Pix" ], "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 cadastrado uma Conta Financeira.\n\n## Eventos de Webhook\n\nO evento `transfer.db.created` é disparado nesta operação.\n\n[block:callout]\n{\n \"type\": \"info\",\n \"body\": \"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`.\",\n \"title\": \"Próximos passos\"\n}\n[/block]", "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": "01981b15-9343-7570-b535-6e8a1181bbd4", "status": "scheduled", "scheduled_to": "2025-07-18T09:10:55+08:00", "registration_status": "pending", "financial_account_uid": "01981b15-92f6-778d-991d-10ff551f1c7b", "amount": 100.4, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 2038232, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "document_number": "80.815.210/0000-96", "account_type": "checkings" }, "internal": null, "pix": { "pix_type": "bank_account", "txid": null, "key": null, "key_type": null, "end_to_end_id": null }, "transfer_kind": "pix" }, "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", "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "created_at": "2025-07-18T09:10:55+08:00", "updated_at": "2025-07-18T09:10:55+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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" ], "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": "01981b15-9557-752f-83ae-c04de229bda8", "status": "scheduled", "scheduled_to": "2025-07-19T09:10:55+08:00", "registration_status": "pending", "financial_account_uid": "01981b15-954a-7dcd-82fb-d32d899f3d81", "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": "2025-07-21T09:10:56+08:00" }, "transfer_kind": "pix" }, "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:56+08:00", "updated_at": "2025-07-18T09:10:56+08: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/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 é necessário ter cadastrado uma Conta Financeira.\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": "01981b15-9701-7f8f-bb6f-230a6e769d15", "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-96a1-7b54-aa02-2c095fe57115", "transport_kind": "ted", "transfers": [ { "uid": "01981b15-96fe-7324-b968-42ebd5819e87", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-96a1-7b54-aa02-2c095fe57115", "amount": 100.0, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 2038232, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "document_number": "80.815.210/0000-96", "account_type": "checkings" }, "internal": null, "pix": null, "transfer_kind": "ted" }, "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:56+08:00", "updated_at": "2025-07-18T09:10:56+08:00" }, { "uid": "01981b15-96ff-7d5a-8586-2b7dcb8fd8e0", "status": "scheduled", "scheduled_to": "2025-08-18T09:10:56+08:00", "registration_status": "pending", "financial_account_uid": "01981b15-96a1-7b54-aa02-2c095fe57115", "amount": 100.0, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 2038232, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "document_number": "80.815.210/0000-96", "account_type": "checkings" }, "internal": null, "pix": null, "transfer_kind": "ted" }, "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:56+08:00", "updated_at": "2025-07-18T09:10:56+08:00" }, { "uid": "01981b15-9700-7fbf-8189-755b2640269d", "status": "scheduled", "scheduled_to": "2025-08-18T09:10:56+08:00", "registration_status": "pending", "financial_account_uid": "01981b15-96a1-7b54-aa02-2c095fe57115", "amount": 100.0, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 2038232, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "document_number": "80.815.210/0000-96", "account_type": "checkings" }, "internal": null, "pix": null, "transfer_kind": "ted" }, "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", "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "created_at": "2025-07-18T09:10:56+08:00", "updated_at": "2025-07-18T09:10:56+08:00" } ], "created_at": "2025-07-18T09:10:56+08:00", "updated_at": "2025-07-18T09:10:56+08: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", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "transfers.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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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": "01981b15-9987-7b9b-9a35-79fda22bdd98", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-997b-7315-b90a-bc2a64d63076", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 2038232, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "document_number": "80.815.210/0000-96", "account_type": "checkings" }, "internal": null, "pix": null, "transfer_kind": "ted" }, "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:57+08:00", "updated_at": "2025-07-18T09:10:57+08:00" }, { "uid": "01981b15-994a-7ab2-ab1a-e27112169e2a", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-993e-7e90-a421-76082cfa73a5", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 2038232, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "document_number": "80.815.210/0000-96", "account_type": "checkings" }, "internal": null, "pix": null, "transfer_kind": "ted" }, "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:57+08:00", "updated_at": "2025-07-18T09:10:57+08:00" }, { "uid": "01981b15-990e-767f-94bd-12e8c51ea9c5", "status": "pending", "scheduled_to": null, "registration_status": "pending", "financial_account_uid": "01981b15-9901-77ca-8702-9abd64134c44", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 2038232, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "document_number": "80.815.210/0000-96", "account_type": "checkings" }, "internal": null, "pix": null, "transfer_kind": "ted" }, "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:57+08:00", "updated_at": "2025-07-18T09:10:57+08:00" } ], "pagination": { "prev_url": "/v2/transfer/ted?per_page=20&page=", "next_url": "/v2/transfer/ted?per_page=20&page=", "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"read\".", "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 cadastrado uma Conta Financeira.\n\n## Eventos de Webhook\n\nO evento `transfer.db.created` é disparado nesta operação.\n\n[block:callout]\n{\n \"type\": \"info\",\n \"body\": \"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`.\",\n \"title\": \"Próximos passos\"\n}\n[/block]", "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": "01981b15-9bc7-7576-875f-ce1c9052f57b", "status": "scheduled", "scheduled_to": "2025-07-18T09:10:57+08:00", "registration_status": "pending", "financial_account_uid": "01981b15-9b77-7b21-b112-1961ac43e45a", "amount": 100.4, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 2038232, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "document_number": "80.815.210/0000-96", "account_type": "checkings" }, "internal": null, "pix": null, "transfer_kind": "ted" }, "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", "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "created_at": "2025-07-18T09:10:57+08:00", "updated_at": "2025-07-18T09:10:57+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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": "01981b15-9dc3-71a7-ae78-3ce62cc3e5f6", "status": "scheduled", "scheduled_to": "2025-07-19T09:10:58+08:00", "registration_status": "pending", "financial_account_uid": "01981b15-9db5-71da-b54e-54fad1a4664d", "amount": 0.1, "target": { "beneficiary": { "document_number": "80.815.210/0000-96", "name": "Kobana" }, "bank_account": { "compe_number": 1, "ispb_number": 2038232, "agency_number": "4042", "agency_digit": "8", "account_number": "8873", "account_digit": "x", "document_number": "80.815.210/0000-96", "account_type": "checkings" }, "internal": null, "pix": null, "transfer_kind": "ted" }, "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:58+08:00", "updated_at": "2025-07-18T09:10:58+08: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/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 pagamento é necessário ter cadastrado um Conta Financeira.\n\n## Eventos de Webhook\n\nO evento `payment.batch.db.created` é disparado nesta operação.\n\nAo cadastrar um Lote de Pagamento, o sistema cria um comando para registrá-lo na instituição financeira. Após o registro do lote ser confirmado na instituição, o evento `payment.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": "01981b15-457d-7c90-beee-98f8608a0ae8", "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-44bd-7170-8e7c-e8ba0a682441", "created_at": "2025-07-18T09:10:35+08:00", "updated_at": "2025-07-18T09:10:35+08:00", "payments": [ { "uid": "01981b15-456a-7add-ae47-9fc3c263e55f", "amount": 100.4, "scheduled_to": "2025-07-18T09:10:35+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-44bd-7170-8e7c-e8ba0a682441", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:35+08:00", "updated_at": "2025-07-18T09:10:35+08:00", "bank_billet": { "code": "81770000001800005659970741131079703900143338", "beneficiary": { "name": null, "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-456c-731f-874d-ba152f883f6b", "amount": 100.4, "scheduled_to": "2025-07-18T09:10:35+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-44bd-7170-8e7c-e8ba0a682441", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": null, "external_id": "26843f45f68d3bc098a89c550a34845847", "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "created_at": "2025-07-18T09:10:35+08:00", "updated_at": "2025-07-18T09:10:35+08: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", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "payments.payable.code", "detail": "Payments payable code precisa conter 44, 47 ou 48 caracteres numéricos" }, { "code": "validation_error", "param": "payments.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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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": "01981b15-4a29-705c-bb72-3f0f22ec9622", "amount": 100.0, "scheduled_to": "2025-07-19T09:10:36+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-4a15-7650-a990-dc9a45f3b697", "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:36+08:00", "updated_at": "2025-07-18T09:10:36+08:00", "bank_billet": { "code": "02290115605832025050812137580327724690338199", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-49e2-72dd-b4b4-0f350e3d3ce6", "amount": 100.0, "scheduled_to": "2025-07-19T09:10:36+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-49ce-75a6-9c57-b748999b9ecb", "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:36+08:00", "updated_at": "2025-07-18T09:10:36+08:00", "bank_billet": { "code": "02790115605666800040907833418089685733392020", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-4997-7f58-a21c-28c9bc7b37b9", "amount": 100.0, "scheduled_to": "2025-07-19T09:10:36+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-4984-7625-bf15-7778b8ae2c6b", "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:36+08:00", "updated_at": "2025-07-18T09:10:36+08:00", "bank_billet": { "code": "07290115605433635060295471452636811554310540", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-4952-7c3c-ab03-af83008d5ced", "amount": 100.0, "scheduled_to": "2025-07-19T09:10:36+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-493d-7b91-bc8f-361dd1e15112", "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:36+08:00", "updated_at": "2025-07-18T09:10:36+08:00", "bank_billet": { "code": "00890115600053071680276101634606191056870284", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-490c-7f11-9115-236b44e86c45", "amount": 100.0, "scheduled_to": "2025-07-19T09:10:36+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-48f7-706e-9b1e-5078e2389e89", "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:36+08:00", "updated_at": "2025-07-18T09:10:36+08:00", "bank_billet": { "code": "09990115603534607550587932730347069936677590", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } ], "pagination": { "prev_url": "/v2/payment/bank_billets?per_page=5&page=", "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 cadastrado uma Conta Financeira.\n\n## Eventos de Webhook\n\nO evento `payment.db.created` é disparado nesta operação.\n\n[block:callout]\n{\n \"type\": \"info\",\n \"body\": \"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`.\",\n \"title\": \"Próximos passos\"\n}\n[/block]", "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": "01981b15-4b51-719d-8d47-572801d006e6", "amount": 100.4, "scheduled_to": "2025-07-18T09:10:37+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-4afe-76a2-a35d-cb2c71162eed", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": null, "external_id": "26843f45f68d3bc098a89c550a34845847", "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "created_at": "2025-07-18T09:10:37+08:00", "updated_at": "2025-07-18T09:10:37+08:00", "bank_billet": { "code": "81770000018000056599707411310797039001433708", "beneficiary": { "name": null, "document_number": null } } } }, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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": "01981b15-4d42-75a3-ad0a-ff61df431b37", "amount": 100.0, "scheduled_to": "2025-07-19T09:10:37+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-4d28-7e02-9e1e-1f2300a9f3e4", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:37+08:00", "updated_at": "2025-07-18T09:10:37+08:00", "bank_billet": { "code": "04790115603175569210846613342930350413234264", "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/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": "01981b15-531f-7a3c-87f9-d1566275a2c7", "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-52e8-71ed-b9e8-55a18ddc8c2d", "created_at": "2025-07-18T09:10:39+08:00", "updated_at": "2025-07-18T09:10:39+08:00", "payments": [ { "uid": "01981b15-52fe-7f01-8940-d99194d09972", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-52e8-71ed-b9e8-55a18ddc8c2d", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:39+08:00", "updated_at": "2025-07-18T09:10:39+08:00", "bank_billet": { "code": "07090115600611017410253183383103336601856499", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-530b-7fa1-9af6-4f041252abb9", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-52e8-71ed-b9e8-55a18ddc8c2d", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:39+08:00", "updated_at": "2025-07-18T09:10:39+08:00", "bank_billet": { "code": "04790115600471576140055673605456878202919452", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-531b-7353-97f5-2464a03da860", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-52e8-71ed-b9e8-55a18ddc8c2d", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:39+08:00", "updated_at": "2025-07-18T09:10:39+08:00", "bank_billet": { "code": "08590115605373804110484679004870957438442319", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } ] }, { "uid": "01981b15-52af-7b70-bb27-d1f642d8ae6b", "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-527b-7aed-bfbc-3f68326c6968", "created_at": "2025-07-18T09:10:39+08:00", "updated_at": "2025-07-18T09:10:39+08:00", "payments": [ { "uid": "01981b15-5290-7cb1-81bc-7967164cbe35", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-527b-7aed-bfbc-3f68326c6968", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:38+08:00", "updated_at": "2025-07-18T09:10:39+08:00", "bank_billet": { "code": "05090115601856662280815342479142391321093772", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-529d-7d39-81aa-f03b95f33fcc", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-527b-7aed-bfbc-3f68326c6968", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:39+08:00", "updated_at": "2025-07-18T09:10:39+08:00", "bank_billet": { "code": "04390115601610566370628226482667189974328757", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-52aa-7e79-8c1a-4b603876af4f", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-527b-7aed-bfbc-3f68326c6968", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:39+08:00", "updated_at": "2025-07-18T09:10:39+08:00", "bank_billet": { "code": "00690115603880859120789575545874740949874993", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } ] }, { "uid": "01981b15-5240-737c-9c25-3745b7d3bf0f", "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-5209-7602-b629-339c1443f8f9", "created_at": "2025-07-18T09:10:38+08:00", "updated_at": "2025-07-18T09:10:38+08:00", "payments": [ { "uid": "01981b15-5220-76e3-ab1c-9885bfe4d981", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-5209-7602-b629-339c1443f8f9", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:38+08:00", "updated_at": "2025-07-18T09:10:38+08:00", "bank_billet": { "code": "05690115602288722530685802516694536919499142", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-522d-7e49-b50f-890c100c6f3c", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-5209-7602-b629-339c1443f8f9", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:38+08:00", "updated_at": "2025-07-18T09:10:38+08:00", "bank_billet": { "code": "06190115607141170190051571101001431495973665", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-523b-7cb7-bf82-d3b79a510027", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-5209-7602-b629-339c1443f8f9", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:38+08:00", "updated_at": "2025-07-18T09:10:38+08:00", "bank_billet": { "code": "03690115606597444650816533504292792129623140", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } ] }, { "uid": "01981b15-51cb-7579-8dd6-b1c58408fa24", "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-5195-7725-9e1c-fff16a1216dd", "created_at": "2025-07-18T09:10:38+08:00", "updated_at": "2025-07-18T09:10:38+08:00", "payments": [ { "uid": "01981b15-51ab-791c-adec-1a8ead12e672", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-5195-7725-9e1c-fff16a1216dd", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:38+08:00", "updated_at": "2025-07-18T09:10:38+08:00", "bank_billet": { "code": "08990115603569173350618113040077798116292308", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-51b9-7c2c-9f90-f7563c83125d", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-5195-7725-9e1c-fff16a1216dd", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:38+08:00", "updated_at": "2025-07-18T09:10:38+08:00", "bank_billet": { "code": "05390115604739637470471578713389670336939467", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-51c6-7d3b-9e6c-41667662da11", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-5195-7725-9e1c-fff16a1216dd", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:38+08:00", "updated_at": "2025-07-18T09:10:38+08:00", "bank_billet": { "code": "00690115602872204880800794518535881221856271", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } ] }, { "uid": "01981b15-5155-77dd-94e4-e8d92b3d80dc", "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-5119-7f65-a46d-70f69aea2079", "created_at": "2025-07-18T09:10:38+08:00", "updated_at": "2025-07-18T09:10:38+08:00", "payments": [ { "uid": "01981b15-5130-750e-b93d-4101698de3de", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-5119-7f65-a46d-70f69aea2079", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:38+08:00", "updated_at": "2025-07-18T09:10:38+08:00", "bank_billet": { "code": "04690115601703650940932008919288325828581844", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-5140-7b31-8310-575e7ef1fce8", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-5119-7f65-a46d-70f69aea2079", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:38+08:00", "updated_at": "2025-07-18T09:10:38+08:00", "bank_billet": { "code": "01790115606839366060911343435931170998687958", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-514e-7396-9865-e74183dc29ec", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-5119-7f65-a46d-70f69aea2079", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:38+08:00", "updated_at": "2025-07-18T09:10:38+08:00", "bank_billet": { "code": "00590115607576530520055326619965850199631015", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } ] } ], "pagination": { "prev_url": "/v2/payment/batches?per_page=5&page=", "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": "01981b15-5471-7250-8463-9752a1174fd1", "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-5435-7902-bc59-252556e47c7a", "created_at": "2025-07-18T09:10:39+08:00", "updated_at": "2025-07-18T09:10:39+08:00", "payments": [ { "uid": "01981b15-5453-77eb-a7b9-86845c36f632", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-5435-7902-bc59-252556e47c7a", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:39+08:00", "updated_at": "2025-07-18T09:10:39+08:00", "bank_billet": { "code": "08790115603032632310240247423707719434629950", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-545f-747a-a84c-1ca4a1d824fe", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-5435-7902-bc59-252556e47c7a", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:39+08:00", "updated_at": "2025-07-18T09:10:39+08:00", "bank_billet": { "code": "06090115601375714410318725118790762599259894", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-546c-79fe-bb4e-a4c178036ac5", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-5435-7902-bc59-252556e47c7a", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:39+08:00", "updated_at": "2025-07-18T09:10:39+08:00", "bank_billet": { "code": "07690115605403483340425039987862794778241521", "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 [block:callout]\n {\n \"type\": \"info\",\n \"body\": \"Este endpoint é processado assincronamente e cria um comando de aprovação para o Lote de Pagamento.\",\n \"title\": \"Processamento Assíncrono\"\n }\n [/block]\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 [block:callout]\n {\n \"type\": \"warning\",\n \"body\": \"O status de Aprovado não é terminal. Quando a instituição financeira confirmar os pagamentos, os mesmos terão seus status alterados para Confirmado\",\n \"title\": \"Atenção ao status Aprovado\"\n }\n [/block]", "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": 1034, "status": "pending", "operation": "approve", "params": null, "payload": null, "created_at": "2025-07-18T09:10:40+08:00", "updated_at": "2025-07-18T09:10:40+08:00", "message": null, "error_message": null, "warning_message": null, "payment_batch": { "uid": "01981b15-5615-71e1-999c-8ee2f3d90a1c", "status": "awaiting_approval", "registration_status": "confirmed", "financial_account_uid": "01981b15-55df-7d14-b2d6-ac297cd92d45", "created_at": "2025-07-18T09:10:39+08:00", "updated_at": "2025-07-18T09:10:39+08:00", "payments": [ { "uid": "01981b15-55f5-7cf4-9911-749ab48fa35d", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-55df-7d14-b2d6-ac297cd92d45", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:39+08:00", "updated_at": "2025-07-18T09:10:39+08:00", "bank_billet": { "code": "03990115603658978770768328795348652184447752", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-5601-7a83-a2a3-e2543ca23f97", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-55df-7d14-b2d6-ac297cd92d45", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:39+08:00", "updated_at": "2025-07-18T09:10:39+08:00", "bank_billet": { "code": "08990115607184407490447865397109280349727053", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-560e-7744-acdf-4d89fe1a0beb", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-55df-7d14-b2d6-ac297cd92d45", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:39+08:00", "updated_at": "2025-07-18T09:10:39+08:00", "bank_billet": { "code": "04390115609741309960194411226851755078363054", "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_entity", "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 [block:callout]\n {\n \"type\": \"info\",\n \"body\": \"Este endpoint é processado assincronamente e cria um comando de reprovação para o Lote de Pagamento.\",\n \"title\": \"Processamento Assíncrono\"\n }\n [/block]\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 [block:callout]\n {\n \"type\": \"warning\",\n \"body\": \"O status de Reprovado é terminal. Quando a instituição financeira cancelar os pagamentos, os mesmos terão seus status alterados para Reprovado\",\n \"title\": \"Atenção ao status Reprovado\"\n }\n [/block]", "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": 1035, "status": "pending", "operation": "reprove", "params": null, "payload": null, "created_at": "2025-07-18T09:10:40+08:00", "updated_at": "2025-07-18T09:10:40+08:00", "message": null, "error_message": null, "warning_message": null, "payment_batch": { "uid": "01981b15-59b9-7b01-9c8e-3c5be22c77c2", "status": "awaiting_approval", "registration_status": "confirmed", "financial_account_uid": "01981b15-5979-7abd-b433-a01ba41346f6", "created_at": "2025-07-18T09:10:40+08:00", "updated_at": "2025-07-18T09:10:40+08:00", "payments": [ { "uid": "01981b15-5995-7b20-ba96-60b496031dfe", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-5979-7abd-b433-a01ba41346f6", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:40+08:00", "updated_at": "2025-07-18T09:10:40+08:00", "bank_billet": { "code": "01090115604465016970880192569934728863669809", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-59a4-7d48-a362-95ae2e625393", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-5979-7abd-b433-a01ba41346f6", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:40+08:00", "updated_at": "2025-07-18T09:10:40+08:00", "bank_billet": { "code": "03290115608373524460650952432387416802795819", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-59b4-7b37-8eb6-1b6ad82bb306", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-5979-7abd-b433-a01ba41346f6", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:40+08:00", "updated_at": "2025-07-18T09:10:40+08:00", "bank_billet": { "code": "03290115605385780980066540514977846461198228", "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_entity", "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/darf_batches": { "post": { "summary": "Criar um Lote de Pagamento de DARF", "tags": [ "DARF (beta)" ], "security": [ { "bearerAuth": [] } ], "description": "\nEsse endpoint é utilizado para a geração de um lote de pagamento de DARF.\n\n[block:callout]\n{\n \"type\": \"warning\",\n \"title\": \"⚠️**Novidade em Desenvolvimento!**\",\n \"body\": \"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\\nPara dúvidas sobre esta funcionalidade, entre em contato conosco.\"\n}\n[/block]\n\n## Pré-requisito\n\nPara emitir um pagamento é necessário ter cadastrado uma Conta Financeira.\n\n## Eventos de Webhook\n\nO evento `payment.batch.db.created` é disparado nesta operação.\n\nAo cadastrar um Lote de Pagamento, o sistema cria um comando para registrá-lo na instituição financeira. Após o registro do lote ser confirmado na instituição, o evento `payment.darf_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": "01981b15-5d32-7629-a5e1-668b1bfaa218", "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-5cb9-798f-a607-cb8d028ad40c", "created_at": "2025-07-18T09:10:41+08:00", "updated_at": "2025-07-18T09:10:41+08:00", "payments": [ { "uid": "01981b15-5d30-7dd8-8cc0-99e0c77ebbe2", "amount": 100.4, "scheduled_to": "2025-07-18T09:10:41+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-5cb9-798f-a607-cb8d028ad40c", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:41+08:00", "updated_at": "2025-07-18T09:10:41+08:00", "darf": { "calculation_date": "2023-01-01", "expire_at": "2023-01-31", "reference_number": null, "taxpayer_number": "16.000.630/0000-15", "taxpayer_name": "Teste Darf 1", "tax_code": "6106", "fine_amount": 0.0, "interest_amount": 0.0, "gross_income_amount": 0.0 } }, { "uid": "01981b15-5d31-71ab-91e1-de448bbb9ddf", "amount": 200.5, "scheduled_to": "2025-07-18T09:10:41+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-5cb9-798f-a607-cb8d028ad40c", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": null, "external_id": "26843f45f68d3bc098a89c550a34845847", "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "created_at": "2025-07-18T09:10:41+08:00", "updated_at": "2025-07-18T09:10:41+08:00", "darf": { "calculation_date": "2023-02-01", "expire_at": "2023-02-28", "reference_number": null, "taxpayer_number": "16.000.630/0000-15", "taxpayer_name": "Teste Darf 2", "tax_code": "6106", "fine_amount": 0.0, "interest_amount": 0.0, "gross_income_amount": 0.0 } } ] } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_payment_batch_darf" } } } } } }, "422": { "description": "Erro de validação", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "payments.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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_payment_batch_darf" } } }, "required": true, "description": "Parametros para criação de um Lote de Pagamento de DARF" } } }, "/v2/payment/darfs": { "get": { "summary": "Listar Pagamentos de DARF", "tags": [ "DARF (beta)" ], "security": [ { "bearerAuth": [] } ], "description": "\n[block:callout]\n{\n \"type\": \"warning\",\n \"title\": \"⚠️**Novidade em Desenvolvimento!**\",\n \"body\": \"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\\nPara dúvidas sobre esta funcionalidade, entre em contato conosco.\"\n}\n[/block]\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": "01981b15-61e4-760d-9f09-d4abede8f9c1", "amount": 100.0, "scheduled_to": "2025-07-19T09:10:42+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-61cf-74b8-8a60-7b9ec214e1df", "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:42+08:00", "updated_at": "2025-07-18T09:10:42+08:00", "darf": { "calculation_date": "2025-08-31", "expire_at": "2025-07-21", "reference_number": "1161307", "taxpayer_number": "05.813.794/0001-26", "taxpayer_name": "Kobana Instituição de Pagamento Ltda.", "tax_code": "0107", "fine_amount": 0.0, "interest_amount": 0.0, "gross_income_amount": 0.0 } }, { "uid": "01981b15-6186-79f5-8371-07dd7d887714", "amount": 100.0, "scheduled_to": "2025-07-19T09:10:42+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-6176-72f1-969c-d92dfcb80be0", "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:42+08:00", "updated_at": "2025-07-18T09:10:42+08:00", "darf": { "calculation_date": "2025-08-31", "expire_at": "2025-07-21", "reference_number": "1161307", "taxpayer_number": "05.813.794/0001-26", "taxpayer_name": "Kobana Instituição de Pagamento Ltda.", "tax_code": "0107", "fine_amount": 0.0, "interest_amount": 0.0, "gross_income_amount": 0.0 } }, { "uid": "01981b15-6131-700c-a905-9a48e7a15f70", "amount": 100.0, "scheduled_to": "2025-07-19T09:10:42+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-6121-7bd5-9367-22c7b1cb67e5", "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:42+08:00", "updated_at": "2025-07-18T09:10:42+08:00", "darf": { "calculation_date": "2025-08-31", "expire_at": "2025-07-21", "reference_number": "1161307", "taxpayer_number": "05.813.794/0001-26", "taxpayer_name": "Kobana Instituição de Pagamento Ltda.", "tax_code": "0107", "fine_amount": 0.0, "interest_amount": 0.0, "gross_income_amount": 0.0 } }, { "uid": "01981b15-60e9-723e-9f8e-134c22b0fc0a", "amount": 100.0, "scheduled_to": "2025-07-19T09:10:42+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-60d6-7082-9a9e-d54cc12b3a09", "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:42+08:00", "updated_at": "2025-07-18T09:10:42+08:00", "darf": { "calculation_date": "2025-08-31", "expire_at": "2025-07-21", "reference_number": "1161307", "taxpayer_number": "05.813.794/0001-26", "taxpayer_name": "Kobana Instituição de Pagamento Ltda.", "tax_code": "0107", "fine_amount": 0.0, "interest_amount": 0.0, "gross_income_amount": 0.0 } }, { "uid": "01981b15-60a6-76ed-b50d-bdfd6e50e198", "amount": 100.0, "scheduled_to": "2025-07-19T09:10:42+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-6093-734b-ad03-4631ad61d394", "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:42+08:00", "updated_at": "2025-07-18T09:10:42+08:00", "darf": { "calculation_date": "2025-08-31", "expire_at": "2025-07-21", "reference_number": "1161307", "taxpayer_number": "05.813.794/0001-26", "taxpayer_name": "Kobana Instituição de Pagamento Ltda.", "tax_code": "0107", "fine_amount": 0.0, "interest_amount": 0.0, "gross_income_amount": 0.0 } } ], "pagination": { "prev_url": "/v2/payment/darfs?per_page=5&page=", "next_url": "/v2/payment/darfs?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_darf" } }, "pagination": { "$ref": "#/components/schemas/v2_pagination" } } } } } } } }, "post": { "summary": "Criar um Pagamento de DARF", "tags": [ "DARF (beta)" ], "security": [ { "bearerAuth": [] } ], "description": "\nEsse endpoint é utilizado para a geração de um pagamento de Darf.\n\n[block:callout]\n{\n \"type\": \"warning\",\n \"title\": \"⚠️**Novidade em Desenvolvimento!**\",\n \"body\": \"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\\nPara dúvidas sobre esta funcionalidade, entre em contato conosco.\"\n}\n[/block]\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 criado", "content": { "application/json": { "example": { "status": 201, "data": { "uid": "01981b15-6311-7199-8fd2-f8f85d1c666a", "amount": 100.4, "scheduled_to": "2025-07-18T09:10:43+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-62c3-72c4-b999-d07aaff893b0", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": null, "external_id": "26843f45f68d3bc098a89c550a34845847", "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "created_at": "2025-07-18T09:10:43+08:00", "updated_at": "2025-07-18T09:10:43+08:00", "darf": { "calculation_date": "2023-01-01", "expire_at": "2023-01-31", "reference_number": null, "taxpayer_number": "60.577.154/0000-91", "taxpayer_name": "Teste Darf", "tax_code": "6106", "fine_amount": 0.0, "interest_amount": 0.0, "gross_income_amount": 0.0 } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_payment_darf" } } } } } }, "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "schema": { "$ref": "#/components/schemas/v2_error" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_new_payment_darf" } } }, "required": true, "description": "Parametros para criação de um Pagamento de DARF" } } }, "/v2/payment/darfs/{uid}": { "get": { "summary": "Visualizar um Pagamento de DARF", "tags": [ "DARF (beta)" ], "security": [ { "bearerAuth": [] } ], "description": "\nConsulta informações específicas de um Pagamento de DARF.\n\n[block:callout]\n{\n \"type\": \"warning\",\n \"title\": \"⚠️**Novidade em Desenvolvimento!**\",\n \"body\": \"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\\nPara dúvidas sobre esta funcionalidade, entre em contato conosco.\"\n}\n[/block]\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": "UUID do Pagamento de DARF", "required": true, "example": "018c9160-5c85-725f-b56e-4af36f2564be", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Pagamento encontrado", "content": { "application/json": { "example": { "status": 200, "data": { "uid": "01981b15-6507-71a7-952d-ac27cd1c8904", "amount": 100.0, "scheduled_to": "2025-07-19T09:10:43+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-64f5-7e8c-88aa-bd1db90ef714", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:43+08:00", "updated_at": "2025-07-18T09:10:43+08:00", "darf": { "calculation_date": "2025-08-31", "expire_at": "2025-07-21", "reference_number": "1161307", "taxpayer_number": "05.813.794/0001-26", "taxpayer_name": "Kobana Instituição de Pagamento Ltda.", "tax_code": "0107", "fine_amount": 0.0, "interest_amount": 0.0, "gross_income_amount": 0.0 } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Status HTTP. Ex: `400`." }, "data": { "$ref": "#/components/schemas/v2_payment_darf" } } } } } }, "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_batches": { "post": { "summary": "Criar um Lote de Pagamento Pix", "tags": [ "Pix" ], "security": [ { "bearerAuth": [] } ], "description": "\nEsse endpoint é utilizado para a geração de um lote de pagamento.\n\n## Pré-requisito\n\nPara emitir um pagamento é necessário ter cadastrado um Conta Financeira.\n\n## Eventos de Webhook\n\nO evento `payment.batch.db.created` é disparado nesta operação.\n\nAo cadastrar um Lote de Pagamento, o sistema cria um comando para registrá-lo na instituição financeira. Após o registro do lote ser confirmado na instituição, o evento `payment.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": "01981b15-66c5-710d-b406-d7fd2652e7a6", "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-6654-711f-9249-3398cc4275af", "created_at": "2025-07-18T09:10:44+08:00", "updated_at": "2025-07-18T09:10:44+08:00", "payments": [ { "uid": "01981b15-66c3-76ee-b61a-53d0da1ad69e", "amount": 100.4, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-6654-711f-9249-3398cc4275af", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:44+08:00", "updated_at": "2025-07-18T09:10:44+08:00", "pix": { "qrcode": "00020126330014br.gov.bcb.pix01111335366962052040000530398654040", "beneficiary": { "name": null, "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-66c4-7137-89db-e4e7897c6220", "amount": 100.4, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-6654-711f-9249-3398cc4275af", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": null, "external_id": "26843f45f68d3bc098a89c550a34845847", "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "created_at": "2025-07-18T09:10:44+08:00", "updated_at": "2025-07-18T09:10:44+08:00", "pix": { "qrcode": "00020126330014br.gov.bcb.pix01111335366962052040000530398654040", "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_pix" } } } } } }, "422": { "description": "Erro de validação", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "payments.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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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" ], "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": "01981b15-6b52-7c8d-8479-ebbeae7bb8c1", "amount": 100.0, "scheduled_to": "2025-07-18T09:10:44+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-6b42-78ba-b90c-4d25748cd3c5", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:45+08:00", "updated_at": "2025-07-18T09:10:45+08:00", "pix": { "qrcode": "00020126330014br.gov.bcb.pix01111335366962052040000530398654040", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-6b14-71dd-9662-cd590b6054a8", "amount": 100.0, "scheduled_to": "2025-07-18T09:10:44+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-6b04-79ab-ad99-1d85ba6dce93", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:45+08:00", "updated_at": "2025-07-18T09:10:45+08:00", "pix": { "qrcode": "00020126330014br.gov.bcb.pix01111335366962052040000530398654040", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-6ad4-7381-9bd7-96ede6be0875", "amount": 100.0, "scheduled_to": "2025-07-18T09:10:44+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-6abe-7694-a0f5-463e813298fc", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:45+08:00", "updated_at": "2025-07-18T09:10:45+08:00", "pix": { "qrcode": "00020126330014br.gov.bcb.pix01111335366962052040000530398654040", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-6a8f-7ed1-92c1-5dc3a9a342ee", "amount": 100.0, "scheduled_to": "2025-07-18T09:10:44+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-6a7e-7ea4-b9a6-f8994d5a5f2e", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:45+08:00", "updated_at": "2025-07-18T09:10:45+08:00", "pix": { "qrcode": "00020126330014br.gov.bcb.pix01111335366962052040000530398654040", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-6a4c-7bc6-882b-4709bd7d8add", "amount": 100.0, "scheduled_to": "2025-07-18T09:10:44+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-6a3c-7278-981a-6da8808fc72c", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:45+08:00", "updated_at": "2025-07-18T09:10:45+08:00", "pix": { "qrcode": "00020126330014br.gov.bcb.pix01111335366962052040000530398654040", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } ], "pagination": { "prev_url": "/v2/payment/pix?per_page=5&page=", "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" ], "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 cadastrado uma Conta Financeira.\n\n## Eventos de Webhook\n\nO evento `payment.db.created` é disparado nesta operação.\n\n[block:callout]\n{\n \"type\": \"info\",\n \"body\": \"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`.\",\n \"title\": \"Próximos passos\"\n}\n[/block]", "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": "01981b15-6c76-7318-b2c6-948709404a92", "amount": 100.4, "scheduled_to": "2025-07-18T00:00:00+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-6c29-70c5-9fa4-cdfca82f54d1", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": "SID1234567890", "external_id": "26843f45f68d3bc098a89c550a34845847", "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "created_at": "2025-07-18T09:10:45+08:00", "updated_at": "2025-07-18T09:10:45+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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" ], "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": "01981b15-6e5b-7fc4-b749-91dc8c69465d", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-6e4d-7dc9-a286-84562d8df6ef", "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:46+08:00", "updated_at": "2025-07-18T09:10:46+08: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/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": "01981b15-7297-7b47-b71e-4b346d6bd24b", "amount": 100.0, "scheduled_to": "2025-07-18T09:10:46+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-727a-70ff-9e5a-e30bacebb773", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:47+08:00", "updated_at": "2025-07-18T09:10:47+08:00", "utility": { "code": "00790115602325357030932463962167535923628607", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-7249-74df-9464-81b522c3dab1", "amount": 100.0, "scheduled_to": "2025-07-18T09:10:46+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-7230-72ff-8ee1-e2a449432159", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:47+08:00", "updated_at": "2025-07-18T09:10:47+08:00", "utility": { "code": "04290115604796303670335818942328044430100701", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-7200-753d-a85c-567670a1c344", "amount": 100.0, "scheduled_to": "2025-07-18T09:10:46+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-71ed-71aa-9798-157b21bd192c", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:47+08:00", "updated_at": "2025-07-18T09:10:47+08:00", "utility": { "code": "01090115606493737580690461282041646974484793", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-71bd-748b-b5fc-56c3e01d7b79", "amount": 100.0, "scheduled_to": "2025-07-18T09:10:46+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-71a8-7b40-80c6-c91c02c0c0b1", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:46+08:00", "updated_at": "2025-07-18T09:10:46+08:00", "utility": { "code": "03590115603533876360745955264846682881880280", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-7172-77f7-b4f0-2b6c0d0942db", "amount": 100.0, "scheduled_to": "2025-07-18T09:10:46+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-7157-7bbc-9f42-ed87cc6008a1", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "view", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:46+08:00", "updated_at": "2025-07-18T09:10:46+08:00", "utility": { "code": "09390115600649605660084517088276878389714492", "beneficiary": { "name": "Margret Santos LTDA", "document_number": "34.414.342/0000-99" } } } ], "pagination": { "prev_url": "/v2/payment/utilities?per_page=5&page=", "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 cadastrado uma Conta Financeira.\n\n## Eventos de Webhook\n\nO evento `payment.db.created` é disparado nesta operação.\n\n[block:callout]\n{\n \"type\": \"info\",\n \"body\": \"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`.\",\n \"title\": \"Próximos passos\"\n}\n[/block]", "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": "01981b15-73ce-75cd-b737-96f75d50d1b7", "amount": 100.4, "scheduled_to": "2025-07-18T00:00:00+08:00", "status": "scheduled", "registration_status": "pending", "financial_account_uid": "01981b15-737e-7a40-ac59-065e9c625e31", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": null, "external_id": "26843f45f68d3bc098a89c550a34845846", "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "created_at": "2025-07-18T09:10:47+08:00", "updated_at": "2025-07-18T09:10:47+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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": "01981b15-75c6-7733-a9e7-5b78cf0ac25f", "amount": 100.0, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-75af-75ae-bd4e-cff82057dedc", "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, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:48+08:00", "updated_at": "2025-07-18T09:10:48+08:00", "utility": { "code": "05390115602542946210168292581159448964486650", "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/utility_batches": { "post": { "summary": "Criar um Lote de Pagamento de Contas de Consumo", "tags": [ "Contas de Consumo" ], "security": [ { "bearerAuth": [] } ], "description": "\nEsse endpoint é utilizado para a geração de um lote de pagamento.\n\n## Pré-requisito\n\nPara emitir um pagamento é necessário ter cadastrado um Conta Financeira.\n\n## Eventos de Webhook\n\nO evento `payment.batch.db.created` é disparado nesta operação.\n\nAo cadastrar um Lote de Pagamento, o sistema cria um comando para registrá-lo na instituição financeira. Após o registro do lote ser confirmado na instituição, o evento `payment.utility_batch.confirmed` é disparado.\n\nO evento `payment.db.created` também é disparado nesta operação caso o lote contenha um novo pagamento.", "parameters": [ { "name": "User-Agent", "in": "header", "required": false, "description": "Informar um e-mail válido para contatos.", "example": "Kevin Mitnick ", "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": "01981b15-774a-7c12-b3e3-71e8fdf35049", "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-76ed-7343-b17f-2334403aa5f2", "created_at": "2025-07-18T09:10:48+08:00", "updated_at": "2025-07-18T09:10:48+08:00", "payments": [ { "uid": "01981b15-7748-7fd4-b450-f67c4d9f518d", "amount": 100.4, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-76ed-7343-b17f-2334403aa5f2", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": null, "external_id": null, "custom_data": null, "tags": [], "tag_list": null, "created_at": "2025-07-18T09:10:48+08:00", "updated_at": "2025-07-18T09:10:48+08:00", "utility": { "code": "00196994400000100040000003128557120985944917", "beneficiary": { "name": null, "document_number": "34.414.342/0000-99" } } }, { "uid": "01981b15-7749-7644-81c8-246cd4dbaf5d", "amount": 100.4, "scheduled_to": null, "status": "pending", "registration_status": "pending", "financial_account_uid": "01981b15-76ed-7343-b17f-2334403aa5f2", "confirmed_at": null, "rejected_error": null, "rejected_at": null, "transaction_code": null, "transaction_date": null, "source": "api", "identifier": null, "external_id": "26843f45f68d3bc098a89c550a34845847", "custom_data": { "foo": "bar", "spam": "eggs" }, "tags": [ "tag1", "tag2" ], "tag_list": "tag1,tag2", "created_at": "2025-07-18T09:10:48+08:00", "updated_at": "2025-07-18T09:10:48+08: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", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "payments.payable.code", "detail": "Payments payable code precisa conter 44, 47 ou 48 caracteres numéricos" }, { "code": "validation_error", "param": "payments.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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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/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": "01981b14-b255-777b-9a18-90855ea5a577", "line": "75691.43279 01022.938508 07722.200016 1 99470000000200", "barcode": "75691994700000002001432701022938500772220001", "expire_at": "2024-12-31", "amount": 2.0, "minimum_amount": 2.0, "maximum_amount": 2.0, "original_amount": 2.0, "beneficiary": { "name": "KOBANA INSTITUICAO DE PAGAMENTO LTDA", "kind": "juridical", "document_type": "CNPJ", "document_number": "05.813.794/0001-26" }, "guarantor": null, "payer": { "name": "KIVANIO PEREIRA BARBOSA", "kind": "natural", "document_type": "CPF", "document_number": "000.233.771-19" }, "fine": { "value": 0 }, "interest": { "value": 0 }, "discount": { "value": 0 }, "status": "success", "tags": [ "tag1", "tag2" ], "custom_data": { "key1": "value1", "key2": "value2" }, "created_via_api": true, "external_id": "DH2YG348T7953T", "error_message": null, "processed_at": "2025-07-18T09:09:58+08:00", "created_at": "2025-07-18T09:09:57+08:00", "updated_at": "2025-07-18T09:09:57+08: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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": "01981b14-b5d9-7e65-bc74-f1c1a7516fe9", "line": "75691.43279 01022.938508 07722.200016 1 99470000000200", "barcode": "75691994700000002001432701022938500772220001", "expire_at": null, "amount": null, "minimum_amount": null, "maximum_amount": null, "original_amount": null, "beneficiary": null, "guarantor": 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": "2025-07-18T09:09:58+08:00", "created_at": "2025-07-18T09:09:58+08:00", "updated_at": "2025-07-18T09:09:58+08:00" }, { "uid": "01981b14-b5d3-7149-bc53-b44afeddf7b6", "line": "75691.43279 01022.938508 07722.200016 1 99470000000200", "barcode": "75691994700000002001432701022938500772220001", "expire_at": null, "amount": null, "minimum_amount": null, "maximum_amount": null, "original_amount": null, "beneficiary": null, "guarantor": 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": "2025-07-18T09:09:58+08:00", "updated_at": "2025-07-18T09:09:58+08:00" }, { "uid": "01981b14-b5c4-7207-9c3b-d9f360b4a1f8", "line": "75691.43279 01022.938508 07722.200016 1 99470000000200", "barcode": "75691994700000002001432701022938500772220001", "expire_at": "2023-12-31", "amount": 20.0, "minimum_amount": 15.0, "maximum_amount": 25.0, "original_amount": 20.0, "beneficiary": { "name": "Beneficiário", "kind": "juridical", "document_type": "CNPJ", "document_number": "37.006.044/7078-01" }, "guarantor": { "name": "Beneficiário Final", "kind": "juridical", "document_type": "CNPJ", "document_number": "66.267.634/0290-14" }, "payer": { "name": "Pagador", "kind": "juridical", "document_type": "CNPJ", "document_number": "86.271.587/7348-26" }, "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": "2025-07-18T09:09:58+08:00", "created_at": "2025-07-18T09:09:58+08:00", "updated_at": "2025-07-18T09:09:58+08:00" } ], "pagination": { "prev_url": "/v2/data/bank_billet_queries?page=&per_page=50", "next_url": "/v2/data/bank_billet_queries?page=&per_page=50", "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": "01981b14-f412-7ebc-a0cb-4ac9384c0453", "name": "EDI Name 10", "resource": { "type": "financial.account", "uid": "01981b14-f3fa-77f3-b518-7f34b2b0437a" }, "account_owner": { "name": "Margret Santos Filgueiras", "kind": "natural", "document_type": "CPF", "document_number": "525.383.180-09", "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": "benton_hayes@feeney-corkery.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "external_code": "000001", "tags": [ "corrupti", "et", "atque" ], "tag_list": "corrupti,et,atque", "custom_data": { "numero_erp": 63126 } }, "letter_owner": null, "bank_manager": { "name": "Margret Santos Filgueiras", "kind": "natural", "document_type": "CPF", "document_number": "676.343.326-31", "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": "rickie.aufderhar@jerde.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "external_code": "000001", "tags": [ "non", "molestias", "consequatur" ], "tag_list": "non,molestias,consequatur", "custom_data": { "numero_erp": 63126 } }, "kind": "cnab400", "operation": "payment", "created_at": "2025-07-18T09:10:14+08:00", "updated_at": "2025-07-18T09:10:14+08:00", "validated_at": null, "enabled_at": null, "letter_status": "creating", "status": null, "letter_pdf": null }, { "uid": "01981b14-f3b2-74b2-8fd4-5b9c79da21d7", "name": "EDI Name 5", "resource": { "type": "charge.bank_billet_account", "uid": "01981b14-f38e-7b2f-a97b-8dfefe59ac5d" }, "account_owner": { "name": "Margret Santos Filgueiras", "kind": "natural", "document_type": "CPF", "document_number": "979.874.364-45", "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": "jules@kerluke.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "external_code": "000001", "tags": [ "nemo", "ullam", "perferendis" ], "tag_list": "nemo,ullam,perferendis", "custom_data": { "numero_erp": 63126 } }, "letter_owner": null, "bank_manager": { "name": "Margret Santos Filgueiras", "kind": "natural", "document_type": "CPF", "document_number": "361.670.747-12", "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": "donella@doyle-conroy.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "external_code": "000001", "tags": [ "ipsum", "magnam", "et" ], "tag_list": "ipsum,magnam,et", "custom_data": { "numero_erp": 63126 } }, "kind": "cnab400", "operation": "charge", "created_at": "2025-07-18T09:10:14+08:00", "updated_at": "2025-07-18T09:10:14+08:00", "validated_at": null, "enabled_at": null, "letter_status": "creating", "status": null, "letter_pdf": null } ], "pagination": { "prev_url": "/v2/edi/edi_boxes?per_page=2&page=", "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": "01981b14-f6d6-7c6b-abe2-a22208047cec", "name": null, "resource": { "type": "charge.bank_billet_account", "uid": "01981b14-f64c-751f-b941-fae532cd8841" }, "account_owner": { "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": { "name": "Margret Santos Cartas", "emails": [ { "label": "Pessoal", "address": "nome@example.com" } ], "phones": [ { "kind": null, "country_code": "55", "local_code": "21", "number": "30030386" } ] }, "bank_manager": { "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": "2025-07-18T09:10:15+08:00", "updated_at": "2025-07-18T09:10:15+08:00", "validated_at": null, "enabled_at": null, "letter_status": "creating", "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": "01981b14-fa3c-7431-8198-1ffb951acbde", "name": "EDI Name 88", "resource": { "type": "charge.bank_billet_account", "uid": "01981b14-fa17-723d-8e54-72b2893b03df" }, "account_owner": { "name": "Margret Santos Filgueiras", "kind": "natural", "document_type": "CPF", "document_number": "588.053.335-22", "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": "rex@powlowski.test" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "external_code": "000001", "tags": [ "qui", "excepturi", "deleniti" ], "tag_list": "qui,excepturi,deleniti", "custom_data": { "numero_erp": 63126 } }, "letter_owner": null, "bank_manager": { "name": "Margret Santos Filgueiras", "kind": "natural", "document_type": "CPF", "document_number": "620.526.079-43", "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": "duncan@heaney.example" } ], "phones": [ { "kind": "landline", "country_code": "55", "local_code": "21", "number": "30030386" } ], "external_code": "000001", "tags": [ "illum", "sit", "sapiente" ], "tag_list": "illum,sit,sapiente", "custom_data": { "numero_erp": 63126 } }, "kind": "cnab400", "operation": "charge", "created_at": "2025-07-18T09:10:16+08:00", "updated_at": "2025-07-18T09:10:16+08:00", "validated_at": null, "enabled_at": null, "letter_status": "creating", "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 do scope \"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": "01981b14-fc78-7e24-b647-5670b2efca65", "name": "EDI Name 64", "resource": { "type": "charge.bank_billet_account", "uid": "01981b14-fc46-70b9-b508-2136a09d9607" }, "account_owner": { "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": { "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": { "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": "2025-07-18T09:10:16+08:00", "updated_at": "2025-07-18T09:10:17+08:00", "validated_at": null, "enabled_at": null, "letter_status": "creating", "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://developers.kobana.com.br/reference/token-de-acesso" } ] }, "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 do scope \"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": "Falha na validação", "content": { "application/json": { "example": { "status": 422, "errors": [ { "code": "validation_error", "param": "resource", "detail": "Recurso Associado é obrigatório(a)" }, { "code": "validation_error", "param": "account_owner", "detail": "Proprietário da conta > Nome não pode ficar em branco" }, { "code": "validation_error", "param": "bank_manager", "detail": "Gerente do banco > Nome 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 atualizada." } } } }, "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_entity`." }, "detail": { "type": "string", "description": "Descrição do erro em detalhe. Ex: `\"O Token de API é diferente para cada Servidor/URL, mais em https://developers.kobana.com.br/reference/token-de-acesso\"`." } } } } } }, "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." } } }, "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": 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": "Anotaçõ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 ], "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_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." }, "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": "Anotaçõ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`: Não se aplica\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 }, "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": 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": "Anotaçõ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": "Anotaçõ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_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": "Anotaçõ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 ], "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`: Não se aplica\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": 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": "Anotaçõ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": 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": "Anotaçõ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": "Anotaçõ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": "Anotaçõ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": 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": "Anotaçõ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": "Anotaçõ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, "description": "Dígito da Agência. Dependendo da carteira escolhida poderá ser obrigátorio." }, "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", "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." }, "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": 0, "description": "Quem irá gerenciar o pix\n * 1 - Kobana\n * 2 - Banco\n * 3 - Desabilitado" }, "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." }, "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, "description": "Agência.\n A alteração da agência, somente é permitida enquanto a carteira não estiver homologada." }, "agency_digit": { "type": "string", "maxLength": 2, "description": "Dígito da Agência.\n A alteração do dígito da agência, somente é permitida enquanto a carteira não estiver homologada." }, "account_number": { "type": "string", "maxLength": 20, "description": "Número da Conta.\n A alteração do número da conta, somente é permitida enquanto a carteira não estiver homologada." }, "account_digit": { "type": "string", "maxLength": 2, "description": "Dígito da Conta.\n A alteração do dígito da conta, somente é permitida enquanto a carteira não estiver homologada." }, "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", "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, "description": "Habilitar Bolepix" }, "bolepix": { "type": "object", "nullable": true, "description": "Configuração de Boleto Híbrido", "properties": { "pix_mode": { "type": "integer", "nullable": true, "example": 0, "description": "Quem irá gerenciar o pix\n * 1 - Kobana\n * 2 - Banco" }, "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", "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, "description": "Dígito da Agência. Dependendo da carteira escolhida poderá ser obrigátorio." }, "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", "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." }, "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": 0, "description": "Quem irá gerenciar o pix\n * 1 - Kobana\n * 2 - Banco\n 3 - Desabilitado" }, "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* `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.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_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* `statement_transaction.db.created` Linha de Extrato criada.\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* `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.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.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.ted_batch.awaiting_approval` Lote de Transferência TED aguardando liberação.\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.internal_batch.awaiting_approval` Lote de Transferência Entre Contas aguardando liberação.\n* `transfer.internal_batch.register.requested` Lote de Transferência Entre Contas solicitado.\n* `transfer.internal_batch.register.confirmed` Lote de Transferência Entre Contas confirmado.\n* `transfer.internal_batch.register.failed` Falha no envio de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.register.error` Ocorreu um erro no envio de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.approve.requested` Liberação de Lote de Transferência Entre Contas solicitada.\n* `transfer.internal_batch.approve.confirmed` Liberação de Lote de Transferência Entre Contas confirmada.\n* `transfer.internal_batch.approve.failed` Falha na liberação de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.reprove.requested` Rejeição de Lote de Transferência Entre Contas solicitada.\n* `transfer.internal_batch.reprove.confirmed` Rejeição de Lote de transferência Entre Contas confirmada.\n* `transfer.internal_batch.reprove.failed` Falha na rejeição de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência Entre Contas.\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.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.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.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.internal.register.requested` Transferência Entre Contas solicitada.\n* `transfer.internal.register.confirmed` Transferência Entre Contas confirmada.\n* `transfer.internal.register.failed` Falha no envio da Transferência Entre Contas.\n* `transfer.internal.register.error` Ocorreu um erro no envio da Transferência Entre Contas.\n* `transfer.internal.reschedule.requested` Reagendamento de Transferência Entre Contas solicitado.\n* `transfer.internal.reschedule.confirmed` Reagendamento de Transferência Entre Contas confirmado.\n* `transfer.internal.reschedule.failed` Falha no Reagendamento de Transferência Entre Contas.\n* `transfer.internal.reschedule.error` Ocorreu um erro no Reagendamento de Transferência Entre Contas.\n* `transfer.internal.approve.requested` Liberação de Transferência Entre Contas solicitada.\n* `transfer.internal.approve.confirmed` Liberação de Transferência Entre Contas confirmada.\n* `transfer.internal.approve.failed` Falha na liberação da transferência Entre Contas.\n* `transfer.internal.approve.error` Ocorreu um erro na liberação da Transferência Entre Contas.\n* `transfer.internal.cancel.requested` Cancelamento de Transferência Entre Contas solicitado.\n* `transfer.internal.cancel.confirmed` Cancelamento de Transferência Entre Contas confirmado.\n* `transfer.internal.cancel.failed` Falha no cancelamento de Transferência Entre Contas.\n* `transfer.internal.cancel.error` Ocorreu um erro no cancelamento de Transferência Entre Contas.\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.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.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.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.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.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.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.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.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.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.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.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.darf_batch.awaiting_approval` Lote de Pagamento de DARF aguardando liberação.\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.utility_batch.awaiting_approval` Lote de Pagamento de Conta de Consumo aguardando liberação.\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.gru_batch.awaiting_approval` Lote de Pagamento de GRU aguardando liberação.\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.pix_batch.awaiting_approval` Lote de Pagamento de Pix aguardando liberação.\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.dda.account.db.created` Conta DDA criada\n* `payment.dda.account.register.requested` Conta 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 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 Boletoe.\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.bank_billet.db.created` Boleto DDA criado\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* `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.payment.db.created` Pagamento de cobrança criado.\n* `charge.payment.db.updated` Pagamento de cobrança atualizado.\n* `charge.payment.db.deleted` Pagamento de cobrança excluído.\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* `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* `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* `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.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_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* `statement_transaction.db.created` Linha de Extrato criada.\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* `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.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.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.ted_batch.awaiting_approval` Lote de Transferência TED aguardando liberação.\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.internal_batch.awaiting_approval` Lote de Transferência Entre Contas aguardando liberação.\n* `transfer.internal_batch.register.requested` Lote de Transferência Entre Contas solicitado.\n* `transfer.internal_batch.register.confirmed` Lote de Transferência Entre Contas confirmado.\n* `transfer.internal_batch.register.failed` Falha no envio de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.register.error` Ocorreu um erro no envio de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.approve.requested` Liberação de Lote de Transferência Entre Contas solicitada.\n* `transfer.internal_batch.approve.confirmed` Liberação de Lote de Transferência Entre Contas confirmada.\n* `transfer.internal_batch.approve.failed` Falha na liberação de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.reprove.requested` Rejeição de Lote de Transferência Entre Contas solicitada.\n* `transfer.internal_batch.reprove.confirmed` Rejeição de Lote de transferência Entre Contas confirmada.\n* `transfer.internal_batch.reprove.failed` Falha na rejeição de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência Entre Contas.\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.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.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.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.internal.register.requested` Transferência Entre Contas solicitada.\n* `transfer.internal.register.confirmed` Transferência Entre Contas confirmada.\n* `transfer.internal.register.failed` Falha no envio da Transferência Entre Contas.\n* `transfer.internal.register.error` Ocorreu um erro no envio da Transferência Entre Contas.\n* `transfer.internal.reschedule.requested` Reagendamento de Transferência Entre Contas solicitado.\n* `transfer.internal.reschedule.confirmed` Reagendamento de Transferência Entre Contas confirmado.\n* `transfer.internal.reschedule.failed` Falha no Reagendamento de Transferência Entre Contas.\n* `transfer.internal.reschedule.error` Ocorreu um erro no Reagendamento de Transferência Entre Contas.\n* `transfer.internal.approve.requested` Liberação de Transferência Entre Contas solicitada.\n* `transfer.internal.approve.confirmed` Liberação de Transferência Entre Contas confirmada.\n* `transfer.internal.approve.failed` Falha na liberação da transferência Entre Contas.\n* `transfer.internal.approve.error` Ocorreu um erro na liberação da Transferência Entre Contas.\n* `transfer.internal.cancel.requested` Cancelamento de Transferência Entre Contas solicitado.\n* `transfer.internal.cancel.confirmed` Cancelamento de Transferência Entre Contas confirmado.\n* `transfer.internal.cancel.failed` Falha no cancelamento de Transferência Entre Contas.\n* `transfer.internal.cancel.error` Ocorreu um erro no cancelamento de Transferência Entre Contas.\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.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.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.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.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.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.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.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.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.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.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.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.darf_batch.awaiting_approval` Lote de Pagamento de DARF aguardando liberação.\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.utility_batch.awaiting_approval` Lote de Pagamento de Conta de Consumo aguardando liberação.\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.gru_batch.awaiting_approval` Lote de Pagamento de GRU aguardando liberação.\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.pix_batch.awaiting_approval` Lote de Pagamento de Pix aguardando liberação.\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.dda.account.db.created` Conta DDA criada\n* `payment.dda.account.register.requested` Conta 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 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 Boletoe.\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.bank_billet.db.created` Boleto DDA criado\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* `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.payment.db.created` Pagamento de cobrança criado.\n* `charge.payment.db.updated` Pagamento de cobrança atualizado.\n* `charge.payment.db.deleted` Pagamento de cobrança excluído.\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* `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* `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* `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.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_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* `statement_transaction.db.created` Linha de Extrato criada.\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* `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.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.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.ted_batch.awaiting_approval` Lote de Transferência TED aguardando liberação.\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.internal_batch.awaiting_approval` Lote de Transferência Entre Contas aguardando liberação.\n* `transfer.internal_batch.register.requested` Lote de Transferência Entre Contas solicitado.\n* `transfer.internal_batch.register.confirmed` Lote de Transferência Entre Contas confirmado.\n* `transfer.internal_batch.register.failed` Falha no envio de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.register.error` Ocorreu um erro no envio de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.approve.requested` Liberação de Lote de Transferência Entre Contas solicitada.\n* `transfer.internal_batch.approve.confirmed` Liberação de Lote de Transferência Entre Contas confirmada.\n* `transfer.internal_batch.approve.failed` Falha na liberação de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.reprove.requested` Rejeição de Lote de Transferência Entre Contas solicitada.\n* `transfer.internal_batch.reprove.confirmed` Rejeição de Lote de transferência Entre Contas confirmada.\n* `transfer.internal_batch.reprove.failed` Falha na rejeição de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência Entre Contas.\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.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.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.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.internal.register.requested` Transferência Entre Contas solicitada.\n* `transfer.internal.register.confirmed` Transferência Entre Contas confirmada.\n* `transfer.internal.register.failed` Falha no envio da Transferência Entre Contas.\n* `transfer.internal.register.error` Ocorreu um erro no envio da Transferência Entre Contas.\n* `transfer.internal.reschedule.requested` Reagendamento de Transferência Entre Contas solicitado.\n* `transfer.internal.reschedule.confirmed` Reagendamento de Transferência Entre Contas confirmado.\n* `transfer.internal.reschedule.failed` Falha no Reagendamento de Transferência Entre Contas.\n* `transfer.internal.reschedule.error` Ocorreu um erro no Reagendamento de Transferência Entre Contas.\n* `transfer.internal.approve.requested` Liberação de Transferência Entre Contas solicitada.\n* `transfer.internal.approve.confirmed` Liberação de Transferência Entre Contas confirmada.\n* `transfer.internal.approve.failed` Falha na liberação da transferência Entre Contas.\n* `transfer.internal.approve.error` Ocorreu um erro na liberação da Transferência Entre Contas.\n* `transfer.internal.cancel.requested` Cancelamento de Transferência Entre Contas solicitado.\n* `transfer.internal.cancel.confirmed` Cancelamento de Transferência Entre Contas confirmado.\n* `transfer.internal.cancel.failed` Falha no cancelamento de Transferência Entre Contas.\n* `transfer.internal.cancel.error` Ocorreu um erro no cancelamento de Transferência Entre Contas.\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.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.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.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.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.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.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.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.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.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.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.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.darf_batch.awaiting_approval` Lote de Pagamento de DARF aguardando liberação.\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.utility_batch.awaiting_approval` Lote de Pagamento de Conta de Consumo aguardando liberação.\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.gru_batch.awaiting_approval` Lote de Pagamento de GRU aguardando liberação.\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.pix_batch.awaiting_approval` Lote de Pagamento de Pix aguardando liberação.\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.dda.account.db.created` Conta DDA criada\n* `payment.dda.account.register.requested` Conta 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 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 Boletoe.\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.bank_billet.db.created` Boleto DDA criado\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* `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.payment.db.created` Pagamento de cobrança criado.\n* `charge.payment.db.updated` Pagamento de cobrança atualizado.\n* `charge.payment.db.deleted` Pagamento de cobrança excluído.\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* `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* `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* `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.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_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* `statement_transaction.db.created` Linha de Extrato criada.\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* `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.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.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.ted_batch.awaiting_approval` Lote de Transferência TED aguardando liberação.\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.internal_batch.awaiting_approval` Lote de Transferência Entre Contas aguardando liberação.\n* `transfer.internal_batch.register.requested` Lote de Transferência Entre Contas solicitado.\n* `transfer.internal_batch.register.confirmed` Lote de Transferência Entre Contas confirmado.\n* `transfer.internal_batch.register.failed` Falha no envio de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.register.error` Ocorreu um erro no envio de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.approve.requested` Liberação de Lote de Transferência Entre Contas solicitada.\n* `transfer.internal_batch.approve.confirmed` Liberação de Lote de Transferência Entre Contas confirmada.\n* `transfer.internal_batch.approve.failed` Falha na liberação de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.reprove.requested` Rejeição de Lote de Transferência Entre Contas solicitada.\n* `transfer.internal_batch.reprove.confirmed` Rejeição de Lote de transferência Entre Contas confirmada.\n* `transfer.internal_batch.reprove.failed` Falha na rejeição de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência Entre Contas.\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.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.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.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.internal.register.requested` Transferência Entre Contas solicitada.\n* `transfer.internal.register.confirmed` Transferência Entre Contas confirmada.\n* `transfer.internal.register.failed` Falha no envio da Transferência Entre Contas.\n* `transfer.internal.register.error` Ocorreu um erro no envio da Transferência Entre Contas.\n* `transfer.internal.reschedule.requested` Reagendamento de Transferência Entre Contas solicitado.\n* `transfer.internal.reschedule.confirmed` Reagendamento de Transferência Entre Contas confirmado.\n* `transfer.internal.reschedule.failed` Falha no Reagendamento de Transferência Entre Contas.\n* `transfer.internal.reschedule.error` Ocorreu um erro no Reagendamento de Transferência Entre Contas.\n* `transfer.internal.approve.requested` Liberação de Transferência Entre Contas solicitada.\n* `transfer.internal.approve.confirmed` Liberação de Transferência Entre Contas confirmada.\n* `transfer.internal.approve.failed` Falha na liberação da transferência Entre Contas.\n* `transfer.internal.approve.error` Ocorreu um erro na liberação da Transferência Entre Contas.\n* `transfer.internal.cancel.requested` Cancelamento de Transferência Entre Contas solicitado.\n* `transfer.internal.cancel.confirmed` Cancelamento de Transferência Entre Contas confirmado.\n* `transfer.internal.cancel.failed` Falha no cancelamento de Transferência Entre Contas.\n* `transfer.internal.cancel.error` Ocorreu um erro no cancelamento de Transferência Entre Contas.\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.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.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.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.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.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.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.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.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.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.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.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.darf_batch.awaiting_approval` Lote de Pagamento de DARF aguardando liberação.\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.utility_batch.awaiting_approval` Lote de Pagamento de Conta de Consumo aguardando liberação.\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.gru_batch.awaiting_approval` Lote de Pagamento de GRU aguardando liberação.\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.pix_batch.awaiting_approval` Lote de Pagamento de Pix aguardando liberação.\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.dda.account.db.created` Conta DDA criada\n* `payment.dda.account.register.requested` Conta 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 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 Boletoe.\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.bank_billet.db.created` Boleto DDA criado\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* `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.payment.db.created` Pagamento de cobrança criado.\n* `charge.payment.db.updated` Pagamento de cobrança atualizado.\n* `charge.payment.db.deleted` Pagamento de cobrança excluído.\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* `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* `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* `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.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_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* `statement_transaction.db.created` Linha de Extrato criada.\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* `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.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.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.ted_batch.awaiting_approval` Lote de Transferência TED aguardando liberação.\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.internal_batch.awaiting_approval` Lote de Transferência Entre Contas aguardando liberação.\n* `transfer.internal_batch.register.requested` Lote de Transferência Entre Contas solicitado.\n* `transfer.internal_batch.register.confirmed` Lote de Transferência Entre Contas confirmado.\n* `transfer.internal_batch.register.failed` Falha no envio de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.register.error` Ocorreu um erro no envio de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.approve.requested` Liberação de Lote de Transferência Entre Contas solicitada.\n* `transfer.internal_batch.approve.confirmed` Liberação de Lote de Transferência Entre Contas confirmada.\n* `transfer.internal_batch.approve.failed` Falha na liberação de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.reprove.requested` Rejeição de Lote de Transferência Entre Contas solicitada.\n* `transfer.internal_batch.reprove.confirmed` Rejeição de Lote de transferência Entre Contas confirmada.\n* `transfer.internal_batch.reprove.failed` Falha na rejeição de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência Entre Contas.\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.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.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.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.internal.register.requested` Transferência Entre Contas solicitada.\n* `transfer.internal.register.confirmed` Transferência Entre Contas confirmada.\n* `transfer.internal.register.failed` Falha no envio da Transferência Entre Contas.\n* `transfer.internal.register.error` Ocorreu um erro no envio da Transferência Entre Contas.\n* `transfer.internal.reschedule.requested` Reagendamento de Transferência Entre Contas solicitado.\n* `transfer.internal.reschedule.confirmed` Reagendamento de Transferência Entre Contas confirmado.\n* `transfer.internal.reschedule.failed` Falha no Reagendamento de Transferência Entre Contas.\n* `transfer.internal.reschedule.error` Ocorreu um erro no Reagendamento de Transferência Entre Contas.\n* `transfer.internal.approve.requested` Liberação de Transferência Entre Contas solicitada.\n* `transfer.internal.approve.confirmed` Liberação de Transferência Entre Contas confirmada.\n* `transfer.internal.approve.failed` Falha na liberação da transferência Entre Contas.\n* `transfer.internal.approve.error` Ocorreu um erro na liberação da Transferência Entre Contas.\n* `transfer.internal.cancel.requested` Cancelamento de Transferência Entre Contas solicitado.\n* `transfer.internal.cancel.confirmed` Cancelamento de Transferência Entre Contas confirmado.\n* `transfer.internal.cancel.failed` Falha no cancelamento de Transferência Entre Contas.\n* `transfer.internal.cancel.error` Ocorreu um erro no cancelamento de Transferência Entre Contas.\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.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.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.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.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.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.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.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.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.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.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.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.darf_batch.awaiting_approval` Lote de Pagamento de DARF aguardando liberação.\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.utility_batch.awaiting_approval` Lote de Pagamento de Conta de Consumo aguardando liberação.\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.gru_batch.awaiting_approval` Lote de Pagamento de GRU aguardando liberação.\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.pix_batch.awaiting_approval` Lote de Pagamento de Pix aguardando liberação.\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.dda.account.db.created` Conta DDA criada\n* `payment.dda.account.register.requested` Conta 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 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 Boletoe.\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.bank_billet.db.created` Boleto DDA criado\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* `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.payment.db.created` Pagamento de cobrança criado.\n* `charge.payment.db.updated` Pagamento de cobrança atualizado.\n* `charge.payment.db.deleted` Pagamento de cobrança excluído.\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* `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* `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", "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.add_pix.requested", "bank_billet.add_pix.confirmed", "bank_billet.add_pix.failed", "bank_billet.add_pix.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", "statement_transaction.db.created", "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", "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.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.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.ted_batch.awaiting_approval", "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.internal_batch.awaiting_approval", "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.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.cancel.requested", "transfer.pix.cancel.confirmed", "transfer.pix.cancel.failed", "transfer.pix.cancel.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.cancel.requested", "transfer.ted.cancel.confirmed", "transfer.ted.cancel.failed", "transfer.ted.cancel.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.cancel.requested", "transfer.internal.cancel.confirmed", "transfer.internal.cancel.failed", "transfer.internal.cancel.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.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.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.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.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.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.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.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.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.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.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.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.darf_batch.awaiting_approval", "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.utility_batch.awaiting_approval", "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.gru_batch.awaiting_approval", "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.pix_batch.awaiting_approval", "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.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.bank_billet.db.created", "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", "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.payment.db.created", "charge.payment.db.updated", "charge.payment.db.deleted", "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", "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", "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 }, "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" } } }, "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 } } }, "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" } } } }, "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" } } } }, "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." }, "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", "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: `validation_error`." }, "param": { "type": "string", "description": "Nome do parâmetro que falhou a validação. Ex: `amount`." }, "detail": { "type": "string", "description": "Detalhe da validação que gerou o erro. Ex: `não pode ficar em branco`." } } } } } }, "v2_pagination": { "type": "object", "properties": { "prev_url": { "type": "string", "description": "URL da página anterior." }, "next_url": { "type": "string", "description": "URL da próxima página." }, "page": { "type": "integer", "description": "Número da página atual." } } }, "v2_pix_command": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Comando." }, "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" }, "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." }, "pix": { "$ref": "#/components/schemas/v2_pix" } } }, "v2_pix": { "type": "object", "required": [ "amount", "pix_account_uid", "expire_at" ], "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID do Pix" }, "amount": { "type": "number", "format": "float", "description": "Quantia", "example": 120.99 }, "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" }, "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", "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" }, "pix_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Pix", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "txid": { "type": "string", "nullable": true, "description": "TXID do Pix" }, "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" } }, "qrcode": { "type": "object", "description": "QR Code do Pix", "readOnly": true, "properties": { "emv": { "type": "string", "nullable": true, "description": "QR Code no formato EMV.", "readOnly": true }, "png": { "type": "string", "nullable": true, "description": "QR Code no format PNG em base64.", "readOnly": true } } }, "registration_kind": { "type": "string", "writeOnly": true, "description": "Tipo do Pix.\n\n `instant`: Imediato (default)\n `billing`: Cobrança\n" }, "kind": { "type": "string", "readOnly": true, "description": "Tipo do Pix.\n\n`instant`: Imediato (default)\n`billing`: Cobrança\n" }, "command_ids": { "type": "array", "readOnly": true, "items": { "type": "integer", "description": "IDs dos registros de Comandos do Pix" } }, "end_to_end_id": { "type": "string", "nullable": true, "readOnly": true, "description": "End To End Id do Pix" }, "custom_data": { "type": "object", "nullable": true, "example": "{\"codigo\": \"123\", \"vip\": true}", "description": "Hash com chave e valor no formato JSON." }, "virtual_pix_id": { "type": "integer", "readOnly": true, "format": "int32", "nullable": true, "description": "ID do Pix gerado por membro BackOffice. (BackOffice precisa estar habilitado).", "example": null }, "fine_type": { "type": "integer", "nullable": true, "description": "Tipo do Multa:\n * `0` Sem multa (isento)\n * `1` Por valor\n * `2` Por porcentagem", "enum": [ 0, 1, 2 ], "default": 0 }, "fine_amount": { "type": "string", "nullable": true, "example": "50.00", "description": "Valor da Multa" }, "fine_percentage": { "type": "string", "nullable": true, "example": "5", "description": "Percentual da Multa" }, "reduction_type": { "type": "integer", "nullable": true, "description": "Tipo de Abatimento:\n * `0` Não se aplica\n * `1` Por valor\n * `2` Por porcentagem", "enum": [ 0, 1, 2 ], "default": 0 }, "reduction_amount": { "type": "string", "nullable": true, "example": "25.00", "description": "Valor do Abatimento" }, "reduction_percentage": { "type": "string", "nullable": true, "example": "2.5", "description": "Percentual do Abatimento" }, "interest_type": { "type": "integer", "nullable": true, "description": "Tipo do Juros:\n * `0` Não se Aplica (isento)\n * `1` Por valor Diário\n * `2` Por porcentagem Diária\n * `3` Por porcentagem Mensal", "enum": [ 0, 1, 2, 3 ], "default": 0 }, "interest_amount": { "type": "string", "nullable": true, "example": "20.00", "description": "Valor da Multa" }, "interest_percentage": { "type": "string", "nullable": true, "example": "2.5", "description": "Percentual da Multa" }, "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 }, "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" }, "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", "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, "description": "Tipo do Multa:\n * `0` Sem multa (isento)\n * `1` Por valor\n * `2` Por porcentagem", "enum": [ 0, 1, 2 ], "default": 0 }, "fine_amount": { "type": "string", "nullable": true, "example": "50.00", "description": "Valor da Multa" }, "fine_percentage": { "type": "string", "nullable": true, "example": "5", "description": "Percentual da Multa" }, "reduction_type": { "type": "integer", "nullable": true, "description": "Tipo de Abatimento:\n * `0` Não se aplica\n * `1` Por valor\n * `2` Por porcentagem", "enum": [ 0, 1, 2 ], "default": 0 }, "reduction_amount": { "type": "string", "nullable": true, "example": "25.00", "description": "Valor do Abatimento" }, "reduction_percentage": { "type": "string", "nullable": true, "example": "2.5", "description": "Percentual do Abatimento" }, "interest_type": { "type": "integer", "nullable": true, "description": "Tipo do Juros:\n * `0` Não se Aplica (isento)\n * `1` Por valor Diário\n * `2` Por porcentagem Diária\n * `3` Por porcentagem Mensal", "enum": [ 0, 1, 2, 3 ], "default": 0 }, "interest_amount": { "type": "string", "nullable": true, "example": "20.00", "description": "Valor da Multa" }, "interest_percentage": { "type": "string", "nullable": true, "example": "2.5", "description": "Percentual da Multa" }, "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", "required": [ "financial_provider_slug", "key" ], "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID da Conta Pix" }, "custom_name": { "type": "string", "description": "Nome customizado da conta pix" }, "financial_provider_slug": { "type": "string", "description": "Slug do provedor financeiro", "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" }, "beneficiary": { "type": "object", "description": "Beneficiário", "properties": { "document_number": { "type": "string", "description": "Número do documento do beneficiário", "readOnly": true }, "name": { "type": "string", "description": "Nome do beneficiário", "example": "Nome do Beneficiário" }, "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 do beneficiário", "example": "123" }, "complement": { "type": "string", "description": "Complemento 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" } } } } }, "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_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." } } }, "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", "bank_billet_id", "bank_billet_account_id", "paid_amount", "kind" ], "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Recebimento de Boleto" }, "uid": { "type": "string", "readOnly": true, "description": "UID 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." }, "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, "description": "Dígito da Agência. Dependendo da carteira escolhida poderá ser obrigátorio." }, "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", "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" }, "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, "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": 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": "Anotaçõ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 ], "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", "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", "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." }, "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": "Anotaçõ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_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" }, "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": "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" }, "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, "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 }, "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" } } } }, "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": 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": "Anotaçõ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": "Anotaçõ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_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": "Anotaçõ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_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": "Anotaçõ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": "Anotaçõ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" }, "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/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": 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": "Anotaçõ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": "Anotaçõ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" ] } } }, "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 } } }, "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" } } } }, "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" ], "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", "description": "Dígito da Agência" }, "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", "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" } } }, "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", "description": "Dígito da Agência" }, "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", "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 Instituição de Pagamento 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_financial_account_command": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID do Comando." }, "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" }, "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." }, "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", "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" } } }, "v2_subaccount": { "type": "object", "required": [ "nickname" ], "properties": { "id": { "type": "integer", "readOnly": true, "description": "ID da subconta" }, "uid": { "type": "string", "readOnly": true, "description": "UID da subconta" }, "parent_id": { "type": "integer", "readOnly": true, "description": "ID 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": { "id": { "type": "integer", "readOnly": true, "description": "ID da subconta" }, "uid": { "type": "string", "readOnly": true, "description": "UID do Evento" }, "parent_id": { "type": "integer", "readOnly": true, "description": "ID 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 }, "account_level": { "type": "integer", "readOnly": true, "description": "Nível da conta", "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" }, "credentials": { "type": "object", "description": "Credenciais.\n" }, "certificate_uid": { "type": "string", "format": "uuid", "example": "018df180-7208-727b-a10a-ea545e4a75a8", "nullable": true, "description": "UID do Certificado." }, "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" }, "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" ], "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" } } }, "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" }, "credentials": { "type": "object", "description": "Credenciais.\n" }, "certificate_uid": { "type": "string", "format": "uuid", "example": "018df180-7208-727b-a10a-ea545e4a75a8", "nullable": true, "description": "UUID do Certificado." }, "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" ], "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_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" }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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" } } }, "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 V2.\n`transfer`: Transferência/Pagamentos.\n`transfer`: Transferência/Pagamentos V2.\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" ], "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" } } }, "v2_new_connection_bradesco_3": { "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" }, "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" ], "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" } } }, "v2_new_connection_btg_2": { "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" }, "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" } } }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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`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" ], "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" } } }, "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" }, "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`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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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" } } }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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`statement`: Extrato.\n`statement`: Extrato V4.\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" ], "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" } } }, "v2_new_connection_sicoob_3": { "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" }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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" ], "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" } } }, "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" }, "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 da Confirmação" }, "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 de Autenticação", "example": "2023-12-12" }, "source": { "readOnly": true, "nullable": true, "type": "string", "description": "Origem da Transferência.\n\n`api`: API.\n`view`: Browser\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`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": "COMPE" }, "ispb_number": { "type": "integer", "description": "ISPB" }, "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" }, "document_number": { "type": "string", "description": "CPF/CNPJ do Beneficiário" } } }, "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" } } } } }, "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" }, "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_new_transfer_pix": { "type": "object", "description": "Nova Transferência Pix", "required": [ "amount", "financial_account_uid", "type" ], "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" }, "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", "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`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": "COMPE" }, "ispb_number": { "type": "integer", "description": "ISPB" }, "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" }, "document_number": { "type": "string", "description": "CPF/CNPJ do Beneficiário" } } }, "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" ], "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" }, "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", "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": "COMPE" }, "ispb_number": { "type": "integer", "description": "ISPB" }, "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" }, "document_number": { "type": "string", "description": "CPF/CNPJ do Beneficiário" } } } } }, "v2_new_transfer_internal": { "type": "object", "description": "Nova Transferência Entre Contas", "required": [ "amount", "financial_account_uid", "internal" ], "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" }, "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", "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" }, "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" }, "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" }, "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" ], "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" }, "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", "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`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": "COMPE" }, "ispb_number": { "type": "integer", "description": "ISPB" }, "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" }, "document_number": { "type": "string", "description": "CPF/CNPJ do Beneficiário" } } }, "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" }, "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" ], "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" }, "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", "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": "COMPE" }, "ispb_number": { "type": "integer", "description": "ISPB" }, "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" }, "document_number": { "type": "string", "description": "CPF/CNPJ do Beneficiário" } } } } }, { "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" }, "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" ], "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" }, "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", "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." }, "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" }, "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." }, "pix": { "$ref": "#/components/schemas/v2_transfer_batch" } } }, "v2_payment_bank_billet": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID do Pagamento", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "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" }, "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 da Confirmação" }, "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 de Autenticação", "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" }, "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`: Browser\n" }, "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" } } } } }, "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" }, "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" } } }, "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" }, "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" } } } }, "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" }, "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_pix" } ] } }, "financial_account_uid": { "type": "string", "format": "uuid", "description": "UID da Conta Financeira de Origem", "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" }, "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" }, "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" } } } }, { "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" }, "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" }, "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." }, "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" }, "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." }, "pix": { "$ref": "#/components/schemas/v2_payment_batch" } } }, "v2_payment_utility": { "type": "object", "properties": { "uid": { "type": "string", "format": "uuid", "readOnly": true, "description": "UID do Pagamento", "example": "018df180-7208-727b-a10a-ea545e4a75a8" }, "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" }, "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 da Confirmação" }, "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 de Autenticação", "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" }, "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`: Browser\n" }, "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." } } } } }, "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" }, "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" } } }, "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" }, "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" }, "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" }, "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" }, "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" }, "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" }, "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" }, "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 da Confirmação" }, "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 de Autenticação", "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" }, "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`: Browser\n" }, "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." } } } } }, "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" }, "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" } } }, "v2_new_payment_pix": { "type": "object", "description": "Novo Pagamento Pix.", "required": [ "amount", "financial_account_uid", "qrcode" ], "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" }, "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", "example": 120.99, "description": "Quantia\n\n\n* Opcional para `qrcode` imediato ou com vencimento.\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" }, "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_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" }, "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" }, "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" }, "payments": { "type": "array", "description": "Lista de Pagamentos de Pix novos ou existentes.", "items": { "anyOf": [ { "type": "object", "description": "Novo Pagamento Pix.", "required": [ "amount", "qrcode" ], "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" }, "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" }, "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" }, "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 da Confirmação" }, "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 de Autenticação", "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" }, "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`: Browser\n" }, "darf": { "type": "object", "description": "Dados do DARF a ser pago.", "properties": { "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" }, "tax_code": { "type": "string", "nullable": true, "description": "Código da Receita" } } }, "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" }, "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" } } }, "v2_new_payment_darf": { "type": "object", "description": "Novo Pagamento DARF.", "required": [ "amount", "financial_account_uid" ], "properties": { "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", "example": "16.974.923/0001-84" }, "tax_code": { "type": "string", "nullable": true, "description": "Código da Receita" } } }, "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" }, "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" }, "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" }, "payments": { "type": "array", "description": "Lista de Pagamentos de Darf novos ou existentes.", "items": { "anyOf": [ { "type": "object", "description": "Novo Pagamento DARF.", "required": [ "amount" ], "properties": { "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", "example": "16.974.923/0001-84" }, "tax_code": { "type": "string", "nullable": true, "description": "Código da Receita" } } }, { "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_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 Instituição de Pagamento 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": "Anotaçõ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": "Anotaçõ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": "bank_billet.created", "description": "Código do evento.\n* `ping` Ping\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.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_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* `statement_transaction.db.created` Linha de Extrato criada.\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* `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.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.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.ted_batch.awaiting_approval` Lote de Transferência TED aguardando liberação.\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.internal_batch.awaiting_approval` Lote de Transferência Entre Contas aguardando liberação.\n* `transfer.internal_batch.register.requested` Lote de Transferência Entre Contas solicitado.\n* `transfer.internal_batch.register.confirmed` Lote de Transferência Entre Contas confirmado.\n* `transfer.internal_batch.register.failed` Falha no envio de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.register.error` Ocorreu um erro no envio de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.approve.requested` Liberação de Lote de Transferência Entre Contas solicitada.\n* `transfer.internal_batch.approve.confirmed` Liberação de Lote de Transferência Entre Contas confirmada.\n* `transfer.internal_batch.approve.failed` Falha na liberação de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.reprove.requested` Rejeição de Lote de Transferência Entre Contas solicitada.\n* `transfer.internal_batch.reprove.confirmed` Rejeição de Lote de transferência Entre Contas confirmada.\n* `transfer.internal_batch.reprove.failed` Falha na rejeição de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência Entre Contas.\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.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.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.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.internal.register.requested` Transferência Entre Contas solicitada.\n* `transfer.internal.register.confirmed` Transferência Entre Contas confirmada.\n* `transfer.internal.register.failed` Falha no envio da Transferência Entre Contas.\n* `transfer.internal.register.error` Ocorreu um erro no envio da Transferência Entre Contas.\n* `transfer.internal.reschedule.requested` Reagendamento de Transferência Entre Contas solicitado.\n* `transfer.internal.reschedule.confirmed` Reagendamento de Transferência Entre Contas confirmado.\n* `transfer.internal.reschedule.failed` Falha no Reagendamento de Transferência Entre Contas.\n* `transfer.internal.reschedule.error` Ocorreu um erro no Reagendamento de Transferência Entre Contas.\n* `transfer.internal.approve.requested` Liberação de Transferência Entre Contas solicitada.\n* `transfer.internal.approve.confirmed` Liberação de Transferência Entre Contas confirmada.\n* `transfer.internal.approve.failed` Falha na liberação da transferência Entre Contas.\n* `transfer.internal.approve.error` Ocorreu um erro na liberação da Transferência Entre Contas.\n* `transfer.internal.cancel.requested` Cancelamento de Transferência Entre Contas solicitado.\n* `transfer.internal.cancel.confirmed` Cancelamento de Transferência Entre Contas confirmado.\n* `transfer.internal.cancel.failed` Falha no cancelamento de Transferência Entre Contas.\n* `transfer.internal.cancel.error` Ocorreu um erro no cancelamento de Transferência Entre Contas.\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.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.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.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.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.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.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.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.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.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.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.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.darf_batch.awaiting_approval` Lote de Pagamento de DARF aguardando liberação.\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.utility_batch.awaiting_approval` Lote de Pagamento de Conta de Consumo aguardando liberação.\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.gru_batch.awaiting_approval` Lote de Pagamento de GRU aguardando liberação.\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.pix_batch.awaiting_approval` Lote de Pagamento de Pix aguardando liberação.\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.dda.account.db.created` Conta DDA criada\n* `payment.dda.account.register.requested` Conta 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 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 Boletoe.\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.bank_billet.db.created` Boleto DDA criado\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* `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.payment.db.created` Pagamento de cobrança criado.\n* `charge.payment.db.updated` Pagamento de cobrança atualizado.\n* `charge.payment.db.deleted` Pagamento de cobrança excluído.\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* `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* `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" } } }, "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* `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.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_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* `statement_transaction.db.created` Linha de Extrato criada.\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* `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.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.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.ted_batch.awaiting_approval` Lote de Transferência TED aguardando liberação.\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.internal_batch.awaiting_approval` Lote de Transferência Entre Contas aguardando liberação.\n* `transfer.internal_batch.register.requested` Lote de Transferência Entre Contas solicitado.\n* `transfer.internal_batch.register.confirmed` Lote de Transferência Entre Contas confirmado.\n* `transfer.internal_batch.register.failed` Falha no envio de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.register.error` Ocorreu um erro no envio de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.approve.requested` Liberação de Lote de Transferência Entre Contas solicitada.\n* `transfer.internal_batch.approve.confirmed` Liberação de Lote de Transferência Entre Contas confirmada.\n* `transfer.internal_batch.approve.failed` Falha na liberação de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.approve.error` Ocorreu um erro na liberação de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.reprove.requested` Rejeição de Lote de Transferência Entre Contas solicitada.\n* `transfer.internal_batch.reprove.confirmed` Rejeição de Lote de transferência Entre Contas confirmada.\n* `transfer.internal_batch.reprove.failed` Falha na rejeição de Lote de Transferência Entre Contas.\n* `transfer.internal_batch.reprove.error` Ocorreu um erro na rejeição de Lote de Transferência Entre Contas.\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.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.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.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.internal.register.requested` Transferência Entre Contas solicitada.\n* `transfer.internal.register.confirmed` Transferência Entre Contas confirmada.\n* `transfer.internal.register.failed` Falha no envio da Transferência Entre Contas.\n* `transfer.internal.register.error` Ocorreu um erro no envio da Transferência Entre Contas.\n* `transfer.internal.reschedule.requested` Reagendamento de Transferência Entre Contas solicitado.\n* `transfer.internal.reschedule.confirmed` Reagendamento de Transferência Entre Contas confirmado.\n* `transfer.internal.reschedule.failed` Falha no Reagendamento de Transferência Entre Contas.\n* `transfer.internal.reschedule.error` Ocorreu um erro no Reagendamento de Transferência Entre Contas.\n* `transfer.internal.approve.requested` Liberação de Transferência Entre Contas solicitada.\n* `transfer.internal.approve.confirmed` Liberação de Transferência Entre Contas confirmada.\n* `transfer.internal.approve.failed` Falha na liberação da transferência Entre Contas.\n* `transfer.internal.approve.error` Ocorreu um erro na liberação da Transferência Entre Contas.\n* `transfer.internal.cancel.requested` Cancelamento de Transferência Entre Contas solicitado.\n* `transfer.internal.cancel.confirmed` Cancelamento de Transferência Entre Contas confirmado.\n* `transfer.internal.cancel.failed` Falha no cancelamento de Transferência Entre Contas.\n* `transfer.internal.cancel.error` Ocorreu um erro no cancelamento de Transferência Entre Contas.\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.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.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.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.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.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.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.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.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.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.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.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.darf_batch.awaiting_approval` Lote de Pagamento de DARF aguardando liberação.\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.utility_batch.awaiting_approval` Lote de Pagamento de Conta de Consumo aguardando liberação.\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.gru_batch.awaiting_approval` Lote de Pagamento de GRU aguardando liberação.\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.pix_batch.awaiting_approval` Lote de Pagamento de Pix aguardando liberação.\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.dda.account.db.created` Conta DDA criada\n* `payment.dda.account.register.requested` Conta 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 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 Boletoe.\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.bank_billet.db.created` Boleto DDA criado\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* `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.payment.db.created` Pagamento de cobrança criado.\n* `charge.payment.db.updated` Pagamento de cobrança atualizado.\n* `charge.payment.db.deleted` Pagamento de cobrança excluído.\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* `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* `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", "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.add_pix.requested", "bank_billet.add_pix.confirmed", "bank_billet.add_pix.failed", "bank_billet.add_pix.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", "statement_transaction.db.created", "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", "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.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.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.ted_batch.awaiting_approval", "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.internal_batch.awaiting_approval", "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.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.cancel.requested", "transfer.pix.cancel.confirmed", "transfer.pix.cancel.failed", "transfer.pix.cancel.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.cancel.requested", "transfer.ted.cancel.confirmed", "transfer.ted.cancel.failed", "transfer.ted.cancel.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.cancel.requested", "transfer.internal.cancel.confirmed", "transfer.internal.cancel.failed", "transfer.internal.cancel.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.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.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.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.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.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.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.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.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.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.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.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.darf_batch.awaiting_approval", "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.utility_batch.awaiting_approval", "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.gru_batch.awaiting_approval", "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.pix_batch.awaiting_approval", "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.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.bank_billet.db.created", "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", "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.payment.db.created", "charge.payment.db.updated", "charge.payment.db.deleted", "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", "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", "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 } } }, "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" }, "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 }, "beneficiary": { "type": "object", "readOnly": true, "nullable": true, "description": "Dados do Beneficiário", "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": { "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" } } }, "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", "example": { "amount": 100, "percentage": 2.0 } }, "interest": { "type": "object", "nullable": true, "readOnly": true, "description": "Juros", "example": { "amount": 50, "percentage": 1.0 } }, "discount": { "type": "object", "nullable": true, "readOnly": true, "description": "Desconto", "example": { "amount": 200, "percentage": 5.0 } }, "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_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" }, "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_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" }, "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_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" }, "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_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" } } } } }, "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": "Assinaturas", "description": "Gerenciar assinaturas" }, { "name": "Boletos", "description": "Gerenciar boletos" }, { "name": "CNAB (Retorno)", "description": "CNAB (Retorno)" }, { "name": "Carnês", "description": "Gerenciar carnês" }, { "name": "Carteiras de Cobrança", "description": "Gerenciar carteiras" }, { "name": "Clientes", "description": "Gerenciar clientes" }, { "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": "Usuário", "description": "Usuário" }, { "name": "Webhooks", "description": "Webhooks" }, { "name": "certificates", "description": "Gerenciar Certificados" }, { "name": "connections", "description": "Gerenciar Conexões" }, { "name": "contas-financeiras", "description": "Gerenciar Contas" }, { "name": "edi", "description": "Gerenciar EDI" }, { "name": "pagamentos", "description": "Gerenciar Pagamentos" }, { "name": "person", "description": "Gerenciar Pessoas" }, { "name": "pix", "description": "Gerenciar Pix" }, { "name": "subaccount", "description": "Gerenciar Subcontas" }, { "name": "transferencias", "description": "Gerenciar Transferências" }, { "name": "users", "description": "Gerenciar Usuários" } ] }