Fetch Descriptors
curl --request GET \
--url https://api.chargeblast.com/api/descriptors \
--header 'X-API-Key: <x-api-key>'import requests
url = "https://api.chargeblast.com/api/descriptors"
headers = {"X-API-Key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};
fetch('https://api.chargeblast.com/api/descriptors', 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/descriptors",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.chargeblast.com/api/descriptors"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.chargeblast.com/api/descriptors")
.header("X-API-Key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.chargeblast.com/api/descriptors")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"descriptors": [
{
"hasEmailSent": true,
"site": {
"retailer": {
"sites": "<array>",
"user": {
"tokens": [
{
"connectionId": "<string>",
"accessToken": "<string>",
"storeUniqueName": "<string>",
"isReady": true,
"publicToken": "<string>",
"platform": "<string>",
"externalId": "<string>",
"platformToken": "<string>",
"id": "<string>"
}
],
"agentDeal": [
{
"agentPayload": {},
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"invitations": [
{
"email": "<string>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"announcements": [
{
"message": "<string>",
"id": "<string>"
}
],
"accounts": [
{
"id": "<string>",
"email": "<string>"
}
],
"hubspotId": "<string>",
"pfStripeId": "<string>",
"svixId": "<string>",
"id": "<string>",
"fromInvite": true,
"referralCode": "<string>",
"merchantId": "<string>",
"phonenumber": "<string>",
"stripeId": "<string>",
"utmSource": "<string>",
"internalCompany": "<string>",
"isBilledForResolved": true,
"internalId": "<string>",
"email": "<string>",
"settings": {
"id": "<string>",
"settings": {
"webhooks": [
"<string>"
],
"apiKey": "<string>",
"emails": [
"<string>"
],
"processor": "<string>",
"ruleset": "<string>",
"descriptors": [
"<string>"
],
"refundUrl": "<string>",
"autoresolve": true,
"integrationSettings": {
"mamopayIntegration": {
"enabled": true,
"apiKey": "<string>"
},
"braintreeIntegration": {
"privateKey": "<string>",
"enabled": true,
"accountId": "<string>",
"merchantId": "<string>",
"publicKey": "<string>"
},
"sealIntegration": {
"enabled": true,
"apiKey": "<string>"
},
"checkoutChampIntegration": {
"password": "<string>",
"enabled": true,
"username": "<string>"
},
"stripeIntegration": {
"account_id": "<string>",
"enabled": true,
"user_id": "<string>",
"shouldAppendDescriptor": true,
"testMode": true,
"state": "<string>",
"useBillingDescriptors": true,
"appendDescriptor": "<string>"
},
"skioIntegration": {
"enabled": true,
"apiKey": "<string>"
},
"discordIntegration": {
"webhook": "<string>",
"enabled": true
},
"stickyIntegration": {
"enabled": true,
"subdomain": "<string>",
"username": "<string>",
"password": "<string>"
},
"shopifyIntegration": {
"id": "<string>",
"store_unique_name": "<string>",
"state": "<string>",
"external_id": "<string>"
},
"nextIntegration": {
"status": "<string>",
"store": "<string>",
"enabled": true
},
"maverickIntegration": {
"enabled": true,
"apiKey": "<string>"
},
"spreedlyIntegration": {
"env": "<string>",
"enabled": true,
"key": "<string>"
},
"smsIntegration": {
"phonenumber": "<string>",
"enabled": true
},
"whopIntegration": {
"userId": "<string>",
"enabled": true,
"companyId": "<string>",
"paymentStatus": "<string>"
},
"slackIntegration": {
"enabled": true,
"channel": "<string>",
"authCode": "<string>"
},
"klaviyoIntegration": {
"enabled": true,
"apiKey": "<string>"
}
},
"arns": [
"<string>"
],
"accountBanned": true,
"alertColumns": [
"<string>"
],
"mcc": "<string>",
"refundAllFromCustomer": true,
"cancelSubscription": true,
"addCustomerToBlockList": true,
"descriptorRules": [
{
"rules": [
{
"logicOperator": "<string>"
}
],
"action": {
"descriptor": "<string>"
}
}
],
"paymentSource": "<string>",
"invoiceSettings": {
"vatCode": "<string>",
"postal_code": "<string>",
"line2": "<string>",
"line1": "<string>",
"state": "<string>",
"country": "<string>",
"vatNumber": "<string>",
"city": "<string>"
},
"selectedAlerts": [
"<string>"
],
"rdrNotifications": true,
"agentSettings": {
"bankTransferInfo": {
"enabled": true,
"bankAddress": "<string>",
"bankName": "<string>",
"routingNumber": "<string>",
"iban": "<string>",
"swiftCode": "<string>",
"accountNumber": "<string>"
},
"cryptoInfo": {
"token": "<string>"
}
},
"claritySettings": {
"websiteForReceipt": "<string>",
"productDescription": "<string>",
"cancellationPolicy": "<string>",
"termsAndConditionsLink": "<string>",
"merchantCategoryCode": "<string>",
"cancellationPolicyRecap": "<string>",
"termsAndConditions": "<string>",
"cancellationPolicyLink": "<string>",
"country": "<string>",
"latitude": "<string>",
"logoUrl": "<string>",
"phoneForReceipt": "<string>",
"termsAndConditionsRecap": "<string>",
"line1": "<string>",
"city": "<string>",
"status": "<string>",
"productName": "<string>",
"countrySubdivision": "<string>",
"description": "<string>",
"name": "<string>",
"postalCode": "<string>",
"refundPolicyLink": "<string>",
"refundPolicyRecap": "<string>",
"refundPolicy": "<string>",
"longitude": "<string>",
"emailForReceipt": "<string>",
"line2": "<string>"
},
"touched": 123,
"webhookSecret": "<string>",
"matchingThreshhold": 123,
"threshholdEnabled": true,
"efwRule": {
"rules": [
{
"logicOperator": "<string>"
}
],
"action": {
"descriptor": "<string>"
}
},
"ethocaRule": {
"rules": [
{
"logicOperator": "<string>"
}
],
"action": {
"descriptor": "<string>"
}
},
"refundAPIEnabled": true,
"hasBetaFeatures": true
}
},
"createdAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"company": "<string>",
"admin": true,
"isSalesAgent": true
},
"name": "<string>",
"rcode": "<string>",
"verifi_name": "<string>",
"merchant_id": "<string>",
"id": "<string>"
},
"descriptors": "<array>",
"name": "<string>",
"id": "<string>"
},
"details": {
"type": "<string>"
},
"id": "<string>",
"bankMid": "<string>"
}
]
}Enrollment
Fetch Descriptors
Fetch all the descriptors for your merchants.
GET
/
api
/
descriptors
Fetch Descriptors
curl --request GET \
--url https://api.chargeblast.com/api/descriptors \
--header 'X-API-Key: <x-api-key>'import requests
url = "https://api.chargeblast.com/api/descriptors"
headers = {"X-API-Key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};
fetch('https://api.chargeblast.com/api/descriptors', 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/descriptors",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.chargeblast.com/api/descriptors"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.chargeblast.com/api/descriptors")
.header("X-API-Key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.chargeblast.com/api/descriptors")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"descriptors": [
{
"hasEmailSent": true,
"site": {
"retailer": {
"sites": "<array>",
"user": {
"tokens": [
{
"connectionId": "<string>",
"accessToken": "<string>",
"storeUniqueName": "<string>",
"isReady": true,
"publicToken": "<string>",
"platform": "<string>",
"externalId": "<string>",
"platformToken": "<string>",
"id": "<string>"
}
],
"agentDeal": [
{
"agentPayload": {},
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"invitations": [
{
"email": "<string>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"announcements": [
{
"message": "<string>",
"id": "<string>"
}
],
"accounts": [
{
"id": "<string>",
"email": "<string>"
}
],
"hubspotId": "<string>",
"pfStripeId": "<string>",
"svixId": "<string>",
"id": "<string>",
"fromInvite": true,
"referralCode": "<string>",
"merchantId": "<string>",
"phonenumber": "<string>",
"stripeId": "<string>",
"utmSource": "<string>",
"internalCompany": "<string>",
"isBilledForResolved": true,
"internalId": "<string>",
"email": "<string>",
"settings": {
"id": "<string>",
"settings": {
"webhooks": [
"<string>"
],
"apiKey": "<string>",
"emails": [
"<string>"
],
"processor": "<string>",
"ruleset": "<string>",
"descriptors": [
"<string>"
],
"refundUrl": "<string>",
"autoresolve": true,
"integrationSettings": {
"mamopayIntegration": {
"enabled": true,
"apiKey": "<string>"
},
"braintreeIntegration": {
"privateKey": "<string>",
"enabled": true,
"accountId": "<string>",
"merchantId": "<string>",
"publicKey": "<string>"
},
"sealIntegration": {
"enabled": true,
"apiKey": "<string>"
},
"checkoutChampIntegration": {
"password": "<string>",
"enabled": true,
"username": "<string>"
},
"stripeIntegration": {
"account_id": "<string>",
"enabled": true,
"user_id": "<string>",
"shouldAppendDescriptor": true,
"testMode": true,
"state": "<string>",
"useBillingDescriptors": true,
"appendDescriptor": "<string>"
},
"skioIntegration": {
"enabled": true,
"apiKey": "<string>"
},
"discordIntegration": {
"webhook": "<string>",
"enabled": true
},
"stickyIntegration": {
"enabled": true,
"subdomain": "<string>",
"username": "<string>",
"password": "<string>"
},
"shopifyIntegration": {
"id": "<string>",
"store_unique_name": "<string>",
"state": "<string>",
"external_id": "<string>"
},
"nextIntegration": {
"status": "<string>",
"store": "<string>",
"enabled": true
},
"maverickIntegration": {
"enabled": true,
"apiKey": "<string>"
},
"spreedlyIntegration": {
"env": "<string>",
"enabled": true,
"key": "<string>"
},
"smsIntegration": {
"phonenumber": "<string>",
"enabled": true
},
"whopIntegration": {
"userId": "<string>",
"enabled": true,
"companyId": "<string>",
"paymentStatus": "<string>"
},
"slackIntegration": {
"enabled": true,
"channel": "<string>",
"authCode": "<string>"
},
"klaviyoIntegration": {
"enabled": true,
"apiKey": "<string>"
}
},
"arns": [
"<string>"
],
"accountBanned": true,
"alertColumns": [
"<string>"
],
"mcc": "<string>",
"refundAllFromCustomer": true,
"cancelSubscription": true,
"addCustomerToBlockList": true,
"descriptorRules": [
{
"rules": [
{
"logicOperator": "<string>"
}
],
"action": {
"descriptor": "<string>"
}
}
],
"paymentSource": "<string>",
"invoiceSettings": {
"vatCode": "<string>",
"postal_code": "<string>",
"line2": "<string>",
"line1": "<string>",
"state": "<string>",
"country": "<string>",
"vatNumber": "<string>",
"city": "<string>"
},
"selectedAlerts": [
"<string>"
],
"rdrNotifications": true,
"agentSettings": {
"bankTransferInfo": {
"enabled": true,
"bankAddress": "<string>",
"bankName": "<string>",
"routingNumber": "<string>",
"iban": "<string>",
"swiftCode": "<string>",
"accountNumber": "<string>"
},
"cryptoInfo": {
"token": "<string>"
}
},
"claritySettings": {
"websiteForReceipt": "<string>",
"productDescription": "<string>",
"cancellationPolicy": "<string>",
"termsAndConditionsLink": "<string>",
"merchantCategoryCode": "<string>",
"cancellationPolicyRecap": "<string>",
"termsAndConditions": "<string>",
"cancellationPolicyLink": "<string>",
"country": "<string>",
"latitude": "<string>",
"logoUrl": "<string>",
"phoneForReceipt": "<string>",
"termsAndConditionsRecap": "<string>",
"line1": "<string>",
"city": "<string>",
"status": "<string>",
"productName": "<string>",
"countrySubdivision": "<string>",
"description": "<string>",
"name": "<string>",
"postalCode": "<string>",
"refundPolicyLink": "<string>",
"refundPolicyRecap": "<string>",
"refundPolicy": "<string>",
"longitude": "<string>",
"emailForReceipt": "<string>",
"line2": "<string>"
},
"touched": 123,
"webhookSecret": "<string>",
"matchingThreshhold": 123,
"threshholdEnabled": true,
"efwRule": {
"rules": [
{
"logicOperator": "<string>"
}
],
"action": {
"descriptor": "<string>"
}
},
"ethocaRule": {
"rules": [
{
"logicOperator": "<string>"
}
],
"action": {
"descriptor": "<string>"
}
},
"refundAPIEnabled": true,
"hasBetaFeatures": true
}
},
"createdAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"company": "<string>",
"admin": true,
"isSalesAgent": true
},
"name": "<string>",
"rcode": "<string>",
"verifi_name": "<string>",
"merchant_id": "<string>",
"id": "<string>"
},
"descriptors": "<array>",
"name": "<string>",
"id": "<string>"
},
"details": {
"type": "<string>"
},
"id": "<string>",
"bankMid": "<string>"
}
]
}⌘I
