Enroll Merchant
Enroll a merchant in an alert or refund program. Send a program discriminator with that program’s fields. ethoca and cdrn require descriptors. rdr requires arns and/or equal-length paired bins/caids (its bins/caids are persisted as queryable RDR descriptors). amex and discover require legal name, DBA, address, and their SE identifiers (they now persist a Pending descriptor you can poll). Enrollment files a request; records start Pending and become Enrolled once the provider-side enrollment confirms. Pass merchant_id to target a specific merchant, or omit it to create a brand-new merchant. Poll GET /api/enrollment_status for per-program state.
Headers
Your API key. Sent in the X-API-Key header.
Body
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Program discriminator. Use ethoca.
ethoca Billing descriptors to enroll. At least one non-blank value is required. Stored uppercased.
Existing merchant (retailer) id to enroll. Omit to create a brand-new merchant. The resolved id is returned as merchantId.
Optional refund / RDR threshold for the merchant (e.g. <300). When supplied and changed, a ruleset snapshot is recorded.
Response
Enrollment applied.
The merchant (retailer) id this enrollment was applied to. Newly created or reused.
True if a new merchant was created for this request, false if an existing one was reused.
The program that was enrolled (lowercased).
Ids of descriptor records created or updated, retrievable via GET /api/v2/descriptors. Populated for Ethoca, CDRN, RDR (one per BIN/CAID pair), Amex, and Discover. Empty only when the program persisted no descriptor (e.g. an RDR enrollment sending arns alone).
Id of the ruleset snapshot recorded, or null if no ruleset change occurred.
