customer

Retrieves a Customer by customer node id

get/customer/{id}

Request

Base URL
https://serverRoot/tmf-api/customerManagement/v4
Auth
- API key in header X-API-Key
- or OAuth 2
  Client credentials
  Token URLhttps://api.mtn.com/v1/oauth/access_token
TypeScript
https://skmtc.dev/mtn/apis/tmf629-customer-management/docs/customer/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

Customer Node Id, SV_MAPPING: Cust_Acct.XSID_I

fieldsstring

Comma-separated properties to provide in response.The field names should be from the first level of property names as defined in Customer schema.

effectiveDatestring date-time

To search a specific customer history record details based on a given effective date value - Format: yyyy-mm-ddThh:nn:ss

reasonstring

The reason for which API is called. Valid values: BalanceTransfer. This value will be retrieved from RT perestapi.REASON

Success

idstring required

Customer id, SV_MAPPING:CustAcct.ObjectKey

hrefstring required

Reference of the customer - <http://<PEREST_HOSTNAME>:<PEREST_PORT>/<customer PEREST URL>/<CustAcct.ObjectKey>

namestring

Customer Name, SV_MAPPING:Cust_Acct.CustAcctName_X

statusstring

Customer Status, SV_MAPPING:Cust_Acct.CustStatus_R

statusChangeReasonstring

Customer Status Change Reason. SV_MAPPING:Cust_Acct.CustStatusChangeReason_X.

defaultDisplayAccountstring

Default Account Id. SV_MAPPING:Cust_Acct.PrimaryAcctID_I or Account.AcctID_I

No recorded changes to this operation across all 1 revision of this API.