View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.

API reference Models

ProcessorResponseDetail

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Represents detailed information about a processor's response, typically used for error reporting.

Values

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields

Field Type Description
result required integer (int32) Gets or sets the result code for the processing operation.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
resultText required string Gets or sets the textual result associated with this response detail. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
approvalCode required string Gets or sets the approval code associated with the processor response. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
hostReferenceNum required string Gets or sets the host reference number carried on this response detail. This copy is not the one to read: no processor rail populates it, because the whole `ProcessorResponseDetail` object is null on every processor response. The object is built only by the gateway's own non-processor response builders (the loopback card simulator, the loopback ACH simulator, the cash tender, and internal ACH account verification), and of those only the loopback ACH builder puts a value here: the ACH trace number it generated. The other three set the empty string. Read `responseData.hostReferenceNumber` instead, which is populated on every processor rail and carries the per-processor definition. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
hostDate required string Gets or sets the host date associated with the processor response detail. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
hostTime required string Gets or sets the host time associated with the processor response detail. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
avsResponse required string Gets or sets the Address Verification Service (AVS) response code returned by the payment processor. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
avsResponseText required string Gets or sets the Address Verification Service (AVS) response text returned by the payment processor. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
cvResponse required string Gets or sets the CV response associated with this processor response detail. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
cvResponseText required string Gets or sets the response text associated with the processor response detail. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
isCommercialCard required boolean Gets or sets a value indicating whether the payment card is identified as a commercial card.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
extendedErrorData required string Gets or sets additional error data provided by the processor. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This model has no documented fields.

Reconnecting to the server

Could not reconnect

This session has ended

Attempt 1

Your work on this page is still here. Retrying keeps it; reloading starts the page again.

The server no longer holds this page's state, so it has to be loaded again.