Custom Gateway API Endpoint
Paths
/private/v1/fraudDiagnosis/instantPayments/fraudScore/retrieve
This api will retrieve the rule details and fraud score for corresponding rules
This api will retrieve the rule details and fraud score for corresponding rules
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
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
The most recent Authorization token
RetrieveFraudDiagnosisInstantPaymentsFraudScoreRequest
Successful operation.
No content
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid Parameters |
| Type | Code | Details |
| error | unAuthorized | Authorization credential is missing or invalid |
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| Type | Code | Details |
| error | resourceNotFound | The requested resource is not found |
| Type | Code | Details |
| error | businessValidationsFailed | Business validations failed |
| error | invalidUniqueCaseReferenceNumber | INVALID UNIQUE CASE REFERENCE NUMBER |
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error |
/private/v1/fraudDiagnosis/instantPayments/transactionDetail
This api is to store Transaction Data and calculate the Fraud score for instant payments
This api is to store Transaction Data and calculate the Fraud score for instant payments
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
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
The most recent Authorization token
RecordFraudDiagnosisInstantPaymentsTransactionDetailRequest
Successful operation.
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid Parameters |
| Type | Code | Details |
| error | unAuthorized | Authorization credential is missing or invalid |
| Type | Code | Details |
| error | accessNotConfigured | The request operation is not configured to access this resource |
| Type | Code | Details |
| error | resourceNotFound | The requested resource is 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": {
"providerInfo": {
"type": "array",
"items": {
"$ref": "#/definitions/ProviderInfo"
},
"maxItems": 1
},
"ruleDetail": {
"description": "Rules which are hit while scoring",
"type": "array",
"items": {
"type": "string"
}
},
"fraudScore": {
"description": "Fraudscore code with 16 digits",
"type": "string",
"example": "45236541263FFFFFF"
}
}
}
{
"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": {
"transactionData": {
"type": "array",
"items": {
"$ref": "#/definitions/TransactionData"
},
"maxItems": 1
},
"transactionMessageExchangedata": {
"type": "array",
"items": {
"$ref": "#/definitions/TransactionMessageExchangeData"
},
"maxItems": 1
}
}
}
{
"properties": {
"transactionData": {
"type": "array",
"items": {
"$ref": "#/definitions/TransactionData"
},
"maxItems": 1
},
"transactionMessageExchangedata": {
"type": "array",
"items": {
"$ref": "#/definitions/TransactionMessageExchangeData"
},
"maxItems": 1
},
"transactionStatusInfo": {
"type": "array",
"items": {
"$ref": "#/definitions/TransactionStatusInfo"
},
"maxItems": 1
}
}
}
{
"properties": {
"providerInfo": {
"type": "array",
"items": {
"$ref": "#/definitions/ProviderInfo"
},
"maxItems": 1
}
}
}
{
"properties": {
"transactionStatus": {
"description": "Status of the transaction",
"type": "string",
"example": "FAILURE"
},
"transactionFailureCode": {
"description": "error Code for transaction status",
"type": "array",
"example": "404",
"items": {
"type": "string"
},
"maxItems": 1
},
"transactionFailureDescription": {
"description": "error description for transaction status",
"type": "string",
"example": "Not Found"
}
}
}
{
"properties": {
"summaryReasonCode": {
"description": "The summary reason codes generated by the customer's selected policy which triggered the rules. The summary reason code is used for the easy identification of a set of rules by using a common summary field for them.",
"type": "string",
"example": "I_01"
},
"policyScore": {
"description": "The policy score of the policy which is calculated based on the sum of the risk weights for each of the rules configured within it.",
"type": "integer"
},
"deviceId": {
"description": "ExactID™ is a persistent global identifier which relies on a variety of persistent markers (browser cookies, Adobe Flash cookies, HTML 5 local storage) to allow ThreatMetrix to 100% accurately identify a device.",
"type": "string",
"example": "c7e0b1aa159b4e8bbb55daf0cb7d11b5"
},
"inputIpAddress": {
"description": "Ip address of the Txn originator",
"type": "string",
"example": "192.168.2.3"
},
"inputIpGeo": {
"description": "The 2 character ISO2 country code of the True IP Address.",
"type": "string",
"example": "GB"
},
"organizationIpAddress": {
"description": "Organisation Ip address",
"type": "string",
"example": "192.168.2.3"
},
"trueClientIpAddress": {
"description": "The true client IP Address detected by ThreatMetrix",
"type": "string"
},
"unknownSession": {
"description": "Indicates if the profiling attributes were not collected for the queried session (otherwise not present).",
"type": "string",
"example": "NO"
}
}
}
{
"properties": {
"transactionReferenceId": {
"description": "Refernce number",
"type": "string",
"example": "abcd1234"
},
"customerNumber ": {
"description": "Customer Id /number",
"type": "integer",
"example": 112223221
},
"citiAccountNumber": {
"description": "Payee Account Number",
"type": "integer",
"example": 112223221
},
"otherBankAccountNumber": {
"description": "Beneficiary Account Number",
"type": "integer",
"example": 626554412
},
"otherBankCode": {
"description": "Bank Indicator Code/remitting Bank Indicator Code",
"type": "integer",
"example": 10300022
},
"otherBankMemberId": {
"description": "Customer Id of the Other Bank customer/remitter",
"type": "string",
"example": "SB12345"
},
"transactionAmount": {
"description": "Payment Amount",
"type": "number",
"format": "double",
"example": 10300022
},
"sourceSystemName": {
"description": "To Identify which system consuming the service",
"type": "string",
"example": "Mainframe"
},
"transactionCurrencyCode": {
"description": "Payment Amount Currency",
"type": "string",
"example": "USD"
},
"localCurrencyTransactionAmount": {
"description": "Payment amount in local currency",
"type": "number",
"format": "double",
"example": 1030002.87
},
"availableBalanceAmount": {
"description": "Payee Account Balance",
"type": "number",
"format": "double",
"example": 10300022.06
},
"accountBalanceCurrencyCode": {
"description": "Account Balance currency code",
"type": "string",
"example": "USD"
},
"foreignExchangeRate": {
"description": "Foreign exchange conversion rate",
"type": "number",
"format": "double",
"example": 1.1e-6
},
"otherBankCustomerMobileNumber": {
"description": "Mobile phone number of the remitter",
"type": "integer",
"example": 7356789123
},
"otherBankCustomerName": {
"description": "Remitter's name",
"type": "string"
},
"paymentMode": {
"description": "Payment mode of the transaction",
"type": "string",
"example": "Outgoing"
},
"primaryMobileNumberUpdateCode": {
"description": "Primary Mobile Number Update status code",
"type": "string",
"example": "TC 8001"
},
"secondaryMobileNumberUpdateCode": {
"description": "Secondary Mobile Number Update status code",
"type": "string",
"example": "TC 8002"
},
"notificationDeactivationCode": {
"description": "Notification Deactivation status Code",
"type": "string",
"example": "TC 8009"
},
"accountOpeningTimestamp": {
"description": "Account Opening Date and Time",
"type": "string",
"format": "dateTime",
"example": "2021-03-11 22:30:22"
},
"accountStatus": {
"description": "Account Status",
"type": "string",
"example": "ACTIVE"
},
"payrollIndicator": {
"description": "Payroll Indicator",
"type": "string",
"example": "N"
}
}
}
{
"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"
}
}
}