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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	memo: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	payout: 
	{
		id: 0,
		eventId: 0,
		eventOwnerId: 0,
		state: String,
		defaultEligibleAt: 0001-01-01,
		grossAmount: 0,
		transactionFee: 0,
		platformCut: 0,
		freeTicketDeduction: 0,
		minimumFeeDeduction: 0,
		extraCostDeduction: 0,
		fastSettlementFee: 0,
		outstandingApplied: 0,
		netAmount: 0,
		fastSettlementRequested: False,
		fastSettlementRequestedAt: 0001-01-01,
		approvedBy: String,
		approvedAt: 0001-01-01,
		isbPayoutBatchRowId: 0,
		createdAt: 0001-01-01,
		updatedAt: 0001-01-01,
		memo: String
	},
	statusCode: 0,
	message: String
}