Skip to main content
DELETE
Funcionalidade em beta. Contrato em proposta, sujeito a mudanças. Veja o guia Cadastro de beneficiários.
Inativa um beneficiário: o status passa para INACTIVE. O cadastro não é apagado e continua aparecendo nas consultas. Depois de inativado:
  • os novos pagamentos de QR Codes que referenciam o beneficiário geram repasses em ERROR, sem transferência, e o valor fica na conta de recebimento;
  • os repasses já criados não mudam. Os agendados continuam agendados e são executados na data. Para impedir um repasse agendado, cancele-o;
  • o externalId fica livre para outro beneficiário ativo.
A inativação não pode ser desfeita. Para voltar a repassar para a mesma conta, cadastre o beneficiário de novo.

Headers

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

Path params

string
required
Identificador do beneficiário (UUID).

Response

Retorna o beneficiário, com status.name igual a INACTIVE, na estrutura descrita em Cadastrar beneficiário.

Erros