Pular para o conteúdo

↑↓ navegar ↵ abrir Ctrl↵ nova aba esc fechar

Pede até 500 enrollments numa chamada, de um ou vários merchants. Cada item segue a regra de Pedir enrollment: os mesmos campos, os mesmos erros, e o pedido repetido volta existing, sem criar outro.

Peça cada enrollment uma vez, quando o vendedor entra na sua base: não inclua os enrollments num envio diário (ver Guia de sincronização).

POST https://api.rapidchargeback.com/api/v1/enrollments/batch
Authorization: Basic base64(client_id:client_secret)
Content-Type: application/json

CampoTipoObrigatórioDescrição
itemsarraySimDe 1 a 500 pedidos, cada um com os campos de Pedir enrollment, inclusive o merchant_id ou merchant_ref próprio
modeenumNãopartial (padrão) ou all_or_nothing
  • Corpo de até 2 MB. Acima disso, 413 PAYLOAD_TOO_LARGE.
  • Campo fora de items e mode no envelope, items vazio ou com mais de 500: o lote inteiro é recusado com 422 VALIDATION_ERROR, sem gravar nada.
modeO que acontece
partialCada item é gravado ou recusado por conta própria. existing conta como sucesso
all_or_nothingA Rapid confere todos os itens antes. Se algum falhar, nada é gravado e o lote volta 422 ENROLLMENT_BATCH_INVALID com a lista dos itens recusados. existing não conta como falha; ENROLLMENT_PREVIOUSLY_REJECTED conta

O mesmo identificador em dois itens do lote (descriptor sem diferenciar maiúsculas, espaços repetidos nem espaços em volta do *, ou o mesmo BIN + CAID): o primeiro vale e os seguintes são recusados com ENROLLMENT_DUPLICATE_IN_BATCH.

Se os pedidos novos do lote passarem a sua empresa de 20.000 enrollments esperando aprovação, o lote inteiro é recusado com 422 ENROLLMENT_PENDING_LIMIT, sem gravar nada.


Janela do terminal
curl -X POST https://api.rapidchargeback.com/api/v1/enrollments/batch \
-H "Authorization: Basic Y2xpZW50X2lkOmNsaWVudF9zZWNyZXQ=" \
-H "Content-Type: application/json" \
-d '{
"mode": "partial",
"items": [
{ "merchant_ref": "PB-1001", "enrollment_type": "descriptor", "descriptor_value": "LOJA EXEMPLO", "descriptor_rule": "exact", "products": ["alert"] },
{ "merchant_ref": "PB-1002", "enrollment_type": "bin_caid", "bin": "424242", "caid": "123456789", "products": ["alert"] },
{ "merchant_ref": "PB-1002", "enrollment_type": "descriptor", "descriptor_value": "loja exemplo", "descriptor_rule": "exact", "products": ["alert"] }
]
}'

200 OK sempre que o lote foi processado, mesmo com itens recusados. Confira failed e o result de cada item.

{
"data": {
"total": 3,
"succeeded": 2,
"failed": 1,
"counts": { "created": 1, "existing": 1 },
"results": [
{
"index": 0,
"result": "existing",
"merchant_ref": "PB-1001",
"enrollment": {
"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"
}
},
{
"index": 1,
"result": "created",
"merchant_ref": "PB-1002",
"enrollment": { "id": "00000000-0000-0000-0000-0000000000ab", "...": "objeto Enrollment" }
},
{
"index": 2,
"result": "error",
"merchant_ref": "PB-1002",
"status": 422,
"error": {
"code": "ENROLLMENT_DUPLICATE_IN_BATCH",
"message": "Descriptor \"loja exemplo\" appears more than once in the batch",
"params": { "identifier": "Descriptor \"loja exemplo\"" }
}
}
]
}
}
CampoDescrição
total, succeeded, failedItens enviados, aceitos (created ou existing) e recusados
countsQuantos de cada: created, existing
resultsUm por item, na ordem do array enviado
results[].indexPosição do item no array enviado, a partir de 0
results[].resultcreated, existing ou error
results[].merchant_refO merchant_ref que você mandou no item (null se veio merchant_id)
results[].enrollmentNo sucesso: o objeto Enrollment, o mesmo de Pedir enrollment
results[].status, results[].errorNo erro: o HTTP que o item teria sozinho e o erro (code, message, params)
HTTP/1.1 422 Unprocessable Entity
{
"error": {
"code": "ENROLLMENT_BATCH_INVALID",
"message": "1 of 3 items were not accepted. Nothing was created.",
"params": { "count": 1, "total": 3 },
"details": {
"errors": [
{
"index": 2,
"code": "ENROLLMENT_DUPLICATE_IN_BATCH",
"message": "Descriptor \"loja exemplo\" appears more than once in the batch",
"params": { "identifier": "Descriptor \"loja exemplo\"" }
}
]
}
}
}
HTTP/1.1 429 Too Many Requests
Retry-After: 5
{
"error": {
"code": "BATCH_IN_PROGRESS",
"message": "Another batch from this account is still being processed. Try again in a few seconds."
}
}

A sua empresa tem um lote de enrollments por vez. O segundo lote enviado enquanto o primeiro ainda está sendo gravado é recusado inteiro: espere o Retry-After e mande de novo.

HTTPCódigoQuando
422VALIDATION_ERROREnvelope inválido: items ausente, vazio, com mais de 500, mode fora da lista ou campo desconhecido no envelope
422ENROLLMENT_BATCH_INVALIDTudo ou nada com algum item recusado (params.count, params.total, details.errors)
422ENROLLMENT_PENDING_LIMITO lote passaria a sua empresa de 20.000 pendentes (params.limit)
413PAYLOAD_TOO_LARGECorpo acima de 2 MB
429RATE_LIMIT_EXCEEDEDMais de 60 escritas por minuto (cada lote conta uma)
429BATCH_IN_PROGRESSOutro lote de enrollments da sua empresa ainda em andamento
403KYB_NOT_APPROVED, COMPANY_NOT_ACTIVE, COMPANY_BLOCKEDEmpresa sem cadastro aprovado, inativa ou bloqueada
503SERVICE_UNAVAILABLEIndisponibilidade temporária: repita depois do Retry-After

  • Repetir é seguro. Depois de um 503 ou de uma queda de conexão, mande o mesmo lote: o que já foi gravado volta existing. Se receber BATCH_IN_PROGRESS, o lote anterior ainda está sendo gravado: espere e repita.
  • Mande um lote depois do outro, não em paralelo.
  • Auth, rate limit, códigos de erro: ver Autenticação e Códigos de resposta.