Skip to main content

Authorization

Follow this guide to create a new Chargedesk credential that will allow Nexla to authenticate to and exchange data with your Chargedesk account.
chargedesk_api_auth.png

Chargedesk

Prerequisites​

The ChargeDesk API uses HTTP Basic Authentication. Nexla authenticates by sending your ChargeDesk secret API key as the Basic Auth username, with the password left blank. Before creating a credential, obtain your secret API key from your ChargeDesk account.

Obtain a ChargeDesk Secret API Key​

ChargeDesk connects to your underlying payment gateway (such as Stripe, PayPal, Braintree, Recurly, or Authorize.Net) and exposes a unified API for billing operations. The secret API key authorizes Nexla to read and manage that billing data.

  1. Sign in to your ChargeDesk account at chargedesk.com.

  2. Open your account settings and navigate to the API or developer section, where ChargeDesk lists your API keys.

  3. Locate your Secret API Key. This key authenticates server-to-server requests and should be treated as a sensitive credential—never share it publicly or embed it in client-side code.

  4. Copy the secret API key for use when creating the Nexla credential.

ChargeDesk uses your payment gateway as the primary source of record rather than its own internal systems, so the data returned through the API reflects the records stored in your connected gateway. For complete details about authentication and key management, see the official ChargeDesk API documentation.

Keep your secret key secure

Your ChargeDesk secret API key grants full access to your billing data, including the ability to create charges and issue refunds. Store it securely and rotate it immediately if you suspect it has been exposed.

Create a Chargedesk Credential​

  • To create a new Chargedesk credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Authentication Settings​

ChargeDesk uses HTTP Basic Authentication. Provide your secret API key in the username field; the password field can be left blank because ChargeDesk authenticates using only the secret key.

  1. Enter your ChargeDesk secret API key in the Username Or API Key field. Nexla sends this value as the Basic Auth username on every API request.

  2. Leave the Password field blank when authenticating with a secret API key in the username field. ChargeDesk's HTTP Basic Authentication uses only the secret key as the username, and the password is not required.

  3. Enter the ChargeDesk API base URL in the Base URL field. This value defaults to https://api.chargedesk.com/v1 and should only be changed if directed to use a different host by ChargeDesk.

    The base URL is the root address that Nexla appends each endpoint path to (for example, /charges or /customers). For most accounts, the default value of https://api.chargedesk.com/v1 is correct.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.