Skip to content

↑↓ navigate ↵ open Ctrl↵ new tab esc close

An enrollment is the registration of a billing identifier of one of your merchants: the name shown on the card statement (descriptor) or the store’s BIN + CAID pair. Through the enrollment Rapid recognizes that an alert is yours and which merchant it belongs to: without an approved enrollment, the alert does not arrive.

Through the API you request enrollments, follow the approval and request deactivation. The Rapid team is the one who approves.

enrollment_typeFieldsWhen to use
descriptordescriptor_value and descriptor_ruleThe name on the cardholder’s statement. descriptor_rule is exact (equal) or startswith (starts with, at least 5 characters)
bin_caidbin and caidThe card BIN (6 to 10 digits) and the CAID (the store’s identifier at the acquirer)

Which type each card network uses is in Alert: overview. The descriptor_value is saved in lowercase; case differences, repeated spaces and spaces around * do not create another enrollment.

Each enrollment can apply to one or two products, each with its own status:

Product in the APIWhat it is
alertAlert
preventionPrevention. Requires the merchant’s registration: always store_name, merchant_url and contact_phone; depending on the case, also a full address and the store details (description, logo, MCC, terms, refund policy and customer service). The MERCHANT_INCOMPLETE_FOR_PREVENTION error lists what is missing in params.fields

Your company needs to have the product contracted to request an enrollment on it.

StatusWhat it means
pendingRequested, waiting for approval by the Rapid team
activeApproved: alerts for this identifier arrive
rejectedRejected by the team. The reason comes in rejection_reason
deactivation_requestedDeactivation requested. Keeps receiving until the team confirms
inactiveDeactivated

A product that was never requested comes as null in products.

  1. You request the enrollment (Request enrollment or Enrollment batch). Every requested product starts as pending.
  2. The request goes through approval by the Rapid team, which approves it (active) or rejects it (rejected, with a reason). The person in charge of your account gets the notice in the dashboard and by email.
  3. You follow it through the enrollments list with updated_since.
  4. To stop, you request the deactivation. The team confirms it, and until then the enrollment keeps receiving alerts.

An enrollment cannot be edited: to change the identifier, request a new one and the deactivation of the old one.

The same descriptor or BIN + CAID can only be in use (pending, active or deactivation_requested) in one enrollment across the whole platform. Requesting an identifier already in use responds 409 ENROLLMENT_DUPLICATE; if the enrollment in use is your company’s, the response brings its id.