Atualizar Credencial

Atualiza os dados de uma credencial existente: dados de autenticação, dados adicionais (roteamento e voucher), ativação e modo de teste.

PUT/v1/credentials/{id}

Habilitar voucher

Credencial PagSeguro que ainda não tem additionalData.

Request

{
  "additionalData": {
    "voucherEnabled": true
  }
}

Response

{
  "id": "d6uoabc42nrc73gv8690",
  "createdAt": "2026-03-20T10:30:00Z",
  "updatedAt": "2026-04-02T14:15:00Z",
  "subacquirerId": "d59gpddc93gc73jvje0g",
  "merchantId": "d6uo5nc42nrc73gv867g",
  "providerId": "d1niaaopa579sdaa4tug",
  "authenticationData": {
    "merchantIdentifier": "T5F6FEF0937427C",
    "terminalIdentifier": "00000001"
  },
  "additionalData": {
    "voucherEnabled": true
  },
  "testMode": false,
  "enabled": true
}

Voucher com roteamento

Credencial que já tem schemes: ["master"]. O additionalData é enviado completo, com o roteamento atual mais o voucher.

Request

{
  "additionalData": {
    "schemes": ["master"],
    "voucherEnabled": true
  }
}

Response

{
  "id": "d6uoabc42nrc73gv8692",
  "createdAt": "2026-03-20T10:30:00Z",
  "updatedAt": "2026-04-02T14:15:00Z",
  "subacquirerId": "d59gpddc93gc73jvje0g",
  "merchantId": "d6uo5nc42nrc73gv867g",
  "providerId": "d1nic8kpa579sdaa4tuj",
  "authenticationData": {
    "merchantIdentifier": "BTG00000000001"
  },
  "additionalData": {
    "schemes": ["master"],
    "voucherEnabled": true
  },
  "testMode": false,
  "enabled": true
}

Desabilitar credencial

Somente enabled é enviado; authenticationData e additionalData omitidos ficam como estão.

Request

{
  "enabled": false
}

Response

{
  "id": "d6uoabc42nrc73gv8692",
  "createdAt": "2026-03-20T10:30:00Z",
  "updatedAt": "2026-04-02T14:20:00Z",
  "subacquirerId": "d59gpddc93gc73jvje0g",
  "merchantId": "d6uo5nc42nrc73gv867g",
  "providerId": "d1nic8kpa579sdaa4tuj",
  "authenticationData": {
    "merchantIdentifier": "BTG00000000001"
  },
  "additionalData": {
    "schemes": ["master"]
  },
  "testMode": false,
  "enabled": false
}

Parâmetros de Path

Parâmetro	Tipo	Obrigatório	Descrição
id	string	✓	Identificador da credencial (XID), obtido em Listar Credenciais ou na resposta de Criar Credencial

Parâmetros do Corpo

Todos os campos são opcionais.

Parâmetro	Tipo	Obrigatório	Descrição
authenticationData	object	—	Credenciais específicas do provedor; mesma estrutura de Criar Credencial
additionalData	object	—	Configuração adicional específica do provedor (ex.: schemes para roteamento, voucherEnabled para voucher, pixKey quando o banco exigir)
enabled	boolean	—	Ativa ou desativa a credencial
testMode	boolean	—	Se a credencial opera em modo de teste

providerId, merchantId e a organização não podem ser alterados: vêm da credencial gravada, não do corpo da requisição.

Cada bloco é substituído por inteiro

authenticationData e additionalData não são mesclados com o valor atual:

• Omitido ou null — mantém o valor atual.
• Enviado — substitui o bloco inteiro. Ex.: enviar só {"voucherEnabled": true} em additionalData apaga um schemes existente.
• {} — limpa o bloco.

Para alterar um único campo, envie o bloco completo com o valor atual dos demais campos.

A validação é a mesma da criação (dados de autenticação, roteamento schemes e voucherEnabled). A mudança passa a valer no terminal na próxima carga de tabelas de inicialização (logon diário, atualização manual ou quando o adquirente sinaliza).

Erros

Status	Quando ocorre
400	Dados inválidos no corpo. Erros de roteamento e de voucher vêm por campo (ex.: additionalData.voucherEnabled)
404	Credencial inexistente ou de outra organização

400 — voucherEnabled não booleano

{
  "error": [
    {
      "field": "additionalData.voucherEnabled",
      "error": "invalid voucher: field \"voucherEnabled\" must be a boolean"
    }
  ],
  "code": 400
}

404 — credencial não encontrada

{
  "error": "credential not found",
  "code": 404
}

Resposta

Retorna 200 com a credencial completa, com os mesmos campos descritos em Criar Credencial — Campos da Resposta.

Habilitar o voucher de um comerciante

1. Liste as credenciais e pegue o id da credencial do adquirente de cartão presente do comerciante.
2. Envie PUT /v1/credentials/{id} com o additionalData atual da credencial mais "voucherEnabled": true.
3. Para desligar, envie o mesmo PUT com "voucherEnabled": false.