Skip to main content

Ding Connect Data Source

The Ding Connect connector enables you to ingest data from the DingConnect platform's catalog, account, provider, and transaction endpoints. This connector is particularly useful for applications that need to synchronize the DingConnect product catalog into a data warehouse, monitor provider health, reconcile transfer records, or validate mobile account numbers before executing top-ups.

DingConnect is the world's leading international mobile top-up and airtime API platform, enabling businesses to deliver prepaid recharges and digital products across 190+ countries and 700+ operator networks. Follow the instructions below to create a new data flow that ingests data from a Ding Connect source in Nexla.
ding_connect_api.png

Ding Connect

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Ding Connect connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Ding Connect instance, and click Next; or, create a new Ding Connect credential for use in this flow.

  3. In Nexla, Ding Connect data sources can be created using pre-built endpoint templates, which expedite source setup for common Ding Connect endpoints. Each template is designed specifically for the corresponding Ding Connect endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Ding Connect sources can also be configured manually, allowing you to ingest data from Ding Connect endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Ding Connect endpoints. Each template is designed specifically for the corresponding Ding Connect endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

List Countries

Returns a list of all countries supported by the DingConnect platform. Use this endpoint to populate or refresh a reference table of available country codes and names, which can be used to filter or validate subsequent requests — such as looking up products or providers for a specific country.

  • No additional parameters are required for this endpoint. After selecting it from the Endpoint menu, Nexla will automatically retrieve all supported countries using paginated requests, fetching up to 100 records per page until the full list is returned.
  • The response includes country codes (ISO 3166 format) and country names. These country codes are referenced in other DingConnect endpoints such as List Products and List Providers.

This endpoint uses offset-based pagination. Nexla handles pagination automatically — you do not need to configure any additional paging parameters.

List Currencies

Returns a list of all currencies supported by the DingConnect platform. Use this endpoint to build or refresh a reference table of supported currency codes and their display names, which can then be used when interpreting product pricing data or validating send/receive value fields.

  • No additional parameters are required for this endpoint. Nexla will automatically retrieve the complete currency list using paginated requests.
  • The response includes ISO 4217 currency codes (e.g., USD, EUR, GBP) and their full names. Currency codes appear in product pricing records returned by the List Products endpoint.

This endpoint uses offset-based pagination. Nexla handles pagination automatically — no additional configuration is needed.

List Regions

Returns a list of all geographic regions covered by DingConnect services. Regions are sub-groupings within countries used by some providers to define the geographic scope of their products. Use this endpoint to populate a reference table of region codes that can be used to filter product or provider lookups.

  • No additional parameters are required for this endpoint. Nexla will automatically retrieve all regions using paginated requests, fetching up to 100 records per page.
  • Region codes returned by this endpoint can be used as filter parameters in the List Products and List Providers endpoints when you want to narrow results to a specific geographic area.

List Products

Returns a list of all available products offered through the DingConnect catalog. Products represent specific airtime, data, or digital top-up SKUs that can be sent via the Send Transfer destination endpoint. Use this endpoint to synchronize the product catalog into your data warehouse or analytics environment for pricing analysis, product selection, and integration with your customer-facing interfaces.

  • No additional parameters are required for this endpoint. Nexla will automatically retrieve the complete product catalog using paginated requests, fetching up to 100 products per page until the full catalog is returned.

  • Each product record includes the following key fields:

    • SkuCode: The unique product identifier required when executing a Send Transfer. Only SkuCode values returned by this endpoint should be used — do not attempt to guess or manufacture SkuCodes.
    • SendValue / ReceiveValue: The send and receive amounts for the product, expressed in the distributor's send currency and the recipient's local currency respectively.
    • ProviderCode: The code for the mobile network operator (MNO) that delivers the product.
    • CountryIso: The ISO 3166 country code where the product is available.

DingConnect recommends refreshing your product catalog regularly, as SKUs, pricing, and availability can change. Consider scheduling this data source to run daily or weekly to keep your catalog current.

List Providers

Returns a list of all mobile network operator (MNO) service providers available in the DingConnect network. Use this endpoint to populate a reference table of provider codes and names, which can be used to filter products by provider, look up provider status, or validate the provider for a given account number.

  • No additional parameters are required. Nexla will automatically retrieve all providers using paginated requests, fetching up to 100 records per page.
  • Each provider record includes a ProviderCode (used as an identifier in other API calls), the provider's display name, and the country or region where the provider operates.

