Identificadores

Campos da API: payment.id, transaction.id, order.id

Existem 3 campos diferentes com a função de identificação. Embora parecidos, cada um tem um papel distinto na plataforma.

• Pagamento: representa o código do pagamento. Deve ser informado na criação de um pagamento e usado na atualização posterior do mesmo pagamento. Normalmente este é um código interno que será usado para agrupar retentativas automáticas de transação. Se não for informado, um código será gerado pela plataforma.
• Transação: código opcional da transação. Representa uma tentativa de comunicação com uma instituição financeira. Você deve enviar um código interno do seu sistema sempre que possível. Caso contrário, envie uma concatenação do código do conector mais o código único gerado pelo conector (TID, NSU, etc). Por exemplo: 31231-9957812331231. Ainda assim, se não for possível gerar um código único, não envie o campo.
• Pedido: código opcional do pedido (mensalidade, carrinho, etc). Este código será usado para rastrear retentativas realizadas em múltiplos pagamentos diferentes.

Entendemos que muitas vezes nem todas essas informações estão disponíveis e que uma solução natural é repetir o mesmo código duas ou até três vezes nos campos acima. Não recomendamos essa prática, pois os campos são opcionais. Quando a informação não estiver disponível, evite enviar dados apenas para preencher o campo.

Se o mesmo código for enviado repetido em vários campos, poderão haver consequências na qualidade da análise. Por exemplo: quando o identificador do pedido recebe o mesmo valor que o identificador do pagamento, a plataforma irá reportar erroneamente que a quantidade de tentativas por compra é sempre 1. Nesse caso, a solução ideal é buscar algum identificador que represente o pedido (ou mensalidade, etc) em todos os pagamentos que o cliente (ou sistema) possa vir a realizar.

Em último caso, se não for possível obter uma informação confiável, não envie o campo opcional. Dessa forma, as análises não serão afetadas negativamente por dados que não representam a realidade.