Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-2428350487.0 KB
Orders

Cancel a previously created BR-DGE Hosted Payment Page Order.

put/orders/{orderId}/cancel

Path parameters

orderIdstring required

The unique identifier for the Order.

This can be sourced from the orderId field in the response we sent to you when creating the Order.

Response

OK

codestring

A unique identifier covering the outcome of the request

idstring

The ID of this request

messagestring

A description of the outcome of the request

orderIdstring

The ID of this order

redirectUrlstring

The URL to redirect your customer to in progress the order

Example response

{
  "code": "1000",
  "id": "4fad8e2e06a15656"
}