TicketUserServices

<back to all web services

DonationPayoutByReferenceRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequired permission:ReadData
The following routes are available for this service:
GET/donations/payout/{MarkPaidReference}
DonationPayoutByReferenceRequest Parameters:
NameParameterData TypeRequiredDescription
MarkPaidReferencepathstringNo
DonationPayoutBatchResult Parameters:
NameParameterData TypeRequiredDescription
RowsformList<DonationPayoutRow>No
CountformintNo
DonationAmountformlongNo
PayoutAmountformdecimalNo
PayoutAmountIskformlongNo
AlreadyPaidCountformintNo
ReplayedformboolNo
MarkPaidReferenceformstringNo
OwnerIdformint?No
StatusCodeformintNo
MessageformstringNo
DonationPayoutRow Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DonationIdformintNo
OwnerIdformintNo
OwnerCardIdformint?No
PaymentMethodIdformstringNo
PaymentReferenceformstringNo
AmountformdecimalNo
TxnPercentformdecimalNo
PayoutAmountformdecimalNo
MarkPaidReferenceformstringNo
SourceformstringNo
NoteformstringNo
CreatedUTCformDateTimeNo
CreatedByformstringNo
DonationPaidUTCformDateTime?No

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

HTTP + CSV

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

GET /donations/payout/{MarkPaidReference} HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"rows":[{"id":0,"donationId":0,"ownerId":0,"ownerCardId":0,"paymentMethodId":"String","paymentReference":"String","amount":0,"txnPercent":0,"payoutAmount":0,"markPaidReference":"String","source":"String","note":"String","createdUTC":"0001-01-01T00:00:00.0000000","createdBy":"String","donationPaidUTC":"0001-01-01T00:00:00.0000000"}],"count":0,"donationAmount":0,"payoutAmount":0,"payoutAmountIsk":0,"alreadyPaidCount":0,"replayed":false,"markPaidReference":"String","ownerId":0,"statusCode":0,"message":"String"}