POST api/pos/redeemdeposits

Redeemes an array of booking deposits.

Request Information

URI Parameters

None.

Body Parameters

RedeemDeposits
NameDescriptionTypeAdditional information
bookingId integer

Required
deposits Collection of Deposit

Required

Request Formats

application/json, text/json

Sample: 
{
  "bookingId": 1,
  "deposits": [
    {
      "depositId": 1,
      "description": "sample string 1",
      "amount": 1.0,
      "amountOutstanding": 1.0,
      "reference": "sample string 2",
      "terminalId": "sample string 3",
      "isCardPayment": true,
      "isCashPayment": true,
      "isBankTransfer": true,
      "isRefund": true,
      "depositPaidOn": "2025-12-06T03:15:07.2230369+00:00",
      "dueDate": "2025-12-06T03:15:07.2230369+00:00"
    },
    {
      "depositId": 1,
      "description": "sample string 1",
      "amount": 1.0,
      "amountOutstanding": 1.0,
      "reference": "sample string 2",
      "terminalId": "sample string 3",
      "isCardPayment": true,
      "isCashPayment": true,
      "isBankTransfer": true,
      "isRefund": true,
      "depositPaidOn": "2025-12-06T03:15:07.2230369+00:00",
      "dueDate": "2025-12-06T03:15:07.2230369+00:00"
    }
  ]
}

application/xml, text/xml

Sample: 
<RedeemDeposits xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TillApi.DTOs.Request.POS">
  <BookingId>1</BookingId>
  <Deposits>
    <Deposit>
      <AmendId>1</AmendId>
      <Amount>1</Amount>
      <AmountOutstanding>1</AmountOutstanding>
      <BookingId>1</BookingId>
      <CreateDate>2025-12-06T03:15:07.224035+00:00</CreateDate>
      <CreateName>sample string 11</CreateName>
      <CreatedId>1</CreatedId>
      <CustomerId>1</CustomerId>
      <DepositId>1</DepositId>
      <DepositPaidOn>2025-12-06T03:15:07.2230369+00:00</DepositPaidOn>
      <Description>sample string 1</Description>
      <DueDate>2025-12-06T03:15:07.2230369+00:00</DueDate>
      <IsBankTransfer>true</IsBankTransfer>
      <IsCard>true</IsCard>
      <IsCash>true</IsCash>
      <IsRefund>true</IsRefund>
      <PaymentMethod>sample string 4</PaymentMethod>
      <Redeemed>true</Redeemed>
      <Reference>sample string 2</Reference>
      <SiteLookupId>1</SiteLookupId>
      <TerminalId>sample string 3</TerminalId>
    </Deposit>
    <Deposit>
      <AmendId>1</AmendId>
      <Amount>1</Amount>
      <AmountOutstanding>1</AmountOutstanding>
      <BookingId>1</BookingId>
      <CreateDate>2025-12-06T03:15:07.224035+00:00</CreateDate>
      <CreateName>sample string 11</CreateName>
      <CreatedId>1</CreatedId>
      <CustomerId>1</CustomerId>
      <DepositId>1</DepositId>
      <DepositPaidOn>2025-12-06T03:15:07.2230369+00:00</DepositPaidOn>
      <Description>sample string 1</Description>
      <DueDate>2025-12-06T03:15:07.2230369+00:00</DueDate>
      <IsBankTransfer>true</IsBankTransfer>
      <IsCard>true</IsCard>
      <IsCash>true</IsCash>
      <IsRefund>true</IsRefund>
      <PaymentMethod>sample string 4</PaymentMethod>
      <Redeemed>true</Redeemed>
      <Reference>sample string 2</Reference>
      <SiteLookupId>1</SiteLookupId>
      <TerminalId>sample string 3</TerminalId>
    </Deposit>
  </Deposits>
  <SiteId>1</SiteId>
</RedeemDeposits>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RedeemDeposits'.

multipart/form-data

