Menu

Developer Resources

  • All Files

AuthResult

Required if you use the ChargePaymentRequest API.

After you authorize a transaction with your gateway/acquirer, use the AuthResult API to send the authorization results to our platform to receive the finalized Risk Probability Index, Risk Score, and IsGuaranteeable responses.

 

Request Parameters

Expand/Collapse All

Use the following request parameters when integrating to AuthResult:

ClosedAccountName (Required)

Data Type: String

Field Dependence: Required

Sensitive: No

Description: API username.

Maximum Length: 32

ClosedAcquirerAVSResultCode (Required)

Data Type: String

Field Dependence: Required

Sensitive: No

Description: The result of your acquirer's address verification system (AVS) check. Required unless explicitly exempted by our platform.

Maximum Length: N/A

ClosedAcquirerAuthResultCode (Required)

Data Type: String

Field Dependence: Required

Sensitive: No

Description: The result from the authorization transaction.

Maximum Length: N/A

ClosedAcquirerCD

Data Type: Integer

Field Dependence: Optional

Sensitive: No

Description: The acquirer used to authorize a transaction.

Maximum Length: N/A

Possible Values:

1 - Chase Paymentech

2 - FirstData

3 - AIB

4 - Vantiv

5 - RapidConnectCNP

6 - Synthesis

7 - TSYS

8 - ProPay

9 - Allpago

1000 - Braintree

1001 - TrustCommerce

1002 - Authorize.Net

1003 - Wells Fargo

1004 - PayKings

1005 - Credibanco

1006 - Card Connect

1007 - Stripe

ClosedAcquirerCVVResultCode (Required)

Data Type: String

Field Dependence: Required

Sensitive: No

Description: The result of your acquirer's card verification value (CVV) check. Required unless explicitly exempted by our platform.

Maximum Length: N/A

ClosedAmount (Required)

Data Type: Currency

Field Dependence: Required

Sensitive: No

Description: The amount of money sent for authorization.

Maximum Length: 12

ClosedPassword (Required)

Data Type: String

Field Dependence: Required

Sensitive: Yes

Description: API password.

Maximum Length: 64

ClosedPaymentID (Required)

Data Type: String

Field Dependence: Required

Sensitive: No

Description: The identification number generated to track the transaction.

Maximum Length: 12

ClosedTransactionID (Required)

Data Type: String

Field Dependence: Required

Sensitive: No

Description: The unique identification number used to track the transaction.

Maximum Length: 36

Response Parameters

AuthResult returns the following response parameters:

ClosedIsPaymentGuaranteeable

Data Type: Boolean

Sensitive: No

Description: Returns whether our platform can guarantee the transaction.

Maximum Length: N/A

Possible Values:

0 - Payment cannot be guaranteed

1 - Payment can be guaranteed

ClosedIsShadowPayment

Data Type: Boolean

Sensitive: No

Description: Returns whether the transaction is a shadow payment (not actually guaranteed).

Maximum Length: N/A

Possible Values:

1 - This is a shadow payment and so not actually guaranteed.

ClosedPaymentID

Data Type: String

Sensitive: No

Description: Returns the identification number to track the transaction.

Maximum Length: 12

ClosedPaymentStatus

Data Type: Integer

Sensitive: No

Description: Returns the result of the authorization transaction.

Maximum Length: N/A

Possible Values:

1 - Bank denied.

52 - Post-Authorization completed.

62 - Post-Authorization communication error. The transaction did not complete. Re-run the transaction. If the problem persists, contact Support.

ClosedResponseCode

Data Type: Integer

Sensitive: No

Description: Returns a 0 for success or a non-zero code for failure to process the API. See Response Codes for the possible non-zero code returned by the AuthResult API.

Maximum Length: N/A

ClosedResponseText

Data Type: String

Sensitive: No

Description: Returns a description for non-zero Response Codes.

Maximum Length: 1024

ClosedRiskProbabilityIndex

Data Type: Integer

Sensitive: No

Description: Returns the level of risk associated with accepting the requested transaction.

Maximum Length: N/A

Possible Values:

1 - High Risk

2 - Mild Risk

3 - Average

4 - Safe

5 - Very Safe

ClosedRiskScore

Data Type: Integer

Sensitive: No

Description: Returns the risk score associated with the transaction. Valid values are 0-100; the higher the score, the greater the fraud risk associated with the transaction. This score is only presented if the Fraud Score feature is enabled.

Maximum Length: N/A

Response Codes

Each API call returns a numeric response code. If the response code is zero, the API transaction completed successfully without errors; however, the status of the transaction may not be complete. If the response code is non-zero, an error message is included with the response code.

Note: When non-zero response codes are returned, the response fields might not be returned correctly. Review the error messages associated with non-zero response codes and take appropriate steps to resolve the error conditions. Most of the non-zero response codes indicate a system configuration or integration issue. Before production deployment, you should resolve these issues during the testing phase.

Closed0 Success.

Suggested Customer Message: Transaction completed.

Note: Not an error condition.

Closed1 General system failure.

Suggested Customer Message: System not available. Please try again later.

Note: A low-level error message that may indicate a communication problem, a timing problem, an intermittent failure to contact an acquirer, or another condition not captured by the other response codes. If this response code is returned after repeated attempts, contact Support.

Closed510 Parameter [name] is required.

Note: No value was sent for a required parameter. Check all required parameters are included in the API call.

Closed511 Parameter [name] exceeds max length of [value].

Note: A required parameter contains too many characters. Check the length does not exceed the maximum length value specified for the parameter.

Closed512 Parameter [name] is not a valid [value].

Note: A general type-mismatch error. Check the required parameters are being populated correctly.

Closed513 Parameter [name] cannot be undefined or null.

Note: The parameter is empty. Check the parameter that fills this field.

Closed514 Parameter [name] is invalid. Valid values are [valid values].

Suggested Customer Message: Please select a correct value.

Note: The input value does not match one of the multiple-choice values provided.

Closed1001 Login failed.

Suggested Customer Message: System not available. Please try again later.

Note: Authentication failed. Check your credentials and try again, or contact Support.

1035 Amount must be greater than 0.

1036 Payment not eligible for authorization results processing.

Closed1062 Payment not found.

Note: Indicates a problem with the PaymentID parameter. Validate the correct value was submitted.