Skip to main content
Version: v1

PUT Cancel Transaction

Inform Beam of a cancelled transaction

Authorization​

The cancel transaction endpoint takes the OMS Integration API Key.

Authorization: "Api-Key {{ oms_integration_api_key }}"

Endpoint​

PUT https://api.beamimpact.com/api/v3/cancelTransactionByOrderId?orderId={{ orderId }}

Body​

N/A -- No request body is required for cancelling a transaction. Include the order Id in the query parameters.

Response​

{
  "transactionId": {{ transactionId }}, // Int
  "message": "{{ message }}" // String, ex: "Successfully cancelled transaction"
}