GiftCard Provider Protocol - Compreensão dos endpoints de Cancelamento

Olá, estamos ajustando uma integração de provedor de GiftCard e surgiu uma dúvida à respeito dos endpoints de cancelamento de um GiftCard.

Hoje, temos dois endpoints de cancelamento:

  • List All GiftCard Transactions Cancellations
  • Create GiftCard Transaction Cancellation

O endpoint de criação de um cancelamento é bem claro quanto a seu funcionamento.

Quanto ao endpoint de listagem dos cancelamentos de um GiftCard, não ficou claro qual seria o objetivo, poderiam auxiliar com este entendimento?

No contrato do endpoint de listagem de cancelamentos, o resultado esperado é o seguinte:

[
  {
    "oid": "",
    "value": 0.0,
    "date": ""
  }
]

A idéia seria que caso já tenhamos um cancelamento processado para este giftcard, que o valor seja retornado neste endpoint?

Exemplo:

  1. O pedido é realizado, utilizando um GiftCard no valor de R$100,00.
  2. O participante solicita o cancelamento parcial do pedido.
    2.1. VTEX requisita nosso endpoint de Listagem de Cancelamentos, que deve retornar um array vazio, visto que ainda não foi realizado nenhum cancelamento para aquele GiftCard.
    2.2. VTEX requisita nosso endpoint de criação de um cancelamento, informando o valor cancelado.
    2.3. Nós (provedor de GiftCard), processamos o cancelamento
  3. Participante solicita um novo cancelamento
    3.1. VTEX requisita nosso endpoint de Listagem de Cancelamentos, que deve retornar um item com o valor cancelado no item 2.2.
    3.2. VTEX requisita nosso endpoint de cancelamento informando o novo valor cancelado.

Seria este o fluxo?
Caso não, poderiam ajudar a entender melhor como deve funcionar este endpoint de listagem de cancelamentos?

Obrigado

2 Likes