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".

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

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.

IDSignificado
5Pagamento
10Cancelamento
15Administrativo

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.

ValorStatus
1Token pendente
2Ativo
3Duplicado
4Cancelado
5Inativo

Status da Intenção de Impressão

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

Status de Intenção de Venda

ValorStatusSignificado
5PendenteTransação pendente de pagamento. Somente foi criada e não iniciou nenhum fluxo de pagamento ainda.
6Em pagamentoTransação já iniciou um processo de pagamento.
10CreditadoPagamento aprovado.
15ExpiradoSe é 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.
18Cancelamento iniciadoSolicitado o processo de cancelamento.
19Em cancelamentoSistema de pagamento recebeu a solicitação de cancelamento.
20CanceladoCancelamento concluído.
25Pagamento recusadoPagamento não aprovado pela adquirente ou banco emissor.

Status do Pagamento Externo

ValorStatus
5Pendente
10Em operação
15Finalizado

Status do Pagamento Recorrente

ValorStatus
5Agendado
10Aprovado
15Negado
20Cancelado

Status do Pedido

ValorStatus
5Aberto
6Aguardando pagamento
10Pago
15Cancelado

Status de Produtos

ValorStatus
5Ativo
10Inativo