TicketUserServices

<back to all web services

DonationPayoutMarkRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequired permission:Tickets.Add
The following routes are available for this service:
POST/donations/payout/mark
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 DonationPayoutRow:
    id: Optional[int] = None
    donation_id: Optional[int] = None
    owner_id: Optional[int] = None
    owner_card_id: Optional[int] = None
    payment_method_id: Optional[str] = None
    payment_reference: Optional[str] = None
    amount: Optional[Decimal] = None
    txn_percent: Optional[Decimal] = None
    payout_amount: Optional[Decimal] = None
    mark_paid_reference: Optional[str] = None
    source: Optional[str] = None
    note: Optional[str] = None
    created_u_t_c: Optional[datetime.datetime] = None
    created_by: Optional[str] = None
    donation_paid_u_t_c: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DonationPayoutBatchResult:
    rows: Optional[List[DonationPayoutRow]] = None
    count: Optional[int] = None
    donation_amount: Optional[int] = None
    payout_amount: Optional[Decimal] = None
    payout_amount_isk: Optional[int] = None
    already_paid_count: Optional[int] = None
    replayed: Optional[bool] = None
    mark_paid_reference: Optional[str] = None
    owner_id: Optional[int] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DonationPayoutMarkRequest:
    owner_id: Optional[int] = None
    mark_paid_reference: Optional[str] = None
    cutoff_u_t_c: Optional[datetime.datetime] = None
    txn_percent_by_method: Optional[Dict[str, Decimal]] = None
    default_txn_percent: Optional[Decimal] = None
    created_by: Optional[str] = None

Python DonationPayoutMarkRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /donations/payout/mark HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DonationPayoutMarkRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <CreatedBy>String</CreatedBy>
  <CutoffUTC>0001-01-01T00:00:00</CutoffUTC>
  <DefaultTxnPercent>0</DefaultTxnPercent>
  <MarkPaidReference>String</MarkPaidReference>
  <OwnerId>0</OwnerId>
  <TxnPercentByMethod xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringdecimal>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:KeyValueOfstringdecimal>
  </TxnPercentByMethod>
</DonationPayoutMarkRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DonationPayoutBatchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <AlreadyPaidCount>0</AlreadyPaidCount>
  <Count>0</Count>
  <DonationAmount>0</DonationAmount>
  <MarkPaidReference>String</MarkPaidReference>
  <Message>String</Message>
  <OwnerId>0</OwnerId>
  <PayoutAmount>0</PayoutAmount>
  <PayoutAmountIsk>0</PayoutAmountIsk>
  <Replayed>false</Replayed>
  <Rows>
    <DonationPayoutRow>
      <Amount>0</Amount>
      <CreatedBy>String</CreatedBy>
      <CreatedUTC>0001-01-01T00:00:00</CreatedUTC>
      <DonationId>0</DonationId>
      <DonationPaidUTC>0001-01-01T00:00:00</DonationPaidUTC>
      <Id>0</Id>
      <MarkPaidReference>String</MarkPaidReference>
      <Note>String</Note>
      <OwnerCardId>0</OwnerCardId>
      <OwnerId>0</OwnerId>
      <PaymentMethodId>String</PaymentMethodId>
      <PaymentReference>String</PaymentReference>
      <PayoutAmount>0</PayoutAmount>
      <Source>String</Source>
      <TxnPercent>0</TxnPercent>
    </DonationPayoutRow>
  </Rows>
  <StatusCode>0</StatusCode>
</DonationPayoutBatchResult>