commonResponse

O objeto commonResponse permite obter informações gerais sobre uma operação.

Os atributos que contém um valor na resposta são os seguintes:

Tabela 1. Objeto commonResponse
commonResponse Formato

responseCode

Consultar o capítulo Gerenciar os erros de aplicação.

Primeiro atributo para analisar seja qual for a operação.

  • O valor 0 indica que a operação foi realizada com sucesso.
  • Um valor diferente de 0 requer uma análise do atributo responseCodeDetails. Este último apresenta a origem do erro.
n..2
responseCodeDetail

Detalhe do erro se o atributo responseCode é diferente de 0.

Consultar o capítulo Gerenciar os erros de aplicação para maiores informações.

string
shopId

Código da loja.

n8
paymentSource

Origem da transação. Os valores possíveis são:

  • EC para o comércio eletrônico.
  • MOTO para um pedido por e-mail ou telefone.
  • CC para um call center.
  • OTHER para um outro canal de venda.
string (enum)
submissionDate

Data e hora UTC da transação apresentadas em formato W3C (exemplo: 2016-07-16T19:20:00Z).

dateTime ans..40
contractNumber

Número de contrato comerciante utilizado.

string
paymentToken

Token Cartão.

string

O atributo transactionStatusLabel, não é informado nesta operação.