Retrieve Risk Assessment

Request to retrieve the details of a risk assessment performed by a risk service provider.

POST https://anzworldline.gateway.mastercard.com/api/nvp/version/100

Authentication Copied to clipboard

This operation requires authentication via one of the following methods:


  • Certificate authentication.
  • To authenticate to the API two additional NVP parameters must be supplied in the request. Provide 'merchant.<your gateway merchant ID>' in the apiUsername field and your API password in the apiPassword field.

Request Copied to clipboard

Fields Copied to clipboard

apiOperation Copied to clipboard String = RETRIEVE_RISK_ASSESSMENT FIXED

Any sequence of zero or more unicode characters.

correlationId Copied to clipboard String OPTIONAL

A transient identifier for the request, that can be used to match the response to the request.

The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.

Data can consist of any characters

Min length: 1 Max length: 100
merchant Copied to clipboard Alphanumeric + additional characters REQUIRED

The unique identifier issued to you by your payment provider.

This identifier can be up to 12 characters in length.

Data may consist of the characters 0-9, a-z, A-Z, '-', '_'

Min length: 1 Max length: 40
riskassessment Copied to clipboard Alphanumeric + additional characters REQUIRED

A unique identifier for this risk assessment to distinguish it from any other risk assessment you create.

Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '%', '.'

Min length: 1 Max length: 40

Response Copied to clipboard

Fields Copied to clipboard

correlationId Copied to clipboard String CONDITIONAL

A transient identifier for the request, that can be used to match the response to the request.

The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.

Data can consist of any characters

Min length: 1 Max length: 100
id Copied to clipboard Alphanumeric + additional characters ALWAYS PROVIDED

A unique identifier for this risk assessment to distinguish it from any other risk assessment you create.

Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '%', '.'

Min length: 1 Max length: 40
provider Copied to clipboard CONDITIONAL

Details about the risk service provider for this risk assessment.

provider.name Copied to clipboard String CONDITIONAL

The name of the risk service provider.

Data can consist of any characters

Min length: 1 Max length: 250
provider.riskAssessmentRequestId Copied to clipboard String CONDITIONAL

The unique identifier for the risk assessment request submitted to the risk service provider.

The gateway generates this value and submits it in the request to the risk service provider so that you can track the risk assessment in the risk service provider's system.

Data can consist of any characters

Min length: 1 Max length: 100
recommendation Copied to clipboard Enumeration CONDITIONAL

The overall result of risk assessment returned by the risk service provider.

Value must be a member of the following list. The values are case sensitive.

ACCEPT

The Risk Service Provider assessed the information you submitted in the risk assessment request and considers the risk of completing the transaction as low risk.

NOT_CHECKED

The Risk Service Provider did not risk assess the information you provided in the risk assessment request because the request contained insufficient information to make a risk assessment.

REJECT

The Risk Service Provider assessed the information you submitted in the risk assessment request and considers the risk of completing the transaction as high risk.

REVIEW

The Risk Service Provider assessed the information you submitted in the risk assessment request and considers the risk of completing the transaction as neither low risk or high risk and recommends that you perform a manual review before completing the transaction.

result Copied to clipboard Enumeration ALWAYS PROVIDED

A system-generated high level overall result of the assessment.

Value must be a member of the following list. The values are case sensitive.

FAILURE

The operation was declined or rejected by the gateway, acquirer or issuer

PENDING

The operation is currently in progress or pending processing

SUCCESS

The operation was successfully processed

UNKNOWN

The result of the operation is unknown

review Copied to clipboard CONDITIONAL

Details of the decision need to make or have made, when the risk service provider has asked to you review this assessment.

review.decision Copied to clipboard Enumeration CONDITIONAL

The status of the risk review decision.

Where a risk review is required you need to go to the risk service provider's system and make the decision. The decision will then be recorded against the risk assessment.

Value must be a member of the following list. The values are case sensitive.

ACCEPTED