List Error Code Descriptions

Returns a static list of all error codes and their human-readable descriptions for the DingConnect API. Use this endpoint to build an error code reference table that can be joined against transfer records or API response logs to make error messages understandable to operations and support teams.

  • No parameters are required. This endpoint returns the complete error code dictionary in a single, non-paginated response.
  • This endpoint is particularly useful for enriching transfer reconciliation data — by joining transfer records with the error code table, you can surface meaningful failure reasons without requiring API knowledge.

Unlike other DingConnect endpoints, List Error Code Descriptions is not paginated and returns the full list in one request. It is recommended to refresh this reference table periodically, as DingConnect may add new error codes when new features or providers are introduced.

List Promotions

Returns a list of all currently active promotions and special offers available through DingConnect. Use this endpoint to surface promotional offers in customer-facing applications, analyze promotional activity across regions, or trigger promotional campaigns in downstream systems.

  • No additional parameters are required. Nexla will automatically retrieve all current promotions using paginated requests, fetching up to 100 records per page.
  • Promotions are time-limited and tied to specific products or providers. Consider scheduling this data source to run frequently (e.g., hourly or daily) to ensure your system reflects current promotional availability.

List Product Descriptions

Returns detailed descriptive information for all available products in the DingConnect catalog. While the List Products endpoint returns pricing and SKU data, this endpoint provides marketing-oriented descriptions that can be used to populate product listings, customer-facing UIs, or catalog databases with human-readable content.

  • No additional parameters are required. Nexla will automatically retrieve all product descriptions using paginated requests, fetching up to 100 records per page.
  • Use this endpoint in conjunction with List Products — join on SkuCode to enrich the product catalog with descriptive text, benefit descriptions, or localized labels.

Get Balance

Returns the current credit balance of the authenticated DingConnect distributor account. Use this endpoint as a pre-flight check before executing batch transfers to verify that your account holds sufficient funds, or schedule it to run at regular intervals to monitor balance levels and trigger low-balance alerts in downstream systems.

  • No parameters are required. This endpoint returns a single non-paginated response containing the current balance amount and the currency in which the balance is held.
  • Consider routing the output of this source into a monitoring flow that alerts your team when the balance drops below a defined threshold — helping to prevent transfer failures caused by insufficient funds.

This endpoint returns the balance for the account associated with the credential used. If your organization has multiple DingConnect accounts (e.g., production and test), ensure you are using the correct credential when monitoring live account balances.

Lookup Account

Validates a mobile account number (typically a phone number including country code) and returns the matching provider, region, and country. Use this endpoint to pre-validate destination phone numbers before executing a Send Transfer, reducing failed transactions caused by invalid or unresolvable account numbers.

  • Enter the mobile phone number to validate in the Account Number field. The account number should include the international country dialing code (e.g., +1 for the United States, +44 for the United Kingdom) without spaces or special characters.

  • The response returns the matched provider code, region code, and country code for the account number. These values can be used to confirm the correct operator before selecting a product SKU and sending a transfer.
  • A successful lookup does not guarantee that a transfer will succeed — it only confirms that DingConnect can resolve the account number to a provider. Always verify that a suitable product SKU is available for the identified provider before executing a transfer.

The Account Number field is required. Include the full international number with country code. For example, a UK mobile number would be entered as +447911123456.

List Provider Status

Returns the current operational status of DingConnect providers (e.g., up, down, or degraded). Use this endpoint to monitor provider health before routing transfers, build provider health dashboards, or implement automated routing logic that avoids degraded providers.

  • Optionally, enter a comma-separated list of provider codes in the Provider Codes field to filter the response to specific providers. Leave this field blank to retrieve the status of all providers in the DingConnect network.

  • Provider codes can be obtained from the List Providers endpoint. If you are monitoring a specific set of providers relevant to your business (e.g., providers in a specific country or region), filtering by provider code reduces the response size and makes downstream processing more efficient.
  • Consider scheduling this data source to run frequently (e.g., every 15 to 30 minutes) when building a real-time provider health monitoring flow, so that your system can react quickly to provider outages.

The Provider Codes parameter is optional. When left blank, the status of all providers is returned.

List Transfer Records

