User Validate

POSThttps://<merchant_base_url>/userValidate

This API is used to validate the status of the user on the merchant.

API Type

DANA Open API

Expected Timeout

5 seconds

SNAP Service Code

application/json

Content Type

application/json

HTTP Response Code

This API must return one of these HTTP response status for the following case:

Response Code	Body	Description
200	OK	Success
201	Created	Order successfully created
400	Bad request	Empty mandatory or illegal parameter(s)
401	Unauthorized	Invalid authentication

version

string

1 - 8 charactersRequired

API version. As per the respective API reference

function

string

1 - 128 charactersRequired

According to specifications defined by each business domain
Value: dana.digital.goods.user.validate

reqTime

string

25 charactersRequired

Request time, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time)

reqMsgId

string

1 - 64 charactersRequired

Identify an unique system request. Each request will be assigned with a unique identifier (UUID)

primaryParam

string

1 - 64 charactersRequired

Mandatory parameter, e.g., cardNo for BPJS autodebit, user identifier, customer identifier

secondaryParam

string

1 - 64 characters

Secondary parameter, e.g., VA number, server identifier

productId

string

1 - 64 charactersRequired

Merchant’s product identifier

{
  "request": {
    "head": {
      "version": "2.0",
      "function": "dana.digital.goods.user.validate",
      "reqTime": "2018-07-04T12:08:56+07:00",
      "reqMsgId": "1234567asdfasdf1123fd123123aasd123"
    },
    "body": {
      "primaryParam": "0001265125533",
      "secondaryParam" : "",
      "productId": "aggr_bpjs_kesehatan_1"
    }
  },
  "signature": "signature string"
}

version

string

1 - 8 charactersRequired

API version. As per the respective API reference

function

string

1 - 128 charactersRequired

According to specifications defined by each business domain
Value: dana.digital.goods.user.validate

respTime

string

25 charactersRequired

Response time, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time)

reqMsgId

string

1 - 64 charactersRequired

Identify an unique system request. Each request will be assigned with a unique identifier (UUID)

validateStatus

json object

Required

Define the detail of validate status information, refer to validateStatus

code

string

1 - 8 charactersRequired

Validation status code

status

string

1 - 16 charactersRequired

Validation status

message

string

1 - 256 charactersRequired

Validation status message

userValidationData

json object

Required

Define the detail of user validation data, refer to userValidationData

primaryParam

string

1 - 64 charactersRequired

Card number of user, user identifier, customer identifier

secondaryParam

string

1 - 32 characters

Virtual account number of user, server identifier

userName

string

1 - 32 charactersConditional

User name

Conditional Info

Y:= bizType is GAME

familyCount

string

1 - 32 characters

Total family count

branchName

string

1 - 32 characters

Branch name of user

flowId

string

1 - 64 charactersConditional

Merchant order identifier or user's biller inquiry identifier or validate identifier from merchant

Conditional Info

Y:= bizType is GAME

userAccount

string

1 - 64 charactersConditional

User game account

Conditional Info

Y:= bizType is GAME

providerName

string

1 - 128 characters

Provider name

productId

string

1 - 64 charactersRequired

Merchant’s product identifier

Success - BPJS
{
  "response": {
    "head": {
      "version": "2.0",
      "function": "dana.digital.goods.user.validate",
      "respTime": "2018-07-04T12:08:56+07:00",
      "reqMsgId": "1234567asdfasdf1123fd123123aasd123"
    },
    "body": {
      "validateStatus": {
        "code": "10",
        "status": "SUCCESS",
        "message": "Success"
      },
      "userValidationData": {
        "primaryParam": "111111111",
        "secondaryParam": "8888801265125533",
        "userName": "Jhon Doe",
        "familyCount": "2",
        "branchName": "Cibubur"
      },
      "providerName": "BPJS Kesehatan",
      "productId" : "aggr_bpjs_kesehatan_1"
    }
  },
  "signature": "signature string"
}

ResultStatus	ResultCode	ResultMessage	Solution
FAILED	06	Unknown Error	Showing error message that user have to try again to inquiry/register
FAILED	07	Data failed to save	Showing error message that user have to try again to inquiry/register
SUCCESS	10	Success	Update order status in DANA to success
FAILED	18	Request Timeout	Showing error message that user have to try again to inquiry/register
FAILED	21	Destination is blocked	Customer account is blocked
FAILED	28	Data not found	DANA will popup error message: `ERROR - Data tidak ditemukan`
FAILED	29	Cut off time	DANA will popup error message: `ERROR - Sedang proses Cut-off, cobalah beberapa saat lagi`
FAILED	90	User already inactive from this platform	Showing error message to contact our CS
FAILED	96	Customer number, Account number, Phone number have to support numeric	Showing error message to the user, that they have to retry to input the customer number
FAILED	97	Preselect date between 1-28th	Showing error message to the user, that they have to retry to input the customer number
FAILED	98	Customer number is not registered as personal insurance	Showing error message to the user, that they have to retry to input the customer number
FAILED	14/94	Invalid customer number	Showing error message to the user, that they have to retry to input the customer number
FAILED	91/92	The user already registered on another platform	Showing error message to the user, that they can’t be registered on the service in DANA

HTTP Response Code​

HTTP Response Code