Skip to main content
POST
/
api
/
enroll_merchant
Enroll Merchant
curl --request POST \
  --url https://api.chargeblast.com/api/enroll_merchant \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "program": "ethoca",
  "descriptors": [
    "<string>"
  ],
  "merchant_id": "<string>",
  "ruleset": "<string>"
}
'
{
  "merchantId": "<string>",
  "merchantCreated": true,
  "program": "<string>",
  "descriptorIds": [
    "<string>"
  ],
  "rulesetSnapshotId": "<string>"
}

Headers

​
X-API-Key
string
required

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

Body

application/json
​
program
enum<string>
required

Program discriminator. Use ethoca.

Available options:
ethoca
​
descriptors
string[]
required

Billing descriptors to enroll. At least one non-blank value is required. Stored uppercased.

​
merchant_id
string | null

Existing merchant (retailer) id to enroll. Omit to create a new merchant. The new id is returned as merchantId.

​
ruleset
string | null

Optional refund / RDR threshold for the merchant (e.g. <300). When supplied and changed, a ruleset snapshot is recorded.

Response

Enrollment applied.

​
merchantId
string
required

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

​
merchantCreated
boolean
required

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

​
program
string
required

The program that was enrolled (lowercased).

​
descriptorIds
string[]
required

Ids of descriptor records created or updated. Populated for Ethoca and CDRN, empty otherwise.

​
rulesetSnapshotId
string | null

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