production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/customers/interbank-payees/risk-scores/retrieve
post /v1/customers/interbank-payees/risk-scores/retrieve
retrieve-interbank-payee-risk-score
LOB: Mobile; Feature: Threat Metrix score; Functionality: Retrieve Risk Score for inter-bank payees operation
This API helps to complete data about adding a new interbank payee in order to retrieve the risk score from TMX through Transmit
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
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
interbankPayeeRiskScoreRequest
Required 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/interbank-payees/risk-scores/retrieve
/v1/customers/intrabank-payees/risk-scores/retrieve
post /v1/customers/intrabank-payees/risk-scores/retrieve
retrieve-intrabank-payee-risk-score
LOB: Mobile; Feature: Threat Metrix score; Functionality: Retrieve Risk Score for intra-bank payees operation
This API helps to complete data about adding a new intrabank payee in order to retrieve the risk score from TMX through Transmit
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
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
sid
Required in header
string
SessionId sent by Consumer
IntrabankPayeeRiskScoreRequest
Required 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/intrabank-payees/risk-scores/retrieve
Definitions
{
"type": "object",
"properties": {
"dataCenterLocation": {
"description": "It is an identifier of the place where the User was created.",
"type": "string",
"example": "10"
},
"tmxSessionId": {
"description": "This is a session identifier generated when device profiling was initiated",
"type": "string",
"example": "12345678"
},
"webSessionId": {
"description": "The inputted Web Session ID that represents a session for a user in a customers",
"type": "string",
"example": "2da237808d724441a94797dad7c30d00"
},
"eventType": {
"description": "Type of the performed event",
"type": "string",
"example": "ADD_PAYEE"
},
"localTransactionDate": {
"description": "Local date and time when the transaction takes place at the acceptor location.",
"type": "string",
"format": "date-time",
"example": "2017-07-21T17:32:28Z"
},
"userAuthentication": {
"$ref": "#/definitions/UserAuthenticationInfo"
},
"payeeAcount": {
"$ref": "#/definitions/PayeeAccount"
}
},
"required": [
"tmxSessionId",
"eventType",
"userAuthentication",
"payeeAcount",
"localTransactionDate"
]
}
{
"type": "object",
"properties": {
"transactionId": {
"description": "Identifier retrieved from transmit generated in TMX",
"type": "string",
"example": "4013060000"
},
"highRiskCode": {
"description": "Risk score from TMX transaction risk assessment",
"type": "string",
"example": "10"
},
"operationName": {
"description": "Name of the operation name configured in Transmit",
"type": "string",
"example": "Login"
},
"decisionCode": {
"description": "Refers to how the operation should proceed 1-allow, 2-review, 3-deny",
"type": "string",
"example": "1"
}
},
"required": [
"transactionId",
"highRiskCode",
"operationName",
"decisionCode"
]
}
{
"type": "object",
"properties": {
"dataCenterLocation": {
"description": "It is an identifier of the place where the User was created.",
"type": "string",
"example": "10"
},
"tmxSessionId": {
"description": "This is a session identifier generated when device profiling was initiated",
"type": "string",
"example": "12345678"
},
"eventType": {
"description": "Type of the event performed",
"type": "string",
"example": "PAYMENT"
},
"legacySessionId": {
"description": "The inputted Web Session ID that represents a session for a user in a customers",
"type": "string",
"example": "2da237808d724441a94797dad7c30d00"
},
"localTransactionDate": {
"description": "Local date and time when the transaction takes place at the acceptor location.",
"type": "string",
"format": "date-time",
"example": "2017-07-21T17:32:28Z"
},
"customer": {
"$ref": "#/definitions/Customer"
},
"device": {
"$ref": "#/definitions/Device"
}
},
"required": [
"tmxSessionId",
"eventType",
"localTransactionDate"
]
}
{
"type": "object",
"properties": {
"transactionId": {
"description": "Identifier retrieved from transmit generated in TMX",
"type": "string",
"example": "4013060000"
},
"highRiskCode": {
"description": "Risk score from TMX transaction risk assessment",
"type": "string",
"example": "10"
},
"operationName": {
"description": "Name of the operation made ",
"type": "string",
"example": "Login"
},
"decisionCode": {
"description": "Refers to how the operation should proceed 1-allow, 2-review, 3-deny",
"type": "string",
"example": "1"
}
},
"required": [
"transactionId",
"highRiskCode",
"operationName",
"decisionCode"
]
}
{
"type": "object",
"properties": {
"customerId": {
"description": "This is a unique customer identifier",
"type": "string",
"example": "1234567"
},
"payeeAccountInfo": {
"$ref": "#/definitions/PayeeAccountInfo"
}
},
"required": [
"payeeAccountInfo"
]
}
{
"type": "object",
"properties": {
"accountType": {
"description": "Type of the account",
"type": "string",
"example": "10"
},
"accountNumber": {
"description": "Beneficiary account Number",
"type": "string",
"example": "123456789"
},
"accountAlias": {
"description": "Beneficiary CLABE",
"type": "string",
"example": "456789945613"
},
"cardNumber": {
"description": "Beneficiary card number",
"type": "string",
"example": "1234567890123456"
},
"phoneNumber": {
"description": "Beneficiary phone number associated to the destination account",
"type": "string",
"example": "123456789"
},
"branchId": {
"description": "Branch identifier of the destination account",
"type": "string",
"example": "1234",
"maxLength": 4
},
"currencyCode": {
"description": "A currency code is a code that uniquely identifies a currency. ISO 4217 is the International Standard for currency codes",
"type": "string",
"maxLength": 4,
"example": "USD"
},
"payeeInfo": {
"$ref": "#/definitions/PayeeInfo"
}
},
"required": [
"currencyCode",
"payeeInfo",
"accountType"
]
}
{
"type": "object",
"properties": {
"payeeNickName": {
"description": "Beneficiary Alias",
"type": "string",
"example": "TELMEX"
},
"transactionLimitAmount": {
"description": "Limit of the transaction amount set for the payee",
"type": "number",
"format": "double",
"example": 20000.55
},
"emailAddress": {
"description": "Payee email address",
"type": "string",
"example": "john.wick@citi.com"
}
},
"required": [
"payeeNickName",
"transactionLimitAmount"
]
}
{
"type": "object",
"properties": {
"deviceApplicationType": {
"description": "The type of application used on the device for authentication. Sample application types are Mobile Thin IOS, Mobile Thick Android etc.",
"type": "string",
"maxLength": 255,
"example": "MOBILE_THICK_IOS"
},
"ipAddress": {
"description": "Ip address of the device",
"type": "string",
"example": "100.200.102.500"
},
"geoLatitude": {
"description": "Device location latitude",
"type": "string",
"maxLength": 20,
"example": "23.634501"
},
"geoLongitude": {
"description": "Device location longitude",
"type": "string",
"maxLength": 20,
"example": "-102.552788"
}
}
}
{
"type": "object",
"properties": {
"userId": {
"description": "This is a unique customer identifier e.g. user name, account id, or login name.",
"type": "string",
"example": "111577480"
},
"device": {
"$ref": "#/definitions/Device"
}
},
"required": [
"userId"
]
}
{
"type": "object",
"properties": {
"payeeRecipientType": {
"description": "Type of the recipient account",
"type": "string",
"example": "SAME_BANK"
},
"accountType": {
"description": "Type of the account",
"type": "string",
"example": "DEBIT"
},
"accountNumber": {
"description": "Beneficiary account Number",
"type": "string",
"example": "123456789"
},
"accountAlias": {
"description": "Beneficiary CLABE",
"type": "string",
"example": "456789945613"
},
"payee": {
"$ref": "#/definitions/Payee"
}
},
"required": [
"accountType",
"payeeRecipientType",
"payee"
]
}
{
"type": "object",
"properties": {
"payeeType": {
"description": "Type of the payee",
"type": "string",
"example": "1551"
},
"payeeFullName": {
"description": "Full name of the payee",
"type": "string",
"example": "JUAN PEREZ"
},
"payeeNickName": {
"description": "Beneficiary Alias",
"type": "string",
"example": "TELMEX"
},
"transactionLimitAmount": {
"description": "Limit of the transaction amount set for the payee",
"type": "number",
"format": "double",
"example": 20000.55
},
"emailAddress": {
"description": "Payee email address",
"type": "string",
"example": "john.wick@citi.com"
},
"taxId": {
"description": "Payee RFC",
"type": "string",
"example": "JOSN871010HL6"
},
"curp": {
"description": "Payee CURP",
"type": "string",
"example": "JOSN871010MMCXPX09"
}
},
"required": [
"payeeType",
"payeeFullName",
"payeeNickName",
"transactionLimitAmount"
]
}
{
"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 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"
]
}