Retrieve an Order

get

https://{environment}.joinforage.app/api/orders/{order_ref}/

A GET request to /orders/{order_ref}/ retrieves the specified Order object.

The order_ref is the ref value that Forage returns in response to the request that created the order’s parent Session.

You can use this endpoint to request the transaction outcome from Forage after a customer completes a Fully Hosted or Custom Session.

Path Params

order_ref

string

required

A unique reference hash for the Forage Order object, returned when the order’s parent Session was created.

Headers

Authorization

string

required

An OAuth 2.0 bearer token that validates the request. You can use either a short-lived session token if the request is coming from the front-end, or an authentication token for server-side requests. Pass the token in this header after the word Bearer and a whitespace, for example Bearer sandbox_sZawPSUSm9eetx8LrfBbJlzUZS3zWD.

Merchant-Account

string

required

A unique merchant ID that Forage provides during onboarding, as in 123ab45c67. The Merchant ID can be found in the Forage sandbox or production dashboard.

API-Version

string

The Forage version, represented as a string with the format of a YYYY-MM-DD date.

If not specified in the request header, then the version defaults to the value set in the Forage dashboard.

Responses

Language

Credentials

OAuth2

URL

Request

Response

Choose an example:

application/json

200OK - Success

400Bad request - The request was not accepted because of an error in the request body or path.

401Unauthorized

404Not Found - The requested resource was not found.

429Too Many Requests

500Internal Server Error