Skip to content

↑↓ navigate ↵ open Ctrl↵ new tab esc close

Lists your company’s enrollments (see Enrollments: overview). Use it to follow the approval of requests, find a seller’s enrollments or check whether an identifier is already registered.

GET https://api.rapidchargeback.com/api/v1/enrollments
Authorization: Basic base64(client_id:client_secret)

All optional. A parameter outside this table is rejected with 422 VALIDATION_ERROR (Unknown field: <name>).

ParamTypeDefaultDescription
pageint (≥ 1)1Page
per_pageint (1–100)20Items per page
merchant_idstring (UUID)-Only this merchant’s enrollments
merchant_refstring (up to 100)-Only the enrollments of the merchant with this reference from your system. Without a merchant with the reference, the list comes back empty. The comparison ignores case and accents
enrollment_typeenum-descriptor or bin_caid
productenum-alert or prevention. Alone: the enrollments where the product was requested
statusenum-pending, active, deactivation_requested, inactive or rejected. Without product: some product in that status. With product: that product only
descriptor_valuestring (up to 255)-The exact value, case-insensitive
binstring (6 to 10 digits)-Exact BIN
caidstring (up to 50)-Exact CAID
updated_sinceISO 8601 date and time with time zone-Only enrollments changed from that moment on (e.g. 2026-11-06T12:00:00Z)

With merchant_id and merchant_ref together, both must point to the same merchant; otherwise the list comes back empty.

Without updated_since, the order is by request (oldest first, then id). With updated_since, only what changed from that moment on, oldest first (updated_at, then id).

To know when a request was approved or rejected, query this list with updated_since every few minutes:

  1. Keep the highest updated_at you received.
  2. On the next query, send that value minus 2 minutes as updated_since.
  3. Skip the (id, updated_at) pair you already processed.
  4. Read the pages up to total_pages.

The 2-minute margin covers a change saved out of order or during your read.


Terminal window
curl -G "https://api.rapidchargeback.com/api/v1/enrollments" \
--data-urlencode "merchant_ref=PB-1001" \
-H "Authorization: Basic Y2xpZW50X2lkOmNsaWVudF9zZWNyZXQ="
Terminal window
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="
Terminal window
curl -G "https://api.rapidchargeback.com/api/v1/enrollments" \
--data-urlencode "product=alert" \
--data-urlencode "status=pending" \
-H "Authorization: Basic Y2xpZW50X2lkOmNsaWVudF9zZWNyZXQ="

{
"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 }
}

The fields are in Request enrollment.

{
"error": {
"code": "VALIDATION_ERROR",
"message": "Unknown field: merchant",
"params": { "field": "merchant" }
}
}

  • Only your company’s enrollments. The company comes from the credential.
  • Blocked company receives 403 COMPANY_BLOCKED.
  • Auth, rate limit, error codes: see Authentication and Response codes.