Skip to main content

Refund a Transaction

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

There are two ways to refund; through your payment gateway and mark it refunded in Commerce Manager, or directly through Commerce Manager or API.

  • Mark as Refunded: You can manually mark a transaction as refunded. Before you can mark the order as refunded, you need to handle the actual refund on your side with your payment provider. Mark as Refunded is a full refund made to the transaction.
  • Refund through Composable Commerce: You can process a full or partial refund to a supported payment provider directly from Commerce Manager or API by providing the refund amount. When you start the refund process, the request is directly sent to the payment gateway.
caution

If you use manual gateway for partial or full refund, you need to handle the actual refund on your side with your payment provider.

Request​

Responses​

Response Headers

    Authorization: http

    name: bearerAuthtype: httpscheme: bearer
    var client = new HttpClient();
    var request = new HttpRequestMessage(HttpMethod.Post, "https://useast.api.elasticpath.com/v2/orders/:orderID/transactions/:transactionID/refund");
    request.Headers.Add("Accept", "application/json");
    request.Headers.Add("Authorization", "Bearer <TOKEN>");
    var content = new StringContent("{\n  \"data\": {\n    \"amount\": 0,\n    \"options\": {\n      \"note\": \"string\"\n    }\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
    Parameters
    — pathrequired
    — pathrequired
    Body
    {
  "data": {
    "amount": 0,
    "options": {
      "note": "string"
    }
  }
}
    ResponseClear

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