Sign in

v1

latestOpenAPI 3.0.12026-07-26158956.2 KB
Enrollment

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.

post/api/enroll_merchant

Headers

X-API-Keystring required

Your API key. Sent in the X-API-Key header.

Request body

OR
OR
OR
OR

Response

Enrollment applied.

merchantIdstring required

The merchant (retailer) id this enrollment was applied to. Newly created or reused.

merchantCreatedboolean required

True if a new merchant was created for this request, false if an existing one was reused.

programstring required

The program that was enrolled (lowercased).

descriptorIdsstring[] required

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).

rulesetSnapshotIdstring nullable

Id of the ruleset snapshot recorded, or null if no ruleset change occurred.