Menu

Developer Resources

  • All Files

Disposition

Conditional:

Disposition informs our platform if you settled or canceled the transaction based on its risk score.

 

Request Parameters

Expand/Collapse All

Use the following request parameters when integrating to Disposition:

ClosedAccountName (Required)

Data Type: String

Field Dependence: Required

Sensitive: No

Description: API username.

Maximum Length: 32

ClosedAmount (Required)

Data Type: Currency

Field Dependence: Required

Sensitive: No

Description: The amount of money to be confirmed for settlement. This amount must be less than or equal to the authorized amount.

Maximum Length: 12

ClosedDispositionComment

Data Type: String

Field Dependence: Optional

Sensitive: No

Description: The text comments for the transaction.

Maximum Length: 255

ClosedDispositionComment (Required)

Data Type: String

Field Dependence: Required

Sensitive: No

Description: The text comments for the transaction.

Maximum Length: 255

ClosedDispositionType (Required)

Data Type: Integer

Field Dependence: Required

Sensitive: No

Description: Informs our platform if the transaction was completed or cancelled.

Maximum Length: N/A

Possible Values:

1 - Sale complete

2 - Sale cancelled

ClosedGuaranteeCD

Data Type: Integer

Field Dependence: Conditional

Sensitive: No

Description: Indicates if our platform needs to guarantee the transaction.

Maximum Length: N/A

Possible Values:

1 - Guarantee payment

2 - Do not guarantee payment

ClosedGuaranteeCD

Data Type: Integer

Field Dependence: Optional

Sensitive: No

Description: Indicates if our platform needs to guarantee the transaction.

Maximum Length: N/A

Possible Values:

1 - Guarantee payment

2 - Do not guarantee payment

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

Disposition returns the following response parameters:

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.

ClosedPaymentGuaranteeStatus

Data Type: Integer

Sensitive: No

Description: Returns our platform's decision to guarantee the payment.

Maximum Length: N/A

Possible Values:

1 - Guaranteed payment

2 - Non-guaranteed payment

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 disposition result.

Maximum Length: N/A

Possible Values:

10 - Successful payment

33 - Pre-Authorization declined by the merchant

34 - Post-Authorization declined by the merchant

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 Disposition API.

Maximum Length: N/A

ClosedResponseText

Data Type: String

Sensitive: No

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

Maximum Length: 1024

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.

Closed521 Parameter [name] is not a valid credit card number.

Suggested Customer Message: Please check your credit card information.

Note: The credit/debit card number must contain 13 to 19 digits.

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.

Closed1005 Account not active.

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

Note: Indicates a problem with the merchant's account. Contact Support.

1035 Amount must be greater than 0.

1037 Provided {DispositionType} and {GuaranteeCD} combination not supported.

Closed1062 Payment not found.

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

1064 Payment not eligible for this API call.

1065 Payment not eligible for requested {DispositionType}.

1066 Payment not eligible for the requested guarantee code.

1067 Parameter {GuaranteeCD} not applicable for the given payment.

1090 Payment is already confirmed.

1091 Payment not authorized.

1092 Amount larger than original authorization.

1093 Authorization is already expired.

1094 Original transaction was from a different interface.

1095 Card validation transaction cannot be confirmed.