Introdução

Integração Voucher

Nossas APIs oferecem suporte à integração com as principais bandeiras de vouchers:

  • Pluxee
  • VR
  • Ticket
  • Alelo (Em breve 🔜)


1. Tokenizar cartão voucher


Tokenização bandeiras: Pluxee e VR

Para Pluxee e VR, o primeiro passo é converter os dados sensíveis do cartão em um token seguro utilizando a API de tokenização.
Esse token será utilizado nas operações de cobrança.

Endpoint

POST /api/v2/sellers/{sellerId}/vouchers/tokens

Exemplo:

curl --request POST \
     --url https://apisandbox.bempaggo.io/api/v2/sellers/1/vouchers/tokens \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "cardType": "FOOD",
  "cardBrand": "TICKET", 
  "cardNumber": "0000000000000000",
  "cvv": "444",
  "expires": {
    "month": 10,
    "year": 34
  },
  "holder": {
    "name": "John Snow",
    "document": "07855143092"
  }
}
'

Tokenização bandeira Ticket

Para simplificar a integração com a Ticket, o Bempaggo encapsula a criação da URL da bandeira ticket/connect/authorize.
O integrador apenas informa a URL de notificação (webhook) e recebe de volta a URL de autorização pronta para ser aberta no navegador do usuário.

Resumo do fluxo

  1. Integrador chama o endpoint POST /api/v2/sellers/1/vouchers/{sellerId}/ticket/tokens com a notificationUrl no body.
  2. Bempaggo retorna um response com o atributoauthUrl montada (com response_type=code, client_id, scope, redirect_uri, acr_values, etc.).
  3. Integrador renderiza o atributo authUrl no navegador do usuário.
  4. Usuário autentica-se na Ticket → Ticket redireciona para o redirect_uri gerenciado pela Bempaggo.
  5. Bempaggo troca code por tokens e dispara um webhook para notificationUrl com o token utilizável na cobrança para o integrador.

2. Criar autorização

Com o token do cartão, você pode realizar uma cobrança no voucher.

Endpoint

POST /api/v2/sellers/{sellerId}/vouchers/payments

Exemplo:

curl --request POST \
     --url https://apisandbox.bempaggo.io/api/v2/sellers/1/vouchers/payments \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
   "amount":1000,
   "installments":1,
   "referenceId":"1756301592483",
   "card":{
      "cardType":"FOOD",
      "cardBrand":"PLUXEE",
      "token":"635dc2b1-3487-46d7-af08-17953498ccbf"
   },
   "customer":{
      "document":"07855143092",
      "name":"John Snow"
   }
}
'