Listar enrollments
Lista os enrollments da sua empresa (ver Enrollments: visão geral). Use para acompanhar a aprovação dos pedidos, achar os enrollments de um vendedor ou conferir se um identificador já está cadastrado.
Endpoint
Seção intitulada “Endpoint”https://api.rapidchargeback.com/api/v1/enrollmentsAutenticação
Seção intitulada “Autenticação”Authorization: Basic base64(client_id:client_secret)Query params
Seção intitulada “Query params”Todos opcionais. Parâmetro fora desta tabela é recusado com 422 VALIDATION_ERROR (Unknown field: <nome>).
| Param | Tipo | Default | Descrição |
|---|---|---|---|
page | int (≥ 1) | 1 | Página |
per_page | int (1–100) | 20 | Itens por página |
merchant_id | string (UUID) | - | Só os enrollments desse merchant |
merchant_ref | string (até 100) | - | Só os enrollments do merchant com essa referência do seu sistema. Sem merchant com a referência, a lista vem vazia. A comparação não diferencia maiúsculas nem acentos |
enrollment_type | enum | - | descriptor ou bin_caid |
product | enum | - | alert ou prevention. Sozinho: os enrollments em que o produto foi pedido |
status | enum | - | pending, active, deactivation_requested, inactive ou rejected. Sem product: algum produto nesse status. Com product: só aquele produto |
descriptor_value | string (até 255) | - | O valor exato, sem diferenciar maiúsculas |
bin | string (6 a 10 dígitos) | - | BIN exato |
caid | string (até 50) | - | CAID exato |
updated_since | data e hora ISO 8601 com fuso | - | Só os enrollments alterados a partir desse instante (ex.: 2026-11-06T12:00:00Z) |
Com merchant_id e merchant_ref juntos, os dois precisam apontar o mesmo merchant; senão a lista vem vazia.
Sem updated_since, a ordem é a de pedido (o mais antigo primeiro, depois id). Com updated_since, só o que mudou a partir desse instante, do mais antigo para o mais novo (updated_at, depois id).
Acompanhar a aprovação
Seção intitulada “Acompanhar a aprovação”Para saber quando um pedido foi aprovado ou recusado, consulte esta lista com updated_since a cada poucos minutos:
- Guarde o maior
updated_atque você recebeu. - Na consulta seguinte, mande esse valor menos 2 minutos como
updated_since. - Ignore o par (
id,updated_at) que você já processou. - Leia as páginas até
total_pages.
A folga de 2 minutos cobre a mudança gravada fora de ordem ou durante a sua leitura.
Exemplos
Seção intitulada “Exemplos”Os enrollments de um vendedor
Seção intitulada “Os enrollments de um vendedor”curl -G "https://api.rapidchargeback.com/api/v1/enrollments" \ --data-urlencode "merchant_ref=PB-1001" \ -H "Authorization: Basic Y2xpZW50X2lkOmNsaWVudF9zZWNyZXQ="O que mudou desde a última leitura
Seção intitulada “O que mudou desde a última leitura”curl -G "https://api.rapidchargeback.com/api/v1/enrollments" \ --data-urlencode "updated_since=2026-11-07T14:58:00Z" \ --data-urlencode "per_page=100" \ -H "Authorization: Basic Y2xpZW50X2lkOmNsaWVudF9zZWNyZXQ="Alertas esperando aprovação
Seção intitulada “Alertas esperando aprovação”curl -G "https://api.rapidchargeback.com/api/v1/enrollments" \ --data-urlencode "product=alert" \ --data-urlencode "status=pending" \ -H "Authorization: Basic Y2xpZW50X2lkOmNsaWVudF9zZWNyZXQ="Resposta
Seção intitulada “Resposta”Sucesso
Seção intitulada “Sucesso”{ "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": "active", "rejection_reason": null, "approved_at": "2026-11-07T15:00:00.000Z" }, "prevention": null }, "created_at": "2026-11-06T12:00:00.000Z", "updated_at": "2026-11-07T15:00:00.000Z" } ], "meta": { "page": 1, "per_page": 20, "total": 1, "total_pages": 1 }}Os campos estão em Pedir enrollment.
Parâmetro desconhecido
Seção intitulada “Parâmetro desconhecido”{ "error": { "code": "VALIDATION_ERROR", "message": "Unknown field: merchant", "params": { "field": "merchant" } }}- Só os enrollments da sua empresa. A empresa vem da credencial.
- Empresa bloqueada recebe
403 COMPANY_BLOCKED. - Auth, rate limit, códigos de erro: ver Autenticação e Códigos de resposta.