POST api/v2/admin/coupons/refund/record

Request Information

URI Parameters

None.

Body Parameters

CouponAdminWrite
NameDescriptionTypeAdditional information
RequestId

globally unique identifier

None.

Reason

string

None.

ExpectedVersion

globally unique identifier

None.

Coupon

Coupon

None.

Affiliate

Affiliate

None.

AffiliateEmail

string

None.

AffiliateId

globally unique identifier

None.

OrderId

string

None.

AmountMinor

integer

None.

Reference

string

None.

CompletedExternally

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "RequestId": "f54f75be-d423-4e8e-9daa-790548c8e256",
  "Reason": "sample string 2",
  "ExpectedVersion": "f3b1afc4-79d1-4a64-bc55-009d4c1bfb36",
  "Coupon": {
    "Id": "37ff800c-1e91-4f19-a688-9d57994bc637",
    "Code": "sample string 2",
    "Name": "sample string 3",
    "Enabled": true,
    "DiscountKind": "sample string 5",
    "DiscountValue": 6,
    "Offer": "sample string 7",
    "StartsAtUtc": "2026-11-23T00:05:40.175308+03:00",
    "EndsAtUtc": "2026-11-23T00:05:40.175308+03:00",
    "MaxUses": 8,
    "OncePerAccount": true,
    "AffiliateId": "7a7c910f-ae22-4172-9539-4e686472a04f",
    "CommissionBps": 10,
    "Version": "63c3cb57-5a05-46d2-b3e7-192ad30d2e43"
  },
  "Affiliate": {
    "Id": "39836a91-a08c-4cf1-a3e7-efe61358d1d3",
    "Name": "sample string 2",
    "Email": "sample string 3",
    "Notes": "sample string 4",
    "Enabled": true,
    "Version": "9c8182a0-f5c7-4e98-97c6-857edb0126b7"
  },
  "AffiliateEmail": "sample string 4",
  "AffiliateId": "e2add5d8-d9c8-48eb-9666-97d3a6220806",
  "OrderId": "sample string 6",
  "AmountMinor": 7,
  "Reference": "sample string 8",
  "CompletedExternally": true
}

application/xml, text/xml

Sample:
<CouponAdminWrite xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SatisEntegrasyonWebApi.Controllers">
  <Affiliate xmlns:d2p1="http://schemas.datacontract.org/2004/07/SatisEntegrasyonWebApi.Util.Coupons">
    <d2p1:Email>sample string 3</d2p1:Email>
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Id>39836a91-a08c-4cf1-a3e7-efe61358d1d3</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:Notes>sample string 4</d2p1:Notes>
    <d2p1:Version>9c8182a0-f5c7-4e98-97c6-857edb0126b7</d2p1:Version>
  </Affiliate>
  <AffiliateEmail>sample string 4</AffiliateEmail>
  <AffiliateId>e2add5d8-d9c8-48eb-9666-97d3a6220806</AffiliateId>
  <AmountMinor>7</AmountMinor>
  <CompletedExternally>true</CompletedExternally>
  <Coupon xmlns:d2p1="http://schemas.datacontract.org/2004/07/SatisEntegrasyonWebApi.Util.Coupons">
    <d2p1:AffiliateId>7a7c910f-ae22-4172-9539-4e686472a04f</d2p1:AffiliateId>
    <d2p1:Code>sample string 2</d2p1:Code>
    <d2p1:CommissionBps>10</d2p1:CommissionBps>
    <d2p1:DiscountKind>sample string 5</d2p1:DiscountKind>
    <d2p1:DiscountValue>6</d2p1:DiscountValue>
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:EndsAtUtc>2026-11-23T00:05:40.175308+03:00</d2p1:EndsAtUtc>
    <d2p1:Id>37ff800c-1e91-4f19-a688-9d57994bc637</d2p1:Id>
    <d2p1:MaxUses>8</d2p1:MaxUses>
    <d2p1:Name>sample string 3</d2p1:Name>
    <d2p1:Offer>sample string 7</d2p1:Offer>
    <d2p1:OncePerAccount>true</d2p1:OncePerAccount>
    <d2p1:StartsAtUtc>2026-11-23T00:05:40.175308+03:00</d2p1:StartsAtUtc>
    <d2p1:Version>63c3cb57-5a05-46d2-b3e7-192ad30d2e43</d2p1:Version>
  </Coupon>
  <ExpectedVersion>f3b1afc4-79d1-4a64-bc55-009d4c1bfb36</ExpectedVersion>
  <OrderId>sample string 6</OrderId>
  <Reason>sample string 2</Reason>
  <Reference>sample string 8</Reference>
  <RequestId>f54f75be-d423-4e8e-9daa-790548c8e256</RequestId>
</CouponAdminWrite>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CouponAdminWrite'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.