POST api/Cards/BookTransaction

Send card transaction and Order to be booked

Request Information

URI Parameters

None.

Body Parameters

cardId, ReceiptNumber, amount, KSCode, transDate, deviceNo, TransType

Name	Description	Type	Additional information
cardId	CardId	string	None.
ReceiptNumber	BelegNr	string	None.
Amount	Amount	decimal number	None.
KSCode	KSCode	string	None.
KstNr	KstNr	integer	None.
TransDate	TransactionDate	date	None.
DeviceNo	Device Number	string	None.
TransType	Type of transaction (0=register;1=vendingmachine)	string	None.
Articles	List of items	Collection of KassenArtikel	None.
Payments	List of Payments	Collection of KassenZahlung	None.
PayType	0=PaymentType must be provided in Payments, 1=Bar,2=MA,3=EC, 4=GS, 5=LS	integer	None.
Info1	Additional Info 1	string	None.
Info2	Additional Info 2	string	None.
Info3	Additional Info 3	string	None.
Info4	Additional Info 4	string	None.
Info5	Additional Info 5	string	None.
Info6	Additional Info 6	string	None.
Info7	Additional Info 7	string	None.
Info8	Additional Info 8	string	None.
Info9	Additional Info 9	string	None.
Info10	Additional Info 10	string	None.
PaidWithCard	Paid with card and no additional payment information will be provided	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "cardId": "sample string 1",
  "ReceiptNumber": "sample string 2",
  "Amount": 3.0,
  "KSCode": "sample string 4",
  "KstNr": 5,
  "TransDate": "2026-04-14T03:14:28.1555991+00:00",
  "DeviceNo": "sample string 7",
  "TransType": "sample string 8",
  "Articles": [
    {
      "PLUNr": "sample string 1",
      "Steuersatz": 2.1,
      "Einzelpreis": 3.0,
      "Menge": 4.1,
      "containerCodes": [
        {
          "external": true,
          "Code": "sample string 2"
        },
        {
          "external": true,
          "Code": "sample string 2"
        }
      ]
    },
    {
      "PLUNr": "sample string 1",
      "Steuersatz": 2.1,
      "Einzelpreis": 3.0,
      "Menge": 4.1,
      "containerCodes": [
        {
          "external": true,
          "Code": "sample string 2"
        },
        {
          "external": true,
          "Code": "sample string 2"
        }
      ]
    }
  ],
  "Payments": [
    {
      "ZahlArt": "sample string 1",
      "Betrag": 2.1,
      "ZAType": 3
    },
    {
      "ZahlArt": "sample string 1",
      "Betrag": 2.1,
      "ZAType": 3
    }
  ],
  "PayType": 9,
  "Info1": "sample string 10",
  "Info2": "sample string 11",
  "Info3": "sample string 12",
  "Info4": "sample string 13",
  "Info5": "sample string 14",
  "Info6": "sample string 15",
  "Info7": "sample string 16",
  "Info8": "sample string 17",
  "Info9": "sample string 18",
  "Info10": "sample string 19",
  "PaidWithCard": true
}

application/xml, text/xml

Sample:

<cFullTransaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KOSTIFC">
  <Amount>3</Amount>
  <Articles>
    <KassenArtikel>
      <Einzelpreis>3</Einzelpreis>
      <Menge>4.1</Menge>
      <PLUNr>sample string 1</PLUNr>
      <Steuersatz>2.1</Steuersatz>
      <containerCodes>
        <cContainerCode>
          <Code>sample string 2</Code>
          <external>true</external>
        </cContainerCode>
        <cContainerCode>
          <Code>sample string 2</Code>
          <external>true</external>
        </cContainerCode>
      </containerCodes>
    </KassenArtikel>
    <KassenArtikel>
      <Einzelpreis>3</Einzelpreis>
      <Menge>4.1</Menge>
      <PLUNr>sample string 1</PLUNr>
      <Steuersatz>2.1</Steuersatz>
      <containerCodes>
        <cContainerCode>
          <Code>sample string 2</Code>
          <external>true</external>
        </cContainerCode>
        <cContainerCode>
          <Code>sample string 2</Code>
          <external>true</external>
        </cContainerCode>
      </containerCodes>
    </KassenArtikel>
  </Articles>
  <DeviceNo>sample string 7</DeviceNo>
  <Info1>sample string 10</Info1>
  <Info10>sample string 19</Info10>
  <Info2>sample string 11</Info2>
  <Info3>sample string 12</Info3>
  <Info4>sample string 13</Info4>
  <Info5>sample string 14</Info5>
  <Info6>sample string 15</Info6>
  <Info7>sample string 16</Info7>
  <Info8>sample string 17</Info8>
  <Info9>sample string 18</Info9>
  <KSCode>sample string 4</KSCode>
  <KstNr>5</KstNr>
  <PaidWithCard>true</PaidWithCard>
  <PayType>9</PayType>
  <Payments>
    <KassenZahlung>
      <Betrag>2.1</Betrag>
      <ZAType>3</ZAType>
      <ZahlArt>sample string 1</ZahlArt>
    </KassenZahlung>
    <KassenZahlung>
      <Betrag>2.1</Betrag>
      <ZAType>3</ZAType>
      <ZahlArt>sample string 1</ZahlArt>
    </KassenZahlung>
  </Payments>
  <ReceiptNumber>sample string 2</ReceiptNumber>
  <TransDate>2026-04-14T03:14:28.1555991+00:00</TransDate>
  <TransType>sample string 8</TransType>
  <cardId>sample string 1</cardId>
</cFullTransaction>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CardData(Valid, Balance)

cResponseFullTransaction

Name	Description	Type	Additional information
Success	Success	boolean	None.
Message	Message	string	None.
GUID	Transaction-GUID	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "GUID": "sample string 3"
}

application/xml, text/xml

Sample:

<cResponseFullTransaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KOSTIFC">
  <GUID>sample string 3</GUID>
  <Message>sample string 2</Message>
  <Success>true</Success>
</cResponseFullTransaction>