Você está na página 1de 5

Manual do Desenvolvedor

Versão 2.0
Documentação API : Pagamentos

Pré-requisitos ténicos
O ambiente de integração com a API de pagamentos da Pagconsorcio é bem simples, de modo que apenas
conhecimentos intermediários de programação Web são o suficiente para sua utilização. Todas APIs são
acessadas via GET ou POST e os dados são enviados e recebidos no formado JSON.

Informações para utilização da API


URL de testes: http://dev.pagconsorcio.com/api/

APIKey de testes: AmdZhlQX+ISTUaPJcGqkgg==

Lista de Cartões

Retorna uma lista com os cartões da empresa de acordo com a APIKey informada.

URL: api/payment/list-cards?APIKey=AmdZhlQX+ISTUaPJcGqkgg==
Método: GET
Retorno:
[
{
"id": 17,
"nome": "Visa",
"bandeira": 1,
"mascaracartao": "9999-9999-9999-9999",
"mascaracsv": "999",
"parcelamentomax": 3
},
{
"id": 18,
"nome": "Mastercard",
"bandeira": 2,
"mascaracartao": "9999-9999-9999-9999",
"mascaracsv": "999",
"parcelamentomax": 3
}
]

Lista de Operadores

Retorna uma lista com os operadores da empresa de acordo com a APIKey informada.

URL: api/payment/list-operadores?APIKey=AmdZhlQX+ISTUaPJcGqkgg==
Método: GET
Retorno:
[
{
"CodigoOperador": "HOMO-01",
"Nome": "Portal Homologação"
},
{
"CodigoOperador": "HOMO-02",
"Nome": "Portal Homologação"
},
......
]

Criar Transações

Cria uma nova transação com a administradora de crédito. Deverá ser enviado via JSON os dados obrigatórios informados
abaixo.

URL: api/payment/create-transaction?APIKey=AmdZhlQX+ISTUaPJcGqkgg==&CartaoCSC=Código de Segurança do Cartão.


Método: POST
Dados:
{
"ContratoNumero":"0321",
"Nome":"João dos Testes",
"CartaoTitular":"João dos Testes",
"ContratoValor":800.00
"CartaoTitularCPF":"27875578647",
"CartaoNumero":"4012001038443335",
"CartaoID":2,
"CartaoValidadeAno":2018,
"CartaoValidadeMes":05,
"CartaoLogradouro":"Rua dos Testes",
"CartaoLogradouroNumero":"1221",
"CartaoCidade":"Sorotestes",
"CartaoEstado":"SP",
"Email":"joao@teste.com",
"CartaoCep":"18055555",
"CartaoParcelas" : 1,
"TransacaoID" : 0
}
Retorno:
{
"TransacaoID": 102,
"Codigo": "00",
"Descricao": "Transação Autorizada",
"Autorizacao": "123456",
"Status": "Transação Autorizada"
}

Para criar uma transação nova, o TransacaoID deverá ser igual a 0 (zero). Caso ocorra algum problema com a transação e no
retorno seja exibido o TransacaoID, este ID deverá ser informado para uma segunda tentativa, mesmo para um número de
cartão e dados diferentes. Caso ocorra algum erro ao tentar se criar a transação, eles serão descritos no mesmo padrão do
retorno informado acima.

Obs.: O campo ContratoValor, é o valor do pagamento a ser realizado e deve ser utilizado apenas ponto para separar decimais.
Não utilizar vírgula ou qualquer outro caracter não númerico. Ex.: R$ 1.500,00 = 1500.00
Lista de Transações

Retorna uma lista com as transações da empresa de acordo com a APIKey informada.

URL: api/payment/list-transaction?APIKey=AmdZhlQX+ISTUaPJcGqkgg==
Método: POST
Dados:
{
"TransacaoID" : 0,
Lista de Status para filtragem:
"Nome":"João dos Testes",
"CpfCnpj":"32214436699",
1 = Transações Criadas
"Grupo":"123",
2 = Transações Em Processamento
"Cota":"123",
3 = Transações Autorizadas
"Contrato":"123",
4 = Transações Negadas
"CodigoOperador":"HOMO-01",
5 = Transações Canceladas
"Status":1,
6 = Transações Com Erro de TimeOut
"DataInicial":"2015-10-10",
7 = Transações Com Erro
"DataFinal":"2015-10-20"
}
Retorno: > Os dados serão necessários Apenas para quando
[ desejar realizar filtragens e não são obrigatórios.
{ Por exemplor: Caso queira filtrar somente por nome,
"TransacaoID": 97, basta informar apenas: { "Nome":"João dos Testes" }
"Nome": "João dos Testes",
"Email": "joao@teste.com", > Para obter o CodigoOperador para filtragem, basta
"CpfCnpj": null, usar a API Lista Operadores acima
"Telefone": null,
"Celular": null,
"ContratoGrupo": null,
"ContratoCota": null,
"ContratoValor": 80,
"ContratoCredito": null,
"ContratoDescricao": null,
"CartaoBandeira": 1,
"CartaoLogradouro": "Rua dos Testes",
"CartaoLogradouroNumero": "1221",
"CartaoComplemento": null,
"CartaoBairro": null,
"CartaoCep": "18055555",
"CartaoCidade": "Sorotestes",
"CartaoEstado": "SP",
"CartaoTitular": "João dos Testes",
"CartaoTitularCPF": null,
"CartaoNumero": "****-****-****-3335",
"CartaoParcelas": 0,
"CartaoValidadeMes": 5,
"CartaoValidadeAno": 2018,
"VendedorCodigo": null,
"VendedorNome": null,
"VendedorEmail": null,
"VendedorCelular": null,
"Logradouro": null,
"Numero": null,
"Complemento": null,
"Bairro": null,
"Cep": null,
"Cidade": null,
"Estado": null,
"DataRegistro": "2015-09-11T14:51:07.383",
"TransacaoStatus": 7
}
Cancelar Transação

Cancela uma transação. Para obter o TransactionID deverá ser usado a API Lista de Transações informada acima.

URL: api/payment/cancel-transaction?APIKey=AmdZhlQX+ISTUaPJcGqkgg==&TransactionID=101&MotivoCancelamento=Teste
Método: GET
Retorno:
{
"TransacaoID": 101,
"Codigo": "",
"Descricao": "Transacao cancelada com sucesso",
"Autorizacao": null,
"Status": "Transação Cancelada"
}

Você também pode gostar