Skip to main content
POST
/
api
/
v1
/
pix-keys
curl -X POST 'https://app.plowf.com/api/v1/pix-keys' \
  -H 'Authorization: Bearer seu_token_aqui' \
  -H 'Content-Type: application/json' \
  -d '{ "type": "DOCUMENT" }'

{
  "message": "Chave PIX criada com sucesso.",
  "data": {
    "key": "+5511999999999",
    "type": "PHONE",
    "is_active": true,
    "created_at": "2026-01-19T19:32:14.000000Z"
  }
}
Cria uma nova chave PIX na conta autenticada. 
curl -X POST 'https://app.plowf.com/api/v1/pix-keys' \
  -H 'Authorization: Bearer seu_token_aqui' \
  -H 'Content-Type: application/json' \
  -d '{ "type": "DOCUMENT" }'

​
Validações

  • Para PHONE e EMAIL, auth_code_id e auth_code são obrigatórios — solicite o código antes via auth-code
  • Máximo de 3 chaves por tipo por conta
  • Rate limit: 3 tentativas por 60 segundos por conta
  • provider_uuid, se informado, deve referenciar um provedor NOMINAL existente na conta. Se omitido, o provedor padrão de PIX é usado.

​
Body Parameters

​
type
string
required
Tipo da chave PIX. Valores aceitos: DOCUMENT, EMAIL, PHONE, RANDOM
​
auth_code_id
string
Identificador retornado pelo endpoint de código de autenticação. Obrigatório para PHONE e EMAIL.
​
auth_code
string
Código de 6 dígitos recebido por SMS ou e-mail. Obrigatório para PHONE e EMAIL.
​
provider_uuid
string
UUID do provedor onde a chave será criada. Apenas provedores do tipo NOMINAL (conta dedicada) suportam chaves PIX — provedores POOL são rejeitados. Liste os UUIDs em GET /providers.Quando omitido, a chave é criada no provedor padrão de PIX da conta. Ignorado quando o token está vinculado a um provedor — o provedor do token prevalece.

​
Validações

  • Para PHONE e EMAIL, auth_code_id e auth_code são obrigatórios — solicite o código antes via auth-code
  • Máximo de 3 chaves por tipo por conta
  • Rate limit: 3 tentativas por 60 segundos por conta
  • provider_uuid, se informado, deve referenciar um provedor NOMINAL existente na conta. Se omitido, o provedor padrão de PIX é usado.

​
Resposta de Sucesso

{
  "message": "Chave PIX criada com sucesso.",
  "data": {
    "key": "+5511999999999",
    "type": "PHONE",
    "is_active": true,
    "created_at": "2026-01-19T19:32:14.000000Z"
  }
}
​
message
string
Mensagem de confirmação da criação
​
data
object

​
Erros Comuns