API Reference

JWT data structure

The Bazk / INOVAPAY products use a JSON Web Token (JWT) to secure and authenticate the merchant against our services. The endpoint will receive JWT-encoded data generated using SHA256 encryption and a pre-shared secret key.

The data passed to the service must be located within the 'data' segment of the JWT block. Once encrypted, it will be identifiable using the 'jwt' element key in the JSON structure.

All API responses will be returned to the merchant in JWT-encoded format. Valid responses will correspond to HTTP status codes in the 200 range (e.g., 200 or 201).


  • For further references on JWT please follow the link; https://jwt.io/
  • REST API Test Environment URL: To be provided by Bazk / INOVAPAY
  • REST API Production Environment URL: To be provided by Bazk / INOVAPAY

JWT pre-encoded Example - Request

{
  "iat": 1712175617,
  "exp": 1712175677,
  "data": {
    "name": "João Souza",
    "email": "[email protected]",
    "cpf": "123.456.789-10",
    "amount": 100,
    "currency": "BRL",
    "reference": "generated",
    "merchant_user": "user123",
    "country": "BR",
    "buyer_ip": "10.10.20.10",
    "phone": "+55 51 9999-9999",
    "brand": ""
  }
}


JWT pre-encoded Example - Response

{
  "iat": 1637318390,
  "exp": 1637318450,
  "code": 201,
  "data": {
    "id": "100446",
    "currency": "BRL",
    "amount": "200,00",
    "reference": "587980673109",
    "qrCodeText": "00020101021226760014br.gov.bcb.pix2554pix.example.com/qr/v2/9d36b84fc70b478fb95c12729b90ca255204000053039865802BR5922SAFEPAG PAGAMENTOS S A6012PORTO ALEGRE62070503***63048244",
    "qrCodeImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAfQAAAH0AQAAAADjreInAAADY0lEQVR4Xu2UQY7kSAwDC/D//7oPMNDbQUppdx4GyNnLtkBV2U5RDPoi+PP1n+qfz66cVfhdOavwu3JW4XflrMLvylmF35WzCr8rZxV+V84q/K6cVfhdOavwu3JW/xf+/qguna77QtLj+/JBA87LGX4Qr57pJUsdeHjonM4uf/g5/DP77tiUDpDO1IOfzvCzeAzrO6IU5BbAwk/mG5OBs0tuturlDD+KXyk2l+9FdV/O8KP42hP5/vx7bVT4KfxTt74hvUPeHwTYtTarwm/CL+Vvb483Q8a1K+BgNGvQOeFn8NIrScALr2E5nlP4OTyUZ6AdowT7OTOtWweEH8JfQuq/bp1NDp1e4Mjwk/gvM9geH/3Vx5qLu1HDD+LL6RGIb0p6hotdXfgZvDmWx/Pak+9+JXJcOR0Qfgav6WXdzo8+GM2SZ0YvCT+MZ9pWezk4oA3m/Jbws3j8DETjLAOJRHnmF7xDww/hP7hgmXp1VpR1/ZXhc/hBvIe9QT7pkpfI3iBlhx/Gf89lwqIguk7SVAbi9LLw0/jHKFr/FitHWAUZCz+Erwx/HNwAqH+gm3QpHRB+Bu+pCduxOUO7hGNTws/hEVYGAa6VSl6F1i/8JF6AnOZK7DT1r/1pPPwQHp8z7qKxOI3N+qE4Nfw0Xpui7agohFeCAnyFn8dD18AkWY+7oqQTHX4W/xHtcXcIneuf0xsPP4Y3q93Q4mDR/hCzcMU7OvwonqkIHUyqVZQkp3UffhKv6d2Lo5MFQnVpddaOhR/Fo9Tu4HDK3YkIvKLABw8/hGd/CneAlueJ0IEkv0ez8HN49TI7zI+KcpzlFRp+FM/22OZHr4nuS7dLWxZ+Eu8QXED9X25uzEjTs/DwU3jN7dW29NKsy5NasRUQfgrvAfOKsU8ETRHaqYLDj+ELxyYjD7Hgz8DSKyH8DL6LHEzgMEpSREWiMC1/+Df9e3mYxopiW9wX/1kK8/CjePXFYC+3ky/PiepR+GE8W2IDKcBVRTJaW2Y1/Dwe1vSFqtly69yZqvClz+Ftqyx2ZUm6flZ4P38/77vAWiH8QBJ1cK4OFRR+CF/fhR4BAUM4Xb2CdQ4/iv/bCr8rZxV+V84q/K6cVfhdOavwu3JW4XflrMLvylmF35WzCr8rZxV+V87q1/P/ApLHTfREDOwhAAAAAElFTkSuQmCC"
  }
}


JWT encoded within JSON structure

{
  "jwt":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3MTIxNzU2MTcsImV4cCI6MTcxMjE3NTY3NywiZGF0YSI6eyJuYW1lIjoiSm_Do28gU291emEiLCJlbWFpbCI6InVzZXJAZXhhbXBsZS5jb20iLCJjcGYiOiIxMjMuNDU2Ljc4OS0xMCIsImFtb3VudCI6MTAwLCJjdXJyZW5jeSI6IkJSTCIsInJlZmVyZW5jZSI6ImdlbmVyYXRlZCIsIm1lcmNoYW50X3VzZXIiOiJ1c2VyMTIzIiwiY291bnRyeSI6IkJSIiwiYnV5ZXJfaXAiOiIxMC4xMC4yMC4xMCIsInBob25lIjoiKzU1IDUxIDk5OTktOTk5OSIsImJyYW5kIjoiIn19.SZFazrNi-p_9VpgqLABulMOXMnAjx4kEEdabm67xXww"
}