Gerar credencial da API de Contas para conta filha.

POST

/accounts/{accountId}/credentials

Credenciais

Gera uma nova credencial da API de Contas (clientId e clientSecret) para uma conta filha do BaaS da credencial autenticada.

Este endpoint é exclusivo para credenciais BaaS, não exige o cabeçalho x-account-id e não pode ser utilizado para a própria conta dona do BaaS. A conta filha precisa estar ativa e habilitada para a API de Contas.

O clientSecret é retornado apenas no momento da criação e não pode ser recuperado posteriormente. Cada conta filha pode ter no máximo 10 credenciais ativas da API de Contas.

Requisição

Authorization

OAuth 2.0

Client Credentials

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Token URL: /oauth/token

Scopes:

baas.credentials.write-Permite criar credenciais de API para contas vinculadas

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200

application/json

Credencial criada

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🟠422

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location '/accounts//credentials' \
--header 'Content-Type: application/json' \
--data '{
    "description": "Integração ERP",
    "allowedIps": [
        "200.150.100.50",
        "200.150.100.0/24"
    ],
    "scopes": [
        "pix.read",
        "pix.write",
        "account.read"
    ]
}'

Response Example

200 - Exemplo de resposta

{
    "clientId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "clientSecret": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
    "id": 1234,
    "description": "Integração ERP",
    "allowedIps": [
        "200.150.100.50",
        "200.150.100.0/24"
    ]
}

Página anterior

Consultar conta do BaaS.

Próxima página

Gerar credencial da API de QR Codes (Pix) para conta filha.