NetCard Server Web API

<back to all web services

CreateCashDispense

The following routes are available for this service:
POST/CashDispense

To override the Content-type in your clients 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 /xml/reply/CreateCashDispense HTTP/1.1 
Host: testkioskapi.netcard.net.au 
Content-Type: application/xml
Content-Length: length

<CreateCashDispense xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NetCard.Server.API.ServiceModel.CashDispense">
  <CashDispense xmlns:d2p1="http://schemas.datacontract.org/2004/07/NetCard.Server.API.DTO">
    <d2p1:CashDispenseId>0</d2p1:CashDispenseId>
    <d2p1:CashDispenseQuantity>
      <d2p1:CashDispenseQuantityId>0</d2p1:CashDispenseQuantityId>
      <d2p1:CoinFiftyCentQty>0</d2p1:CoinFiftyCentQty>
      <d2p1:CoinFiveCentQty>0</d2p1:CoinFiveCentQty>
      <d2p1:CoinOneQty>0</d2p1:CoinOneQty>
      <d2p1:CoinTenCentQty>0</d2p1:CoinTenCentQty>
      <d2p1:CoinTwentyCentQty>0</d2p1:CoinTwentyCentQty>
      <d2p1:CoinTwoQty>0</d2p1:CoinTwoQty>
      <d2p1:NoteFiftyQty>0</d2p1:NoteFiftyQty>
      <d2p1:NoteFiveQty>0</d2p1:NoteFiveQty>
      <d2p1:NoteOneHundredQty>0</d2p1:NoteOneHundredQty>
      <d2p1:NoteTenQty>0</d2p1:NoteTenQty>
      <d2p1:NoteTwentyQty>0</d2p1:NoteTwentyQty>
    </d2p1:CashDispenseQuantity>
    <d2p1:CashDispenseTypeId>0</d2p1:CashDispenseTypeId>
    <d2p1:CashDispenserDeviceId>0</d2p1:CashDispenserDeviceId>
    <d2p1:CashKioskGenericAccount>
      <d2p1:AccountCode>String</d2p1:AccountCode>
      <d2p1:UserAccountTypeId>0</d2p1:UserAccountTypeId>
    </d2p1:CashKioskGenericAccount>
    <d2p1:CoinFiftyCent>0</d2p1:CoinFiftyCent>
    <d2p1:CoinFiveCent>0</d2p1:CoinFiveCent>
    <d2p1:CoinOne>0</d2p1:CoinOne>
    <d2p1:CoinTenCent>0</d2p1:CoinTenCent>
    <d2p1:CoinTwentyCent>0</d2p1:CoinTwentyCent>
    <d2p1:CoinTwo>0</d2p1:CoinTwo>
    <d2p1:Currency>String</d2p1:Currency>
    <d2p1:DateIn>0001-01-01T00:00:00</d2p1:DateIn>
    <d2p1:DeviceId>0</d2p1:DeviceId>
    <d2p1:InvalidMoney>
      <d2p1:AssistingUserId>0</d2p1:AssistingUserId>
      <d2p1:BentCoinAmount>0</d2p1:BentCoinAmount>
      <d2p1:ChequeAmount>0</d2p1:ChequeAmount>
      <d2p1:InvalidMoneyId>0</d2p1:InvalidMoneyId>
      <d2p1:RippedNoteAmount>0</d2p1:RippedNoteAmount>
      <d2p1:TotalAmount>0</d2p1:TotalAmount>
      <d2p1:TransactionLogId>0</d2p1:TransactionLogId>
    </d2p1:InvalidMoney>
    <d2p1:NoteFifty>0</d2p1:NoteFifty>
    <d2p1:NoteFive>0</d2p1:NoteFive>
    <d2p1:NoteOneHundred>0</d2p1:NoteOneHundred>
    <d2p1:NoteTen>0</d2p1:NoteTen>
    <d2p1:NoteTwenty>0</d2p1:NoteTwenty>
    <d2p1:TotalCash>0</d2p1:TotalCash>
    <d2p1:TotalCoin>0</d2p1:TotalCoin>
    <d2p1:TotalNote>0</d2p1:TotalNote>
    <d2p1:TransactionLog>
      <d2p1:AccountCode>String</d2p1:AccountCode>
      <d2p1:AmountAvailable>0</d2p1:AmountAvailable>
      <d2p1:AssistedUserId>0</d2p1:AssistedUserId>
      <d2p1:CustomerId>0</d2p1:CustomerId>
      <d2p1:DeviceId>0</d2p1:DeviceId>
      <d2p1:Options>String</d2p1:Options>
      <d2p1:OrderId>0</d2p1:OrderId>
      <d2p1:PreviousTransactionLogId>0</d2p1:PreviousTransactionLogId>
      <d2p1:ReferenceNumber>String</d2p1:ReferenceNumber>
      <d2p1:Tax>0</d2p1:Tax>
      <d2p1:TransactionAmount>0</d2p1:TransactionAmount>
      <d2p1:TransactionLogId>0</d2p1:TransactionLogId>
      <d2p1:TransactionTime>0001-01-01T00:00:00</d2p1:TransactionTime>
      <d2p1:TransactionTypeId>0</d2p1:TransactionTypeId>
      <d2p1:UserAccountTypeId>0</d2p1:UserAccountTypeId>
    </d2p1:TransactionLog>
    <d2p1:TransactionLogId>0</d2p1:TransactionLogId>
    <d2p1:UserId>0</d2p1:UserId>
  </CashDispense>
  <PreviousTransactionLogId>0</PreviousTransactionLogId>
  <TransactionTypeId>0</TransactionTypeId>
