Skip to main content
PATCH
Funcionalidade em beta. Contrato em proposta, sujeito a mudanças. Veja o guia Cadastro de beneficiários.
Atualiza um beneficiário ativo. Envie só os campos que quer mudar.
A mudança vale para os repasses criados depois dela. Os repasses já criados, inclusive os agendados, guardam os dados da conta que tinham no momento da criação.

Headers

string
required
Sua API key.
string
required
Número da conta de recebimento.

Path params

string
required
Identificador do beneficiário (UUID).

Body

Os campos são os mesmos de Cadastrar beneficiário, todos opcionais. O id e a conta de recebimento dona do cadastro não podem ser alterados.
string
Novo identificador do beneficiário no seu sistema.
string
Nova forma de repasse. Ao mudar a forma de repasse, envie também o account com os campos obrigatórios da nova forma.
object
Campos da conta a alterar. Depois da atualização, a conta precisa ter todos os campos obrigatórios do transferType, e as mesmas validações do cadastro são aplicadas.

Response

Retorna o beneficiário atualizado, com a estrutura descrita em Cadastrar beneficiário.

Erros