Cancel an Order

post

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

A POST request to /orders/{order_ref}/cancel/ cancels an existing Order.

An Order can only be canceled if its status is draft.

Cancel an Order to prevent it from being submitted for capture in the future, while still maintaining a record of the Order on Forage's server.

On success, the API responds with the canceled Order object.

Check the Forage Errors reference for a comprehensive list of error codes.

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 authentication token that validates the request. Send a POST to the /o/token/ endpoint to generate an authentication token. Pass the token in this header after the word Bearer and a whitespace, for example Bearer <api_key>.

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.

Idempotency-Key

string

required

An alphanumeric key that clients can use to identify repeated requests that are dropped in transit. Generate a distinct key for every unique request and only re-use keys for retries.

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json

200OK - Success

400Bad Request

401Unauthorized

404Not Found - The requested resource was not found.

409Conflict

429Too Many Requests

500Internal Server Error