Skip to main content

UAT API credentials for DingConnect API users

Updated

DingConnect users can now create test API keys and test OAuth2 credentials through DingConnect+ portal and test API endpoints using those test credentials.

 

How it works

You must first create a Test Agent. Any API key or OAuth2 credential created under that Test Agent will be created as a test credential.

 

Credential limits

  • 1 Test Agent per distributor
  • Under the Test Agent: max 2 API keys + max 2 OAuth2 credentials
  • Test Agents may also be created by DingConnect admin using Agent type “UAT”
  • New distributors will have a default Test Agent called “UAT Api Agent”

 

How to generate Test Credentials

  1. Create a Test Agent

Prerequisite You would require to be an Administrator to create Test Agent. Once logged in, please click on Account Settings → Users → Agents → New Agent → set Type = Test → Save

Notes:

  • Agent balance has no effect for Test Agents
  • Test Agents cannot create users
     

2. Create test API key / OAuth2 credentials

Go to: Account Settings → Developer → API Security Configuration

  • For ApiKey, select the Test Agent (“UAT Api Agent”) in the Agent dropdown and click Add

  • For OAuth2, select OAuth2 and generate credentials under the Test Agent

     

UAT response behaviour

1. Account-number based methods (e.g., GetProducts, GetAccountLookup):

  • These methods using filter “?AccountNumber=” return an actual response for any real/valid number.
  • For non-valid account numbers, the API attempts to detect the country from the provided account number and returns the first provider from that country.
  • This behaviour applies to methods that filter by account number, such as:
    • GetProviders
    • GetProducts
    • GetAccountLookup


2. SendTransfer error simulation

  • For SendTransfer, every valid number returns a UAT success.
  • To reproduce errors, use the UAT number returned in GetProducts response where the last digits match the mapping in the table (examples: 0000X, 000XX).
  • You can use any UAT number that matches the pattern—the example below shows a convenient set for an India UAT Number 910000000000:
Phone NumberErrorContext
910000000001RateLimited 
910000000002TransientProviderErrorProviderTimedOut
910000000003TransientProviderErrorProviderRefusedRequest
910000000004ProviderErrorProductUnavailable
910000000005AccountNumberInvalidProviderRefusedRequest
910000000006TransientProviderErrorProviderTemporarilyUnavailable
910000000007InsufficientBalance 
910000000008AccountNumberInvalidAccountNumberFailedRegex
910000000009ProviderErrorRechargeNotAllowed
910000000010TransientProviderErrorAccountTemporarilyUnavailable
910000000011ProviderErrorProviderUnknownError
910000000012OtherError 


3. Throttling (UAT test credentials)

Please note throttling is applied for all methods when using test credentials.

All methods follow DingConnect API rate limits, except these methods, which are limited to 100 requests per day for UAT traffic:

  • GetProviders
  • GetAccountLookup
  • GetProducts
  • SendTransfer
  • GetPromotions

Important: The limit is per distributor (not per API key), and throttling is only applied for UAT traffic.

Related articles