production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/private/customers/profiles/services
post /v1/private/customers/profiles/services
customer-by-service
This API is used to get customer information by customer number, service number and serviceType
API information retrieved from S016
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
channelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
dataCenterLocation
Optional in header
string
CSI Data center location number
{
"maxLength": 2
}stationName
Optional in header
string
Computer name calling or executing API
{
"maxLength": 8
}customerByServiceRequest
Optional in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/private/customers/profiles/services
/v1/private/customers/profiles/service
post /v1/private/customers/profiles/service
create-customer-service
To create service information for the customer
This API is used to create service information for the customer
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
channelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
dataCenterLocation
Optional in header
string
CSI Data center location number
{
"maxLength": 2
}stationName
Optional in header
string
Computer name calling or executing API
{
"maxLength": 8
}createCustomerServiceRequest
Optional in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/private/customers/profiles/service
put /v1/private/customers/profiles/service
update-customer-service
To update service information for the customer
This API is used to update service information for the customer
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
channelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
dataCenterLocation
Optional in header
string
CSI Data center location number
{
"maxLength": 2
}stationName
Optional in header
string
Computer name calling or executing API
{
"maxLength": 8
}updateCustomerServiceRequest
Optional in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
PUT https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/private/customers/profiles/service
Definitions
{
"type": "object",
"properties": {
"customerServiceDetail": {
"$ref": "#/definitions/CustomerServiceDetail"
}
}
}
{
"type": "object",
"properties": {
"customerName": {
"description": "Name of the customer",
"type": "string",
"example": "Chris Brown"
},
"agentId": {
"description": "Identifier of the agent",
"type": "string",
"example": "123456789012"
},
"activationDate": {
"description": "Operation start Date",
"type": "string",
"format": "date",
"example": "2018-01-01"
},
"addressType": {
"description": "Address type",
"type": "string",
"example": "Office"
},
"applicationVersion": {
"description": "Software Version",
"type": "string",
"example": "1234"
},
"canceledDate": {
"description": "Service Cancel Date",
"type": "string",
"format": "date",
"example": "2018-01-01"
},
"consolidatedStatementIndicator": {
"description": "Edition Account Statement",
"type": "integer",
"example": 12
},
"createdDate": {
"description": "Creation Date",
"type": "string",
"format": "date",
"example": "2018-01-01"
},
"stationName": {
"description": "Computer name calling or executing API",
"type": "string",
"example": "1234"
},
"pinUpdateDate": {
"description": "Password update date",
"type": "string",
"format": "date",
"example": "2019-03-26"
},
"pinAssignmentCode": {
"description": "Password assignment to the customer",
"type": "integer",
"example": 12
},
"customerServiceStatus": {
"description": "Status of the customer in the service",
"type": "string",
"example": "40"
},
"lastUpdatedDate": {
"description": "Date of last modification",
"type": "string",
"format": "date",
"example": "2018-01-01"
},
"preferContactMedium": {
"description": "Delivery device",
"type": "string",
"example": "2000"
},
"preferredBranchId": {
"description": "Service Promoter Branch",
"type": "string",
"example": "1234"
},
"renewalDate": {
"description": "Service Renewal Date",
"type": "string",
"format": "date",
"example": "2018-01-01"
},
"securityTokenIndicator": {
"description": "equipment Proprietary",
"type": "string",
"example": "12"
},
"statementDeliveryMode": {
"description": "Account Statement Device",
"type": "string",
"example": "2"
},
"fee": {
"type": "array",
"items": {
"$ref": "#/definitions/Fee"
}
},
"account": {
"$ref": "#/definitions/Account"
}
}
}
{
"type": "object",
"properties": {
"feeAmount": {
"description": "feesCharge",
"type": "number",
"format": "double",
"example": 100
}
}
}
{
"type": "object",
"properties": {
"customerCategoryType": {
"description": "Customer´s Electronic Banking service, based on the catalog D9 of S080 15-51, 15-21, 15-06, 15-99",
"type": "string",
"example": "21"
},
"customerId": {
"description": "Unique Identifier of the customer",
"type": "string",
"example": "123456789012"
},
"customerServiceNumber": {
"description": "Service Number",
"type": "string",
"example": "15"
}
},
"required": [
"customerId"
]
}
{
"type": "object",
"properties": {
"billingCycleDay": {
"description": "billingCycleDay",
"type": "integer",
"example": 28,
"maxLength": 2
},
"productCode": {
"description": "productCode",
"type": "string",
"example": "0066",
"maxLength": 4
},
"productInstrument": {
"description": "productInstrument",
"type": "string",
"example": "0006",
"maxLength": 4
},
"accountNumber": {
"description": "accountNumber",
"type": "string",
"example": "009000498622",
"maxLength": 12
}
}
}
{
"type": "object",
"properties": {
"customerServiceInformation": {
"$ref": "#/definitions/CustomerServiceInformation"
}
}
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique Identifier of the customer",
"type": "string",
"example": "123456789012",
"maxLength": 12
},
"agentId": {
"description": "Identifier of the agent",
"type": "string",
"example": "123456789012",
"maxLength": 10
},
"addressType": {
"description": "Address type",
"type": "string",
"example": "Office",
"maxLength": 4
},
"applicationVersion": {
"description": "Software Version",
"type": "string",
"example": "1234",
"maxLength": 4
},
"consolidatedStatementIndicator": {
"description": "Edition Account Statement",
"type": "integer",
"example": 12,
"maxLength": 2
},
"customerServiceStatus": {
"description": "Status of the customer in the service",
"type": "string",
"example": "40",
"maxLength": 2
},
"preferContactMedium": {
"description": "Delivery device",
"type": "string",
"example": "2000",
"maxLength": 4
},
"preferredBranchId": {
"description": "Service Promoter Branch",
"type": "string",
"example": "1234",
"maxLength": 4
},
"securityTokenIndicator": {
"description": "equipment Proprietary",
"type": "string",
"example": "12",
"maxLength": 2
},
"statementDeliveryMode": {
"description": "Account Statement Device",
"type": "string",
"example": "2",
"maxLength": 2
},
"customerCategoryType": {
"description": "Customer´s Electronic Banking service, based on the catalog D9 of S080 15-51, 15-21, 15-06, 15-99",
"type": "string",
"example": "21",
"maxLength": 2
},
"customerServiceNumber": {
"description": "Service Number",
"example": "15",
"type": "string",
"maxLength": 4
},
"feeInformation": {
"type": "array",
"items": {
"$ref": "#/definitions/FeeInformation"
}
},
"accountInformation": {
"$ref": "#/definitions/AccountInformation"
}
},
"required": [
"customerId"
]
}
{
"type": "object",
"properties": {
"feeAmount": {
"description": "feesCharge",
"type": "number",
"format": "double",
"example": 10,
"maxLength": 2
}
}
}
{
"type": "object",
"properties": {
"billingCycleDay": {
"description": "billingCycleDay",
"type": "integer",
"example": 28,
"maxLength": 2
},
"productCode": {
"description": "productCode",
"type": "string",
"example": "0066",
"maxLength": 4
},
"productInstrument": {
"description": "productInstrument",
"type": "string",
"example": "0006",
"maxLength": 4
},
"accountNumber": {
"description": "accountNumber",
"type": "string",
"example": "009000498622",
"maxLength": 12
}
}
}
{
"type": "object",
"properties": {
"activationDate": {
"description": "Operation start Date",
"type": "string",
"format": "date",
"example": "2018-01-01",
"maxLength": 10
},
"renewalDate": {
"description": "Service Renewal Date",
"type": "string",
"format": "date",
"example": "2018-01-01",
"maxLength": 10
},
"lastUpdatedDate": {
"description": "Date of last modification",
"type": "string",
"format": "date",
"example": "2018-01-01",
"maxLength": 10
},
"createdDate": {
"description": "Creation Date",
"type": "string",
"format": "date",
"example": "2018-01-01",
"maxLength": 10
},
"canceledDate": {
"description": "Service Cancel Date",
"type": "string",
"format": "date",
"example": "2018-01-01",
"maxLength": 10
}
}
}
{
"type": "object",
"properties": {
"customerServiceData": {
"$ref": "#/definitions/CustomerServiceData"
}
}
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique Identifier of the customer",
"type": "string",
"example": "123456789012",
"maxLength": 12
},
"customerCategoryType": {
"description": "Customer´s Electronic Banking service, based on the catalog D9 of S080 15-51, 15-21, 15-06, 15-99",
"type": "string",
"example": "21",
"maxLength": 2
},
"customerServiceNumber": {
"description": "Service Number",
"type": "string",
"example": "15",
"maxLength": 4
},
"customerServiceStatus": {
"description": "Status of the customer in the service",
"type": "string",
"example": "40",
"maxLength": 2
},
"accountDetail": {
"$ref": "#/definitions/AccountDetail"
}
},
"required": [
"customerId"
]
}
{
"type": "object",
"properties": {
"billingCycleDay": {
"description": "billingCycleDay",
"type": "integer",
"example": 28,
"maxLength": 2
},
"productCode": {
"description": "productCode",
"type": "string",
"example": "0066",
"maxLength": 4
},
"productInstrument": {
"description": "productInstrument",
"type": "string",
"example": "0006",
"maxLength": 4
},
"accountNumber": {
"description": "accountNumber",
"type": "string",
"example": "009000498622",
"maxLength": 12
}
}
}
{
"type": "object",
"properties": {
"activationDate": {
"description": "Operation start Date",
"type": "string",
"format": "date",
"example": "2018-01-01",
"maxLength": 10
},
"renewalDate": {
"description": "Service Renewal Date",
"type": "string",
"format": "date",
"example": "2018-01-01",
"maxLength": 10
},
"lastUpdatedDate": {
"description": "Date of last modification",
"type": "string",
"format": "date",
"example": "2018-01-01",
"maxLength": 10
},
"createdDate": {
"description": "Creation Date",
"type": "string",
"format": "date",
"example": "2018-01-01",
"maxLength": 10
},
"canceledDate": {
"description": "Service Cancel Date",
"type": "string",
"format": "date",
"example": "2018-01-01",
"maxLength": 10
}
}
}
{
"properties": {
"type": {
"type": "string",
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
]
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "More Info can be used to pass any additional details",
"type": "string"
},
"uuid": {
"description": "128 bit UUID that you generate for every request",
"type": "string"
},
"timestamp": {
"description": "Timestamp of the error",
"type": "string"
}
},
"required": [
"type",
"code"
]
}