Link de Pagamento

Versão v1.0.2

Download Documentação

Nesse download está todo material necessário para integração com documentações, exemplos e anotações importantes sobre o uso dessa API. Lembrando que para utilizar os recursos do CreditallPay você tem uma chave criptografada disponíbilizada pelo CreditallPay.

Introdução

Todas as APIs do CreditallPay foram desenvolvidas seguindo os atuais padrões técnicos de mercado. Tudo isso para que a experiência na hora da integração seja a mais fácil possível. Todas as URLs são amigáveis e orientadas a recursos e utilizam os padrões do protocolo HTTP como autenticação, verbos e códigos de retorno. Isso permite que APIs possam ser utilizadas por clientes HTTP já existentes. Todas as respostas são retornadas no formato JSON.

Como pode ser visto abaixo, as APIs foram cuidadosamente trabalhadas para que os termos de negócios contidos sejam facilmente entendidos por desenvolvedores que não tenham conhecimento prévio do sistema. Elas foram meticulosamente estudadas para que um nome de campo em um endpoint tenha rigorosamente o mesmo significado em outros recursos.

Atenção: Todos os testes devem ser realizados na área de "produção": Podendo prejudicar a operação ou causando divergências com a operações verdadeiras executadas dentro do sistema.

Toda a comunicação (recebimento e envio de dados) utiliza a chave de criptografada para autenticação.

Requisição de Pagamento

Seu e-commerce irá solicitar o pagamento de um pedido através do Creditallpay na finalização do carrinho de compras. Após a requisição, o cliente receberá um link para a efetuação do cadastro junto a Creditall e a análise com métricas próprias para avaliar o perfil sócio-econômico do consumidor em questão.

Assim que a análise for concluída e retornar como aprovado, o cliente receberá o comprovante de aprovação e os boletos atualizados para pagamento.

Method Envio: post

Ambiente URL
Homologação
Produção https://www.siscredit.com.br/integracao/createLink.php
Parametros
Parâmetro Descrição
chave_acesso * A chave de acesso, é informada pela creditall ao solicitar integração.
cpf_cnpj cpf_cnpj é um campo opcional a informar na API
valor_total * Valor do link de pagamento
vencimento * Data de vencimento do link, ao passar a data, o link ficará indisponível
pedido * Numero de pedido para o seu controle interno
url * Url a ser informada para atualização de status (0 - Em aberto | 1 - Bloqueado | 2 - Negado | 3 - Aprovado)

Retorno API

Cancelamento

Para cancelamento o consumidor deverá entrar em contato com a loja e realizar o pedido de cancelamento, para que a loja cancele a venda pelo painel gerêncial da Creditall. Ou a loja querendo cancelar, deverá avisar o consumidor e cancelar pelo painel gerêncial da Creditall.

Consultar Situação

A Creditall enviará a situação automaticamente na url de retorno informada no momento da geração do link de pagamento. Nessa página você receberá por metodo POST as seguintes variaveis (chave_acesso,pedido,status)