DingConnect
API integration

create_a_ding_connect_cancel_transfer

Cancel one or more DingConnect transfers in batch by submitting an explicit list of records to cancel (use ListTransferRecords first to find TransferIds available to cancel). Each result item reports the transfer's ProcessingState — 'Cancelled' means the transfer was successfully cancelled and balance compensations applied, any other state means it could not be cancelled. Returns per item:…

create_a_ding_connect_estimate_price

Estimate send or receive prices for Ding products by submitting a batch of estimation requests. Returns per-item: Price (CustomerFee, DistributorFee, ReceiveValue, TaxRate), SkuCode, BatchItemRef, ResultCode, ErrorCodes. SendValue and ReceiveValue cannot both be non-zero.

list_all_ding_connect_get_account_lookups

Look up the provider and product information for a specific account number in DingConnect. Returns country, provider and region code details for the account number, ready to pass to GetProducts; typically a single entry, but can return multiple items, and returns an empty list when no match is found.

list_all_ding_connect_get_balances

Get the current DingConnect agent balance, including any commission-on-sale increments but excluding transfers that are still processing. Returns the balance record with CurrencyIso and CurrencyName.

list_all_ding_connect_get_countries

List the countries supported by Ding Connect, each with its ISO 3166-1 alpha-2 two letter code (XG is used for products available in all countries) and the country name in English. Returns: CountryIso, CountryName, InternationalDialingInformation, RegionCodes.

list_all_ding_connect_get_currencies

List the ISO 4217 currencies supported by dingconnect. Returns each currency as a three-letter code with its English name: CurrencyIso, CurrencyName. Requires no parameters.

list_all_ding_connect_get_error_code_descriptions

Get a list of error code descriptions in DingConnect: the human readable messages corresponding to the ErrorCodes returned in failed API responses. Returns items with: Code, Description. Messages are aimed at agents, not suitable for end-user display; new error codes may be added over time.

list_all_ding_connect_get_product_descriptions

List localized product descriptions in DingConnect, optionally filtered by product SKU codes and language codes. Returns each record's SkuCode, LocalizationKey, and Descriptions with the localized strings per language. English (en) is always included, and not all items have translations in every language.

list_all_ding_connect_get_products

List Ding Connect products that can be used in SendTransfer, filterable by country, region, provider, SKU, benefit, and account number. Returns each product's SkuCode, ProviderCode, Minimum and Maximum prices, Benefits, ProcessingMode, RedemptionMechanism, SettingDefinitions, and UatNumber. Call GetProductDescriptions for localized product text.

list_all_ding_connect_get_promotion_descriptions

Get localized promotion description strings from DingConnect, each keyed to its promotion via LocalizationKey. Returns: Dates, Headline, TermsAndConditionsMarkDown, BonusValidity, PromotionType, LocalizationKey, LanguageCode, SendAmounts. Optionally filter by language_codes.

list_all_ding_connect_get_promotions

List the Ding promotions that may apply for the submitted criteria. Returns promotion records with id and validity_period_iso (ISO8601 duration, e.g. P30D is 30 days). Localized promotion text is provided separately by the GetPromotionDescriptions endpoint.

list_all_ding_connect_get_providers

List the DingConnect product providers available to the agent account, optionally filtered by provider codes, country ISOs, region codes, or an account number. Returns provider records including ProviderCode, Name, RegionCode, plus ValidationRegex, CustomerCareNumber, and LogoUrl where available. All query filters are optional; use international phone number format for phone-based account numbers.

list_all_ding_connect_get_provider_status

Get the current status of product providers in dingconnect to check whether it is possible to send a transfer to each one. Returns status entries including the agent-facing Message detail, which is unlocalized and not suitable for end users. Optionally filter with provider_codes.

list_all_ding_connect_get_regions

List the regions used in the Ding Connect system. Returns: RegionCode, RegionName, CountryIso.

list_all_ding_connect_list_transfer_records

Query transfer records submitted by the agent in DingConnect. Returns: TransferRecord (with TransferId, SkuCode, Price, CommissionApplied, StartedUtc, CompletedUtc, ProcessingState, ReceiptText, ReceiptParams, AccountNumber), ResultCode, and ErrorCodes. Only transfers from the last 2 months are searchable. Required: Take.

create_a_ding_connect_lookup_bill

Search available bills for an account in dingconnect before paying them via SendTransfer. Returns each matching bill's BillRef, Price (send/receive values, fees, tax), and AdditionalInfo. Only needed for products where LookupBillsRequired is true. Required: SkuCode, AccountNumber.

create_a_ding_connect_send_transfer

Send a transfer to an account in DingConnect. Returns the created transfer record with TransferId, SkuCode, Price (send/receive values, fees, tax), ProcessingState, CommissionApplied, AccountNumber, and receipt details. SkuCode must come from GetProducts; transfers exceeding 90 seconds return ProviderTimedOut and are not charged. Required: SkuCode, SendValue, AccountNumber, DistributorRef, ValidateOnly.