POST InKassoClaims/QueryClaims
DoPayment same as in the IOBS InKasso SCHEMA
Request Information
URI Parameters
None.
Body Parameters
Name | Description | Type | Additional information |
---|---|---|---|
Request |
The request object that is sent to the InKasso or Debitum api. Can have diffrent structure depending on context. Please see property documentation. |
None. |
|
WebservicePath |
Binded from Form values in body. Service path |
string |
Required |
Username |
Binded from Form values in body. Service username |
string |
Required |
Password |
Binded from Form values in body. Service password |
string |
Required |
Request Formats
application/xml, text/xml
Sample:
<QueryClaimsModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<WebservicePath>sample string 2</WebservicePath>
<Username>sample string 3</Username>
<Password>sample string 4</Password>
<Request>
<Claimant xmlns="http://IcelandicOnlineBanking/2005/12/01/ClaimTypes">sample string 1</Claimant>
<Identifier xmlns="http://IcelandicOnlineBanking/2005/12/01/ClaimTypes">sample string 2</Identifier>
<Period DateSpanReferenceDate="DueDate" xmlns="http://IcelandicOnlineBanking/2005/12/01/ClaimTypes">
<DateFrom>2024-04-29</DateFrom>
<DateTo>2024-04-29</DateTo>
</Period>
<Payor xmlns="http://IcelandicOnlineBanking/2005/12/01/ClaimTypes">sample string 3</Payor>
<Status xmlns="http://IcelandicOnlineBanking/2005/12/01/ClaimTypes">Unpaid</Status>
<EntryFrom xmlns="http://IcelandicOnlineBanking/2005/12/01/ClaimTypes">5</EntryFrom>
<EntryTo xmlns="http://IcelandicOnlineBanking/2005/12/01/ClaimTypes">7</EntryTo>
</Request>
</QueryClaimsModel>
Response Information
Resource Description
Name | Description | Type | Additional information |
---|---|---|---|
Version |
None. |
||
Content |
None. |
||
StatusCode |
None. |
||
ReasonPhrase | string |
None. |
|
Headers | Collection of |
None. |
|
RequestMessage |
None. |
||
IsSuccessStatusCode | boolean |
None. |
Response Formats
application/xml, text/xml
Sample:
<QueryClaimsResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<TotalCount xmlns="http://IcelandicOnlineBanking/2005/12/01/ClaimTypes">1</TotalCount>
<Claims xmlns="http://IcelandicOnlineBanking/2005/12/01/ClaimTypes">
<Key>
<ClaimantID>sample string 1</ClaimantID>
<Account>sample string 2</Account>
<DueDate>2024-04-29</DueDate>
</Key>
<PayorID>sample string 15</PayorID>
<CancellationDate>2024-04-29</CancellationDate>
<Identifier>sample string 17</Identifier>
<Amount>18</Amount>
<Reference>sample string 19</Reference>
<FinalDueDate>2024-04-29</FinalDueDate>
<BillNumber>sample string 21</BillNumber>
<CustomerNumber>sample string 22</CustomerNumber>
<NoticeAndPaymentFee>
<Printing>1</Printing>
<Paperless>2</Paperless>
</NoticeAndPaymentFee>
<DefaultCharge ReferenceDate="DueDate">
<First xsi:type="DiscountOrDefaultChargeAmount" Days="1">2</First>
<Second xsi:type="DiscountOrDefaultChargeAmount" Days="1">2</Second>
</DefaultCharge>
<OtherCosts>23</OtherCosts>
<OtherDefaultCosts>24</OtherDefaultCosts>
<DefaultInterest>
<Rule>NoDefaultInterest</Rule>
<Percentage4>1</Percentage4>
<SpecialCode>sample string 3</SpecialCode>
</DefaultInterest>
<CurrencyInformation>
<ReferenceRate>ExchangeRate</ReferenceRate>
<Currency>sample string 1</Currency>
<PaymentRate>DueDateRate</PaymentRate>
</CurrencyInformation>
<PermitOutOfSequencePayment>true</PermitOutOfSequencePayment>
<Discount ReferenceDate="DueDate" IsPostRefDate="true">
<First xsi:type="DiscountOrDefaultChargeAmount" Days="1">2</First>
<Second xsi:type="DiscountOrDefaultChargeAmount" Days="1">2</Second>
</Discount>
<IsPartialPaymentAllowed>true</IsPartialPaymentAllowed>
<BillPresentmentSystem>
<Type>sample string 1</Type>
<Parameters>sample string 2</Parameters>
</BillPresentmentSystem>
<Printing>
<ClaimantAddress>
<Name xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 1</Name>
<AddressLine1 xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 2</AddressLine1>
<AddressLine2 xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 3</AddressLine2>
<PostCodeNumber xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 4</PostCodeNumber>
<City xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 5</City>
<Region xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 6</Region>
<Country xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 7</Country>
</ClaimantAddress>
<PayorAddress>
<Name xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 1</Name>
<AddressLine1 xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 2</AddressLine1>
<AddressLine2 xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 3</AddressLine2>
<PostCodeNumber xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 4</PostCodeNumber>
<City xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 5</City>
<Region xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 6</Region>
<Country xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 7</Country>
</PayorAddress>
<ItemRows>
<Text>sample string 1</Text>
<Amount>2</Amount>
</ItemRows>
<ItemRows>
<Text>sample string 1</Text>
<Amount>2</Amount>
</ItemRows>
<Comments>sample string 1</Comments>
<Comments>sample string 2</Comments>
</Printing>
<Status>Unpaid</Status>
<CategoryCode>sample string 1</CategoryCode>
<TotalAmountDue>2</TotalAmountDue>
<NoticeChargeAmount>3</NoticeChargeAmount>
<DefaultChargeAmount>5</DefaultChargeAmount>
<OtherCostsAmount>7</OtherCostsAmount>
<OtherDefaultCostsAmount>9</OtherDefaultCostsAmount>
<DefaultInterestAmount>11</DefaultInterestAmount>
<DiscountAmount>13</DiscountAmount>
</Claims>
<Claims xmlns="http://IcelandicOnlineBanking/2005/12/01/ClaimTypes">
<Key>
<ClaimantID>sample string 1</ClaimantID>
<Account>sample string 2</Account>
<DueDate>2024-04-29</DueDate>
</Key>
<PayorID>sample string 15</PayorID>
<CancellationDate>2024-04-29</CancellationDate>
<Identifier>sample string 17</Identifier>
<Amount>18</Amount>
<Reference>sample string 19</Reference>
<FinalDueDate>2024-04-29</FinalDueDate>
<BillNumber>sample string 21</BillNumber>
<CustomerNumber>sample string 22</CustomerNumber>
<NoticeAndPaymentFee>
<Printing>1</Printing>
<Paperless>2</Paperless>
</NoticeAndPaymentFee>
<DefaultCharge ReferenceDate="DueDate">
<First xsi:type="DiscountOrDefaultChargeAmount" Days="1">2</First>
<Second xsi:type="DiscountOrDefaultChargeAmount" Days="1">2</Second>
</DefaultCharge>
<OtherCosts>23</OtherCosts>
<OtherDefaultCosts>24</OtherDefaultCosts>
<DefaultInterest>
<Rule>NoDefaultInterest</Rule>
<Percentage4>1</Percentage4>
<SpecialCode>sample string 3</SpecialCode>
</DefaultInterest>
<CurrencyInformation>
<ReferenceRate>ExchangeRate</ReferenceRate>
<Currency>sample string 1</Currency>
<PaymentRate>DueDateRate</PaymentRate>
</CurrencyInformation>
<PermitOutOfSequencePayment>true</PermitOutOfSequencePayment>
<Discount ReferenceDate="DueDate" IsPostRefDate="true">
<First xsi:type="DiscountOrDefaultChargeAmount" Days="1">2</First>
<Second xsi:type="DiscountOrDefaultChargeAmount" Days="1">2</Second>
</Discount>
<IsPartialPaymentAllowed>true</IsPartialPaymentAllowed>
<BillPresentmentSystem>
<Type>sample string 1</Type>
<Parameters>sample string 2</Parameters>
</BillPresentmentSystem>
<Printing>
<ClaimantAddress>
<Name xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 1</Name>
<AddressLine1 xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 2</AddressLine1>
<AddressLine2 xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 3</AddressLine2>
<PostCodeNumber xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 4</PostCodeNumber>
<City xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 5</City>
<Region xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 6</Region>
<Country xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 7</Country>
</ClaimantAddress>
<PayorAddress>
<Name xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 1</Name>
<AddressLine1 xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 2</AddressLine1>
<AddressLine2 xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 3</AddressLine2>
<PostCodeNumber xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 4</PostCodeNumber>
<City xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 5</City>
<Region xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 6</Region>
<Country xmlns="http://IcelandicOnlineBanking/2005/12/01/CommonTypes">sample string 7</Country>
</PayorAddress>
<ItemRows>
<Text>sample string 1</Text>
<Amount>2</Amount>
</ItemRows>
<ItemRows>
<Text>sample string 1</Text>
<Amount>2</Amount>
</ItemRows>
<Comments>sample string 1</Comments>
<Comments>sample string 2</Comments>
</Printing>
<Status>Unpaid</Status>
<CategoryCode>sample string 1</CategoryCode>
<TotalAmountDue>2</TotalAmountDue>
<NoticeChargeAmount>3</NoticeChargeAmount>
<DefaultChargeAmount>5</DefaultChargeAmount>
<OtherCostsAmount>7</OtherCostsAmount>
<OtherDefaultCostsAmount>9</OtherDefaultCostsAmount>
<DefaultInterestAmount>11</DefaultInterestAmount>
<DiscountAmount>13</DiscountAmount>
</Claims>
</QueryClaimsResult>