| Requires any of the roles: | Admin, TeamAdmin | Required permission: | Tickets.Add |
| POST | /GiftCard/RefundCredit |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LocalizedMessage:
is_: Optional[str] = field(metadata=config(field_name='is'), default=None)
en: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GiftCardRedeemResult:
ok: Optional[bool] = None
reason: Optional[str] = None
message: Optional[LocalizedMessage] = None
redeemed_amount_minor: Optional[int] = None
new_balance_minor: Optional[int] = None
transaction_id: Optional[int] = None
settlement_tag: Optional[str] = None
status_code: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GiftCardRefundCreditRequest:
gift_card_id: Optional[int] = None
code: Optional[str] = None
amount_minor: Optional[int] = None
order_payment_reference: Optional[str] = None
idempotency_key: Optional[str] = None
note: Optional[str] = None
Python GiftCardRefundCreditRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /GiftCard/RefundCredit HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GiftCardRefundCreditRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
<AmountMinor>0</AmountMinor>
<Code>String</Code>
<GiftCardId>0</GiftCardId>
<IdempotencyKey>String</IdempotencyKey>
<Note>String</Note>
<OrderPaymentReference>String</OrderPaymentReference>
</GiftCardRefundCreditRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GiftCardRedeemResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
<Message>
<En>String</En>
<Is>String</Is>
</Message>
<NewBalanceMinor>0</NewBalanceMinor>
<Ok>false</Ok>
<Reason>String</Reason>
<RedeemedAmountMinor>0</RedeemedAmountMinor>
<SettlementTag>String</SettlementTag>
<StatusCode>0</StatusCode>
<TransactionId>0</TransactionId>
</GiftCardRedeemResult>