Skip to main content
POST
/
api
/
unenroll
Unenroll Merchant
curl --request POST \
  --url https://api.chargeblast.com/api/unenroll \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "descriptor_ids": [
    "<string>"
  ],
  "descriptor_id": "<string>"
}
'
import requests

url = "https://api.chargeblast.com/api/unenroll"

payload = {
"descriptor_ids": ["<string>"],
"descriptor_id": "<string>"
}
headers = {
"X-API-Key": "<x-api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-Key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({descriptor_ids: ['<string>'], descriptor_id: '<string>'})
};

fetch('https://api.chargeblast.com/api/unenroll', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.chargeblast.com/api/unenroll",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'descriptor_ids' => [
'<string>'
],
'descriptor_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <x-api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.chargeblast.com/api/unenroll"

payload := strings.NewReader("{\n \"descriptor_ids\": [\n \"<string>\"\n ],\n \"descriptor_id\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-Key", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.chargeblast.com/api/unenroll")
.header("X-API-Key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"descriptor_ids\": [\n \"<string>\"\n ],\n \"descriptor_id\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.chargeblast.com/api/unenroll")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"descriptor_ids\": [\n \"<string>\"\n ],\n \"descriptor_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "unenrolled": [
    "<string>"
  ],
  "notFound": [
    "<string>"
  ]
}

Headers

X-API-Key
string
required

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

Body

application/json

Descriptors to unenroll. Supply descriptor_ids; a single legacy descriptor_id is also accepted and folded into the list.

descriptor_ids
string[]

Descriptor ids to unenroll, e.g. desc_xxxxxxxxxxxxx. Obtain them from GET /api/descriptors.

descriptor_id
string | null

Legacy single descriptor id. Prefer descriptor_ids.

Response

Unenrollment queued.

unenrolled
string[]
required

Descriptor ids on your account that were queued for unenrollment. They keep their current status until Chargeblast confirms provider de-registration, then they are removed.

notFound
string[]
required

Requested ids that did not match a descriptor on your account.