Dicionário de dados

O dicionário de dados apresenta a lista completa dos campos que podem ser utilizados no formulário de pagamento.

Detalha inicialmente as principais categorias (tais como as informações técnicas, as informações do pedido…). O conjunto dos campos que pertencem à uma categoria são apresentados.

Estas tabelas são apresentadas da seguinte maneira:

  • Nome do campo: nome do parâmetro, como ele será usado em um pedido HTTP.
  • Formato: formato dos dados
  • Descrição: descrição do campo
  • Entrada: caracteriza um campo a enviar no pedido
  • Saída: caracteriza um campo enviado na resposta

O dicionário de dados apresenta em seguida o detalhe para cada um dos campos. Cada campo é descrito da seguinte maneira:

  • Descrição: descrição do campo
  • Formato: formato dos dados (ver quadro acima Lista de campos e formatos)
  • Valores possíveis: valores esperados quando o campo é valorizado com valores específicos
  • Exemplo: exemplo de codificação correta dos dados
  • Código de erro: em caso de erro na interface entre o site de e-commerce e a plataforma de pagamento, esta última indicará com um código numérico o parâmetro errado no campo vads_extra_result
  • Observação: informações adicionais, precisões
  • Categoria: categoria com a qual o campo esta vinculado

Detalhes de códigos de erro:

Código de erro corresponde ao número de erro quando for apresentado um formulário de pagamento incorreto.

  • Em modo teste este código será exibido na página de pagamento.
  • Em modo produção um e-mail de alerta será enviado precisando o código de erro e o nome do parâmetro incorreto.

Exemplo: Erro 09 corresponde a um erro sobre o valor. O valor enviado não está conforme ao formato requerido.