commonResponse

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

Atributo 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 (não confundir com o status da transação).
  • 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
transactionStatusLabel

Denominação do status da transação. Os valores possíveis são:

  • INITIAL

    Em andamento.

    Este status é temporário. O status definitivo será retornado assim que a sincronização for realizada.
  • NOT_CREATED

    A transação não foi criada e não está exibida no Back Office Estabelecimento comercial.

  • AUTHORISED

    Captura em andamento.

    A transação foi aceita e será capturada automaticamente no banco na data prevista.
  • AUTHORISED_TO_VALIDATE

    Para ser aprovado.

    A transação, criada em validação manual, foi autorizada. O Estabelecimento comercial deve validar manualmente a captura no banco. A transação pode ser aprovada enquanto a data de captura não for vencida. Se esta data estiver vencida, então o pagamento tem o status Expirado (status definitivo).
  • WAITING_AUTHORISATION

    Autorização em andamento.

    A data de captura solicitada é superior à data de fim de validade da solicitação de autorização.
    Uma autorização de 1 BRL foi realizada e aceita pelo banco emissor. A solicitado de autorização e a captura no banco serão acionadas automaticamente.
  • WAITING_AUTHORISATION_TO_VALIDATE

    Para ser aprovado e autorizado.

    A data de captura solicitada é superior à data de fim de validade da solicitação de autorização.
    Uma autorização de 1 BRL foi realizada e aceita pelo banco emissor. A solicitação de autorização será automaticamente efetuada a D-1 antes da data de captura no banco. O pagamento poderá ser aceito ou recusado. Captura automática no banco.
  • REFUSED

    Recusada.

    A transação foi recusada.
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