TicketUserServices

<back to all web services

EventPayoutCancelRequest

Requires Authentication
Requires the role:Admin
The following routes are available for this service:
POST/payouts/{Id}/cancel
EventPayoutCancelRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
MemobodystringNo
EventPayoutGetResult Parameters:
NameParameterData TypeRequiredDescription
PayoutformEventPayoutNo
StatusCodeformintNo
MessageformstringNo
EventPayout Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
EventIdformintNo
EventOwnerIdformintNo
StateformstringNo
DefaultEligibleAtformDateTimeNo
GrossAmountformlongNo
TransactionFeeformlongNo
PlatformCutformlongNo
FreeTicketDeductionformlongNo
MinimumFeeDeductionformlongNo
ExtraCostDeductionformlongNo
FastSettlementFeeformlongNo
OutstandingAppliedformlongNo
NetAmountformlongNo
FastSettlementRequestedformboolNo
FastSettlementRequestedAtformDateTime?No
ApprovedByformstringNo
ApprovedAtformDateTime?No
IsbPayoutBatchRowIdformint?No
CreatedAtformDateTimeNo
UpdatedAtformDateTime?No
MemoformstringNo

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 /payouts/{Id}/cancel HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EventPayoutCancelRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Id>0</Id>
  <Memo>String</Memo>
</EventPayoutCancelRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EventPayoutGetResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Message>String</Message>
  <Payout xmlns:d2p1="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel.Types.Payouts">
    <d2p1:ApprovedAt>0001-01-01T00:00:00</d2p1:ApprovedAt>
    <d2p1:ApprovedBy>String</d2p1:ApprovedBy>
    <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
    <d2p1:DefaultEligibleAt>0001-01-01T00:00:00</d2p1:DefaultEligibleAt>
    <d2p1:EventId>0</d2p1:EventId>
    <d2p1:EventOwnerId>0</d2p1:EventOwnerId>
    <d2p1:ExtraCostDeduction>0</d2p1:ExtraCostDeduction>
    <d2p1:FastSettlementFee>0</d2p1:FastSettlementFee>
    <d2p1:FastSettlementRequested>false</d2p1:FastSettlementRequested>
    <d2p1:FastSettlementRequestedAt>0001-01-01T00:00:00</d2p1:FastSettlementRequestedAt>
    <d2p1:FreeTicketDeduction>0</d2p1:FreeTicketDeduction>
    <d2p1:GrossAmount>0</d2p1:GrossAmount>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:IsbPayoutBatchRowId>0</d2p1:IsbPayoutBatchRowId>
    <d2p1:Memo>String</d2p1:Memo>
    <d2p1:MinimumFeeDeduction>0</d2p1:MinimumFeeDeduction>
    <d2p1:NetAmount>0</d2p1:NetAmount>
    <d2p1:OutstandingApplied>0</d2p1:OutstandingApplied>
    <d2p1:PlatformCut>0</d2p1:PlatformCut>
    <d2p1:State>String</d2p1:State>
    <d2p1:TransactionFee>0</d2p1:TransactionFee>
    <d2p1:UpdatedAt>0001-01-01T00:00:00</d2p1:UpdatedAt>
  </Payout>
  <StatusCode>0</StatusCode>
</EventPayoutGetResult>