Valores de status, IDs e tipos

Durante o uso das APIs, podem ser observados diversos tipos de valores para status, IDs e outras propriedades. Nesta secção, mostraremos os significados dos valores mais comuns usados nestes campos.

Forma de Pagamento (formaPagamentoId)

Formas de pagamento são os tipos de pagamento aceitos nas intenções de venda da plataforma. Para mais informações sobre elas, acesse a secção "Integrando com o ControlPay".

ID	Significado
11	POS - Crédito
12	POS - Débito
13	POS - Voucher
20	TEF - Genérico
21	TEF - Crédito
22	TEF - Débito
23	TEF - Voucher
24	TEF - Outros
25	TEF - Carteira Digital
41	Dinheiro
51	Link de pagamento Crédito
52	Link de pagamento Débito
53	Boleto

Tipo de Pagamento Externo

Uma mesma intenção de venda por ter múltiplos pagamentos externos: uma venda que posteriormente foi cancelada terá uma intenção de venda (a venda original) e dois pagamentos externos (o pagamento da venda realizado inicialmente e o cancelamento da venda posterior). Sendo assim, há a necessidade de existirem tipos de pagamentos externos, como mostra a tabela a seguir.

ID	Significado
5	Pagamento
10	Cancelamento
15	Administrativo

Status de Cartões de Clientes

Este status se refere aos cartões tokenizados de clientes para uso de transações via link de pagamento / sem cartão presencial.

Valor	Status
1	Token pendente
2	Ativo
3	Duplicado
4	Cancelado
5	Inativo

Status da Intenção de Impressão

Valor	Status
5	Impressão enviada
10	Imprimindo
15	Impresso
20	Expirado
25	Erro de impressão

Status de Intenção de Venda

Valor	Status	Significado
5	Pendente	Transação pendente de pagamento. Somente foi criada e não iniciou nenhum fluxo de pagamento ainda. Transações com este status ainda não tiveram seu processamento iniciado pelo PayGo Windows. Transações criadas sem início automático e que estão com este status, normalmente, podem ser encontradas na tela de "Transações" do PayGo Windows.
6	Em pagamento	Transação já iniciou um processo de pagamento. Esta etapa significa que o PayGo Windows já recebeu a transação e ela está em processamento.
10	Creditado	Pagamento aprovado. A transação foi finalizada e está com seu status final.
15	Expirado	Se é solicitado o "iniciar pagamento automático" e não for possível iniciá-lo, a transação fica com status de expirado após 15 segundos.
18	Cancelamento iniciado	Solicitado o processo de cancelamento. Este status é análogo ao status "Pendente" de uma venda, significando que a requisição de cancelamento foi iniciada mas ainda não teve seu processamento iniciado pelo PayGo Windows (podendo estar em aguardo na tela de "Transações").
19	Em cancelamento	Sistema de pagamento recebeu a solicitação de cancelamento. Esta etapa é análoga ao status "Em pagamento" de uma venda, indicando que o PayGo Windows recebeu o cancelamento e ele está em processamento.
20	Cancelado	Cancelamento concluído. A transação foi cancelada e está com seu status final.
25	Pagamento recusado	Pagamento não aprovado pela adquirente ou banco emissor.

Status do Pagamento Externo

Valor	Status
5	Pendente
10	Em operação
15	Finalizado

Status do Pagamento Recorrente

Valor	Status
5	Agendado
10	Aprovado
15	Negado
20	Cancelado

Status do Pedido

Valor	Status
5	Aberto
6	Aguardando pagamento
10	Pago
15	Cancelado

Status de Produtos

Valor	Status
5	Ativo
10	Inativo