Desvincular recebedor
curl --request DELETE \
--url https://api.sandbox.z2pay.com/v1/recipients/{id} \
--header 'x-api-key: <api-key>'const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/recipients/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/recipients/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text){
"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"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": "A request with this idempotency key is already being processed"
}{
"error": "Idempotency key already used with a different request body"
}Recebedores
Desvincular recebedor
Remove o recebedor da sua conta. O cadastro dele continua existindo para as outras.
DELETE
/
recipients
/
{id}
Desvincular recebedor
curl --request DELETE \
--url https://api.sandbox.z2pay.com/v1/recipients/{id} \
--header 'x-api-key: <api-key>'const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/recipients/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/recipients/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text){
"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"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": "A request with this idempotency key is already being processed"
}{
"error": "Idempotency key already used with a different request body"
}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
curl -X DELETE https://api.sandbox.z2pay.com/v1/recipients/rec_v57bi6ruyolouw3cpaq2ofy1k \
-H "x-api-key: SUA_CHAVE_DE_SANDBOX"
Resposta 200
{
"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.Authorizations
API Key da Credential (gerada no Backoffice)
Headers
Chave única para garantir idempotência da requisição
Path Parameters
ID do recebedor
Response
Recebedor desvinculado
Identificador único do registro.
Nome do registro.
E-mail de contato.
Documento (CPF ou CNPJ) do titular.
Tipo do recebedor: individual (pessoa física) ou company (pessoa jurídica).
Papel do recebedor no split (ex.: seller).
Situação da conta bancária. Valores: active, inactive, pending.
Instante em que o vínculo foi removido — preenchido nesta resposta.