Update Customer Status

'UpdateCustomerStatus' API enables to change the status of customer

Bank or financial institution can update customer status with any one of the valid statuses depending on the requirement. On providing customer details and the required status to be updated as request, the customer status is updated.

Method: POST

{{URL}}/jsonrpc

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameter	Description
method Mandatory	String API method that is being called to update customer status through customer service Constant value: "CustomerService.UpdateCustomerStatus"
id Mandatory	String Unique ID of API request Sample value: "1"
params Mandatory	Object
api Mandatory	Object
signature Mandatory	String Signature for request validation Sample value: "signature code"
keyId Mandatory	String API key used for request authentication Sample value: "ApplicationKeyId"
credential Mandatory	String API credential provided by NetXD Sample value: "Credential"
payload Mandatory	Object
ID Mandatory	String Unique ID of the Customer Sample value: 100000000025001
Status Mandatory	Enum The status to be updated for the Customer Valid values: ACTIVE - Currently active and can perform all defined activities IN_ACTIVE - Not currently active DORMANT - Inactive for specific period SUSPENDED - Temporarily disabled BLOCKED - Restricted to perform all defined activities BLACK_LISTED - Permanently banned Sample value: ACTIVE
notes Optional	String Description or notes given related to customer update status Sample value: Testing Update

cURL

curl --location --globoff '{{URL}}/jsonrpc' \
--header 'Content-Type: application/json' \
--data '{"method":"CustomerService.UpdateCustomerStatus","id":"1","params":{"api":{"signature":"{{signature}}","keyId":"{{ApplicationKeyId}}","credential":"{{Credential}}"},"payload":{"ID":"100000000025001","status":"ACTIVE","notes":"Testing Update"}}}'

C#

var options = new RestClientOptions("{{URL}}/jsonrpc")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"  ""method"": ""CustomerService.UpdateCustomerStatus"",
" + "\n" +
@"  ""id"": ""1"",
" + "\n" +
@"  ""params"": {
" + "\n" +
@"    ""api"": {
" + "\n" +
@"      ""signature"": ""{{signature}}"",
" + "\n" +
@"      ""keyId"": ""{{ApplicationKeyId}}"",
" + "\n" +
@"      ""credential"": ""{{Credential}}""
" + "\n" +
@"    },
" + "\n" +
@"    ""payload"": {
" + "\n" +
@"      ""ID"": ""100000000025001"",
" + "\n" +
@"      ""status"": ""ACTIVE"",
" + "\n" +
@"      ""notes"": ""Testing Update""
" + "\n" +
@"    }
" + "\n" +
@"  }
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "{{URL}}/jsonrpc"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
  "method": "CustomerService.UpdateCustomerStatus",`+"
"+`
  "id": "1",`+"
"+`
  "params": {`+"
"+`
    "api": {`+"
"+`
      "signature": "{{signature}}",`+"
"+`
      "keyId": "{{ApplicationKeyId}}",`+"
"+`
      "credential": "{{Credential}}"`+"
"+`
    },`+"
"+`
    "payload": {`+"
"+`
      "ID": "100000000025001",`+"
"+`
      "status": "ACTIVE",`+"
"+`
      "notes": "Testing Update"`+"
"+`
    }`+"
"+`
  }`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

NodeJS

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': '{{URL}}',
  'path': '/jsonrpc',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "method": "CustomerService.UpdateCustomerStatus",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}"
    },
    "payload": {
      "ID": "100000000025001",
      "status": "ACTIVE",
      "notes": "Testing Update"
    }
  }
});

req.write(postData);

req.end();

Body

{
  "method": "CustomerService.UpdateCustomerStatus",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}"
    },
    "payload": {
      "ID": "100000000025001",
      "status": "ACTIVE",
      "notes": "Testing Update"
    }
  }
}

Response: 200

Response Parameters

Parameter	Description
id	String Response ID echoed from the request ID Sample value: "1"
result	Object
Id	String Unique ID of the customer Sample Value: 100000000005002
Status	Enum Updated status of the Customer Valid values: ACTIVE - Currently active and can perform all defined activities IN_ACTIVE - Not currently active DORMANT - Inactive for specific period SUSPENDED - Temporarily disabled BLOCKED - Restricted to perform all defined activities BLACK_LISTED - Permanently banned Sample Value: ACTIVE

{
  "id": "1",
  "result": {
    "Id": "100000000005002",
    "Status": "ACTIVE"
  }
}