DocumentationAPI Reference
API Reference

After the consumer has interacted with the site specified in a Redirect URL, their browser is redirected to the Return URL specified in the original request. The response and signature query parameters are appended to this URL. The response contains the following JSON-encoded data.

FieldTypeRequiredNotes
ErrorobjectYesIf present, the order could not be authorized due to an error.
> CodestringYesA request-specific error code, described in the Error Codes section for the specific request.
> MessagestringNoA short description of the error.
FieldTypeRequiredNotes
OrderIduuidYesThe 36 character UUID which identifies the order in the Reach system.
ContractIduuidNoThe contract identifier, if the order is associated with a contract.
UnderReviewbooleanNoSet to true if a fraud review has been initiated for the order. Payment cannot be processed until the review has been completed. If not present, assume false.
OrderStatestringYesSee documentation on Order States.
CapturedbooleanNoAn indication of whether or not the payment has been captured and therefore completed. A notification will be sent when payment has completed regardless of the value of this field. If not present, assume false.