Upload
lamdieu
View
213
Download
0
Embed Size (px)
Citation preview
Table of ContentsOverview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Version information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Contact information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
License information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
URI scheme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Busca produtos do catálogo do próprio fornecedor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Cria um novo pedido. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Finaliza um pedido. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Realiza cancelamento (estorno) de um pedido. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Realiza captura (confirmação) de um pedido com produto(s) credenciado(s). . . . . . . . . . . . . . . . . . . 5
Realiza captura (confirmação) de um pedido com produto genérico. . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Cria uma nota fiscal para o pedido informado. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Recupera lista de notas fiscais atribuídas ao pedido. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Altera a nota fiscal eletrônica de um pedido. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Recupera a nota fiscal informada atribuída ao pedido. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Altera a nota fiscal informada para o pedido informado. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Exclui a nota fiscal informada para o pedido informado. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Realiza pagamento de um pedido. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Realiza login no sistema. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Realiza logout no sistema. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Realiza simulação de financiamento. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Obtém a taxa de financiamento para o mês corrente. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
CpfCnpj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
DadosCancelamento . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
DadosCaptura . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
DadosCartao . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
DadosPedido . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
ItemPedido . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
LoginParameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
MensagemResposta . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
NotaFiscal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
ParametrosPedido . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Produto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Resposta . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
RespostaCancelamento . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
RespostaCaptura . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
RespostaPagamento . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
ResultadoSimulacao . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Simulacao . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
OverviewAPI para uso do Cartão BNDES como meio de pagamento
Version informationVersion : 1.0.42-SNAPSHOT
Contact informationContact : BNDES
License informationLicense : Todos os direitos reservados ao BNDESTerms of service : null
URI schemeHost : ws-h.bndes.gov.brBasePath : /cbn-pagamento/apiSchemes : HTTPS
Tags• Operações de catálogo
• Operações de pedidos
• Operações de simulação de financiamento
• Operações para autenticação e gerenciamento de sessão
1
Paths
Busca produtos do catálogo do próprio fornecedor.
GET /v1/catalogo/produto
Parameters
Type Name Description Schema
QuerycnpjFabricanteoptional
CNPJ do fabricante do produto. Campo de 14posições no formato 99999999999999.
string
Querymodelooptional
Modelo do produto. Campo de 45 posições. string
QuerynumeroReferenciaoptional
Número de referência do produto. Campo de 12posições
string
Responses
HTTPCode
Description Schema
200 Lista de produtos. Produto
400 Erro na execução da operação. Retorna lista de mensagens de erro. Resposta
Produces
• application/json;charset=utf-8
Tags
• Operações de catálogo
Cria um novo pedido.
POST /v1/pedido
Parameters
2
Type Name Description Schema
Bodybodyrequired
Dados para criacao do pedido. ParametrosPedido
Responses
HTTPCode
Description Schema
201 Pedido criado. Retorna o identificador do pedido. No Content
400 Erro na execução da operação. Retorna lista de mensagens de erro. Resposta
Consumes
• application/json
Produces
• application/json;charset=utf-8
Tags
• Operações de pedidos
Finaliza um pedido.
PUT /v1/pedido/{pedido}
Parameters
Type Name Description Schema
Pathpedidorequired
Identificador do pedido. integer(int32)
Bodybodyrequired
Dados para finalização do pedido. DadosPedido
Responses
HTTPCode
Description Schema
200 Pedido finalizado. No Content
400 Erro na execução da operação. Retorna lista de mensagens de erro. Resposta
3
Consumes
• application/json
Produces
• application/json;charset=utf-8
Tags
• Operações de pedidos
Realiza cancelamento (estorno) de um pedido.
POST /v1/pedido/{pedido}/cancelamento
Parameters
Type Name Description Schema
Pathpedidorequired
Identificador do pedido. integer(int32)
Bodybodyrequired
Dados para cancelamento do pedido. DadosCancelamento
Responses
HTTPCode
Description Schema
200Cancelamento do pedido processado. É necessário verificar os dadosretornados para confirmar se o pedido foi cancelado.
RespostaCancelamento
400 Erro na execução da operação. Retorna lista de mensagens de erro. Resposta
Consumes
• application/json
Produces
• application/json;charset=utf-8
Tags
• Operações de pedidos
4
Realiza captura (confirmação) de um pedido comproduto(s) credenciado(s).
POST /v1/pedido/{pedido}/captura
Parameters
Type Name Description Schema
Pathpedidorequired
Identificador do pedido. integer(int32)
Bodybodyrequired
Dados para captura do pedido. DadosCaptura
Responses
HTTPCode
Description Schema
200Captura do pedido processado. É necessário verificar os dadosretornados para confirmar se o pedido foi capturado.
RespostaCaptura
400 Erro na execução da operação. Retorna lista de mensagens de erro. Resposta
Consumes
• application/json
Produces
• application/json;charset=utf-8
Tags
• Operações de pedidos
Realiza captura (confirmação) de um pedido comproduto genérico.
POST /v1/pedido/{pedido}/captura/nfe
Parameters
5
Type Name Description Schema
Pathpedidorequired
Identificador do pedido. integer(int32)
Bodybodyoptional
Nota fiscal eletrônica em formato XML. Pode serinformado posteriormente através da operaçãode alteração de nota fiscal.
string
Responses
HTTPCode
Description Schema
200Captura do pedido processado. É necessário verificar os dadosretornados para confirmar se o pedido foi capturado.
RespostaCaptura
400 Erro na execução da operação. Retorna lista de mensagens de erro. Resposta
Consumes
• application/xml
Produces
• application/json;charset=utf-8
Tags
• Operações de pedidos
Cria uma nota fiscal para o pedido informado.
POST /v1/pedido/{pedido}/nfe
Parameters
Type Name Description Schema
Pathpedidorequired
Identificador do pedido. integer(int32)
Bodybodyrequired
Nota fiscal eletrônica em formato XML. string
Responses
6
HTTPCode
Description Schema
201 Nota fiscal criada. No Content
400 Erro na execução da operação. Retorna lista de mensagens de erro. Resposta
404 Pedido não encontrado. Resposta
409 A nota fiscal informada já foi cadastrada. Resposta
Consumes
• application/xml
Produces
• application/json;charset=utf-8
Tags
• Operações de pedidos
Recupera lista de notas fiscais atribuídas ao pedido.
GET /v1/pedido/{pedido}/nfe
Parameters
Type Name Description Schema
Pathpedidorequired
Identificador do pedido. integer(int32)
Responses
HTTPCode
Description Schema
200 Lista de notas fiscais. No Content
404 Pedido não encontrado. Resposta
Consumes
• application/json
Produces
• application/json;charset=utf-8
7
Tags
• Operações de pedidos
Altera a nota fiscal eletrônica de um pedido.
PUT /v1/pedido/{pedido}/nfe
CAUTION operation.deprecated
Parameters
Type Name Description Schema
Pathpedidorequired
Identificador do pedido. integer(int32)
Bodybodyrequired
Nota fiscal eletrônica em formato XML. string
Responses
HTTPCode
Description Schema
200 Nota fiscal eletrônica cadastrada no pedido. No Content
400 Erro na execução da operação. Retorna lista de mensagens de erro. Resposta
Consumes
• application/xml
Produces
• application/json;charset=utf-8
Tags
• Operações de pedidos
Recupera a nota fiscal informada atribuída ao pedido.
GET /v1/pedido/{pedido}/nfe/{chave}
8
Parameters
Type Name Description Schema
Pathchaverequired
Chave da NFe. string
Pathpedidorequired
Identificador do pedido. integer(int32)
Responses
HTTPCode
Description Schema
200 Dados da nota fiscal. NotaFiscal
404 Nota fiscal não encontrada. Resposta
Consumes
• application/json
Produces
• application/json;charset=utf-8
Tags
• Operações de pedidos
Altera a nota fiscal informada para o pedidoinformado.
PUT /v1/pedido/{pedido}/nfe/{chave}
Parameters
Type Name Description Schema
Pathchaverequired
Chave da NFe. string
Pathpedidorequired
Identificador do pedido. integer(int32)
Bodybodyrequired
Nota fiscal eletrônica em formato XML. string
9
Responses
HTTPCode
Description Schema
201 Nota fiscal criada. No Content
400 Erro na execução da operação. Retorna lista de mensagens de erro. Resposta
404 Nota fiscal não encontrada. Resposta
Consumes
• application/xml
Produces
• application/json;charset=utf-8
Tags
• Operações de pedidos
Exclui a nota fiscal informada para o pedidoinformado.
DELETE /v1/pedido/{pedido}/nfe/{chave}
Parameters
Type Name Description Schema
Pathchaverequired
Chave da NFe. string
Pathpedidorequired
Identificador do pedido. integer(int32)
Responses
HTTPCode
Description Schema
200 Nota fiscal excluída. No Content
400 Erro na execução da operação. Retorna lista de mensagens de erro. Resposta
404 Nota fiscal não encontrada. Resposta
10
Consumes
• application/json
Produces
• application/json;charset=utf-8
Tags
• Operações de pedidos
Realiza pagamento de um pedido.
POST /v1/pedido/{pedido}/pagamento
Parameters
Type Name Description Schema
Pathpedidorequired
Identificador do pedido. integer(int32)
Bodybodyrequired
Dados do cartão para pagamento. DadosCartao
Responses
HTTPCode
Description Schema
200Pagamento do pedido processado. É necessário verificar os dadosretornados para confirmar se o pedido foi autorizado.
RespostaPagamento
400 Erro na execução da operação. Retorna lista de mensagens de erro. Resposta
Consumes
• application/json
Produces
• application/json;charset=utf-8
Tags
• Operações de pedidos
11
Realiza login no sistema.
POST /v1/sessao
Parameters
Type Name Description Schema
Bodybodyrequired
Parêmetros de login. LoginParameters
Responses
HTTPCode
Description Schema
201Login realizado com sucesso. Sessao criada. Retorna o identificadorda sessao. Esse identificador deverá passar a ser informado nasdemais requisições através do cookie "CTRL".
No Content
401 Acesso negado. Retorna lista de mensagens de erro. Resposta
Consumes
• application/json
Produces
• application/json;charset=utf-8
Tags
• Operações para autenticação e gerenciamento de sessão
Realiza logout no sistema.
DELETE /v1/sessao
Responses
HTTPCode
Description Schema
200 Logout realizado com sucesso. Sessao finalizada. No Content
401 Erro ao realizar logout. Retorna lista de mensagens de erro. Resposta
12
Produces
• application/json;charset=utf-8
Tags
• Operações para autenticação e gerenciamento de sessão
Realiza simulação de financiamento.
GET /v1/simulacao/financiamento
Parameters
Type Name Description Schema
Queryvalorrequired
Valor para simulação. Campo no formato 9.99 number(double)
Responses
HTTPCode
Description Schema
200 Condições de financiamento para o valor informado.ResultadoSimulacao
400 Erro na execução da operação. Retorna lista de mensagens de erro. Resposta
Produces
• application/json;charset=utf-8
Tags
• Operações de simulação de financiamento
Obtém a taxa de financiamento para o mês corrente.
GET /v1/simulacao/taxa
Responses
HTTPCode
Description Schema
200 Taxa de financiamento para o mês corrente. No Content
13
HTTPCode
Description Schema
400 Erro na execução da operação. Retorna lista de mensagens de erro. Resposta
Produces
• application/json;charset=utf-8
Tags
• Operações de simulação de financiamento
14
Definitions
CpfCnpj
Name Schema
tipoDocumentooptional
enum (CPF, CNPJ)
DadosCancelamentoParâmetros para cancelamento de um pedido.
Name Description Schema
motivooptional
Código de motivo de cancelamento. Valores possíveis: 6 -Erro na informação de dados do comprador; 7 - Erro nainformação de dados dos produtos; 8 - Erro na informaçãode condições da transação; 9 - Desistência definitiva docomprador; 10 - Cancelamento para reprocessamento emcondições diferentes
integer(int32)
DadosCapturaParâmetros para captura de um pedido.
Name Description Schema
notaFiscaloptional
Número(s) da(s) nota(s) fiscal(ais) de faturamento dopedido. Campo de 100 posições. Caso necessário, é possívelinformar várias notas fiscais, bastando separar os númerospor vírgulas.
string
DadosCartaoParâmetros para pagamento de um pedido.
Name Description Schema
anoValidaderequired
Ano de validade do cartão para pagamento. integer(int32)
codigoSegurancaoptional
Código de segurança do cartão para pagamento. Campo de3 posições.
string
mesValidaderequired
Mês de validade do cartão para pagamento. integer(int32)
15
Name Description Schema
numeroCartaorequired
Número do cartão para pagamento. Campo de 16 posiçõesno formato 9999999999999999.
string
DadosPedidoParâmetros para preenchimento e finalização de um pedido.
Name Description Schema
bairrorequired
Bairro de entrega do pedido. Campo de 16 posições. string
ceprequired
CEP de entrega do pedido. Campo de 8 posições no formato99999999.
string
complementooptional
Complemento do endereço de entrega do pedido. Campo de20 posições.
string
enderecorequired
Endereço de entrega do pedido. Campo de 55 posições. string
itensrequired
Itens a serem incluídos na cesta do pedido. < ItemPedido > array
municipiorequired
Município de entrega do pedido. Campo de 32 posições. string
numerorequired
Número do endereço de entrega do pedido. Campo de 10posições.
string
parcelasrequired
Quantidade de parcelas para pagamento com o CartãoBNDES.
integer(int32)
ufrequired
Unidade federativa de entrega do pedido. Campo de 2posições no formato XX.
string
valorPagamentorequired
Valor para pagamento com o Cartão BNDES. Campo noformato 9.99.
number(double)
ItemPedidoItem da cesta de um pedido.
Name Description Schema
precoUnitariorequired
Preço unitário do produto. Campo no formato 9.99. number(double)
produtorequired
Identificador do produto no catálogo do Cartão BNDES. integer(int32)
16
Name Description Schema
quantidaderequired
Quantidade do produto. Campo no formato 9.99. number(double)
LoginParametersParâmetros para autenticação na API.
Name Description Schema
cnpjrequired
Número do CNPJ. Campo de 14 posições no formato99999999999999.
string
loginrequired
Login para autenticação. Campo de 30 posições. string
senharequired
Senha para autenticação. Campo de 30 posições. string
MensagemRespostaMensagens de resultado de uma operação da API.
Name Description Schema
codigooptional
Código da mensagem. integer(int32)
mensagemoptional
Descrição da mensagem. string
NotaFiscalDados da Nota Fiscal eletrônica.
Name Description Schema
numeroChaveNfeoptionalread-only
Chave da Nota Fiscal com 44 dígitos string
numeroNotaoptional
string
ParametrosPedidoParâmetros para criação de um pedido.
17
Name Description Schema
binCartaorequired
BIN do cartão a ser usado para pagamento. Campo de 6posições no formato 999999.Pattern : "[0-9]{6}"
string
cnpjCompradoroptional
Número do CNPJ do comprador. Campo de 14 posições noformato 99999999999999. Este campo será descontinuadoem versão futura da API. Utilizar o campocpfCnpjComprador
string
cpfCnpjCompradorrequired
Número do CPF ou CNPJ do comprador. Campo de 11posições para CPF e 14 posições para CNPJ no formato99999999999999.
string
cpfCnpjCompradorQualquerCampooptional
CpfCnpj
ProdutoProduto do catálogo do Cartão BNDES.
Name Description Schema
cnpjFabricanteoptional
CNPJ do fabricante do produto. string
descricaooptional
Descrição do produto, conforme definida pelo fabricante.Campo de 2000 posições.
string
descricaoModelooptional
Descrição do modelo do produto. string
designacaoComercialoptional
Designação comercial do produto, conforme definida pelofabricante. Campo de 65 posições.
string
modelooptional
Modelo do produto. string
numeroReferenciaoptional
Número de referência do produto, conforme definido pelofabricante. Campo de 12 posições.
string
produtooptional
Identificador do produto no catálogo do Cartão BNDES. integer(int32)
RespostaResposta de resultado de uma operação da API.
18
Name Description Schema
mensagensoptional
Mensagens de resultado da operação.<MensagemResposta> array
RespostaCancelamentoResposta de resutlado de uma tentativa de cancelamento de um pedido.
Name Description Schema
descricaooptional
Descrição da situação da solicitação de cancelamento apósa tentativa.
string
situacaooptional
Código da situação da solicitação de cancelamento após atentativa. Valores possíveis: 10 - Enviada; 20 - Negada; 30 -Aceita (pedido em cancelamento); 40 - Aceita (pedidocancelado)
integer(int32)
RespostaCapturaResposta de resultado de uma tentativa de captura de um pedido.
Name Description Schema
cnpjAdquirenteoptional
CNPJ do adquirente utilizado para a tentativa. string
descricaooptional
Descrição da situação do pedido após a tentativa. string
situacaooptional
Código da situação do pedido após a tentativa. Valorespossíveis: 20 - Autorizado; 40 - Pedido Capturado; 50 -Pedido Não Capturado
integer(int32)
RespostaPagamentoResposta de resutlado de uma tentativa de pagamento de um pedido.
Name Description Schema
cnpjAdquirenteoptional
CNPJ do adquirente utilizado para a tentativa. string
descricaooptional
Descrição da situação do pedido após a tentativa. string
19
Name Description Schema
numeroAutorizacaooptional
Número de autorização retornado pelo adquirente. string
situacaooptional
Código da situação do pedido após a tentativa. Valorespossíveis: 10 - Pedido em Aberto; 20 - Autorizado; 30 - NãoAutorizado
integer(int32)
tidoptional
Identificador da transação retornada pelo adquirente. string
ResultadoSimulacaoResposta da simulação de pagamento para um determinado valor. Indica a taxa de juros decobrança e uma lista com os prazos possíveis para pagamento.
Name Description Schema
formasPagamentooptional
Lista de possibilidades de prazo para pagamento. < Simulacao > array
taxaoptional
Taxa de juros de cobrança. number(double)
SimulacaoResposta da simulação de pagamento para um determinado valor em um determinado prazo.
Name Description Schema
prazooptional
Prazo para pagamento. integer(int32)
valorParcelaoptional
Valor estimado da parcela mensal para pagamento. number(double)
20