Cadastrar chave pix

Em desenvolvimento

POST

/accounts/{userId}/pix-keys/

POR QUE FICAR EM ACCOUNTS?

Gerenciar o perfil do usuário e suas configurações pessoais é responsabilidade de accounts, incluindo identificadores financeiros como chaves PIX para recebimento.

A chave PIX é um dado pessoal e financeiro do usuário que ele gerencia em seu perfil, assim como um endereço ou um número de telefone. A responsabilidade é sobre o "quem" (o usuário e seu perfil), e não sobre o "como" o dinheiro é transacionado.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/accounts//pix-keys/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "CPF",
    "value": "123.456.789-00",
    "description": "Meu CPF principal para recebimentos"
}'

Response Example

200 - Example 1

{
    "message": {
        "title": "Chave PIX Cadastrada",
        "text": "Sua chave PIX foi adicionada com sucesso.",
        "description": "Você já pode usar esta chave para receber valores na plataforma."
    },
    "success": true,
    "status": 201,
    "data": {
        "pixKeyId": "PIXKEY-1342345",
        "userId": "323232",
        "type": "CPF",
        "value": "123.456.789-00",
        "status": "active", // Pode ser "pending_validation" se o banco exigir verificação
        "createdAt": "2025-06-12T10:00:00Z"
    }
}

Requisição

Parâmetros Path

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200Success

application/json

Body

🔴500 Internal Server Error

🟠401Unauthorized

Modificado em 2025-06-12 12:45:04