Skip to main content
POST
/
v4
/
i
/
baas
/
accounts
/
{accountId}
/
pix-keys
/
{pixKeyId}
/
set-current
curl -X POST https://api.owem.com.br/v4/i/baas/accounts/123456789012/pix-keys/75be0efc-51b0-47e1-803d-5162f06b755c/set-current \
  -H "Authorization: Basic $(echo -n 'SUA_API_KEY:SEU_SECRET' | base64)" \
  -H "Content-Type: application/json"
{
  "requestId": "1d27bea6-8fd1-48f2-ae87-0fd9e76d6b6d",
  "success": true,
  "size": 1,
  "data": {
    "success": true,
    "message": "Chave PIX definida como corrente",
    "pixKeyId": "75be0efc-51b0-47e1-803d-5162f06b755c",
    "isCurrent": true
  }
}
curl -X POST https://api.owem.com.br/v4/i/baas/accounts/123456789012/pix-keys/75be0efc-51b0-47e1-803d-5162f06b755c/set-current \
  -H "Authorization: Basic $(echo -n 'SUA_API_KEY:SEU_SECRET' | base64)" \
  -H "Content-Type: application/json"

Descrição

Define uma chave PIX como a chave corrente (principal) de uma conta bancária BaaS. A chave corrente é utilizada como padrão para recebimentos PIX quando não especificada outra chave.
PROGRAMA BETA - Este endpoint está disponível apenas para parceiros aprovados no programa BAAS.

Autenticação

Este endpoint usa Basic Auth com sua API Key + Secret. O scope baas:accounts é configurado pela Owem na sua API Key.
Authorization: Basic {Base64(API_KEY:API_SECRET)}

Request

Headers

HeaderTipoObrigatórioDescrição
AuthorizationstringBasic Auth (API Key + Secret em Base64)
Content-Typestringapplication/json

Path Parameters

ParâmetroTipoObrigatórioDescrição
accountIdstringID da conta (retornado em onboarding/status)
pixKeyIdstringID da chave PIX a ser definida como corrente
Este endpoint não requer body. A chave é identificada pelos path parameters.

Comportamento

Troca Automática

A chave anterior perde automaticamente o status de corrente.

Sem Downtime

A troca é instantânea e não afeta operações em andamento.

Idempotente

Definir a mesma chave como corrente novamente retorna sucesso.

Sem Cooldown

Não há restrição de tempo entre alterações de chave corrente.

Response

Sucesso (200 OK)

{
  "requestId": "1d27bea6-8fd1-48f2-ae87-0fd9e76d6b6d",
  "success": true,
  "size": 1,
  "data": {
    "success": true,
    "message": "Chave PIX definida como corrente",
    "pixKeyId": "75be0efc-51b0-47e1-803d-5162f06b755c",
    "isCurrent": true
  }
}

Campos da Response

CampoTipoDescrição
successbooleanSe a operação foi bem-sucedida
messagestringMensagem de confirmação
pixKeyIdstringID da chave definida como corrente
isCurrentbooleanSempre true em caso de sucesso

Erros

CódigoHTTPDescrição
BAAS_PIX_KEY_NOT_FOUND404Chave PIX não encontrada
BAAS_PIX_KEY_WRONG_ACCOUNT400Chave não pertence à conta informada
BAAS_ACCOUNT_NOT_FOUND404Conta não encontrada
BAAS_ACCOUNT_WRONG_PARTNER403Conta não pertence ao parceiro
Caso de Uso: Use este endpoint antes de deletar uma chave que está marcada como corrente. Primeiro defina outra chave como corrente, depois delete a anterior.
{
  "requestId": "1d27bea6-8fd1-48f2-ae87-0fd9e76d6b6d",
  "success": true,
  "size": 1,
  "data": {
    "success": true,
    "message": "Chave PIX definida como corrente",
    "pixKeyId": "75be0efc-51b0-47e1-803d-5162f06b755c",
    "isCurrent": true
  }
}