production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/customers/services/token/status
post /v1/customers/services/token/status
customer-token-status
LOB:Customers; Feature:Security; Functionality:Token
This API is used to retrieve the status for the customer token, where customer can be both physical or moral
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
countryCode
Optional in header
string
Country code in 2 character ISO 3166 format
businesscode
Optional in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Optional in header
string
SessionId sent by Consumer
serviceStatusRequest
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/customers/services/token/status
/v1/customers/services/token/status/manage
put /v1/customers/services/token/status/manage
update-customer-token-status
LOB:Customers; Feature:Security; Functionality:Token
This API is used to update the status for the customer token, where customer can be both physical or moral
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
countryCode
Optional in header
string
Country code in 2 character ISO 3166 format
businesscode
Optional in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Optional in header
string
SessionId sent by Consumer
updateCustomerTokenStatusRequest
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/customers/services/token/status/manage
post /v1/customers/services/token/status/manage
create-customer-token-status
LOB:Customers; Feature:Security; Functionality:Token
This API is used to create the status for the customer token, where customer can be both physical or moral
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
countryCode
Optional in header
string
Country code in 2 character ISO 3166 format
businesscode
Optional in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Optional in header
string
SessionId sent by Consumer
createCustomerTokenStatusRequest
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/customers/services/token/status/manage
Definitions
{
"type": "object",
"properties": {
"customerId": {
"description": "Customer identifier",
"type": "string",
"example": "000004945914",
"maxLength": 12
},
"stationName": {
"description": "Station name that calls the service",
"type": "string",
"example": "1234"
},
"customerServiceNumber": {
"description": "Service number contracted by the customer, such as 15 than identifies electronic banking service",
"type": "integer",
"format": "int32",
"example": 15,
"maxLength": 4
},
"customerCategoryType": {
"description": "Identifier of customer category type, 99 for physical customers, 00 for companies/enterprises",
"type": "integer",
"format": "int32",
"example": 99,
"maxLength": 2
},
"pageId": {
"description": "page identifier",
"type": "integer",
"format": "int32",
"example": 2,
"maxLength": 3
},
"representativeIndex": {
"description": "Representative index in case of companies/enterprises",
"type": "integer",
"format": "int32",
"example": 1,
"maxLength": 4
}
},
"required": [
"customerId"
]
}
{
"type": "object",
"properties": {
"moreInformationFlag": {
"description": "Flag that indicates if exists more information",
"type": "boolean",
"example": false,
"maxLength": 1
},
"pageId": {
"description": "page id",
"type": "integer",
"example": 2,
"maxLength": 3
},
"service": {
"type": "array",
"items": {
"$ref": "#/definitions/CustomerService"
}
}
},
"required": [
"moreInformationFlag",
"pageId"
]
}
{
"type": "object",
"properties": {
"customerServiceNumber": {
"description": "Service number contracted by the customer, such as 15 than identifies electronic banking service",
"type": "integer",
"format": "int32",
"example": 5544,
"maxLength": 4
},
"customerCategoryType": {
"description": "Identifier of customer category type, 99 for physical customers, 00 for companies/enterprises",
"type": "integer",
"format": "int32",
"example": 20,
"maxLength": 2
},
"serviceStatus": {
"description": "Status of the service",
"type": "integer",
"format": "int32",
"example": 1,
"maxLength": 2
},
"representativeIndex": {
"description": "Representative index in case of companies/enterprises",
"type": "integer",
"format": "int32",
"example": 1,
"maxLength": 2
}
},
"required": [
"customerServiceNumber",
"customerCategoryType",
"serviceStatus",
"representativeIndex"
]
}
{
"type": "object",
"properties": {
"customerService": {
"type": "array",
"items": {
"$ref": "#/definitions/CustomerServiceDetail"
}
}
}
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique identifier of the Customer",
"type": "string",
"example": "123456789012",
"maxLength": 12
},
"stationName": {
"description": "Station name that calls the service",
"type": "string",
"example": "1234"
},
"customerServiceNumber": {
"description": "Service number contracted by the customer, such as 15 than identifies electronic banking service",
"type": "integer",
"format": "int32",
"example": 15,
"maxLength": 4
},
"customerCategoryType": {
"description": "Identifier of customer category type, 99 for physical customers, 00 for companies/enterprises",
"type": "integer",
"format": "int32",
"example": 99,
"maxLength": 2
},
"legalRepresentative": {
"type": "array",
"items": {
"$ref": "#/definitions/LegalRepresentative"
}
}
},
"required": [
"customerId"
]
}
{
"type": "object",
"properties": {
"legalRepresentativeId": {
"description": "Unique identifier for corporate legal Representative",
"type": "string",
"example": "123456789"
},
"legalRepresentativeStatus": {
"description": "Legal Representative Status",
"type": "string",
"example": "02"
}
},
"required": [
"legalRepresentativeId"
]
}
{
"type": "object",
"properties": {
"customerService": {
"type": "array",
"items": {
"$ref": "#/definitions/CustomerServiceInfo"
}
}
}
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique identifier of the Customer",
"type": "string",
"example": "123456789012",
"maxLength": 12
},
"customerServiceNumber": {
"description": "Service number contracted by the customer, such as 15 than identifies electronic banking service",
"type": "integer",
"format": "int32",
"example": 15,
"maxLength": 4
},
"customerCategoryType": {
"description": "Identifier of customer category type, 99 for physical customers, 00 for companies/enterprises",
"type": "integer",
"format": "int32",
"example": 99,
"maxLength": 2
},
"responseStatusFlag": {
"description": "Response status flag",
"type": "boolean",
"example": "True"
},
"responseMessage": {
"description": "Response status Message",
"type": "string",
"example": "Retrieve Error"
},
"legalRepresentative": {
"type": "array",
"items": {
"$ref": "#/definitions/LegalRepresentativeInfo"
}
}
},
"required": [
"customerId"
]
}
{
"type": "object",
"properties": {
"legalRepresentativeId": {
"description": "Unique identifier for corporate legal Representative",
"type": "string",
"example": "123456789"
},
"legalRepresentativeStatus": {
"description": "Legal Representative Status",
"type": "string",
"example": "02"
}
},
"required": [
"legalRepresentativeId"
]
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique identifier of the Customer",
"type": "string",
"example": "123456789012",
"maxLength": 12
},
"customerServiceNumber": {
"description": "Service number contracted by the customer, such as 15 than identifies electronic banking service",
"type": "integer",
"format": "int32",
"example": 15,
"maxLength": 4
},
"customerCategoryType": {
"description": "Identifier of customer category type, 99 for physical customers, 00 for companies/enterprises",
"type": "integer",
"format": "int32",
"example": 99,
"maxLength": 2
},
"legalRepresentative": {
"$ref": "#/definitions/LegalRepresentativeData"
}
},
"required": [
"customerId"
]
}
{
"type": "object",
"properties": {
"legalRepresentativeId": {
"description": "Unique identifier for corporate legal Representative",
"type": "string",
"example": "123456789"
},
"legalRepresentativeStatus": {
"description": "Legal Representative Status",
"type": "string",
"example": "02"
}
}
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique identifier of the Customer",
"type": "string",
"example": "123456789012",
"maxLength": 12
},
"customerServiceNumber": {
"description": "Service number contracted by the customer, such as 15 than identifies electronic banking service",
"type": "integer",
"format": "int32",
"example": 15,
"maxLength": 4
},
"customerCategoryType": {
"description": "Identifier of customer category type, 99 for physical customers, 00 for companies/enterprises",
"type": "integer",
"format": "int32",
"example": 99,
"maxLength": 2
},
"legalRepresentative": {
"$ref": "#/definitions/LegalRepresentativeInformation"
}
},
"required": [
"customerId"
]
}
{
"type": "object",
"properties": {
"legalRepresentativeId": {
"description": "Unique identifier for corporate legal Representative",
"type": "string",
"example": "123456789"
},
"legalRepresentativeStatus": {
"description": "Legal Representative Status",
"type": "string",
"example": "02"
}
}
}
{
"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": "URI to human readable documentation or detailed description of the error",
"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"
]
}