Paths
/thales/{serviceName}
This will provide key-related functionalities.
This will provide key-related functionalities where client will provide some information.
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.
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
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
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Service which channel will invoke like APINUpdate, CVVVerification and more
Operation which involve the cryptographics operation under a service such as encrypt, decrypt, translate more
Successful operation.
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid parameters |
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
| Type | Code | Details |
| error | accessNotConfigured | Access is not configured for this resource |
| Type | Code | Details |
| error | accessNotConfigured | Access is not configured for this resource |
| Type | Code | Details |
| error | businessValidationsFailed | Business validations failed |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error |
Definitions
{
"properties": {
"key": {
"description": "This is key for key-value map that contains the response payload fields",
"type": "string",
"example": "keyGenerationId"
},
"value": {
"description": "This is value for key-value map that contains the response payload fields",
"type": "string",
"example": 1
},
"providerInfo": {
"type": "array",
"items": {
"$ref": "#/definitions/ProviderInfo"
}
}
},
"required": [
"key",
"value"
]
}
{
"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 ICR step which generated the host error, warning, or additional info.",
"type": "string"
}
},
"required": [
"code",
"detail"
]
}
{
"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"
]
}