API Response Structure

Success Response

Sample of Sync Response

Code
{
         "status": 202,
          data:{         
               "message": "We are processing your request and will send the data in the callback URL."
               “job_id”:”XXXX-XXXX-XXXX-XXXX”
          },
          metadata:{
               "source": {{API/Widget/Dashboard/SDK/Portal}}, 
               "entity": {{Data/Insight/Verification/Payment}}         
        },
        error: null, 
 }

Field description

Sample of Async Response

Code
{
    "status": 200,
     "data": {
            "message": “We are successfully able to fetch data”,
            "example-1":"XXXX-XXXX-XXXX",
            "count":{{Number of objects}},
            "example-2"{[
                 "array1":1,
                 "example-3":"xx-xx-xx" 
                 ],[
                 "array2":1,
                 "example-4":"xx-xx-xx"
            ]}  
    },
    metadata:{
        "source": {{API/Widget/Dashboard/SDK/Portal}}, 
        "entity": {{Data/Insight/Verification/Payment}}         
   },
   error: null 
}

Field description

Error Response

Sample of error response

Code
{ 
           "status" : XXX,        
           “error”:{
                  "code": {{brick_unique_error_code}}, 
                  "message": {{description_of_error}}, 
                  "action": {{further_action}},
                  "reason": {{Actual_reason_for_error}}
          }, 
          “metadata”:{
                  "source": {{API/Widget/Dashboard/SDK/Portal}}, 
                  "entity": {{Auth/Insight/Verification/Payment}}
         },
         data:null 
 }

Field description

You can refer all possible error code in the error handling section.