Criação de um Token na contratação de uma assinatura seguida de um pagamento

Para entender o resultado, analise os campos abaixo:

Nome do campo Descrição
vads_page_action Ação realizada.

O valor retornado é REGISTER_PAY_SUBSCRIBE.

vads_identifier_status Status da criação do Token Catão.

Os valores possíveis são:

  • CREATED: a solicitação de autorização foi aceita.

    O Token foi criado com sucesso.

    Consulte o valor do campo vads_recurrence_status para saber se a assinatura foi criada.

  • NOT_CREATED: a solicitação de autorização foi recusada.

    O Token não foi criado e não será exibido no Back Office EC. A assinatura não foi criado.

  • ABANDONED : O comprador desistiu da ação.

    O Token não foi criado e não está exibido no Back Office EC.

    A assinatura não foi criado.

vads_trans_status Status da transação.

Os valores possíveis são:

  • AUTHORISED

    A solicitação de autorização ou de informação foi aceita.

    O Token foi criado e pode ser consultado no Back Office EC.

  • AUTHORISED_TO_VALIDATE

    A solicitação de autorização ou de informação foi aceita.

    O Estabelecimento Comercial deve validar manualmente a transação.

    O Token foi criado e pode ser consultado no Back Office EC.

  • CAPTURED

    A solicitação de autorização ou de informação foi aceita.

    O pagamento está exibido na aba “Transações capturadas” do Back Office.

    O Token foi criado e pode ser consultado no Back Office EC.

  • WAITING_AUTHORISATION

    O prazo de captura no banco é maior que o tempo de validade da autorização. A solicitação de autorização para o valor total ainda não foi feita.

    O Token foi criado e pode ser consultado no Back Office EC.

  • WAITING_AUTHORISATION_TO_VALIDATE

    Para validar e autorizar

    O prazo de captura no banco é maior que o tempo de validade da autorização.

    Uma autorização 1 BRL foi aceita.

    O Estabelecimento Comercial deve validar manualmente a transação para lançar a solicitação de autorização e a captura.

  • REFUSED

    A solicitação de autorização ou de informação foi recusada.

    O Token não foi criado.

  • ABANDONED

    O comprador desistiu da operação.

    A transação não está exibida no Back Office EC.

    O Token não foi criado.

vads_recurrence_status Status da criação da assinatura.

Os valores possíveis são:

  • CREATED: A assinatura foi criada com sucesso.
  • NOT_CREATED: A assinatura não foi criado.
  • ABANDONED : O comprador desistiu da ação. A assinatura não foi criado.
vads_identifier Código do Token.
O valor retornado é:
  • ou idêntico ao valor enviado na solicitação, seja qual for o resultado da criação do Token, mesmo em caso de desistência,
  • ou o valor gerado pela plataforma, se o campo não for enviado na solicitação e que o Token for criado com sucesso (vads_identifier_status=CREATED).

Observação

Se você ativou a verificação da unicidade dos Tokens e que o meio de pagamento já foi salvou com outro Token, este último será o Token retornado.

O campo vads_identifier não será retornado:
  • se não for enviado na solicitação e se o comprador desiste (vads_identifier_status=ABANDONED),
  • se não for enviado na solicitação e se o Token não for criado (vads_identifier_status=NOT_CREATED).
vads_identifier_previously_registered Somente presente se as duas condições forem verdadeiras:
  • você ativou a verificação da unicidade dos Tokens,
  • o meio de pagamento usado já foi salvou com outro Token.
vads_cust_email Endereço e-mail do comprador enviado na solicitação.
vads_site_id Código de identificação da loja.

O valor retornado é idêntico ao valor enviado na solicitação.

vads_ctx_mode Modo de funcionamento.

O valor retornado (TEST ou PRODUCTION) é idêntico ao valor enviado na solicitação.

Para ter o detalhe da assinatura, consulte as dados abaixo:
Nome do campo Observação
vads_subscription Código de identificação da assinatura.
O valor retornado é:
  • ou o valor enviado na solicitação, seja qual for o resultado da criação da assinatura,
  • ou o valor gerado pela plataforma de pagamento, se o campo não for enviado com a solicitação e que a assinatura for criada com sucesso (vads_recurrence_status=CREATED).
O campo vads_subscription não será retornado:
  • se não for enviado na solicitação e se o comprador desiste (vads_recurrence_status=ABANDONED),
  • se não for enviado na solicitação e se a assinatura não for criado (vads_recurrence_status=NOT_CREATED).
vads_sub_amount

Valor das parcelas da assinatura (na sua menor unidade monetária).

vads_sub_currency Código da moeda usada para a assinatura.

Ex: 986 para o Real do Brasil (BRL)

vads_sub_desc Regra de recorrência a ser aplicada segundo a especificação iCalendar RFC5545.

Ex: RRULE:FREQ=MONTHLY

vads_sub_effect_date Data de início da assinatura (o data de vigência) no fuso UTC no formato AAAAMMJJ.

Ex: 20210601

vads_sub_init_amount

Valor das primeiras parcelas. A quantidade das primeiras parcelas é definido por vads_sub_init_amount_number.

