Cancel a Transaction

POST 
https://useast.api.elasticpath.com/v2/orders/:orderID/transactions/:transactionID/cancel

Use this endpoint to cancel or void a pending or authorized transaction. The transaction can be canceled or voided when it is in pending and completed statuses.

caution

This endpoint works only for Stripe and PayPal and does not work for manual gateway.

Request

Responses

200

Response Headers

401

Unauthorized

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://useast.api.elasticpath.com/v2/orders/:orderID/transactions/:transactionID/cancel");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"data\": {\n    \"options\": {},\n    \"reason\": \"string\"\n  }\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://useast.api.elasticpath.com

Auth

Bearer Token

Parameters

orderID — pathrequired

transactionID — pathrequired

Body

{
  "data": {
    "options": {},
    "reason": "string"
  }
}

ResponseClear

Click the Send API Request button above and see the response here!