Custom Gateway API Endpoint
Paths
/private/v1/kafka/sessions/login
APIConnect require to log some message to Kafka, such as error 429 from Datapower, Limit Exceed and so on.
APIConnect require to log some message to Kafka, such as error 429 from Datapower, Limit Exceed and so on.
Client ID generated during application registration with the internal development portal. The internal API Gateway will authenticate the application using the client_id and client_secret. Required if accessing APIs via the internal API Gateway.
Client Secret generated during application registration with the internal development portal. The internal API Gateway will authenticate the application using the client_id and client_secret. Required if accessing APIs via the internal API Gateway.
Content-Types that are acceptable for the response. Always pass application/json.
List of acceptable human languages for response.
The MIME type of the body of the request (used with POST and PUT requests). Always pass application/json.
128 bit random universally unique identifier (UUID) generated for every request.
Session ID.
Registered channel ID for the consumer. Examples: HBK(CBOL), ECL(Eclipse), MBK(Mobile Banking).
Citi business codes. Examples: GCB, VMA, QCC.
Country code in ISO 3166 alpha-2 format. Examples: SG(Singapore), PH(Philippines), TH(Thailand).
Unique customer number generated by RM and used in other host systems.
SOE ID of the user sending the request. Applicable only for assisted channels like Eclipse.
Domicile branch code of the user sending the request. Applicable only for assisted channels like Eclipse.
Responsibility centre of the user sending the request. Applicable only for assisted channels like Eclipse.
Branch code where the request is processed. Applicable only for assisted channels like Eclipse.
Responsibility centre of the branch where the request is processed. Applicable only for assisted channels like Eclipse.
User group. Applicable only for assisted channels like Eclipse. Examples: CPC(CitiPhone), PWS(Branch), BKO (BackOffice), PWT (Teller), MSF(Mobile Sales Force).
Session language code in ISO 639-1 format. Applicable only for assisted channels like Eclipse. Examples: EN(English), PL(Polish), RU(Russian), ES(Spanish).
Customer Credential Store (CCS) unique ID for userID/password. Can be used to uniquely identify a customer in CCS.
Unique code to identify the consumer organization
Information on the client / device / terminal firing the request. Information includes device ID, device name, client IP address, terminal ID, etc.
Successful operation.
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid Parameters |
| error | invalidMemberAccessToken | Member access token is invalid. |
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| Type | Code | Details |
| error | resourceNotFound | Empty resource/resource not found |
| Type | Code | Details |
| error | businessValidationsFailed | Business validations failed |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error |
Definitions
{
"properties": {
"messageId": {
"description": "Message ID for the service request",
"type": "string",
"example": "123456789"
},
"eventProducer": {
"description": "Producer of Event",
"type": "string",
"example": "Datapower"
},
"transactionStatus": {
"description": "This is the status of Transactio. ",
"type": "string",
"example": "Failure"
},
"responseStatusCode": {
"description": "status code of response",
"type": "string",
"example": "429"
},
"responseStatusMessage": {
"type": "string",
"description": "status message of response",
"example": "Limit Exceeded"
},
"businessFunctionId": {
"description": "businessFunctionId",
"type": "string",
"example": "Datapower"
},
"requestUrl": {
"description": "requestUrl",
"type": "string",
"example": "/api/operation"
},
"correlationId": {
"description": "correlationId",
"type": "string",
"example": "987654321"
},
"alternateSessionId": {
"type": "string",
"description": "alternateSessionId",
"example": "123456sdgfgi"
},
"businessId": {
"type": "string",
"description": "businessId",
"example": "GCB"
},
"clientIpAddress": {
"description": "clientIpAddress",
"type": "string",
"example": "172.23.62.36"
},
"jsonPayloadMethod": {
"description": "jsonPayloadMethod",
"type": "string",
"example": "GET"
},
"requestBody": {
"description": "requestBody",
"type": "string",
"example": "https://localhost:8080/api/operation"
},
"responseBody": {
"type": "string",
"description": "responseBody",
"example": "Limit Exceeded"
},
"tppIdentifier": {
"type": "string",
"description": "TPPIdentifier",
"example": "Datapower"
},
"startTime": {
"type": "string",
"format": "time",
"description": "A JSON number representing the number of millisecond from 1970-01-01T00:00:00Z to the UTC expiry time.",
"example": "1610652577398"
},
"providerInfo": {
"type": "array",
"items": {
"$ref": "#/definitions/ProviderInfo"
}
}
},
"required": [
"messageId"
]
}
{
"properties": {
"type": {
"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"
],
"type": "string"
},
"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 of the error",
"type": "object"
}
},
"required": [
"type",
"code"
]
}
{
"properties": {
"code": {
"description": "Codes for overridable host errors, warning messages, or additional info.",
"type": "string"
},
"detail": {
"description": "Description for the host error, warning, or additional info",
"type": "string"
},
"fieldId": {
"description": "The field which generated the host error, warning, or additional info",
"type": "string"
}
},
"required": [
"code",
"detail"
]
}