Sample: 
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SiteId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="BookingId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[0].BookingId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[0].DepositId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[0].Description"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[0].Amount"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[0].AmountOutstanding"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[0].Reference"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[0].TerminalId"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[0].PaymentMethod"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[0].IsCard"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[0].IsCash"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[0].IsBankTransfer"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[0].IsRefund"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[0].Redeemed"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[0].DepositPaidOn"

2025-12-06T03:15:07.2230369+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[0].DueDate"

2025-12-06T03:15:07.2230369+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[0].CustomerId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[0].SiteLookupId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[0].AmendId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[0].CreatedId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[0].CreateDate"

2025-12-06T03:15:07.2240350+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[0].CreateName"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[1].BookingId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[1].DepositId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[1].Description"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[1].Amount"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[1].AmountOutstanding"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[1].Reference"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[1].TerminalId"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[1].PaymentMethod"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[1].IsCard"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[1].IsCash"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[1].IsBankTransfer"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[1].IsRefund"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[1].Redeemed"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[1].DepositPaidOn"

2025-12-06T03:15:07.2230369+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[1].DueDate"

2025-12-06T03:15:07.2230369+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[1].CustomerId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[1].SiteLookupId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[1].AmendId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[1].CreatedId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[1].CreateDate"

2025-12-06T03:15:07.2240350+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Deposits[1].CreateName"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

ResponseOfListOfDeposit
NameDescriptionTypeAdditional information
Message string

None.
Success boolean

None.
StatusCode HttpStatusCode

None.
Data Collection of Deposit

None.
Errors Dictionary of string [key] and Collection of string [value]

None.

Response Formats

application/json, text/json

