Pedir desativação
Pede a desativação de um enrollment da sua empresa. Todo produto active do enrollment passa a deactivation_requested, e a equipe da Rapid confirma a desativação.
Até a confirmação, o enrollment continua recebendo alertas, que seguem valendo como sempre. Depois de confirmada, o produto fica inactive.
Endpoint
Seção intitulada “Endpoint”POST
https://api.rapidchargeback.com/api/v1/enrollments/:enrollment_id/request-deactivationAutenticação
Seção intitulada “Autenticação”Authorization: Basic base64(client_id:client_secret)Content-Type: application/jsonParâmetros de URL
Seção intitulada “Parâmetros de URL”| Param | Tipo | Descrição |
|---|---|---|
enrollment_id | string (UUID) | O id do enrollment |
Corpo da requisição
Seção intitulada “Corpo da requisição”Opcional.
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
reason | string (1 a 500) | Não | O motivo, que a equipe da Rapid vê junto com o pedido |
Campo fora da tabela é recusado com 422 VALIDATION_ERROR (Unknown field: <nome>).
Repetir
Seção intitulada “Repetir”| Situação | Resposta |
|---|---|
Algum produto active | 200, meta.result: "deactivation_requested" |
Nenhum produto active, algum já em deactivation_requested | 200, meta.result: "unchanged". Nada muda |
Nenhum produto active nem em deactivation_requested | 422 ENROLLMENT_NOTHING_TO_DEACTIVATE |
Pedido ainda pending não se desativa por aqui: só produto já aprovado.
Exemplo de requisição
Seção intitulada “Exemplo de requisição”curl -X POST https://api.rapidchargeback.com/api/v1/enrollments/00000000-0000-0000-0000-0000000000aa/request-deactivation \ -H "Authorization: Basic Y2xpZW50X2lkOmNsaWVudF9zZWNyZXQ=" \ -H "Content-Type: application/json" \ -d '{ "reason": "Vendedor encerrou a conta" }'Resposta
Seção intitulada “Resposta”Sucesso
Seção intitulada “Sucesso”HTTP/1.1 200 OK{ "data": { "id": "00000000-0000-0000-0000-0000000000aa", "merchant_id": "00000000-0000-0000-0000-000000000001", "merchant_ref": "PB-1001", "enrollment_type": "descriptor", "descriptor_value": "loja exemplo", "descriptor_rule": "exact", "bin": null, "caid": null, "arn": null, "products": { "alert": { "status": "deactivation_requested", "rejection_reason": null, "approved_at": "2026-11-07T15:00:00.000Z" }, "prevention": null }, "created_at": "2026-11-06T12:00:00.000Z", "updated_at": "2026-12-01T10:00:00.000Z" }, "meta": { "result": "deactivation_requested" }}Nada para desativar
Seção intitulada “Nada para desativar”HTTP/1.1 422 Unprocessable Entity{ "error": { "code": "ENROLLMENT_NOTHING_TO_DEACTIVATE", "message": "No active products to deactivate on this enrollment" }}| HTTP | Código | Quando |
|---|---|---|
| 404 | ENROLLMENT_NOT_FOUND | O enrollment não existe, é de outra empresa, ou o id não é um UUID |
| 422 | ENROLLMENT_NOTHING_TO_DEACTIVATE | Nenhum produto ativo nem com desativação pedida |
| 422 | VALIDATION_ERROR | Campo desconhecido, ou reason vazio ou acima de 500 caracteres (params.field) |
| 403 | KYB_NOT_APPROVED, COMPANY_NOT_ACTIVE, COMPANY_BLOCKED | Empresa sem cadastro aprovado, inativa ou bloqueada |
| 429 | RATE_LIMIT_EXCEEDED | Mais de 60 escritas por minuto |
| 503 | SERVICE_UNAVAILABLE | Indisponibilidade temporária: repita depois do Retry-After |
- Um enrollment por chamada. Para a saída de um vendedor, liste os enrollments dele com Listar enrollments filtrando por
merchant_refe peça a desativação de cada um. - Acompanhe a confirmação pela lista de enrollments com
updated_since. - Atividade: cada pedido aparece na Atividade do painel como feito pela integração.