Returns historical and in-flight transfer records from your DingConnect distributor account. Use this endpoint to reconcile completed transactions, audit transfer activity, monitor batch-mode transfers that have not yet been processed, or feed transfer data into a reporting or analytics pipeline.

  • No additional Nexla-side parameters are required for this endpoint. Nexla will automatically retrieve transfer records using paginated POST requests, fetching up to 100 records per page until all records are returned.

  • Transfer records include the following key fields:

    • TransferId: The unique DingConnect identifier for the transfer, used to cancel or look up a specific transfer.
    • DistributorRef: Your organization's own reference identifier for the transfer, if provided at the time of submission.
    • Status: The current state of the transfer (e.g., Submitted, Processing, Succeeded, Failed, Cancelled).
    • AccountNumber: The destination mobile account number that received the top-up.
    • SkuCode: The product SKU that was sent.
  • For reconciliation workflows, consider using this endpoint in a scheduled flow that runs daily to capture all transfers from the prior day and load them into your data warehouse or accounting system.

This endpoint retrieves all transfer records accessible to the authenticated account. If your organization requires filtering by date range, account number, or distributor reference, these filters can be applied after ingestion using Nexla's data transformation capabilities.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Ding Connect data sources can be manually configured to ingest data from any valid DingConnect API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Ding Connect sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom request parameters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Ding Connect API from the Method pulldown menu. The most common methods for DingConnect read endpoints are:

    • GET: For retrieving catalog, account, and status data (e.g., GetCountries, GetProducts, GetBalance, GetProviderStatus).
    • POST: For endpoints that accept request body parameters (e.g., ListTransferRecords, which accepts filters such as date range and account number in the request body).

API Endpoint URL​

  1. Enter the URL of the DingConnect API endpoint from which this source will fetch data in the Set API URL field. All DingConnect API v1 endpoints use the base URL https://api.dingconnect.com/api/V1/. For example:
    • https://api.dingconnect.com/api/V1/GetCountries
    • https://api.dingconnect.com/api/V1/GetProducts
    • https://api.dingconnect.com/api/V1/ListTransferRecords

The complete list of DingConnect API endpoints and their parameters is available in the DingConnect API documentation. All endpoints require a valid authenticated credential — ensure your Ding Connect credential is selected before testing.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.

Date/time macros are useful for DingConnect endpoints that accept date parameters, such as filtering transfer records by a date range. For example, you could use macros to dynamically set a start date of {now-1} (yesterday) when querying transfer records each day.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are useful when chaining DingConnect API calls. For example, you could use provider codes retrieved from a List Providers source as macro inputs for a dynamic List Provider Status or List Products request that filters by specific providers.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data returned by a DingConnect API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response.

DingConnect API responses typically wrap result records in a top-level Items array alongside pagination metadata. For example, a response from the GetProducts endpoint looks like:

{
  "Items": [ ... ],
  "TotalItemCount": 1500,
  "Skip": 0,
  "Take": 100
}

By specifying the path $.Items[*], you instruct Nexla to treat each element of the Items array as an individual record, rather than ingesting the entire response object as a single record.

Path to Data is essential for all DingConnect list endpoints. Without specifying $.Items[*] (or the equivalent path for the endpoint you are using), Nexla will treat the entire response object — including pagination metadata — as a single record, which is not the intended behavior.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. For most DingConnect endpoints, this value is $.Items[*].

    • For the Get Balance endpoint, the entire response object is the relevant data — enter $ as the path, or leave the field empty to ingest the full response.

    Path to Data Example:

    For most DingConnect list endpoints, enter $.Items[*] to extract each item in the result array as a separate record. For the Get Balance endpoint, enter $ to treat the full response as a single record.

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record.

For DingConnect, the pagination metadata fields (TotalItemCount, Skip, Take) are returned at the top level of the response alongside the Items array. If you want to preserve this pagination context with each record — for example, to track how many total records exist in a given sync — you can specify a metadata path to capture these fields.

Metadata paths are particularly useful when building reconciliation flows where you need to confirm that all records were retrieved (e.g., by checking that the total number of ingested records matches TotalItemCount).

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers may be required for API versioning or other custom requirements specific to your DingConnect integration.

    You do not need to include authentication headers (such as Authorization: Bearer ... or api_key) in this field. These headers are automatically added by Nexla based on the Ding Connect credential you selected.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Ding Connect data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.