Point-of-sale icon

Ativando um cartão vale presente

Ative o cartão vale presente em seu terminal para que o cliente possa usá-lo.

Ao emitir um novo cartão vale presente para um cliente, você precisará fazer uma solicitação de ativação antes que o cartão possa ser usado para transações. Ao ativar o cartão vale presente, você também poderá carregar um saldo inicial.

A ativação do cartão vale presente também é uma ferramenta de proteção contra fraudes. Se o cartão não estiver ativo, ele não poderá ser resgatado.

Quando a solicitação de ativação é processada, você recebe um resultado indicando se a ativação foi bem-sucedida.

Antes de começar

Antes de realizar transações com cartão vale presente, certifique-se de:

Etapa 1: faça a solicitação de ativação

Para ativar um cartão vale presente:

  • Faça uma solicitação POST para o endpoint da API de terminais , especificando:

    • MessageHeader: Segue a estrutura da MessageHeader padrão, explicada nos fundamentos da API de terminais, que incluem:

      • ProtocolVersion: 3.0
      • MessageCategory: StoredValue
      • MessageType: Request
      • SaleID: Seu ID exclusivo para a caixa registradora.
      • ServiceID: Seu ID exclusivo para esta tentativa de transação. Este precisa ser único nas últimas 48 horas
      • POIID: ID exclusivo do terminal. Isso indica para qual terminal a transação será roteada.

    • StoredValueRequest: O corpo da solicitação enviada para a solicitação de ativação deve incluir:

      • SaleData.SaleTransactionID.TransactionID: Sua referência exclusiva para esta solicitação.

      • SaleData.SaleTransactionID.TimeStamp: Data e hora da solicitação, no formato UTC.

      • StoredValueData.StoredValueTransactionType: Activate

      • StoredValueData.StoredValueAccountID: Os detalhes do cartão vale presente:

        • StoredValueAccountType: GiftCard
        • StoredValueProvider: O emissor do cartão vale presente: givex, svs, ou valuelink
        • IdentificationType: PAN
        • EntryMode, StoredValueID e ExpiryDate: Esses parâmetros dependem do metodo de leitura do cartão que você está usando.

          Entrada do cartão Parâmetros
          Scan
          • EntryMode: Scanned
          • StoredValueID: Número do cartão vale presente.
          • ExpiryDate: Data de validade do cartão vale presente.
          Swipe or MKE
          • EntryMode: MagStripe
          • StoredValueID: xxxxxxxxxxxxxxxxxxx.
          • Não inclua o ExpiryDate parâmetro.
      • StoredValueData.ItemAmount: Saldo inicial sendo carregado no cartão vale presente

      • StoredValueData.Currency: Moeda do saldo inicial.

    O exemplo abaixo mostra como você ativaria um cartão vale presente utilizando a leitura por scanner, adicionando um saldo inicial de GBP 10,00.

    Para obter mais informações sobre a estrutura de solicitação da API de terminais, consulte os fundamentos da API de terminais.

A solicitação de ativação é enviada à plataforma de pagamentos da Adyen para processamento.

Etapa 2: recebendo o resultado da ativação

Depois de processada, sua integração recebe um resultado de ativação indicando se o cartão vale presente foi ativado com sucesso. Isso é fornecido em uma resposta de API síncrona, a menos que sua integração use comunicações em nuvem assíncronas.

Se sua integração usar comunicações em nuvem assíncronas, você receberá o resultado em uma notificação de exibição TENDER_FINAL

Se a ativação for bem-sucedida:

  • • Você receberá uma resposta com um objeto StoredValueResponse que inclui:

    • POIData.POITransactionID.TransactionID: Identificador da transação para a ativação do cartão vale presente.

    • StoredValueResult:

      • StoredValueTransactionType: Activate
      • ItemAmount e Currency: saldo atual e moeda associados ao cartão.

    • Response.Result: Success

    O exemplo abaixo indica que o cartão vale presente foi ativado com sucesso, e o cartão foi carregado com um saldo inicial de GBP 10,00.

    Para obter mais informações sobre a estrutura de resposta da API de terminais, consulte os fundamentos da API de terminais.

    {
      "SaleToPOIResponse":{
        "StoredValueResponse":{
          "POIData":{
            "POITransactionID":{
              "TimeStamp":"2019-03-26T09:31:29.000Z",
              "TransactionID":"oLkO001522056689002.9815220566972551"
            }
          },
          ...
          "StoredValueResult":[
            {
              "StoredValueTransactionType":"Activate",
              "ItemAmount":10.00,
              "Currency":"GBP"
            }
          ],
          "Response":{
            "Result":"Success"
          }
        },
        "MessageHeader":{
          "ProtocolVersion":"3.0",
          "SaleID":"POSSystemID12345",
          "MessageClass":"Service",
          "MessageCategory":"StoredValue",
          "ServiceID":"9264",
          "POIID":"V400m-324688179",
          "MessageType":"Response"
        }
      }
    }

Next steps

Veja também