Ex: 1000

vads_sub_init_amount_number Quantidade de parcelas nas quais será aplicado o valor definido por vads_sub_init_amount.

Ex: 3

Para ter o detalhe do pagamento, consulte os dados abaixo:

Informações sobre a transação:

Nome do campo Descrição
vads_operation_type Tipo de transação.

Seu valor é DEBIT.

vads_occurrence_type Tipo de ocorrência da transação.

Seu valor é UNITAIRE.

vads_amount Valor da transação.

O valor retornado é idêntico ao valor enviado na solicitação.

vads_currency Código da moeda usada para o pagamento.
vads_trans_id Código da transação

O valor retornado é idêntico ao valor enviado na solicitação.

vads_trans_uuid Código único da transação.

O valor dele é gerado pela plataforma de pagamento

vads_contract_used Número do contrato associado à transação.
vads_auth_mode Tipo de solicitação realizado para os servidores de autorização:
  • MARK : corresponde a uma autorização de 1 BRL.

    Valor também usado se o tempo entre a data de captura solicitada e a data do vigente for exatamente superior ao tempo de validade da autorização.

  • FULL: corresponde a uma autorização do valor total da transação.

    Valor usado se o tempo entre a data de captura solicitada e a data vigente for exatamente inferior ao tempo de validade da autorização.

vads_auth_number Número de autorização retornado pelo servidor de autorização.

Vazio se a autorização falhou.

vads_auth_result Código retorno da solicitação de autorização devolvida pelo banco emissor.

Vazio se erro antes da autorização.

vads_risk_control Resultado dos controles de risco.

Quando pelo menos um controle retorna o valor ERROR, a transação é recusada.

Consulte a descrição do campo vads_risk_analysis_result para maiores detalhes.

vads_risk_assessment_result

Lista das ações realizadas na transação, após o acionamento das regras de gerenciamento de risco avançado.

Os valores possíveis são:

  • ENABLE_3DS: 3D Secure ativado.
  • DISABLE_3DS: 3D Secure desativado.
  • CHALLENGE_REQUESTED:
    • Cartão 3DS1: O módulo de risco solicitou uma autentificação 3DS.
    • Cartão 3DS2: O módulo de risco solicitou uma autentificação com interação do portador (challenge).
  • CHALLENGE_MANDATE:
    • Cartão 3DS1: O módulo de risco solicitou uma autentificação 3DS.
    • Cartão 3DS2: O módulo de risco solicitou uma autentificação com interação do portador (challenge) por razões legais.
  • MANUAL_VALIDATION: Transação criada em validação manual.

    A captura do pagamento está bloqueada temporariamente para permitir ao Estabelecimento Comercial efetuar todas as verificações desejadas.

  • REFUSE: A transação foi recusada.
  • RUN_RISK_ANALYSIS: Resultado do analista de riscos externos.

    Consulte a descrição do campo vads_risk_analysis_result para maiores detalhes.

  • INFORM: Um aviso foi enviado.

    O Estabelecimento Comercial é avisado que um risco foi identificado por uma ou mais regras do centro de notificação.

Informações sobre o meio de pagamento usado:
Nome do campo Observação
vads_acquirer_network Código da rede adquirente.
vads_bank_code Código do banco emissor
vads_bank_label Nome do banco emissor do cartão usado.
vads_bank_product Código produto do cartão usado.
vads_card_brand Meio de pagamento usado.

Consulte o capítulo Meios de pagamento compatíveis para ter a lista dos valores possíveis.

vads_card_country Código país do cartão usado segundo a norma ISO 3166.
vads_card_number Número do cartão truncado / oculto.
vads_expiry_month Mês de vencimento do cartão usado.  É recomendável usar esses dados para verificar a data de validade do alias.
vads_expiry_year Ano de vencimento do cartão usado.  É recomendável usar esses dados para verificar a data de validade do alias.
Detalhes de autenticação do portador:
Nome do campo Observação
vads_threeds_auth_type Tipo de autenticação do portador.

Uma autenticação forte do portador é obrigatória quando salvar um cartão. O campo terá então sempre o valor CHALLENGE.

vads_threeds_enrolled

Status de inscrição do portador ao programa 3D Secure.

Os valores possíveis são:
  • Y: Autenticação disponível.
  • N: Autenticação não disponível.
  • U: Status de inscrição ao programa 3DS Secure desconhecido.
  • vazio: Processo 3DS não realizado (3DS desativado na solicitação, Estabelecimento Comercial não inscrito ou meio de pagamento não elegível no 3DS).
vads_threeds_status Resultado da autenticação 3D Secure.
Os valores possíveis são:
  • Y: Portador identificado com sucesso.
  • N: Erro de autenticação do portador.
  • U: Autenticação impossível.
  • A: Tentativa de autenticação mas autenticação não efetuada.
  • vazio: Autenticação 3DS não realizada (3DS desativado na solicitação, portador não inscrito ou meio de pagamento não elegível no 3DS).

Os campos facultativos enviados na solicitação são retornados na resposta com os mesmos valores.