Skip to main content

Ding Connect Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a Ding Connect location.
ding_connect_api.png

Ding Connect

Create a Ding Connect Destination​

  1. Click the + icon on the Nexset that will be sent to the Ding Connect destination, and select the Send to Destination option from the menu.

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

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

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

Configure Using a Template​

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

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Send Transfer

    Executes a mobile top-up or airtime transfer to a recipient's mobile account. This is the primary write operation in the DingConnect API and is used to deliver prepaid recharges to mobile subscribers across 190+ countries. Use this endpoint when your Nexset contains transfer requests — each record should include the product SKU, recipient account number, and the send or receive value.

    • Ensure the Nexset being sent to this destination contains the following required fields for each transfer record:

      • SkuCode: The product SKU code identifying the specific top-up product to send. This value must come from the DingConnect product catalog — use the List Products data source endpoint to retrieve valid SKU codes. Do not attempt to guess or construct SkuCodes manually.
      • AccountNumber: The destination mobile phone number of the recipient, including the international country dialing code (e.g., +447911123456 for a UK mobile number).
      • SendValue or ReceiveValue: The amount of the transfer. Provide either the amount in the distributor's send currency (SendValue) or the amount the recipient should receive in their local currency (ReceiveValue). Only one of these two fields is required per transfer record.
      • DistributorRef: A unique reference string that your organization assigns to this transfer for reconciliation purposes. This value is stored by DingConnect and can be used to look up the transfer record later. It must be unique per transfer — a common pattern is to use a UUID or a combination of date and internal order ID.

    • The following optional fields can also be included in each transfer record:

      • ValidateOnly: Set to true to perform a validation-only run. When enabled, DingConnect will validate the transfer parameters and return an indication of whether a live transfer would succeed, without actually executing the transfer or charging your account. This is useful for testing your data pipeline before enabling live transfers.
      • Settings: An optional object for additional provider-specific transfer settings. Consult the DingConnect API documentation for details on provider-specific settings that may be applicable to your use case.
    • DingConnect processes Send Transfer requests synchronously with a maximum processing time of 90 seconds. If the transfer has not been completed within 90 seconds, DingConnect will return a ProviderTimedOut status. In this case, the transfer may still complete asynchronously — use the List Transfer Records data source endpoint to check the final status of timed-out transfers before retrying.

    The DistributorRef field must be unique for each transfer. Submitting a duplicate DistributorRef will cause DingConnect to reject the transfer request. Ensure your Nexset transformation logic generates a unique reference value for every record before sending it to this destination.

    Cancel Transfers

    Cancels one or more previously submitted transfers that have not yet been processed by DingConnect. This endpoint is specifically for cancelling transfers in batch mode that are in a "Submitted" state (i.e., queued but not yet executed by the provider). Use this endpoint when your workflow needs to revoke pending transfers — for example, when a downstream system cancels an order before the transfer is fulfilled.

    • Ensure the Nexset being sent to this destination contains the following field for each cancellation request:

      • TransferId: The unique DingConnect transfer identifier for the transfer to be cancelled. This value is returned when a transfer is submitted via Send Transfer and is also available in the List Transfer Records data source endpoint. Only transfers that are in "Submitted" (batch-pending) state can be cancelled — transfers that are already processing or completed cannot be reversed.
    • The request body is an array of cancellation request objects, each containing the TransferId of the transfer to cancel. Nexla will send the Nexset records to this endpoint as a JSON body according to the DingConnect Cancel Transfers API specification.
    • DingConnect will return a response for each cancellation request indicating whether the cancellation was accepted. Use the List Transfer Records data source endpoint after cancellation to confirm that the transfer status has been updated to "Cancelled".

    Only transfers in "Submitted" (batch-pending) state can be cancelled. Transfers that have already been sent to a provider for processing cannot be cancelled through this endpoint. For failed or provider-timed-out transfers, contact DingConnect support.

    Estimate Prices (Read-Only Compute)

    Submits price estimation requests to the DingConnect API and returns the calculated rates and fees for a given product and transfer amount. This endpoint has no side effects — it does not execute a transfer or charge your account. It is modelled as a destination in Nexla because it accepts a POST request body. Use this endpoint to pre-calculate the cost of transfers before committing to them, or to populate pricing data in downstream systems.

    • Ensure the Nexset being sent to this destination contains the following fields for each estimation request:

      • SkuCode: The product SKU code for which you want to estimate the price. Retrieve valid SKU codes from the List Products data source endpoint.
      • SendValue or ReceiveValue: The amount to use as the basis for the price estimate. Provide either the send amount in the distributor's currency (SendValue) or the receive amount in the recipient's local currency (ReceiveValue).
    • The DingConnect API will return the estimated send value, receive value, exchange rate, and any applicable fees for each estimation request. This data can be captured by enabling the Response Webhook option (see the Configure Manually section below) so that Nexla automatically routes the API response into a new Nexla data source for further processing.

    This endpoint is read-only and has no side effects. It does not deduct from your account balance or execute any transfers. It is safe to use for testing and pricing calculations without affecting your live DingConnect account.

Configure Manually​

Ding Connect destinations can be manually configured to send data to any valid DingConnect API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the DingConnect API after each call to a new Nexla webhook data source — which is particularly useful for capturing transfer confirmations, price estimates, or cancellation responses in real time.

API Method​

  1. To manually configure this destination, 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. All DingConnect write endpoints use POST.

Data Format​

  1. Select the format in which the Nexset data will be sent to the Ding Connect API from the Content Format pulldown menu. DingConnect accepts JSON (application/json) for all write endpoints. Nexla will automatically convert the data to the selected format for each API call.

API Endpoint URL​

  1. Enter the URL of the Ding Connect API endpoint to which you want to send the Nexset data in the URL field. All DingConnect API v1 write endpoints use the base URL https://api.dingconnect.com/api/V1/. For example:
    • https://api.dingconnect.com/api/V1/SendTransfer
    • https://api.dingconnect.com/api/V1/CancelTransfers
    • https://api.dingconnect.com/api/V1/EstimatePrices

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    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.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Ding Connect destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

Response Webhook​

Optional

Nexla can automatically send the response received from the Ding Connect API after each call to a new Nexla webhook data source. This option allows you to capture and act on transfer confirmations, cancellation results, or price estimation responses returned by DingConnect after each API call.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Enabling the Response Webhook is especially recommended for the Send Transfer endpoint, as it allows you to automatically capture DingConnect's transfer confirmation or error response in real time. You can then route these responses into a reconciliation or alerting flow without requiring a separate polling step via the List Transfer Records endpoint.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Ding Connect API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the Ding Connect API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Ding Connect API using the current settings.

Important

When testing the Send Transfer endpoint, set the ValidateOnly field to true in your sample payload to perform a dry-run validation without executing a live transfer or charging your DingConnect account balance.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To activate data flow to the configured Ding Connect endpoint, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to the Ding Connect API until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.