Sumário. Rua República Argentina, 176 Blumenau Santa Catarina Brasil

Tamanho: px

Começar a partir da página:

Download "Sumário. Rua República Argentina, 176 Blumenau Santa Catarina Brasil"

Fátima Lage
4 Há anos
Visualizações:

1 Sumário Introdução... 2 Fluxo de Funções... 2 URLs... 2 Headers... 2 Autenticação... 2 Lista de Bandeiras... 3 Lista de Parcelas... 4 Criação de Transação... 5 Fazer Pagamento... 7 Confirmar Pagamento... 9 Cancelar Pagamento... 9 Consultar Transação Logo de Bandeira Formas de tarifação... 11

2 Introdução Documentação da API de pagamento com cartões de crédito em venda digitada. Destinado a orientar profissionais da área de sistemas. Fluxo de Funções 1. Inicialmente deve-se chamar a lista de bandeiras para obter os códigos. 2. Listar parcelas para obter os valores para cada opção de parcelamento. 3. Criar uma transação para obter o id da transação a ser feita. 4. Fazer o pagamento para obter a autorização do emissor do cartão. 5. Confirmar ou cancelar transação. Em caso de eventual erro, como erro de conexão ou timeout, na função de pagamento ou confirmação/cancelamento, deve-se chamar a função de consulta para verificar o estado da transação. URLs Produção: da api Homologação: da api Headers São necessários 2 headers na requisição de qualquer função. Content-Type: application/json Authorization: Basic ZW1haWxAZG9taW5pby5jb206YWJjZGVm Autenticação A autenticação ocorre através do header Authorization que é composto pela palavra Basic sucedida pelo e token separados por dois pontos codificado com UTF8 em base64. @dominio.com:abcdef Authorization: Basic ZW1haWxAZG9taW5pby5jb206YWJjZGVm

3 Lista de Bandeiras Primeira função a ser chamada para obter a lista de bandeiras disponíveis. Método: GET URL: Cartao/VendaDigitada/v1/Bandeiras Status 200. Conteúdo: Coleção de BandeirasDTO Id Inteiro longo Código da Bandeira Nome Texto Nome da Bandeira [ "Id": "33", "Nome": "Diners", "Id": "2", "Nome": "Master Card", "Id": "1", "Nome": "Visa" ]

4 Lista de Parcelas Obtém a lista de parcelas disponíveis para o pagamento. Método: GET URL: Cartao/VendaDigitada/v1/Parcelamento Bandeira Inteiro Código da Bandeira valorservico Decimal Valor do Serviço (ponto como separador decimal) formatarifacao Inteiro (opcional) Forma de tarifação da operação antecipacao Boolean (optional) Deve ou não antecipar o valor FormaTarifacao*: Ver seção Formas de Tarifação Exemplos: Cartao/VendaDigitada/v1/Parcelamento?Bandeira=1&ValorServico= Cartao/VendaDigitada/v1/Parcelamento?Bandeira=1&ValorServico=500.50&formaTarifacao=1 Cartao/VendaDigitada/v1/Parcelamento?Bandeira=1&ValorServico=500.50&formaTarifacao=1&antecipacao=false Status 200. Conteúdo: Coleção de ParcelasDTO Parcelas Inteiro Quantidade de parcelas ValorParcela Decimal Valor da parcela ValorServico Decimal Valor da compra ValorTotal Decimal Valor total da transação cobrado do cliente Exemplo de retorno: [ "Parcelas": 1, "ValorParcela": 510, "ValorServico": , "ValorTotal": 510, "Parcelas": 2, "ValorParcela": 257, "ValorServico": , "ValorTotal": 514 ]

5 Em caso de inconsistência será retornado status 400 com ReasonPhrase indicando o motivo da inconsistência. Criação de Transação Cria uma transação para fazer o pagamento posteriormente. O resultado desta função é um identificador utilizado para realizar o pagamento junto à autorizadora, e para realizar consultas posteriores. Método: POST URL: Cartao/VendaDigitada/v1/Transacao NSU Texto NSU definido pelo cliente ValorServico Decimal Valor do Serviço. (ponto como separador decimal) ValorTransacao Decimal Valor da transação retornado na função de parcelamento Parcelas Inteiro Quantidade de parcelas Bandeira Inteiro Código da bandeira Descricao Texto Descrição do pagamento ProprietarioCartao ProprietarioCartao* Dados do proprietário do cartão FormaTarifacao Inteiro (opcional)* Forma de tarifação da operação Antecipacao Boolean (opcional) Define se o valor deve ou não ser antecipado FormaTarifacao*: Ver seção Formas de Tarifação ProprietarioCartao* Nome Texto Nome do dono do cartão CPF Texto CPF RG Texto RG TelefoneFixo Texto Número do telefone fixo TelefoneCelular Texto Número do telefone celular Texto Enviar Boolean Indica se o cliente deve receber sobre a transação EnviarSMS Boolean Indica se o cliente deve receber SMS sobre a transação *Todos os campos do proprietário são obrigatórios

