> ## Documentation Index
> Fetch the complete documentation index at: https://docs.z2pay.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Desvincular recebedor
> Remove o recebedor da sua conta. O cadastro dele continua existindo para as outras.
`DELETE /recipients/:id`
Faz parte do recurso [Recebedores](/pt-BR/recipients) — 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](/pt-BR/recipients/list) e deixa de ser destino válido de
[split](/pt-BR/splits). 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](/pt-BR/splits) **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
```bash theme={null}
curl -X DELETE https://api.sandbox.z2pay.com/v1/recipients/rec_v57bi6ruyolouw3cpaq2ofy1k \
-H "x-api-key: SUA_CHAVE_DE_SANDBOX"
```
```json Resposta 200 theme={null}
{
"id": "rec_v57bi6ruyolouw3cpaq2ofy1k",
"name": "Loja do João ME",
"email": "financeiro@lojadojoao.com.br",
"document": "12345678000190",
"type": "company",
"role": "seller",
"status": "active",
"deletedAt": "2026-08-11T11:40:00.000Z"
}
```
O `status` da resposta é o que o vínculo tinha ao ser removido — é o `deletedAt` que confirma a
operação.
## OpenAPI
````yaml openapi/psp.json DELETE /recipients/{id}
openapi: 3.0.3
info:
title: Z2Pay PSP API
version: 1.0.0
description: API pública do PSP — autenticação via API Key (Credential)
servers:
- url: https://api.sandbox.z2pay.com/v1
description: Sandbox
- url: https://api.z2pay.com/v1
description: Produção
security: []
tags:
- name: Cards
description: Cartões salvos de um cliente
- name: Chargebacks
description: Gerenciamento de chargebacks
- name: Customers
description: Gerenciamento de clientes (compradores)
- name: Fees
description: Tabela de taxas da conta (pix, boleto, cartão, saque, refund, chargeback)
- name: Recipients
description: Gerenciamento de recebedores (sellers/merchants que recebem repasses)
- name: Refunds
description: Gerenciamento de reembolsos e estornos
- name: Splits
description: Regras de divisão do valor de uma venda entre recebedores
- name: Transactions
description: Gerenciamento de transações e payments
- name: Wallets
description: Saldo, extrato e resumo da carteira de um recebedor, agrupados por moeda
- name: Webhooks
description: Configuração, gerenciamento e histórico de entregas de webhooks
- name: Withdrawals
description: Solicitação e acompanhamento de saques (payouts) por recipient
paths:
/recipients/{id}:
delete:
tags:
- Recipients
summary: Desvincular recebedor
description: >-
O recebedor deixa de estar apto a receber repasses seus: ele sai da sua
lista e não pode mais ser destino de split.
operationId: RecipientController_delete
parameters:
- name: id
in: path
required: true
description: ID do recebedor
schema:
type: string
- name: Idempotency-Key
in: header
required: false
description: Chave única para garantir idempotência da requisição
schema:
type: string
responses:
'200':
description: Recebedor desvinculado
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Identificador único do registro.
name:
type: string
nullable: true
description: Nome do registro.
email:
type: string
nullable: true
description: E-mail de contato.
document:
type: string
nullable: true
description: Documento (CPF ou CNPJ) do titular.
type:
type: string
nullable: true
description: >-
Tipo do recebedor: `individual` (pessoa física) ou
`company` (pessoa jurídica).
role:
type: string
description: 'Papel do recebedor no split (ex.: seller).'
status:
type: string
description: >-
Situação da conta bancária. Valores: `active`, `inactive`,
`pending`.
deletedAt:
type: string
format: date-time
description: >-
Instante em que o vínculo foi removido — preenchido nesta
resposta.
example:
id: rec_gk1o75xv3ioi4eoqosorz9s62
name: Loja do João ME
email: financeiro@lojadojoao.com.br
document: '12345678000190'
type: company
role: seller
status: active
deletedAt: '2026-08-11T11:40:00.000Z'
'401':
description: Chave de API ausente, malformada ou inválida
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: >-
Identificador estável do erro. É por ele que você deve
ramificar, não pela mensagem.
message:
type: string
description: >-
Descrição legível. Pode mudar sem aviso e não deve ser
usada em condicional.
example:
error:
code: UNAUTHORIZED
message: Invalid API key
'409':
description: >-
Já existe uma requisição em andamento com esta Idempotency-Key. A
API aguarda a primeira concluir por até 5 segundos antes de
responder assim
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: >-
Mensagem do conflito de idempotência. Aqui `error` é
texto, não objeto — ramifique pelo status HTTP.
example:
error: A request with this idempotency key is already being processed
'422':
description: >-
Idempotency-Key já usada com um corpo diferente. Use uma chave nova
para uma operação diferente
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: >-
Mensagem do conflito de idempotência. Aqui `error` é
texto, não objeto — ramifique pelo status HTTP.
example:
error: Idempotency key already used with a different request body
security:
- apiKey: []
components:
securitySchemes:
apiKey:
type: apiKey
in: header
name: x-api-key
description: API Key da Credential (gerada no Backoffice)
````