You made a review decision and accepted the payment for processing.

PENDING

A decision to accept or reject the payment for processing is pending.

REJECTED

You made a review decision and rejected the payment for processing.

review.decisionReason Copied to clipboard String CONDITIONAL

The reason you selected when you reviewed this order in the external risk service provider's system and decided to accept or reject the risk assessment.

Data can consist of any characters

Min length: 1 Max length: 100
review.note Copied to clipboard String CONDITIONAL

The note that you entered when you reviewed this payment in the risk service provider's system and decided to accept or reject the order.

Data can consist of any characters

Min length: 1 Max length: 2000
review.timeOfDecision Copied to clipboard DateTime CONDITIONAL

The date and time you made the decision to accept or reject the payment in the risk service provider's system.

An instant in time expressed in ISO8601 date + time format - "YYYY-MM-DDThh:mm:ss.SSSZ"

review.userId Copied to clipboard String CONDITIONAL

The identifier of the person who made the decision to accept or reject the payment in the risk service provider's system.

Data can consist of any characters

Min length: 1 Max length: 40
rule[n] Copied to clipboard CONDITIONAL

Details of the rules applied by the risk service provider to assess the risk of this payment being fraudulent, as provided by the risk service provider.

rule[n].id Copied to clipboard String CONDITIONAL

The unique identifier for the rule.

Data can consist of any characters

Min length: 1 Max length: 32
rule[n].name Copied to clipboard String CONDITIONAL

The name of the rule.

Data can consist of any characters

Min length: 1 Max length: 100
rule[n].score Copied to clipboard Signed Integer CONDITIONAL

The score resulting from the application of this rule.

A number comprising the digits 0-9, having at least one digit and optionally a leading sign. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#integer.)

Min value: -9999999999999999 Max value: 9999999999999999
totalScore Copied to clipboard Signed Integer CONDITIONAL

The total of the risk scores for all risk rules applied by the risk service provider when assessing the risk of this payment being fraudulent.

The higher the score, the higher the fraud risk.

A number comprising the digits 0-9, having at least one digit and optionally a leading sign. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#integer.)

Min value: -9999999999999999 Max value: 9999999999999999

Errors Copied to clipboard

error Copied to clipboard

Information on possible error conditions that may occur while processing an operation using the API.

error.cause Copied to clipboard Enumeration

Broadly categorizes the cause of the error.

For example, errors may occur due to invalid requests or internal system failures.

Value must be a member of the following list. The values are case sensitive.

INVALID_REQUEST

The request was rejected because it did not conform to the API protocol.

REQUEST_REJECTED

The request was rejected due to security reasons such as firewall rules, expired certificate, etc.

SERVER_BUSY

The server did not have enough resources to process the request at the moment.

SERVER_FAILED

There was an internal system failure.

error.explanation Copied to clipboard String

Textual description of the error based on the cause.

This field is returned only if the cause is INVALID_REQUEST or SERVER_BUSY.

Data can consist of any characters

Min length: 1 Max length: 1000
error.field Copied to clipboard String

Indicates the name of the field that failed validation.

This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.

Data can consist of any characters

Min length: 1 Max length: 100
error.supportCode Copied to clipboard String

Indicates the code that helps the support team to quickly identify the exact cause of the error.

This field is returned only if the cause is SERVER_FAILED or REQUEST_REJECTED.

Data can consist of any characters

Min length: 1 Max length: 100
error.validationType Copied to clipboard Enumeration

Indicates the type of field validation error.

This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.

Value must be a member of the following list. The values are case sensitive.

INVALID

The request contained a field with a value that did not pass validation.

MISSING

The request was missing a mandatory field.

UNSUPPORTED

The request contained a field that is unsupported.

result Copied to clipboard Enumeration

A system-generated high level overall result of the operation.

Value must be a member of the following list. The values are case sensitive.

ERROR

The operation resulted in an error and hence cannot be processed.