Sign in

v1

latestOpenAPI 3.0.22026-08-061464031.4 MB
Biometric Pix Widget Access Token (Brazil)

Generate a payment widget access token

Generate a payment widget access token for the Biometric Pix enrollment or payment process.

post/payments/br/token/

Request body

use_casesstring[] required

The use case of the Biometric Pix widget. You can choose:

  • ENROLLMENT: Use this option if you want to enroll you user's device in the Biometric Pix service.
  • PAYMENT_INTENT: Use this option if you want to create a payment for a Biometric Pix transaction.

📘 Using the widget for both enrollment and payments.

If you pass both the ENROLLMENT and PAYMENT_INTENT use cases, the widget will first enroll the user and then create a payment intent.

Example request

{
  "use_cases": [
    "ENROLLMENT",
    "PAYMENT_INTENT"
  ],
  "widget": {
    "enrollment": {
      "type": "open_finance_biometric_pix",
      "external_id": "4b8a81a0-e33c-45a6-8567-479efb105f73",
      "details": {
        "name": "600f1b4a-Mobile",
        "customer": "c860809f-e96d-4d50-9588-f40ffab77302",
        "institution": "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0"
      },
      "metadata": {
        "internal_reference_id": "GGq73487w2"
      }
    },
    "payment_intent": {
      "amount": "1234.12",
      "external_id": "4b8a81a0-e33c-45a6-8567-479efb105f73",
      "description": "Shoe payment",
      "statement_description": "Super Shoe Store - Brown Sneakers",
      "allowed_payment_method_types": [
        "open_finance_biometric_pix"
      ],
      "payment_method_details": {
        "open_finance_biometric_pix": {
          "beneficiary_bank_account": "a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc",
          "enrollment": "7dc245e3-5f75-4534-bafa-431fc0893593"
        }
      },
      "metadata": {
        "internal_reference_id": "GGq73487w2"
      }
    },
    "callback_urls": {
      "success": "your_deeplink_here://success",
      "exit": "your_deeplink_here://exit"
    },
    "branding": {
      "color_scheme": "LIGHT",
      "company_name": "Acme Inc."
    },
    "top_tier_institutions": [
      "nubank_retail",
      "picpay_retail",
      "mercadopago_retail",
      "itau_retail"
    ],
    "theme": [
      {
        "css_key": "--color-primary-base",
        "value": "#907AD6"
      }
    ]
  }
}

Response

Successful operation

accessstring

The access token to be used to authenticate the widget.

refreshstring

The refresh token to be used to authenticate the widget.

Example response

{
  "access": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzI3MzYwMTk1LCJpYXQiOjE3MjczNTg5OTUsImp0aSI6ImRhN2Q3OTM1ZDZlZTQ0MTBhYTMwYTc3NWQ1OWMxZWIzIiwidXNlcl9pZCI6IjZlOWJlODg0LTQ3ODEtNDE0My1iNjczLWFjYTAyNDc1ZWU4YyIsIm9yZ2FuaXphdGlvbl9uYW1lIjoiRG9taW5payBDaG9sZXdza2kncyB0ZWFtIiwib3JnYW5pemF0aW9uX2lkIjoiNmU5YmU4ODQtNDc4MS00MTQzLWI2NzMtYWNhMDI0NzVlZThjIiwic2NvcGVzIjpbInJlYWRfaW5zdGl0dXRpb25zIiwid3JpdGVfbGlua3MiXSwiZW52aXJvbm1lbnQiOiJzYW5kYm94IiwiYXBpX3VybCI6InNhbmRib3guYmVsdm8uY29tIiwiY3JlZGVudGlhbHNfc3RvcmFnZSI6IjMwZCIsInN0YWxlX2luIjoiMzY1ZCIsImZldGNoX3Jlc291cmNlcyI6WyJPV05FUlMiLCJFTVBMT1lNRU5UUyJdLCJpc3MiOiJzYW5kYm94LmJlbHZvLmNvbSJ9.DaQ8xVTEjA4BD-0SbBCQDylO3NrjhsHiWXTaoPdKWRucS2E0jxNUHC5lwrejrz73-GytgcXTeiI1fhZBYW719A",
  "refresh": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MjM0OTQzODk5NSwiaWF0IjoxNzI3MzU4OTk1LCJqdGkiOiI2YmUyMGFmNTcxZDU0NjQzYjA0Y2U3YTVhNjI5ZDRiMSIsInVzZXJfaWQiOiI2ZTliZTg4NC00NzgxLTQxNDMtYjY3My1hY2EwMjQ3NWVlOGMiLCJvcmdhbml6YXRpb25fbmFtZSI6IkRvbWluaWsgQ2hvbGV3c2tpJ3MgdGVhbSIsIm9yZ2FuaXphdGlvbl9pZCI6IjZlOWJlODg0LTQ3ODEtNDE0My1iNjczLWFjYTAyNDc1ZWU4YyIsInNjb3BlcyI6WyJyZWFkX2luc3RpdHV0aW9ucyIsIndyaXRlX2xpbmtzIl0sImVudmlyb25tZW50Ijoic2FuZGJveCIsImFwaV91cmwiOiJzYW5kYm94LmJlbHZvLmNvbSIsImNyZWRlbnRpYWxzX3N0b3JhZ2UiOiIzMGQiLCJzdGFsZV9pbiI6IjM2NWQiLCJmZXRjaF9yZXNvdXJjZXMiOlsiT1dORVJTIiwiRU1QTE9ZTUVOVFMiXSwiaXNzIjoic2FuZGJveC5iZWx2by5jb20ifQ.T-tnX2BwAjQI0MaYCO686bZD6H7EMIgi_CbOWtHDexGIiTKLer0d7RJGisXJqM6oA_L4y_A_774LEj8NNb7YXQ"
}