HomeDocumentationAPI Reference
API Reference

Return from Redirect

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.

Field

Type

Required

Notes

Error

object

Yes

If present, the order could not be authorized due to an error.

Code

string

Yes

A request-specific error code, described in the Error Codes section for the specific request.

Message

string

No

A short description of the error.

Field

Type

Required

Notes

OrderId

uuid

Yes

The 36 character UUID which identifies the order in the Reach system.

ContractId

uuid

No

The contract identifier, if the order is associated with a contract.

UnderReview

boolean

No

Set 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.

OrderState

string

Yes

See documentation on Order States.

Captured

boolean

No

An 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.