Sample: 
{
  "message": "sample string 1",
  "success": true,
  "statusCode": 100,
  "data": [
    {
      "depositId": 1,
      "description": "sample string 1",
      "amount": 1.0,
      "amountOutstanding": 1.0,
      "reference": "sample string 2",
      "terminalId": "sample string 3",
      "isCardPayment": true,
      "isCashPayment": true,
      "isBankTransfer": true,
      "isRefund": true,
      "depositPaidOn": "2025-12-06T03:15:07.2520297+00:00",
      "dueDate": "2025-12-06T03:15:07.2520297+00:00"
    },
    {
      "depositId": 1,
      "description": "sample string 1",
      "amount": 1.0,
      "amountOutstanding": 1.0,
      "reference": "sample string 2",
      "terminalId": "sample string 3",
      "isCardPayment": true,
      "isCashPayment": true,
      "isBankTransfer": true,
      "isRefund": true,
      "depositPaidOn": "2025-12-06T03:15:07.2520297+00:00",
      "dueDate": "2025-12-06T03:15:07.2520297+00:00"
    }
  ],
  "errors": {
    "sample string 1": [
      "sample string 1",
      "sample string 2"
    ],
    "sample string 2": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample: 
<ResponseOfArrayOfDepositQD0vWtRb xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TillApi.DTOs.Response">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/TillApi.DTOs.Request.POS">
    <d2p1:Deposit>
      <d2p1:AmendId>1</d2p1:AmendId>
      <d2p1:Amount>1</d2p1:Amount>
      <d2p1:AmountOutstanding>1</d2p1:AmountOutstanding>
      <d2p1:BookingId>1</d2p1:BookingId>
      <d2p1:CreateDate>2025-12-06T03:15:07.2520297+00:00</d2p1:CreateDate>
      <d2p1:CreateName>sample string 11</d2p1:CreateName>
      <d2p1:CreatedId>1</d2p1:CreatedId>
      <d2p1:CustomerId>1</d2p1:CustomerId>
      <d2p1:DepositId>1</d2p1:DepositId>
      <d2p1:DepositPaidOn>2025-12-06T03:15:07.2520297+00:00</d2p1:DepositPaidOn>
      <d2p1:Description>sample string 1</d2p1:Description>
      <d2p1:DueDate>2025-12-06T03:15:07.2520297+00:00</d2p1:DueDate>
      <d2p1:IsBankTransfer>true</d2p1:IsBankTransfer>
      <d2p1:IsCard>true</d2p1:IsCard>
      <d2p1:IsCash>true</d2p1:IsCash>
      <d2p1:IsRefund>true</d2p1:IsRefund>
      <d2p1:PaymentMethod>sample string 4</d2p1:PaymentMethod>
      <d2p1:Redeemed>true</d2p1:Redeemed>
      <d2p1:Reference>sample string 2</d2p1:Reference>
      <d2p1:SiteLookupId>1</d2p1:SiteLookupId>
      <d2p1:TerminalId>sample string 3</d2p1:TerminalId>
    </d2p1:Deposit>
    <d2p1:Deposit>
      <d2p1:AmendId>1</d2p1:AmendId>
      <d2p1:Amount>1</d2p1:Amount>
      <d2p1:AmountOutstanding>1</d2p1:AmountOutstanding>
      <d2p1:BookingId>1</d2p1:BookingId>
      <d2p1:CreateDate>2025-12-06T03:15:07.2520297+00:00</d2p1:CreateDate>
      <d2p1:CreateName>sample string 11</d2p1:CreateName>
      <d2p1:CreatedId>1</d2p1:CreatedId>
      <d2p1:CustomerId>1</d2p1:CustomerId>
      <d2p1:DepositId>1</d2p1:DepositId>
      <d2p1:DepositPaidOn>2025-12-06T03:15:07.2520297+00:00</d2p1:DepositPaidOn>
      <d2p1:Description>sample string 1</d2p1:Description>
      <d2p1:DueDate>2025-12-06T03:15:07.2520297+00:00</d2p1:DueDate>
      <d2p1:IsBankTransfer>true</d2p1:IsBankTransfer>
      <d2p1:IsCard>true</d2p1:IsCard>
      <d2p1:IsCash>true</d2p1:IsCash>
      <d2p1:IsRefund>true</d2p1:IsRefund>
      <d2p1:PaymentMethod>sample string 4</d2p1:PaymentMethod>
      <d2p1:Redeemed>true</d2p1:Redeemed>
      <d2p1:Reference>sample string 2</d2p1:Reference>
      <d2p1:SiteLookupId>1</d2p1:SiteLookupId>
      <d2p1:TerminalId>sample string 3</d2p1:TerminalId>
    </d2p1:Deposit>
  </Data>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>sample string 1</d2p1:string>
        <d2p1:string>sample string 2</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>sample string 1</d2p1:string>
        <d2p1:string>sample string 2</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
  </Errors>
  <Message>sample string 1</Message>
  <StatusCode>Continue</StatusCode>
  <Success>true</Success>
</ResponseOfArrayOfDepositQD0vWtRb>

multipart/form-data

Sample: 
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Message"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Success"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="StatusCode"

Continue
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].BookingId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].DepositId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Description"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Amount"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].AmountOutstanding"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Reference"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].TerminalId"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].PaymentMethod"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].IsCard"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].IsCash"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].IsBankTransfer"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].IsRefund"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].Redeemed"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].DepositPaidOn"

2025-12-06T03:15:07.2520297+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].DueDate"

2025-12-06T03:15:07.2520297+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].CustomerId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].SiteLookupId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].AmendId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].CreatedId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].CreateDate"

2025-12-06T03:15:07.2520297+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[0].CreateName"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].BookingId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].DepositId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Description"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Amount"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].AmountOutstanding"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Reference"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].TerminalId"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].PaymentMethod"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].IsCard"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].IsCash"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].IsBankTransfer"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].IsRefund"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].Redeemed"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].DepositPaidOn"

2025-12-06T03:15:07.2520297+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].DueDate"

2025-12-06T03:15:07.2520297+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].CustomerId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].SiteLookupId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].AmendId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].CreatedId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].CreateDate"

2025-12-06T03:15:07.2520297+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data[1].CreateName"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[0].Key"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[0].Value[0]"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[0].Value[1]"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[1].Key"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[1].Value[0]"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[1].Value[1]"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e--