PUT Cancel Transaction

Cancel Transaction Details

Inform Beam of a cancelled transaction

Authorization

The cancel transaction endpoint takes the server API key.

Authorization: "Api-Key {{Server API Key provided by Beam}}"

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"
}