openapi: 3.2.0 info: title: boletos-v2 Boletos V2 API version: '1.0' servers: - url: https://api.stage.cora.com.br/v2/invoices security: - sec0: [] tags: - name: Boletos V2 paths: /: get: summary: Consulta de boletos description: Consulte boletos gerados de acordo com a data de vencimento operationId: consultar-boletos-v2 parameters: - name: start in: query description: Data início schema: type: string format: date - name: end in: query description: Data final schema: type: string format: date - name: state in: query description: Estado do boleto schema: type: string - name: search in: query description: CPF/CNPJ do destinatário schema: type: string - name: page in: query description: Número da página schema: type: integer format: int32 default: 1 - name: perPage in: query description: Número de itens por página schema: type: integer format: int32 default: 20 responses: '200': description: '200' content: application/json: examples: Result: value: "{ \n \"totalItems\": 2,\n \"items\": [\n {\n \"id\": \"inv_OVP4p99hiRr2LJ71omCWAOg\",\n \"status\": \"OPEN\",\n \"created_at\": \"2021-11-26T14:41:27Z\",\n \"total_amount\": 1001,\n \"total_paid\": null,\n \"customer_name\": \"Fulano da Silva\",\n \"customer_document\": \"11122233344\",\n \"due_date\": \"2021-03-01\", \n \"payment_form\": \"BANK_SLIP\",\n \"paid_at: null,\n \"fine_paid\": null,\n \"interest_paid\": null,\n \"discount_paid: null\n },\n {\n \"id\": \"inv_LDjPUWArRPu99Sq4jTzeRJQ\",\n \"status\": \"PAID\",\n \"created_at\": \"2021-11-26T14:39:04Z\",\n \"total_amount\": 2000,\n \"total_paid\": 2000,\n \"customer_name\": \"Fulano Ltda\",\n \"customer_document\": \"11222333000144\",\n \"due_date\": \"2021-03-01\", \n \"payment_form\": \"BANK_SLIP\",\n \"paid_at: \"2021-11-25T08:00:00Z\",\n \"fine_paid\": 0,\n \"interest_paid\": 0,\n \"discount_paid: 0\n }\n ]\n}" '400': description: '400' content: application/json: examples: Date Format: value: "{\n \"code\": \"invalid_request\",\n \"message\": \"Request has invalid parameters\",\n \"errors\": [\n {\n \"code\": \"start\",\n \"message\": \"Failed to convert value of type 'java.lang.String' to required type 'java.time.LocalDate'; nested exception is org.springframework.core.convert.ConversionFailedException: Failed to convert from type [java.lang.String] to type [@org.springframework.format.annotation.DateTimeFormat java.time.LocalDate] for value '2023-15-01'; nested exception is java.lang.IllegalArgumentException: Parse attempt failed for value [2023-15-01]\"\n }\n ]\n}" schema: type: object properties: code: type: string example: invalid_request message: type: string example: Request has invalid parameters errors: type: array items: type: object properties: code: type: string example: start message: type: string example: 'Failed to convert value of type ''java.lang.String'' to required type ''java.time.LocalDate''; nested exception is org.springframework.core.convert.ConversionFailedException: Failed to convert from type [java.lang.String] to type [@org.springframework.format.annotation.DateTimeFormat java.time.LocalDate] for value ''2023-15-01''; nested exception is java.lang.IllegalArgumentException: Parse attempt failed for value [2023-15-01]' '401': description: '401' content: application/json: examples: Unauthorized: value: "{\n \"error\": \"access_denied\"\n}" schema: type: object properties: error: type: string example: access_denied deprecated: false tags: - Boletos V2 post: summary: Emissão de boleto registrado description: Gere um boleto registrado através desta API operationId: emissão-de-boleto-registrado-v2 parameters: - name: Idempotency-Key in: header description: UUID aleatório gerado por você. Nós utilizamos esse header para evitar duplicidade de registros, ou seja, caso você não tenha recebido a resposta de alguma requisição e mandar o mesmo UUID, nós não duplicaremos o registro. required: true schema: type: string default: dd61d5b9-c9fb-4116-b5e0-1f8436993ac4 requestBody: content: application/json: schema: type: object required: - customer - services - payment_terms properties: code: type: string default: meu_id customer: type: object required: - name - email properties: name: type: string email: type: string document: type: object required: - identity properties: identity: type: string type: type: string address: type: object properties: street: type: string number: type: string district: type: string city: type: string state: type: string complement: type: string zip_code: type: string services: type: array description: Objeto para descrição do serviço prestado ao pagador do boleto items: properties: name: type: string description: type: string amount: type: integer format: int32 required: - name - amount type: object payment_terms: type: object required: - due_date properties: due_date: type: string fine: type: object properties: date: type: string amount: type: integer format: int32 rate: type: number format: double discount: type: object properties: type: type: string default: PERCENT value: type: number format: double interest: type: object properties: rate: type: number format: double notification: type: object description: Objeto que representa a configuração das notificações de cobrança. required: - name properties: name: type: string description: Nome do contato para quem será enviada a notificação de cobrança. default: Fulano Ciclano Oliveira channels: type: array description: Lista de objetos que representam os canais de notificação desejados com suas respectivas regras. items: properties: channel: type: string description: Array de Strings que representam os canais de comunicação escolhidos. Hoje aceita o canal "EMAIL" e "SMS" default: EMAIL enum: - EMAIL - SMS contact: type: string description: Contato para quem será enviada a notificação de cobrança. Deve ser informado um endereço de e-mail para canal do tipo EMAIL, e um número de telefone para o canal SMS default: fulano@cora.com.br rules: type: array default: [] required: - channel - contact - rules type: object payment_forms: type: array description: Para criar um boleto com opção de pagamento por QR code é preciso inserir as opções de "BANK_SLIP" e "PIX". default: - BANK_SLIP - PIX items: type: string responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"id\": \"inv_yOgInV7rSPu90wOp21ekGyQ\",\n \"status\": \"OPEN\",\n \"created_at\": \"2022-03-09T18:08:38Z\",\n \"total_amount\": 1000,\n \"total_paid\": 0,\n \"occurrence_date\": null,\n \"code\": \"meu_id\",\n \"customer\": {\n \"name\": \"Gol Transportes Aereos Sa\",\n \"email\": \"email@email.com\",\n \"document\": {\n \"identity\": \"34052649000178\",\n \"type\": \"CNPJ\"\n },\n \"address\": {\n \"street\": \"Rua Gomes de Carvalho\",\n \"number\": \"1629\",\n \"district\": \"Vila Olímpia\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"complement\": \"N/A\",\n \"zip_code\": \"00111222\"\n },\n \"code\": null\n },\n \"services\": [\n {\n \"name\": \"Nome Do Serviço\",\n \"description\": \"Descrição do serviço\",\n \"amount\": 1000,\n \"unit\": \"AMOUNT\",\n \"quantity\": null,\n \"total_amount\": null,\n \"code\": null\n }\n ],\n \"payment_terms\": {\n \"due_date\": \"2022-12-12\",\n \"fine\": {\n \"date\": \"2022-12-13\",\n \"amount\": 200,\n \"rate\": null\n },\n \"interest\": {\n \"rate\": 3.67\n },\n \"discount\": {\n \"percent\": 1.5\n }\n },\n \"payment_options\": {\n \"bank_slip\": {\n \"barcode\": \"00197914200000020000000003215837001258458017\",\n \"digitable\": \"00190000090321583700012584580174791420000002000\",\n \"our_number\": \"32158370012584580\",\n \"registered\": true,\n \"url\": \"https://storage.googleapis.com/download/storage/v1/b/cora_production_exporter_bankslip_storage/o/boleto-cdc8763a-e436-49b2-a5ad-14625e84dbf3.pdf?generation=1654625979053761&alt=media\"\n }\n },\n \"payments\": [],\n \"pix\": null\n}" QR Code Pix: value: "{\n \"id\": \"inv_wNtiSwA5QqyxVSYLygs6OQ\",\n \"status\": \"OPEN\",\n \"created_at\": \"2023-08-09T13:46:55Z\",\n \"total_amount\": 4000,\n \"total_paid\": 0,\n \"occurrence_date\": null,\n \"code\": \"meu_id\",\n \"customer\": {\n \"name\": \"Gol Transportes Aereos Sa\",\n \"email\": \"email@email.com\",\n \"telephone\": null,\n \"document\": {\n \"identity\": \"34052649000178\",\n \"type\": \"CNPJ\"\n },\n \"address\": {\n \"street\": \"Rua Gomes de Carvalho\",\n \"number\": \"1629\",\n \"district\": \"Vila Olímpia\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"complement\": \"N/A\",\n \"zip_code\": \"00111222\"\n },\n \"code\": null\n },\n \"services\": [\n {\n \"name\": \"Nome Do Serviço\",\n \"description\": \"Descrição do serviço\",\n \"amount\": 4000,\n \"unit\": \"AMOUNT\",\n \"quantity\": null,\n \"total_amount\": null,\n \"code\": null\n }\n ],\n \"payment_terms\": {\n \"due_date\": \"2024-12-01\",\n \"fine\": {\n \"date\": \"2024-12-03\",\n \"amount\": 200,\n \"rate\": null\n },\n \"interest\": {\n \"rate\": 3.67\n },\n \"discount\": null\n },\n \"payment_options\": {\n \"bank_slip\": {\n \"barcode\": \"40395991700000040000000092833613000008424801\",\n \"digitable\": \"40390000079283361300000084248012599170000004000\",\n \"our_number\": \"28336130000084248\",\n \"registered\": false,\n \"url\": \"https://storage.googleapis.com/download/storage/v1/b/cora_stage_exporter_bankslip_storage/o/boleto-qrcode-533f7a28-e805-4d05-a276-56b624287c28.pdf?generation=1691588819429263&alt=media\"\n }\n },\n \"payments\": [],\n \"pix\": {\n \"emv\": \"00020101021226830014br.gov.bcb.pix2561qrcode-h.cora.com.br/v1/cobv/c0db624b003942acb155260bca0b3a395204000053039865802BR5912MARI COMPANY6009SAO PAULO62070503***6304BB11\"\n }\n}" schema: oneOf: - type: object properties: id: type: string example: inv_yOgInV7rSPu90wOp21ekGyQ status: type: string example: OPEN created_at: type: string example: '2022-03-09T18:08:38Z' total_amount: type: integer example: 1000 default: 0 total_paid: type: integer example: 0 default: 0 occurrence_date: {} code: type: string example: meu_id customer: type: object properties: name: type: string example: Gol Transportes Aereos Sa email: type: string example: email@email.com document: type: object properties: identity: type: string example: '34052649000178' type: type: string example: CNPJ address: type: object properties: street: type: string example: Rua Gomes de Carvalho number: type: string example: '1629' district: type: string example: Vila Olímpia city: type: string example: São Paulo state: type: string example: SP complement: type: string example: N/A zip_code: type: string example: '00111222' code: {} services: type: array items: type: object properties: name: type: string example: Nome Do Serviço description: type: string example: Descrição do serviço amount: type: integer example: 1000 default: 0 unit: type: string example: AMOUNT quantity: {} total_amount: {} code: {} payment_terms: type: object properties: due_date: type: string example: '2022-12-12' fine: type: object properties: date: type: string example: '2022-12-13' amount: type: integer example: 200 default: 0 rate: {} interest: type: object properties: rate: type: number example: 3.67 default: 0 discount: type: object properties: percent: type: number example: 1.5 default: 0 payment_options: type: object properties: bank_slip: type: object properties: barcode: type: string example: 00197914200000020000000003215837001258458017 digitable: type: string example: 00190000090321583700012584580174791420000002000 our_number: type: string example: '32158370012584580' registered: type: boolean example: true default: true url: type: string example: https://storage.googleapis.com/download/storage/v1/b/cora_production_exporter_bankslip_storage/o/boleto-cdc8763a-e436-49b2-a5ad-14625e84dbf3.pdf?generation=1654625979053761&alt=media payments: type: array pix: {} - title: QR Code Pix type: object properties: id: type: string example: inv_wNtiSwA5QqyxVSYLygs6OQ status: type: string example: OPEN created_at: type: string example: '2023-08-09T13:46:55Z' total_amount: type: integer example: 4000 default: 0 total_paid: type: integer example: 0 default: 0 occurrence_date: {} code: type: string example: meu_id customer: type: object properties: name: type: string example: Gol Transportes Aereos Sa email: type: string example: email@email.com telephone: {} document: type: object properties: identity: type: string example: '34052649000178' type: type: string example: CNPJ address: type: object properties: street: type: string example: Rua Gomes de Carvalho number: type: string example: '1629' district: type: string example: Vila Olímpia city: type: string example: São Paulo state: type: string example: SP complement: type: string example: N/A zip_code: type: string example: '00111222' code: {} services: type: array items: type: object properties: name: type: string example: Nome Do Serviço description: type: string example: Descrição do serviço amount: type: integer example: 4000 default: 0 unit: type: string example: AMOUNT quantity: {} total_amount: {} code: {} payment_terms: type: object properties: due_date: type: string example: '2024-12-01' fine: type: object properties: date: type: string example: '2024-12-03' amount: type: integer example: 200 default: 0 rate: {} interest: type: object properties: rate: type: number example: 3.67 default: 0 discount: {} payment_options: type: object properties: bank_slip: type: object properties: barcode: type: string example: '40395991700000040000000092833613000008424801' digitable: type: string example: '40390000079283361300000084248012599170000004000' our_number: type: string example: '28336130000084248' registered: type: boolean example: false default: true url: type: string example: https://storage.googleapis.com/download/storage/v1/b/cora_stage_exporter_bankslip_storage/o/boleto-qrcode-533f7a28-e805-4d05-a276-56b624287c28.pdf?generation=1691588819429263&alt=media payments: type: array pix: type: object properties: emv: type: string example: 00020101021226830014br.gov.bcb.pix2561qrcode-h.cora.com.br/v1/cobv/c0db624b003942acb155260bca0b3a395204000053039865802BR5912MARI COMPANY6009SAO PAULO62070503***6304BB11 '400': description: '400' content: application/json: examples: Past Date: value: "{\n \"code\": \"invalid_request\",\n \"message\": \"Request has invalid parameters\",\n \"errors\": [\n {\n \"code\": \"paymentTerms.dueDate\",\n \"message\": \"cannot be a past date\"\n }\n ]\n}" Null Parameter: value: "{\n \"code\": \"invalid_request\",\n \"message\": \"Request has invalid parameters\",\n \"errors\": [\n {\n \"code\": \"customer\",\n \"message\": \"must not be null\"\n }\n ]\n}" Idempotency-Key Required: value: "{\n \"code\": \"invalid_request\",\n \"message\": \"Request has invalid parameters\",\n \"errors\": [\n {\n \"code\": \"Idempotency-Key\",\n \"message\": \"header is required\"\n }\n ]\n}" schema: oneOf: - title: Past Date type: object properties: code: type: string example: invalid_request message: type: string example: Request has invalid parameters errors: type: array items: type: object properties: code: type: string example: paymentTerms.dueDate message: type: string example: cannot be a past date - title: Null Parameter type: object properties: code: type: string example: invalid_request message: type: string example: Request has invalid parameters errors: type: array items: type: object properties: code: type: string example: customer message: type: string example: must not be null - title: Idempotency-Key Required type: object properties: code: type: string example: invalid_request message: type: string example: Request has invalid parameters errors: type: array items: type: object properties: code: type: string example: Idempotency-Key message: type: string example: header is required '401': description: '401' content: application/json: examples: Unauthorized: value: "{\n \"error\": \"access_denied\"\n}" schema: type: object properties: error: type: string example: access_denied '415': description: '415' content: text/plain: examples: Result: value: '' x-readme: code-samples: - language: curl code: "curl --request POST \\\n --url https://api.stage.cora.com.br/v2/invoices/ \\\n --header 'Idempotency-Key: dd61d5b9-c9fb-4116-b5e0-1f8436993ac4' \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '\n{\n \"code\": \"meu_id\",\n \"customer\": {\n \"name\": \"Fulano da Silva\",\n \"email\": \"fulano@email.com\",\n \"document\": {\n \"identity\": \"34052649000178\",\n \"type\": \"CNPJ\"\n },\n \"address\": {\n \"street\": \"Rua Gomes de Carvalho\",\n \"number\": \"1629\",\n \"district\": \"Vila Olímpia\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"complement\": \"N/A\",\n \"zip_code\": \"00111222\"\n }\n },\n \"services\": [\n {\n \"name\": \"Serviço A\",\n \"description\": \"Serviço A\",\n \"amount\": 10000\n }\n ],\n \"payment_terms\": {\n \"due_date\": \"2023-12-12\",\n \"fine\": {\n \"amount\": 200\n },\n \"discount\": {\n \"type\": \"PERCENT\",\n \"value\": 1.5\n }\n },\n \"notification\": {\n \"name\": \"Fulano Ciclano Oliveira\",\n \"channels\": [\n {\n \"channel\": \"EMAIL\",\n \"contact\": \"fulano@cora.com.br\",\n \"rules\": [\n \"NOTIFY_TWO_DAYS_BEFORE_DUE_DATE\",\n \"NOTIFY_WHEN_PAID\"\n ]\n },\n {\n \"channel\": \"SMS\",\n \"contact\": \"+5511999999999\",\n \"rules\": [\n \"NOTIFY_TWO_DAYS_BEFORE_DUE_DATE\",\n \"NOTIFY_WHEN_PAID\"\n ]\n }\n ]\n },\n \"payment_forms\": [\n \"BANK_SLIP\",\n \"PIX\"\n ]\n} \n' " samples-languages: - curl tags: - Boletos V2 //: post: summary: Emissão de QR code Pix v2 description: Gere um QR code Pix através desta API operationId: qr-code-pix-v2 parameters: - name: Idempotency-Key in: header description: UUID aleatório gerado por você. Nós utilizamos esse header para evitar duplicidade de registros, ou seja, caso você não tenha recebido a resposta de alguma requisição e mandar o mesmo UUID, nós não duplicaremos o registro. required: true schema: type: string default: dd61d5b9-c9fb-4116-b5e0-1f8436993ac4 requestBody: content: application/json: schema: type: object required: - customer - services - payment_terms properties: code: type: string default: meu_id customer: type: object required: - name - email properties: name: type: string email: type: string document: type: object required: - identity properties: identity: type: string type: type: string address: type: object properties: street: type: string number: type: string district: type: string city: type: string state: type: string complement: type: string zip_code: type: string services: type: array description: Objeto para descrição do serviço prestado ao pagador do boleto payment_terms: type: object required: - due_date properties: due_date: type: string fine: type: object properties: date: type: string amount: type: integer format: int32 rate: type: number format: double discount: type: object properties: type: type: string default: PERCENT value: type: number format: double interest: type: object properties: rate: type: number format: double notification: type: object description: Objeto que representa a configuração das notificações de cobrança. required: - name properties: name: type: string description: Nome do contato para quem será enviada a notificação de cobrança. default: Fulano Ciclano Oliveira channels: type: array description: Lista de objetos que representam os canais de notificação desejados com suas respectivas regras. items: properties: channel: type: string description: Array de Strings que representam os canais de comunicação escolhidos. Hoje aceita o canal "EMAIL" e "SMS" default: EMAIL enum: - EMAIL - SMS contact: type: string description: Contato para quem será enviada a notificação de cobrança. Deve ser informado um endereço de e-mail para canal do tipo EMAIL, e um número de telefone para o canal SMS default: fulano@cora.com.br rules: type: array default: [] required: - channel - contact - rules type: object payment_forms: type: array description: Para criar um QR code de pagamento é preciso inserir apenas a opção de "PIX". default: - PIX items: type: string responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"id\": \"inv_0deQoE91jTDe0FnYkb992bqg\",\n \"status\": \"OPEN\",\n \"created_at\": \"2023-09-27T18:14:12Z\",\n \"total_amount\": 1000,\n \"total_paid\": 0,\n \"occurrence_date\": null,\n \"code\": \"meu_id\",\n \"customer\": {\n \"name\": \"Fulano Da Silva\",\n \"email\": null,\n \"telephone\": null,\n \"document\": {\n \"identity\": \"34052649000178\",\n \"type\": \"CNPJ\"\n },\n \"address\": {\n \"street\": \"Rua Gomes de Carvalho\",\n \"number\": \"1629\",\n \"district\": \"Vila Olímpia\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"complement\": \"N/A\",\n \"zip_code\": \"00111222\"\n },\n \"code\": null\n },\n \"services\": [\n {\n \"name\": \"Nome Do Serviço\",\n \"description\": \"Aluguel de imóvel\",\n \"amount\": 1000,\n \"unit\": \"AMOUNT\",\n \"quantity\": null,\n \"total_amount\": null,\n \"code\": null\n }\n ],\n \"payment_terms\": {\n \"due_date\": \"2023-12-12\",\n \"fine\": null,\n \"interest\": null,\n \"discount\": null\n },\n \"payment_options\": {\n \"bank_slip\": {\n \"barcode\": null,\n \"digitable\": null,\n \"our_number\": null,\n \"registered\": false,\n \"url\": \"https://storage.googleapis.com/download/storage/v1/b/cora_stage_exporter_bankslip_storage/o/cobranca-qrcode-20867afe-10cf-4c7c-9af5-a54f12f98d7c.png?generation=1695838453622906&alt=media\"\n }\n },\n \"payments\": [],\n \"pix\": {\n \"emv\": \"00020101021226830014br.gov.bcb.pix2561qrcode-h.cora.com.br/v1/cobv/d1d790a04fe34c37b41676246fdd9baa5204000053039865802BR5912MARI COMPANY6009SAO PAULO62070503***6304F445\"\n },\n \"notifications\": null\n}" QR Code Pix: value: "{\n \"id\": \"inv_wNtiSwA5QqyxVSYLygs6OQ\",\n \"status\": \"OPEN\",\n \"created_at\": \"2023-08-09T13:46:55Z\",\n \"total_amount\": 4000,\n \"total_paid\": 0,\n \"occurrence_date\": null,\n \"code\": \"meu_id\",\n \"customer\": {\n \"name\": \"Gol Transportes Aereos Sa\",\n \"email\": \"email@email.com\",\n \"telephone\": null,\n \"document\": {\n \"identity\": \"34052649000178\",\n \"type\": \"CNPJ\"\n },\n \"address\": {\n \"street\": \"Rua Gomes de Carvalho\",\n \"number\": \"1629\",\n \"district\": \"Vila Olímpia\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"complement\": \"N/A\",\n \"zip_code\": \"00111222\"\n },\n \"code\": null\n },\n \"services\": [\n {\n \"name\": \"Nome Do Serviço\",\n \"description\": \"Descrição do serviço\",\n \"amount\": 4000,\n \"unit\": \"AMOUNT\",\n \"quantity\": null,\n \"total_amount\": null,\n \"code\": null\n }\n ],\n \"payment_terms\": {\n \"due_date\": \"2024-12-01\",\n \"fine\": {\n \"date\": \"2024-12-03\",\n \"amount\": 200,\n \"rate\": null\n },\n \"interest\": {\n \"rate\": 3.67\n },\n \"discount\": null\n },\n \"payment_options\": {\n \"bank_slip\": {\n \"barcode\": \"40395991700000040000000092833613000008424801\",\n \"digitable\": \"40390000079283361300000084248012599170000004000\",\n \"our_number\": \"28336130000084248\",\n \"registered\": false,\n \"url\": \"https://storage.googleapis.com/download/storage/v1/b/cora_stage_exporter_bankslip_storage/o/boleto-qrcode-533f7a28-e805-4d05-a276-56b624287c28.pdf?generation=1691588819429263&alt=media\"\n }\n },\n \"payments\": [],\n \"pix\": {\n \"emv\": \"00020101021226830014br.gov.bcb.pix2561qrcode-h.cora.com.br/v1/cobv/c0db624b003942acb155260bca0b3a395204000053039865802BR5912MARI COMPANY6009SAO PAULO62070503***6304BB11\"\n }\n}" schema: oneOf: - type: object properties: id: type: string example: inv_0deQoE91jTDe0FnYkb992bqg status: type: string example: OPEN created_at: type: string example: '2023-09-27T18:14:12Z' total_amount: type: integer example: 1000 default: 0 total_paid: type: integer example: 0 default: 0 occurrence_date: {} code: type: string example: meu_id customer: type: object properties: name: type: string example: Fulano Da Silva email: {} telephone: {} document: type: object properties: identity: type: string example: '34052649000178' type: type: string example: CNPJ address: type: object properties: street: type: string example: Rua Gomes de Carvalho number: type: string example: '1629' district: type: string example: Vila Olímpia city: type: string example: São Paulo state: type: string example: SP complement: type: string example: N/A zip_code: type: string example: '00111222' code: {} services: type: array items: type: object properties: name: type: string example: Nome Do Serviço description: type: string example: Aluguel de imóvel amount: type: integer example: 1000 default: 0 unit: type: string example: AMOUNT quantity: {} total_amount: {} code: {} payment_terms: type: object properties: due_date: type: string example: '2023-12-12' fine: {} interest: {} discount: {} payment_options: type: object properties: bank_slip: type: object properties: barcode: {} digitable: {} our_number: {} registered: type: boolean example: false default: true url: type: string example: https://storage.googleapis.com/download/storage/v1/b/cora_stage_exporter_bankslip_storage/o/cobranca-qrcode-20867afe-10cf-4c7c-9af5-a54f12f98d7c.png?generation=1695838453622906&alt=media payments: type: array pix: type: object properties: emv: type: string example: 00020101021226830014br.gov.bcb.pix2561qrcode-h.cora.com.br/v1/cobv/d1d790a04fe34c37b41676246fdd9baa5204000053039865802BR5912MARI COMPANY6009SAO PAULO62070503***6304F445 notifications: {} - title: QR Code Pix type: object properties: id: type: string example: inv_wNtiSwA5QqyxVSYLygs6OQ status: type: string example: OPEN created_at: type: string example: '2023-08-09T13:46:55Z' total_amount: type: integer example: 4000 default: 0 total_paid: type: integer example: 0 default: 0 occurrence_date: {} code: type: string example: meu_id customer: type: object properties: name: type: string example: Gol Transportes Aereos Sa email: type: string example: email@email.com telephone: {} document: type: object properties: identity: type: string example: '34052649000178' type: type: string example: CNPJ address: type: object properties: street: type: string example: Rua Gomes de Carvalho number: type: string example: '1629' district: type: string example: Vila Olímpia city: type: string example: São Paulo state: type: string example: SP complement: type: string example: N/A zip_code: type: string example: '00111222' code: {} services: type: array items: type: object properties: name: type: string example: Nome Do Serviço description: type: string example: Descrição do serviço amount: type: integer example: 4000 default: 0 unit: type: string example: AMOUNT quantity: {} total_amount: {} code: {} payment_terms: type: object properties: due_date: type: string example: '2024-12-01' fine: type: object properties: date: type: string example: '2024-12-03' amount: type: integer example: 200 default: 0 rate: {} interest: type: object properties: rate: type: number example: 3.67 default: 0 discount: {} payment_options: type: object properties: bank_slip: type: object properties: barcode: type: string example: '40395991700000040000000092833613000008424801' digitable: type: string example: '40390000079283361300000084248012599170000004000' our_number: type: string example: '28336130000084248' registered: type: boolean example: false default: true url: type: string example: https://storage.googleapis.com/download/storage/v1/b/cora_stage_exporter_bankslip_storage/o/boleto-qrcode-533f7a28-e805-4d05-a276-56b624287c28.pdf?generation=1691588819429263&alt=media payments: type: array pix: type: object properties: emv: type: string example: 00020101021226830014br.gov.bcb.pix2561qrcode-h.cora.com.br/v1/cobv/c0db624b003942acb155260bca0b3a395204000053039865802BR5912MARI COMPANY6009SAO PAULO62070503***6304BB11 '400': description: '400' content: application/json: examples: Past Date: value: "{\n \"code\": \"invalid_request\",\n \"message\": \"Request has invalid parameters\",\n \"errors\": [\n {\n \"code\": \"paymentTerms.dueDate\",\n \"message\": \"cannot be a past date\"\n }\n ]\n}" Null Parameter: value: "{\n \"code\": \"invalid_request\",\n \"message\": \"Request has invalid parameters\",\n \"errors\": [\n {\n \"code\": \"customer\",\n \"message\": \"must not be null\"\n }\n ]\n}" Idempotency-Key Required: value: "{\n \"code\": \"invalid_request\",\n \"message\": \"Request has invalid parameters\",\n \"errors\": [\n {\n \"code\": \"Idempotency-Key\",\n \"message\": \"header is required\"\n }\n ]\n}" schema: oneOf: - title: Past Date type: object properties: code: type: string example: invalid_request message: type: string example: Request has invalid parameters errors: type: array items: type: object properties: code: type: string example: paymentTerms.dueDate message: type: string example: cannot be a past date - title: Null Parameter type: object properties: code: type: string example: invalid_request message: type: string example: Request has invalid parameters errors: type: array items: type: object properties: code: type: string example: customer message: type: string example: must not be null - title: Idempotency-Key Required type: object properties: code: type: string example: invalid_request message: type: string example: Request has invalid parameters errors: type: array items: type: object properties: code: type: string example: Idempotency-Key message: type: string example: header is required '401': description: '401' content: application/json: examples: Unauthorized: value: "{\n \"error\": \"access_denied\"\n}" schema: type: object properties: error: type: string example: access_denied '415': description: '415' content: text/plain: examples: Result: value: '' deprecated: false x-readme: code-samples: - language: curl code: "curl --request POST \\\n --url https://api.stage.cora.com.br/v2/invoices/ \\\n --header 'Idempotency-Key: dd61d5b9-c9fb-4116-b5e0-1f8436993ac4' \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '\n{\n \"code\": \"meu_id\",\n \"customer\": {\n \"name\": \"Fulano da Silva\",\n \"email\": \"fulano@email.com\",\n \"document\": {\n \"identity\": \"34052649000178\",\n \"type\": \"CNPJ\"\n },\n \"address\": {\n \"street\": \"Rua Gomes de Carvalho\",\n \"number\": \"1629\",\n \"district\": \"Vila Olímpia\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"complement\": \"N/A\",\n \"zip_code\": \"00111222\"\n }\n },\n \"services\": [\n {\n \"name\": \"Serviço A\",\n \"amount\": 10000\n }\n ],\n \"payment_terms\": {\n \"due_date\": \"2023-12-12\",\n \"fine\": {\n \"Amount\": 200\n },\n \"discount\": {\n \"type\": \"PERCENT\",\n \"value\": 1.5\n }\n },\n \"notification\": {\n \"name\": \"Fulano Ciclano Oliveira\",\n \"channels\": [\n {\n \"channel\": \"EMAIL\",\n \"contact\": \"fulano@cora.com.br\",\n \"rules\": [\n \"NOTIFY_TWO_DAYS_BEFORE_DUE_DATE\",\n \"NOTIFY_WHEN_PAID\"\n ]\n },\n {\n \"channel\": \"SMS\",\n \"contact\": \"+5511999999999\",\n \"rules\": [\n \"NOTIFY_TWO_DAYS_BEFORE_DUE_DATE\",\n \"NOTIFY_WHEN_PAID\"\n ]\n }\n ]\n },\n \"payment_forms\": [\n \"PIX\"\n ]\n} \n' " samples-languages: - curl tags: - Boletos V2 /{invoice_id}: get: summary: Consulta de detalhes do boleto description: Verifique mais informações sobre determinado boleto através desta API operationId: consultar-detalhes-de-um-boleto-v2 parameters: - name: invoice_id in: path description: ID da fatura na Cora. Esse ID precisará ser usado para consultar os detalhes da fatura. schema: type: string default: inv_IU6nswNwQjO2JX8eHIzEfw required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"id\": \"inv_D1CdW70OQbiCL1vkbaMErQ\",\n \"status\": \"PAID\",\n \"created_at\": \"2023-01-03T13:23:41Z\",\n \"total_amount\": 3000,\n \"total_paid\": 3000,\n \"occurrence_date\": \"2023-01-03\",\n \"code\": \"meu_id\",\n \"customer\": {\n \"name\": \"Gol Transportes Aereos Sa\",\n \"email\": \"email@email.com\",\n \"telephone\": null,\n \"document\": {\n \"identity\": \"34052649000178\",\n \"type\": \"CNPJ\"\n },\n \"address\": {\n \"street\": \"Rua Gomes de Carvalho\",\n \"number\": \"1629\",\n \"district\": \"Vila Olímpia\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"complement\": \"N/A\",\n \"zip_code\": \"00111222\"\n },\n \"code\": null\n },\n \"services\": [\n {\n \"name\": \"Nome Do Serviço\",\n \"description\": \"Descrição do serviço\",\n \"amount\": 3000,\n \"unit\": \"AMOUNT\",\n \"quantity\": null,\n \"total_amount\": null,\n \"code\": null\n }\n ],\n \"payment_terms\": {\n \"due_date\": \"2023-03-12\",\n \"fine\": {\n \"date\": \"2023-03-14\",\n \"amount\": 200,\n \"rate\": null\n },\n \"interest\": {\n \"rate\": 3.67\n },\n \"discount\": {\n \"percent\": 1.5\n }\n },\n \"payment_options\": {\n \"bank_slip\": {\n \"barcode\": \"00199928700000030000000003480462000004622617\",\n \"digitable\": \"00190000090348046200900046226179992870000003000\",\n \"our_number\": \"34804620000046226\",\n \"registered\": true,\n \"url\": \"https://storage.googleapis.com/download/storage/v1/b/cora_stage_exporter_bankslip_storage/o/boleto-0e05ef46-3e22-4660-9438-521f17e852bf.pdf?generation=1672752221318114&alt=media\"\n }\n },\n \"payments\": [\n {\n \"id\": \"fd1307b0-32f7-4a60-b058-d2973a6638db\",\n \"status\": \"SUCCESS\",\n \"created_at\": \"2023-01-03T13:32:56Z\",\n \"finalized_at\": \"2023-01-03T13:33:02Z\",\n \"total_paid\": 3000,\n \"method\": \"BANK_SLIP\",\n \"order\": 1,\n \"interest\": 0,\n \"fine\": 0\n }\n ],\n \"pix\": null\n}" schema: type: object properties: id: type: string example: inv_D1CdW70OQbiCL1vkbaMErQ status: type: string example: PAID created_at: type: string example: '2023-01-03T13:23:41Z' total_amount: type: integer example: 3000 default: 0 total_paid: type: integer example: 3000 default: 0 occurrence_date: type: string example: '2023-01-03' code: type: string example: meu_id customer: type: object properties: name: type: string example: Gol Transportes Aereos Sa email: type: string example: email@email.com telephone: {} document: type: object properties: identity: type: string example: '34052649000178' type: type: string example: CNPJ address: type: object properties: street: type: string example: Rua Gomes de Carvalho number: type: string example: '1629' district: type: string example: Vila Olímpia city: type: string example: São Paulo state: type: string example: SP complement: type: string example: N/A zip_code: type: string example: '00111222' code: {} services: type: array items: type: object properties: name: type: string example: Nome Do Serviço description: type: string example: Descrição do serviço amount: type: integer example: 3000 default: 0 unit: type: string example: AMOUNT quantity: {} total_amount: {} code: {} payment_terms: type: object properties: due_date: type: string example: '2023-03-12' fine: type: object properties: date: type: string example: '2023-03-14' amount: type: integer example: 200 default: 0 rate: {} interest: type: object properties: rate: type: number example: 3.67 default: 0 discount: type: object properties: percent: type: number example: 1.5 default: 0 payment_options: type: object properties: bank_slip: type: object properties: barcode: type: string example: 00199928700000030000000003480462000004622617 digitable: type: string example: 00190000090348046200900046226179992870000003000 our_number: type: string example: '34804620000046226' registered: type: boolean example: true default: true url: type: string example: https://storage.googleapis.com/download/storage/v1/b/cora_stage_exporter_bankslip_storage/o/boleto-0e05ef46-3e22-4660-9438-521f17e852bf.pdf?generation=1672752221318114&alt=media payments: type: array items: type: object properties: id: type: string example: fd1307b0-32f7-4a60-b058-d2973a6638db status: type: string example: SUCCESS created_at: type: string example: '2023-01-03T13:32:56Z' finalized_at: type: string example: '2023-01-03T13:33:02Z' total_paid: type: integer example: 3000 default: 0 method: type: string example: BANK_SLIP order: type: integer example: 1 default: 0 interest: type: integer example: 0 default: 0 fine: type: integer example: 0 default: 0 pix: {} '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '404': description: '404' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Boletos V2 delete: summary: Cancelamento de boleto description: Cancele os boletos gerados que ainda não foram pagos operationId: cancelamento-de-boleto-v2 parameters: - name: invoice_id in: path schema: type: string default: inv_IU6nswNwQjO2JX8eHIzEfw required: true responses: '200': description: '200' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Boletos V2 components: securitySchemes: sec0: type: oauth2 flows: {} x-readme-fauxas: true x-provenance: method: searched source: https://developers.cora.com.br/reference harvested: '2026-10-14' tool: harvest-readme-openapi.py note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored. assembled_from: - https://developers.cora.com.br/reference/cancelamento-de-boleto-copy.md - https://developers.cora.com.br/reference/cancelamento-de-boleto-v2.md - https://developers.cora.com.br/reference/consultar-boletos-v2.md - https://developers.cora.com.br/reference/consultar-detalhes-de-um-boleto-v2.md - https://developers.cora.com.br/reference/emiss%C3%A3o-de-boleto-registrado-v2.md - https://developers.cora.com.br/reference/qr-code-pix-v2.md merge: pages: 6 deduped: 5 conflicts_kept_first: 0