GET
/
api
/
descriptors
curl --request GET \
  --url https://api.chargeblast.com/api/descriptors
{
  "descriptors": [
    {
      "id": "<string>",
      "hasEmailSent": true,
      "type": "Ethoca",
      "bankMid": "<string>",
      "status": "Pending",
      "site": {
        "retailer": {
          "sites": [
            {}
          ],
          "name": "<string>",
          "rcode": "<string>",
          "user": {
            "hubspotId": "<string>",
            "pfStripeId": "<string>",
            "tokens": [
              {
                "externalId": "<string>",
                "connectionId": "<string>",
                "accessToken": "<string>",
                "platformToken": "<string>",
                "id": "<string>",
                "storeUniqueName": "<string>",
                "isReady": true,
                "status": "active",
                "publicToken": "<string>",
                "platform": "<string>"
              }
            ],
            "svixId": "<string>",
            "id": "<string>",
            "fromInvite": true,
            "referralCode": "<string>",
            "merchantId": "<string>",
            "phonenumber": "<string>",
            "stripeId": "<string>",
            "utmSource": "<string>",
            "agentDeal": [
              {
                "agentPayload": {},
                "id": "<string>",
                "createdAt": "2023-11-07T05:31:56Z"
              }
            ],
            "internalCompany": "<string>",
            "invitations": [
              {
                "email": "<string>",
                "status": "Pending",
                "id": "<string>",
                "createdAt": "2023-11-07T05:31:56Z",
                "permission": "manager"
              }
            ],
            "announcements": [
              {
                "message": "<string>",
                "id": "<string>",
                "type": "Error"
              }
            ],
            "accounts": [
              {
                "id": "<string>",
                "email": "<string>"
              }
            ],
            "isBilledForResolved": true,
            "risk": "High",
            "internalId": "<string>",
            "email": "<string>",
            "settings": {
              "id": "<string>",
              "settings": {
                "webhooks": [
                  "<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": {
                    "apiKey": "<string>",
                    "enabled": true
                  },
                  "checkoutChampIntegration": {
                    "password": "<string>",
                    "enabled": true,
                    "username": "<string>"
                  },
                  "stripeIntegration": {
                    "account_id": "<string>",
                    "user_id": "<string>",
                    "shouldAppendDescriptor": true,
                    "testMode": true,
                    "enabled": 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": {
                    "apiKey": "<string>",
                    "enabled": true
                  },
                  "spreedlyIntegration": {
                    "env": "<string>",
                    "enabled": true,
                    "key": "<string>"
                  },
                  "smsIntegration": {
                    "phonenumber": "<string>",
                    "enabled": true
                  },
                  "whopIntegration": {
                    "userId": "<string>",
                    "enabled": true,
                    "paymentStatus": "<string>",
                    "companyId": "<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": [
                  {
                    "action": {
                      "descriptor": "<string>"
                    },
                    "rules": [
                      {
                        "logicOperator": "<string>"
                      }
                    ]
                  }
                ],
                "apiKey": "<string>",
                "paymentSource": "<string>",
                "emails": [
                  "<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": {
                    "bankAddress": "<string>",
                    "bankName": "<string>",
                    "enabled": true,
                    "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": {
                  "action": {
                    "descriptor": "<string>"
                  },
                  "rules": [
                    {
                      "logicOperator": "<string>"
                    }
                  ]
                },
                "ethocaRule": {
                  "action": {
                    "descriptor": "<string>"
                  },
                  "rules": [
                    {
                      "logicOperator": "<string>"
                    }
                  ]
                },
                "refundAPIEnabled": true,
                "hasBetaFeatures": true
              }
            },
            "createdAt": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "company": "<string>",
            "admin": true,
            "isSalesAgent": true
          },
          "verifiRiskLevel": "High",
          "verifi_name": "<string>",
          "source": "Banks",
          "merchant_id": "<string>",
          "id": "<string>"
        },
        "descriptors": [
          {}
        ],
        "id": "<string>",
        "name": "<string>"
      },
      "details": {
        "type": "<string>"
      }
    }
  ]
}

Query Parameters

api_key
string
required

Response

200 - application/json
OK
descriptors
object[]
required