Pular para o conteúdo

↑↓ navegar ↵ abrir Ctrl↵ nova aba esc fechar

Um enrollment é o cadastro de um identificador de cobrança de um merchant seu: o nome que aparece na fatura do cartão (descriptor) ou o par BIN + CAID da loja. É pelo enrollment que a Rapid reconhece que um alerta é seu e de qual merchant ele é: sem enrollment aprovado, o alerta não chega.

Pela API você pede enrollments, acompanha a aprovação e pede a desativação. Quem aprova é a equipe da Rapid.

enrollment_typeCamposQuando usar
descriptordescriptor_value e descriptor_ruleO nome na fatura do portador. descriptor_rule é exact (igual) ou startswith (começa com, pelo menos 5 caracteres)
bin_caidbin e caidO BIN do cartão (6 a 10 dígitos) e o CAID (identificador da loja no adquirente)

Qual tipo cada bandeira usa está em Alerta: visão geral. O descriptor_value é gravado em minúsculas; diferença de maiúsculas, espaços repetidos e espaços em volta do * não criam outro enrollment.

Cada enrollment pode valer para um ou dois produtos, cada um com o próprio status:

Produto na APIO que é
alertAlerta
preventionPrevenção. Exige o cadastro do merchant: sempre store_name, merchant_url e contact_phone; conforme o caso, também endereço completo e os dados da loja (descrição, logo, MCC, termos, política de reembolso e atendimento). O erro MERCHANT_INCOMPLETE_FOR_PREVENTION diz o que falta em params.fields

A sua empresa precisa ter o produto contratado para pedir enrollment nele.

StatusO que significa
pendingPedido feito, esperando a aprovação da equipe da Rapid
activeAprovado: os alertas desse identificador chegam
rejectedRecusado pela equipe. O motivo vem em rejection_reason
deactivation_requestedDesativação pedida. Continua recebendo até a equipe confirmar
inactiveDesativado

O produto que nunca foi pedido vem null em products.

  1. Você pede o enrollment (Pedir enrollment ou Lote de enrollments). Todo produto pedido nasce pending.
  2. O pedido passa pela aprovação da equipe da Rapid, que aprova (active) ou recusa (rejected, com motivo). O responsável pela sua conta recebe o aviso no painel e por e-mail.
  3. Você acompanha pela lista de enrollments com updated_since.
  4. Para parar, você pede a desativação. A equipe confirma, e até lá o enrollment continua recebendo alertas.

Enrollment não se edita: para trocar o identificador, peça um novo e a desativação do antigo.

O mesmo descriptor ou BIN + CAID só pode estar em uso (pending, active ou deactivation_requested) em um enrollment de toda a plataforma. Pedir um identificador que já está em uso responde 409 ENROLLMENT_DUPLICATE; se o enrollment em uso é da sua empresa, a resposta traz o id dele.