6 "NSU" :"123abc", "ValorServico" : , "ValorTransacao" : 510, "Parcelas" : 1, "Bandeira" : 1, "Descricao" : "Inscrição de curso", Antecipacao : false, "ProprietarioCartao" : "Nome" : "João da Silva", "CPF" : " ", "RG" : " ", "TelefoneFixo" : " ", "TelefoneCelular" : " ", " " : "nome@dominio.com.br", "Enviar " : true, "EnviarSMS" : true Status 200. Conteúdo Sem nome Inteiro longo Identificador da transação Exemplo de retorno: 740 Em caso de inconsistência será retornado status 400 com ReasonPhrase indicando o motivo.

7 Fazer Pagamento Realiza o pedido de pagamento junto à autorizadora. Após esta função é necessário confirmar ou cancelar o pagamento. Em caso de não confirmação nem cancelamento, a transação será cancelada automaticamente em aproximadamente 10 minutos. Método: POST URL: Cartao/VendaDigitada/v1/Pagamento Id Inteiro longo Identificador recebido na criação da transação NumeroCartao Texto Número do cartão CodigoSeguranca Texto Código de segurança Validade Texto Validade do cartão no formato MMYY "Id" : 740 "NumeroCartao" : " ", "CodigoSeguranca" :"123", "Validade" : "1016" ResultadoTransacaoDTO Id Inteiro longo Identificador da transação Sucesso Boolean Indica se a transação foi realizada com sucesso Mensagem Texto Mensagem do servidor NSU Texto NSU definido pelo cliente CupomEstabelecimento Texto Cupom do estabelecimento CupomCliente Texto Cupom do cliente

8 Exemplos de retorno: Com recusa da operadora "Id": 740, "Sucesso": false, "Mensagem": "Houve um problema de transação com o emissor do cartão. Mensagem recebida do emissor do cartão: (denied card)", "NSU": "123abc", "CupomEstabelecimento": null, "CupomCliente": null Com ok da operadora "Id": 740, "Sucesso": true, "Mensagem": "", "NSU": "123abc", "CupomEstabelecimento": "S...I...M...U...L...A...D...O...", "CupomCliente": "S...I...M...U...L...A...D...O..." Em caso de inconsistência será retornado status 400 com ReasonPhrase indicando o motivo.

9 Confirmar Pagamento Confirma o pagamento finalizando a transação. Em caso de não confirmação nem cancelamento, a transação será cancelada automaticamente em aproximadamente 10 minutos. Método: POST URL: Cartao/VendaDigitada/v1/Confirmar Sem Nome Inteiro longo Identificador da transação 740 Status 200 para confirmação ok Em caso de inconsistência será retornado status 400 com ReasonPhrase indicando o motivo. Cancelar Pagamento Cancela um pagamento que aguarda a confirmação ou cancelamento, finalizando a transação. Em caso de não confirmação nem cancelamento, a transação será cancelada automaticamente em aproximadamente 10 minutos. Esta função não trata de estorno de uma transação já confirmada. Esta função apenas possibilita o rollback de uma transação, caso ocorra algum problema em eventual processamento posterior à etapa de pagamento no sistema cliente do PagueVeloz. Método: POST URL: Cartao/VendaDigitada/v1/Cancelar Sem Nome Inteiro longo Identificador da transação 740 Status 200 para cancelamento ok Em caso de inconsistência será retornado status 400 com ReasonPhrase indicando o motivo.

10 Consultar Transação Retorna os dados de uma transação. Utilizado principalmente em casos de timeout ou erros de rede nas etapas de pagamento e confirmação/cancelamento. Método: GET URL: Cartao/VendaDigitada/v1/Consulta/ Id Inteiro longo Identificador da transação Cartao/VendaDigitada/v1/Consulta/740 Operação Id Inteiro longo Quantidade de parcelas NSU Texto NSU definido pelo cliente DataHora DataHora Data e hora da transação ValorTotal Decimal Valor total da transação cobrado do cliente Mensagem Texto Mensagem do servidor CupomEstabelecimento Texto Cupom do estabelecimento CupomCliente Texto Cupom do cliente "Id": 740, "NSU": "123abc", "DataHora": " T15:21: :00", "Status": "Pago", "ValorTotal": 510, "Mensagem": "", "CupomEstabelecimento": ".S...I...M...U...L...A...D...O... ", "CupomCliente": "...S...I...M...U...L...A...D...O...

11 Logo de Bandeira Obtém uma imagem JPEG do logotipo da bandeira. Método: GET URL: Cartao/VendaDigitada/v1/Bandeiras/Logo/ Id Inteiro longo Código da bandeira Cartao/VendaDigitada/v1/Bandeiras/Logo/1 Binário image/jpeg Formas de tarifação A forma de tarifação informa ao sistema PagueVeloz a política de aplicação de taxas sobre o valor do serviço. A disponibilidade das diversas políticas de forma de tarifação depende dos planos contratados, podendo não estar todas disponíveis. Abaixo os valores possíveis. 1 - O valor do serviço é o valor a ser cobrado no cartão. As taxas referentes à operação serão descontados do repasse (antecipação). 2 - O valor do serviço é o valor a ser recebido no repasse (antecipação). As taxas serão adicionadas no valor a ser cobrado no cartão. 3 - Os juros são adicionados ao valor do serviço resultando no valor a ser cobrado no cartão, as taxas administrativas serão descontadas do repasse.

Documentos relacionados

Manual de Integração

Manual de Integração API v.2.10 https://contaderecebimento.com.br/ Pagamento recorrente com cartão de crédito e boleto bancário 1 Introdução Conta de Recebimento é um gateway facilitador de pagamentos