TicketUserServices

<back to all web services

PayoutBatchGetRequest

Requires Authentication
Requires the role:Admin
The following routes are available for this service:
GET/payouts/batches/{Id}
PayoutBatchGetRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
PayoutBatchGetResult Parameters:
NameParameterData TypeRequiredDescription
BatchformIsbPayoutBatchNo
RowsformList<IsbPayoutBatchRow>No
StatusCodeformintNo
MessageformstringNo
IsbPayoutBatch Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
BatchTypeformstringNo
OperationIdformstringNo
CreatedAtformDateTimeNo
DateOfPaymentformDateTime?No
RowCountformintNo
TotalAmountformlongNo
RequestXmlformstringNo
ResponseXmlformstringNo
StatusformstringNo
IsbPayoutBatchRow Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
BatchIdformintNo
EventIdformint?No
EventOwnerIdformint?No
KennitalaformstringNo
BankAccountformstringNo
AmountformlongNo
ReferenceformstringNo
StatusformstringNo
ErrorCodeformstringNo
ErrorTextformstringNo

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 /payouts/batches/{Id} HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"batch":{"id":0,"batchType":"String","operationId":"String","createdAt":"0001-01-01T00:00:00.0000000","dateOfPayment":"0001-01-01T00:00:00.0000000","rowCount":0,"totalAmount":0,"requestXml":"String","responseXml":"String","status":"String"},"rows":[{"id":0,"batchId":0,"eventId":0,"eventOwnerId":0,"kennitala":"String","bankAccount":"String","amount":0,"reference":"String","status":"String","errorCode":"String","errorText":"String"}],"statusCode":0,"message":"String"}