Refund Order

POST 
https://gateway.vertexgateway.com/api/v1/order/refund

Process a full or partial refund for an order.

Request

Responses

204

Refund operation in progress.

Authorization: Api-Access-Token

name: Api-Access-Tokentype: apiKeyin: header

• 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://gateway.vertexgateway.com/api/v1/order/refund");
request.Headers.Add("Api-Access-Token", "<Api-Access-Token>");
var content = new StringContent("{\n  \"shopId\": 1234,\n  \"orderNumber\": \"ORDER-324234\",\n  \"cost\": {\n    \"amount\": \"56.99\",\n    \"currency\": \"USD\"\n  },\n  \"paymentId\": \"26243324234\",\n  \"description\": \"Refund due to order cancellation.\"\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://gateway.vertexgateway.com/api/v1

Auth

ApiKeyAuth

Body required

{
  "shopId": 1234,
  "orderNumber": "ORDER-324234",
  "cost": {
    "amount": "56.99",
    "currency": "USD"
  },
  "paymentId": "26243324234",
  "description": "Refund due to order cancellation."
}