Skip to main content
DELETE
Desvincular recebedor
DELETE /recipients/:id Faz parte do recurso Recebedores — os estados do vínculo, o ciclo de aprovação e o catálogo de pendências estão lá. Desfaz o vínculo entre o recebedor e a sua conta: ele sai da sua listagem e deixa de ser destino válido de split. A resposta traz o vínculo com deletedAt preenchido.
O cadastro não é apagado. O que some é a relação com a sua conta. O recebedor continua existindo na plataforma e continua recebendo das outras contas que o têm vinculado — inclusive com a aprovação que já tinha. Se você o vincular de novo depois, é o mesmo cadastro que volta.
A rota não verifica se o recebedor está em algum split. Não há aviso nem recusa: uma configuração de split que aponte para ele continua existindo e passa a apontar para um recebedor que a sua conta não alcança mais. Confira as suas divisões antes de desvincular — a ordem inversa dá trabalho.
Repasses já liquidados não se movem. O que o recebedor recebeu antes está na carteira dele e segue o próprio calendário de saque. Desvincular olha para a frente, não para trás.

Exemplo

Resposta 200
O status da resposta é o que o vínculo tinha ao ser removido — é o deletedAt que confirma a operação.

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Headers

Idempotency-Key
string

Chave única para garantir idempotência da requisição

Path Parameters

id
string
required

ID do recebedor

Response

Recebedor desvinculado

id
string

Identificador único do registro.

name
string | null

Nome do registro.

email
string | null

E-mail de contato.

document
string | null

Documento (CPF ou CNPJ) do titular.

type
string | null

Tipo do recebedor: individual (pessoa física) ou company (pessoa jurídica).

role
string

Papel do recebedor no split (ex.: seller).

status
string

Situação da conta bancária. Valores: active, inactive, pending.

deletedAt
string<date-time>

Instante em que o vínculo foi removido — preenchido nesta resposta.