</CreateCashDispense>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateCashDispenseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NetCard.Server.API.ServiceModel.CashDispense">
  <ErrorCode xmlns="http://schemas.servicestack.net/types">String</ErrorCode>
  <Message xmlns="http://schemas.servicestack.net/types">String</Message>
  <StackTrace xmlns="http://schemas.servicestack.net/types">String</StackTrace>
  <Errors xmlns="http://schemas.servicestack.net/types">
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
    </ResponseError>
  </Errors>
  <CashDispense xmlns:d2p1="http://schemas.datacontract.org/2004/07/NetCard.Server.API.DTO">
    <d2p1:CashDispenseId>0</d2p1:CashDispenseId>
    <d2p1:CashDispenseQuantity>
      <d2p1:CashDispenseQuantityId>0</d2p1:CashDispenseQuantityId>
      <d2p1:CoinFiftyCentQty>0</d2p1:CoinFiftyCentQty>
      <d2p1:CoinFiveCentQty>0</d2p1:CoinFiveCentQty>
      <d2p1:CoinOneQty>0</d2p1:CoinOneQty>
      <d2p1:CoinTenCentQty>0</d2p1:CoinTenCentQty>
      <d2p1:CoinTwentyCentQty>0</d2p1:CoinTwentyCentQty>
      <d2p1:CoinTwoQty>0</d2p1:CoinTwoQty>
      <d2p1:NoteFiftyQty>0</d2p1:NoteFiftyQty>
      <d2p1:NoteFiveQty>0</d2p1:NoteFiveQty>
      <d2p1:NoteOneHundredQty>0</d2p1:NoteOneHundredQty>
      <d2p1:NoteTenQty>0</d2p1:NoteTenQty>
      <d2p1:NoteTwentyQty>0</d2p1:NoteTwentyQty>
    </d2p1:CashDispenseQuantity>
    <d2p1:CashDispenseTypeId>0</d2p1:CashDispenseTypeId>
    <d2p1:CashDispenserDeviceId>0</d2p1:CashDispenserDeviceId>
    <d2p1:CashKioskGenericAccount>
      <d2p1:AccountCode>String</d2p1:AccountCode>
      <d2p1:UserAccountTypeId>0</d2p1:UserAccountTypeId>
    </d2p1:CashKioskGenericAccount>
    <d2p1:CoinFiftyCent>0</d2p1:CoinFiftyCent>
    <d2p1:CoinFiveCent>0</d2p1:CoinFiveCent>
    <d2p1:CoinOne>0</d2p1:CoinOne>
    <d2p1:CoinTenCent>0</d2p1:CoinTenCent>
    <d2p1:CoinTwentyCent>0</d2p1:CoinTwentyCent>
    <d2p1:CoinTwo>0</d2p1:CoinTwo>
    <d2p1:Currency>String</d2p1:Currency>
    <d2p1:DateIn>0001-01-01T00:00:00</d2p1:DateIn>
    <d2p1:DeviceId>0</d2p1:DeviceId>
    <d2p1:InvalidMoney>
      <d2p1:AssistingUserId>0</d2p1:AssistingUserId>
      <d2p1:BentCoinAmount>0</d2p1:BentCoinAmount>
      <d2p1:ChequeAmount>0</d2p1:ChequeAmount>
      <d2p1:InvalidMoneyId>0</d2p1:InvalidMoneyId>
      <d2p1:RippedNoteAmount>0</d2p1:RippedNoteAmount>
      <d2p1:TotalAmount>0</d2p1:TotalAmount>
      <d2p1:TransactionLogId>0</d2p1:TransactionLogId>
    </d2p1:InvalidMoney>
    <d2p1:NoteFifty>0</d2p1:NoteFifty>
    <d2p1:NoteFive>0</d2p1:NoteFive>
    <d2p1:NoteOneHundred>0</d2p1:NoteOneHundred>
    <d2p1:NoteTen>0</d2p1:NoteTen>
    <d2p1:NoteTwenty>0</d2p1:NoteTwenty>
    <d2p1:TotalCash>0</d2p1:TotalCash>
    <d2p1:TotalCoin>0</d2p1:TotalCoin>
    <d2p1:TotalNote>0</d2p1:TotalNote>
    <d2p1:TransactionLog>
      <d2p1:AccountCode>String</d2p1:AccountCode>
      <d2p1:AmountAvailable>0</d2p1:AmountAvailable>
      <d2p1:AssistedUserId>0</d2p1:AssistedUserId>
      <d2p1:CustomerId>0</d2p1:CustomerId>
      <d2p1:DeviceId>0</d2p1:DeviceId>
      <d2p1:Options>String</d2p1:Options>
      <d2p1:OrderId>0</d2p1:OrderId>
      <d2p1:PreviousTransactionLogId>0</d2p1:PreviousTransactionLogId>
      <d2p1:ReferenceNumber>String</d2p1:ReferenceNumber>
      <d2p1:Tax>0</d2p1:Tax>
      <d2p1:TransactionAmount>0</d2p1:TransactionAmount>
      <d2p1:TransactionLogId>0</d2p1:TransactionLogId>
      <d2p1:TransactionTime>0001-01-01T00:00:00</d2p1:TransactionTime>
      <d2p1:TransactionTypeId>0</d2p1:TransactionTypeId>
      <d2p1:UserAccountTypeId>0</d2p1:UserAccountTypeId>
    </d2p1:TransactionLog>
    <d2p1:TransactionLogId>0</d2p1:TransactionLogId>
    <d2p1:UserId>0</d2p1:UserId>
  </CashDispense>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
</CreateCashDispenseResponse>