---
title: "Cadastrar chave Pix"
method: POST
path: "/brazil/pix_banking/onetime/initialize-enrollment"
tags: ["Pix"]
---

# Cadastrar chave Pix

`POST /brazil/pix_banking/onetime/initialize-enrollment`

## Request

- Base URL: `https://api.trytoku.com`
- URL: `https://api.trytoku.com/brazil/pix_banking/onetime/initialize-enrollment`
- Auth: API key in header `x-api-key`

Cadastra uma chave Pix para um Customer e devolve o Payment Method resultante.

## Request body

- EnrollPixPayload: Dados para cadastrar a chave Pix com que um Customer vai pagar.
  - `external_id` string, required: Identificador da chave no seu sistema. Serve para reaproveitar uma chave já cadastrada.
  - `gateway` string, required: PSP em que a chave Pix será criada.
  - `id_account` string, required: Identificador da Account que recebe os pagamentos feitos na chave.
  - `id_customer` string, required: Identificador do Customer a quem a chave Pix pertence.
  - `id_subscription` string, required: Identificador da Subscription à qual associar a chave. Precisa ser do Customer indicado.
  - `is_sandbox` boolean: Quando `true`, a chave é criada em ambiente de demonstração, sem efeito em produção.

## Response `200`

Successful Response

- EnrollPixResponse: Payment Method resultante do cadastro da chave Pix.
  - `id_payment_method` string, required: Identificador do Payment Method que representa a chave Pix cadastrada.

## Other responses

- `401`: As credenciais não foram enviadas ou não são válidas.
- `403`: As credenciais usadas não dão acesso a este recurso.
- `404`: A Organization da Account não tem um produto Pix configurado.
- `422`: A Account, o Customer ou a Subscription não existem, ou a Subscription não é do Customer indicado.
- `429`: O limite de requisições permitidas foi excedido.

## Changes

- **2026-11-03** `a6ef070075b1`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/trytoku/apis/toku-api/changes/brazil/pix_banking/onetime/initialize-enrollment/post.md)

---

[API](https://skmtc.dev/trytoku/apis/toku-api.md) - [All operations](https://skmtc.dev/trytoku/apis/toku-api/llms.txt) - [OpenAPI document](https://skmtc.dev/trytoku/apis/toku-api/revisions/a6ef070075b1?raw)
