production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/customers/bill-payments/risk-scores/retrieve
post /v1/customers/bill-payments/risk-scores/retrieve
retrieve-bill-risk-score
LOB: Mobile; Feature: Threat Metrix score; Functionality: Retrieve Risk Score for bill payments
This API helps to complete data for Bill Payments in order to retrieve the risk score from TMX
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
retrieveBillRiskScoreRequest
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/bill-payments/risk-scores/retrieve
/v1/customers/tax-payments/risk-scores/retrieve
post /v1/customers/tax-payments/risk-scores/retrieve
retrieve-tax-risk-score
LOB: Mobile; Feature: Threat Metrix score; Functionality: Retrieve Risk Score for tax payments
This API helps to complete data for Tax Payments in order to retrieve the risk score from TMX
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
retrieveTaxRiskScoreRequest
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/tax-payments/risk-scores/retrieve
/v1/customers/credit-payments/risk-scores/retrieve
post /v1/customers/credit-payments/risk-scores/retrieve
retrieve-credit-risk-score
LOB: Mobile; Feature: Threat Metrix score; Functionality: Retrieve Risk Score for credit payments
This API helps to complete data for Credit Payments in order to retrieve the risk score from TMX
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
retrieveCreditRiskScoreRequest
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/credit-payments/risk-scores/retrieve
/v1/customers/order-payments/risk-scores/retrieve
post /v1/customers/order-payments/risk-scores/retrieve
retrieve-order-risk-score
LOB: Mobile; Feature: Threat Metrix score; Functionality: Retrieve Risk Score for order payments
This API helps to complete data for Order Payments in order to retrieve the risk score from TMX
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
retrieveOrderRiskScoreRequest
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/order-payments/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",
"maxLength": 128,
"example": "12345678"
},
"tmxEventType": {
"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"
},
"payeeType": {
"description": "Beneficiary Type: It can be a specific number for each type",
"type": "string",
"example": "1521"
},
"localTransactionDate": {
"description": "Local time when the transaction takes place at the acceptor location.This is also printed on the credit card receipt.",
"type": "string",
"format": "date-time",
"example": "2017-07-21T17:32:28Z"
},
"customer": {
"$ref": "#/definitions/Customer"
}
},
"required": [
"tmxSessionId",
"tmxEventType",
"dataCenterLocation",
"localTransactionDate",
"customer"
]
}
{
"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": {
"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",
"maxLength": 128,
"example": "12345678"
},
"tmxEventType": {
"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"
},
"payeeType": {
"description": "Beneficiary Type: It can be a specific number for each type",
"type": "string",
"example": "1521"
},
"localTransactionDate": {
"description": "Local time when the transaction takes place at the acceptor location.This is also printed on the credit card receipt.",
"type": "string",
"format": "date-time",
"example": "2017-07-21T17:32:28Z"
},
"customer": {
"$ref": "#/definitions/Customer"
}
},
"required": [
"tmxSessionId",
"tmxEventType",
"dataCenterLocation",
"localTransactionDate",
"customer"
]
}
{
"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": {
"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",
"maxLength": 128,
"example": "12345678"
},
"tmxEventType": {
"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"
},
"payeeType": {
"description": "Beneficiary Type: It can be a specific number for each type",
"type": "string",
"example": "1521"
},
"localTransactionDate": {
"description": "Local time when the transaction takes place at the acceptor location.This is also printed on the credit card receipt.",
"type": "string",
"format": "date-time",
"example": "2017-07-21T17:32:28Z"
},
"customer": {
"$ref": "#/definitions/Customer"
}
},
"required": [
"tmxSessionId",
"tmxEventType",
"dataCenterLocation",
"localTransactionDate",
"customer"
]
}
{
"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": {
"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",
"maxLength": 128,
"example": "12345678"
},
"tmxEventType": {
"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"
},
"payeeType": {
"description": "Beneficiary Type: It can be a specific number for each type",
"type": "string",
"example": "1521"
},
"localTransactionDate": {
"description": "Local time when the transaction takes place at the acceptor location.This is also printed on the credit card receipt.",
"type": "string",
"format": "date-time",
"example": "2017-07-21T17:32:28Z"
},
"customer": {
"$ref": "#/definitions/Customer"
}
},
"required": [
"tmxSessionId",
"tmxEventType",
"dataCenterLocation",
"localTransactionDate",
"customer"
]
}
{
"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": {
"customerType": {
"description": "Type of customer",
"type": "string",
"example": "Individual"
},
"customerId": {
"description": "This is a unique customer identifier",
"type": "string",
"example": "123456"
},
"device": {
"$ref": "#/definitions/Device"
},
"transaction": {
"$ref": "#/definitions/Transaction"
}
},
"required": [
"customerType",
"customerId",
"transaction"
]
}
{
"type": "object",
"properties": {
"accountNumber": {
"description": "This is the source account",
"type": "string",
"example": "12345678901"
},
"product": {
"$ref": "#/definitions/Product"
}
}
}
{
"type": "object",
"properties": {
"localCurrencyTransactionAmount": {
"description": "Transaction amount set for the payment in MXN",
"type": "number",
"format": "double",
"example": 20000.55
},
"recurringTransactionFlag": {
"description": "Flag to indicate if the transaction is frequently used",
"type": "boolean",
"example": false
},
"futureDateSelectedFlag": {
"description": "Flag to indicate if the transaction will be applied in the future",
"type": "boolean",
"example": true
},
"transactionReferenceId": {
"description": "Transaction alphanumeric Reference, it is introduced by the customer.",
"type": "string",
"example": "JOB PAYMENT02022021"
},
"foreignCurrencyTransactionAmount": {
"description": "Transaction amount set for the payment in USD",
"type": "number",
"format": "double",
"example": 2000.5
},
"foreignExchangeRate": {
"description": "Exchange rate for the foreign currency transaction amount",
"type": "number",
"format": "double",
"example": 19.38
},
"transactionId": {
"description": "Identifier of the transaction performed",
"type": "string",
"example": "4013060000"
},
"branchId": {
"description": "Branch identifier of the destination account",
"type": "string",
"example": "1234",
"maxLength": 4
},
"merchantName": {
"description": "Common name of the merchant",
"type": "string",
"example": "TELMEX"
},
"merchantId": {
"description": "A unique number assigned to a merchant to identify it",
"type": "string",
"example": "332455"
},
"sourceAccount": {
"$ref": "#/definitions/SourceAccount"
},
"destinationAccount": {
"$ref": "#/definitions/DestinationAccount"
}
},
"required": [
"transactionId",
"localCurrencyTransactionAmount",
"sourceAccount",
"destinationAccount"
]
}
{
"type": "object",
"properties": {
"cardNumber": {
"description": "Beneficiary card number",
"type": "string",
"example": "1234567812345678"
},
"accountNumber": {
"description": "Beneficiary account Number",
"type": "string",
"example": "12345678901"
},
"payeeNickName": {
"description": "Beneficiary alias",
"type": "string",
"example": "Pago de Telefono"
},
"businessSectorName": {
"description": "Economic sector of beneficiary account",
"type": "string",
"example": "Particulares"
},
"payeeFullName": {
"description": "Full name of the payee",
"type": "string",
"example": "JUAN PEREZ"
},
"taxId": {
"description": "Payee RFC",
"type": "string",
"example": "JOSN871010HL6"
},
"curp": {
"description": "Payee CURP",
"type": "string",
"example": "JOSN871010MMCXPX09"
}
}
}
{
"type": "object",
"properties": {
"productCode": {
"description": "Product Code",
"type": "string",
"example": "113"
},
"productInstrument": {
"description": "Instrument",
"type": "string",
"example": "4"
}
}
}
{
"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",
"maxLength": 15,
"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"
}
}
}
{
"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"
]
}