Pular para o conteúdo principal

ControlPay

Esta página descreve como o sistema Plasfran ERP se integra com o ControlPay para processar cobranças eletrônicas, pagamentos via TEF (maquininha) e conciliação financeira automatizada.

Visão Geral​

A integração com o ControlPay permite:

  • Emissão de cobranças com cartão de crédito/débito
  • Acompanhamento do status das transações
  • Integração com maquininhas físicas (TEF)
  • Conciliação automática com o sistema financeiro do ERP

Endpoints - Operacional​

1. Login​

Endpoint:
POST /Login/Login

Descrição:
Este endpoint é utilizado para autenticar um usuário na plataforma ControlPay e obter uma chave de integração (key) temporária. Essa chave é necessária para autenticar as demais requisições à API.

2. Inserir Terminal​

Endpoint:
POST /Terminal/Insert?key={key}

Descrição:
Este endpoint permite cadastrar um novo terminal de pagamento associado a uma pessoa (usuário) no sistema ControlPay.

3. Consultar Terminais por Pessoa​

Endpoint:
POST /Terminal/GetByPessoaId?key={key}&pessoaId={pessoaId}

Descrição:
Este endpoint retorna a lista de terminais de pagamento associados a uma determinada pessoa no sistema ControlPay.

Endpoints - Transacional​

1. Realizar Venda​

Endpoint:
POST /Venda/Vender/?key={{Key}}

Descrição:
Realiza uma venda no sistema ControlPay utilizando os dados da intenção de venda.

2. Cancelar Venda​

Endpoint:
POST /Venda/CancelarVenda?key={{Key}}

Descrição:
Cancela uma venda existente no sistema ControlPay.

3. Consultar Intenções de Venda por Filtro​

Endpoint:
POST /IntencaoVenda/GetByFiltros?key={{Key}}

Descrição:
Retorna uma lista de intenções de venda filtradas por critérios como data, status e terminal.

Callback Intenção de venda​

Endpoint:
POST seusite.com.br/seuservico?cpfCnpj={{CpfCnpj}}&intencaoVendaId={{ControlPayId}}&intencaoVendaReferencia={{SeuId}}&pedidoId={{ControlPayPedidoId}}&pedidoReferencia={{SeuPedidoId}}

Descrição:
Esse endpoint é utilizado como callback (retorno) enviado pela API da ControlPay após a conclusão de uma venda ou atualização de status de uma intenção de venda. Ele notifica seu sistema com os identificadores da transação para que você possa atualizar os registros internos.

Documentação oficial ControlPay​

https://docs.controlpay.com.br/