Generate Biometric Pix Widget Access Token

POST {{baseUrl}}/payments/br/token/

Generate an access token for the Biometric Pix widget. You will need to append the access value to the following URL:

https://pix-biometria.pay.belvo.com/?access_token=${accessToken}

If you check the Visualization tab in the response section, we automatically provide you the full URL to direct your users to.

For more information, check out our dedicated Biometric Pix Widget guide.

Request Body

{"use_cases"=>["ENROLLMENT", "PAYMENT_INTENT"], "widget"=>{"enrollment"=>{"type"=>"open_finance_biometric_pix", "details"=>{"name"=>"optional_name_for_enrollment", "customer"=>{"identifier"=>"CPF", "name"=>"user_name"}}, "metadata"=>{"widget_session_token"=>"required_unique_id_for_session"}}, "payment_intent"=>{"amount"=>"amount_as_string", "description"=>"internal_description", "statement_description"=>"display_description", "allowed_payment_method_types"=>["open_finance_biometric_pix"], "payment_method_details"=>{"open_finance_biometric_pix"=>{"beneficiary_bank_account"=>"bank_account_id_to_receive_funds"}}, "metadata"=>{"widget_session_token"=>"required_unique_id_for_session"}}, "callback_urls"=>{"success"=>"url_in_case_of_success", "exit"=>"url_in_case_of_exit_or_error"}, "branding"=>{"color_scheme"=>"LIGHT", "company_name"=>"your_company_name"}}}