APIs - merci-app/whatsapp-pay-docs GitHub Wiki

Seguem abaixo as APIs de tokenização necessárias para a integração entre WPP e o app do emissor e que devem ser acessíveis via BFF.

Get cards

Obtém os detalhes de um cartão.


Card information

Obtém o panReferenceID relacionado a um cardID.


Token list

Obtém os tokens relacionados a um panReferenceID. O parâmetro pan-reference-id pode ser obtido pela API Card information.


Token details

Obtém os detalhes de um token.

  • Param pan-reference-id: pode ser obtido pela API Card information.
  • Param token-reference-id: pode ser obtido pela API Token list.

Ao combinar esta API com a API Token List, é possível consultar o status de um cartão em cada Wallet (WPP, Apple Pay, etc).


Token activation

Ativa um token.

Algumas informações necessárias para executar a API são obtidas pelo mobile:

  • pan-reference-id
  • token-reference-id
  • deviceIndex
  • deviceID

As informacões do payload audit são de responsabilidade do emissor. Devem ser informados os dados da sessão de usuário e o nome da organização (emissor).

Observação: Ao ativar o token para WPP, é necessário também ativar o device. Para isso, é preciso adicionar operationType=deviceBinding como query param. Assim, a URL fica pans/{pan-reference-id}/tokens/{token-reference-id}/activate?operationType=deviceBinding.

Importante: Ao implementar esta API, o BFF deve se certificar de que o portador vinculado à sessão/bearer é o owner do token que está sendo ativado. Caso negativo, a operação deve ser abortada.

Para isso, pode-se seguir os passos a seguir:

  1. Obter o idCard a partir do pan-reference-id, utilizando a API Card information
  2. Carregar os detalhes do cartão e verificar se o idPessoa é igual ao vinculado à sessão ativa
  3. Executar outras validações antifraude adequadas

APIs de token lifecycle

Token suspend Token unsuspend Delete token