Sign in

e82dca4a4b97

latestOpenAPI 3.0.22026-08-101464031.4 MB
Biometric payments Widget Access Token (Brazil)

Generate a payment widget access token

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

post/payments/br/token/

Request body

use_casesstring[] required

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

  • ENROLLMENT: Use this option to enroll the user's device in the Biometric payments service.
  • PAYMENT_INTENT: Use this option if you want to create a payment for a Biometric payments 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": "jwt_test_ey..........",
  "refresh": "jwt_test_ey.........."
}