islandsbanki.klar.ninja
Open in
urlscan Pro
20.107.224.31
Public Scan
Submitted URL: http://islandsbanki.klar.ninja/
Effective URL: https://islandsbanki.klar.ninja/swagger/ui/index
Submission: On August 06 via api from NL — Scanned from NL
Effective URL: https://islandsbanki.klar.ninja/swagger/ui/index
Submission: On August 06 via api from NL — Scanned from NL
Form analysis 30 forms found in the DOM
<form id="api_selector">
<div class="input"><input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl" type="text"></div>
<div class="input"><input placeholder="api_key" id="input_apiKey" name="apiKey" type="text"></div>
<div class="input"><a id="explore" class="header__btn" href="#" data-sw-translate="">Explore</a></div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mbank0.5254533979940941">bank</label></td>
<td>
<input class="parameter required" minlength="1" name="bank" placeholder="(required)" id="mbank0.5254533979940941" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Bank Number</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mledger0.4350486387404069">ledger</label></td>
<td>
<input class="parameter required" minlength="1" name="ledger" placeholder="(required)" id="mledger0.4350486387404069" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Ledger</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="maccountNumber0.06619409330524184">accountNumber</label></td>
<td>
<input class="parameter required" minlength="1" name="accountNumber" placeholder="(required)" id="maccountNumber0.06619409330524184" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Account Number</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msearchKey0.5227512239508063">searchKey</label></td>
<td>
<input class="parameter required" minlength="1" name="searchKey" placeholder="(required)" id="msearchKey0.5227512239508063" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Kennitala for the debtor</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.9536538113087585">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.9536538113087585" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mclaimant0.2645984433312929">claimant</label></td>
<td>
<input class="parameter required" minlength="1" name="claimant" placeholder="(required)" id="mclaimant0.2645984433312929" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Claim owner</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="midentifier0.5120491592598466">identifier</label></td>
<td>
<input class="parameter required" minlength="1" name="identifier" placeholder="(required)" id="midentifier0.5120491592598466" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Identifier from the bank</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mpayor0.6349780686290107">payor</label></td>
<td>
<input class="parameter required" minlength="1" name="payor" placeholder="(required)" id="mpayor0.6349780686290107" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Debtor</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mfromDate0.6355878935384454">fromDate</label></td>
<td>
<input class="parameter required" minlength="1" name="fromDate" placeholder="(required)" id="mfromDate0.6355878935384454" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Filter records from</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
<tr>
<td class="code required"><label for="mtoDate0.6349661191028759">toDate</label></td>
<td>
<input class="parameter required" minlength="1" name="toDate" placeholder="(required)" id="mtoDate0.6349661191028759" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Filter records to</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
<tr>
<td class="code required"><label for="monlyUnpaid0.8766843508556548">onlyUnpaid</label></td>
<td>
<select class="parameter required " name="onlyUnpaid" id="monlyUnpaid0.8766843508556548">
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p><strong>Only unpaid claims</strong></p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mclaimant0.4922195402220326">claimant</label></td>
<td>
<input class="parameter required" minlength="1" name="claimant" placeholder="(required)" id="mclaimant0.4922195402220326" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Claim owner</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="maccount0.3268731995268066">account</label></td>
<td>
<input class="parameter required" minlength="1" name="account" placeholder="(required)" id="maccount0.3268731995268066" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Full claim number</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mdueDate0.7832146661829558">dueDate</label></td>
<td>
<input class="parameter required" minlength="1" name="dueDate" placeholder="(required)" id="mdueDate0.7832146661829558" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The claim due date</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mclaimant0.10728495622930789">claimant</label></td>
<td>
<input class="parameter required" minlength="1" name="claimant" placeholder="(required)" id="mclaimant0.10728495622930789" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Claim owner</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="midentifier0.7401213809258271">identifier</label></td>
<td>
<input class="parameter required" minlength="1" name="identifier" placeholder="(required)" id="midentifier0.7401213809258271" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Identifier from the bank</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mpayor0.9701051439033541">payor</label></td>
<td>
<input class="parameter required" minlength="1" name="payor" placeholder="(required)" id="mpayor0.9701051439033541" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Debtor</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrecordFrom0.010171921560032882">recordFrom</label></td>
<td>
<input class="parameter required" minlength="1" name="recordFrom" placeholder="(required)" id="mrecordFrom0.010171921560032882" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mrecordTo0.8188759157595189">recordTo</label></td>
<td>
<input class="parameter required" minlength="1" name="recordTo" placeholder="(required)" id="mrecordTo0.8188759157595189" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="monlyUnpaid0.02918239224298058">onlyUnpaid</label></td>
<td>
<select class="parameter required " name="onlyUnpaid" id="monlyUnpaid0.02918239224298058">
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p><strong></strong></p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mclaims0.00836639735421274">claims</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="claims" id="mclaims0.00836639735421274"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6676011094060184" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6676011094060184">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Bankhub.Models.Claim {</span>
<div><span class="propName ">Key</span> (<span class="propType">Bankhub.Models.ClaimKey</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PayorID</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PayorName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ClaimantName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CancellationDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Identifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Amount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Reference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">FinalDueDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BillNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CustomerNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">NoticeAndPaymentFee</span> (<span class="propType">Bankhub.Models.NoticeAndPaymentFee</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DefaultCharge</span> (<span class="propType">Bankhub.Models.DateRestrictedCharge</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OtherCosts</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OtherDefaultCosts</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DefaultInterest</span> (<span class="propType">Bankhub.Models.DefaultInterest</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CurrencyInformation</span> (<span class="propType">Bankhub.Models.CurrencyInformation</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PermitOutOfSequencePayment</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Discount</span> (<span class="propType">Bankhub.Models.DiscountCharge</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IsPartialPaymentAllowed</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BillPresentmentSystem</span> (<span class="propType">Bankhub.Models.BillPresentmentSystem</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Printing</span> (<span class="propType">Bankhub.Models.Printing</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.ClaimKey
{</span>
<div><span class="propName ">Claimant</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Account</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DueDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.NoticeAndPaymentFee {</span>
<div><span class="propName ">Printing</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Paperless</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.DateRestrictedCharge
{</span>
<div><span class="propName ">First</span> (<span class="propType">Bankhub.Models.DiscountOrDefaultChargePercentage</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">FirstAmount</span> (<span class="propType">Bankhub.Models.DiscountOrDefaultChargeAmount</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Second</span> (<span class="propType">Bankhub.Models.DiscountOrDefaultChargePercentage</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SecondAmount</span> (<span class="propType">Bankhub.Models.DiscountOrDefaultChargeAmount</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">ReferenceDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['DueDate', 'FinalDueDate']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"DueDate", "FinalDueDate"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span><br><span class="strong">Bankhub.Models.DefaultInterest {</span>
<div><span class="propWrap"><span class="propName ">Rule</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['NoDefaultInterest', 'DefaultInterestAmount',
'DefaultInterestAmountAndDefaultCharge']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"NoDefaultInterest", "DefaultInterestAmount", "DefaultInterestAmountAndDefaultCharge"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">Percentage4</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SpecialCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.CurrencyInformation
{</span>
<div><span class="propWrap"><span class="propName ">ReferenceRate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['ExchangeRate', 'NoteRate',
'CentralBankMidRate', 'CentralBankStatutoryRate']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"ExchangeRate", "NoteRate", "CentralBankMidRate", "CentralBankStatutoryRate"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">Currency</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">PaymentRate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['DueDateRate', 'PaymentDateRate']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"DueDateRate", "PaymentDateRate"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span><br><span class="strong">Bankhub.Models.DiscountCharge {</span>
<div><span class="propName ">IsPostRefDate</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">First</span> (<span class="propType">Bankhub.Models.DiscountOrDefaultChargePercentage</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">FirstAmount</span> (<span class="propType">Bankhub.Models.DiscountOrDefaultChargeAmount</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Second</span> (<span class="propType">Bankhub.Models.DiscountOrDefaultChargePercentage</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SecondAmount</span> (<span class="propType">Bankhub.Models.DiscountOrDefaultChargeAmount</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">ReferenceDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['DueDate', 'FinalDueDate']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"DueDate", "FinalDueDate"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span><br><span class="strong">Bankhub.Models.BillPresentmentSystem {</span>
<div><span class="propName ">Type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Parameters</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.Printing {</span>
<div><span class="propName ">ClaimantAddress</span> (<span class="propType">Bankhub.Models.Address</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PayorAddress</span> (<span class="propType">Bankhub.Models.Address</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ItemRows</span> (<span class="propType">Array[Bankhub.Models.ItemRow]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Comments</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">Bankhub.Models.DiscountOrDefaultChargePercentage {</span>
<div><span class="propName ">Days</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Value</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.DiscountOrDefaultChargeAmount
{</span>
<div><span class="propName ">Days</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Value</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.Address {</span>
<div><span class="propName ">Name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AddressLine1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AddressLine2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PostalCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">City</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Region</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.ItemRow {</span>
<div><span class="propName ">Text</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Amount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>[
{
"Key": {
"Claimant": "string",
"Account": "string",
"DueDate": "2024-08-06T13:03:40.064Z"
},
"PayorID": "string",
"PayorName": "string",
"ClaimantName": "string",
"CancellationDate": "2024-08-06T13:03:40.064Z",
"Identifier": "string",
"Amount": 0,
"Reference": "string",
"FinalDueDate": "2024-08-06T13:03:40.064Z",
"BillNumber": "string",
"CustomerNumber": "string",
"NoticeAndPaymentFee": {
"Printing": 0,
"Paperless": 0
},
"DefaultCharge": {
"First": {
"Days": 0,
"Value": 0
},
"FirstAmount": {
"Days": 0,
"Value": 0
},
"Second": {
"Days": 0,
"Value": 0
},
"SecondAmount": {
"Days": 0,
"Value": 0
},
"ReferenceDate": "DueDate"
},
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": {
"Rule": "NoDefaultInterest",
"Percentage4": 0,
"SpecialCode": "string"
},
"CurrencyInformation": {
"ReferenceRate": "ExchangeRate",
"Currency": "string",
"PaymentRate": "DueDateRate"
},
"PermitOutOfSequencePayment": true,
"Discount": {
"IsPostRefDate": true,
"First": {
"Days": 0,
"Value": 0
},
"FirstAmount": {
"Days": 0,
"Value": 0
},
"Second": {
"Days": 0,
"Value": 0
},
"SecondAmount": {
"Days": 0,
"Value": 0
},
"ReferenceDate": "DueDate"
},
"IsPartialPaymentAllowed": true,
"BillPresentmentSystem": {
"Type": "string",
"Parameters": "string"
},
"Printing": {
"ClaimantAddress": {
"Name": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"PostalCode": "string",
"City": "string",
"Region": "string",
"Country": "string"
},
"PayorAddress": {
"Name": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"PostalCode": "string",
"City": "string",
"Region": "string",
"Country": "string"
},
"ItemRows": [
{
"Text": "string",
"Amount": 0
}
],
"Comments": [
"string"
]
}
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<Bankhub.Models.Claim>
<Key>
<Claimant>string</Claimant>
<Account>string</Account>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
</Key>
<PayorID>string</PayorID>
<PayorName>string</PayorName>
<ClaimantName>string</ClaimantName>
<CancellationDate>1970-01-01T00:00:00.001Z</CancellationDate>
<Identifier>string</Identifier>
<Amount>1.1</Amount>
<Reference>string</Reference>
<FinalDueDate>1970-01-01T00:00:00.001Z</FinalDueDate>
<BillNumber>string</BillNumber>
<CustomerNumber>string</CustomerNumber>
<NoticeAndPaymentFee>
<Printing>1.1</Printing>
<Paperless>1.1</Paperless>
</NoticeAndPaymentFee>
<DefaultCharge>
<First>
<Days>1</Days>
<Value>1.1</Value>
</First>
<FirstAmount>
<Days>1</Days>
<Value>1.1</Value>
</FirstAmount>
<Second>
<Days>1</Days>
<Value>1.1</Value>
</Second>
<SecondAmount>
<Days>1</Days>
<Value>1.1</Value>
</SecondAmount>
<ReferenceDate>DueDate</ReferenceDate>
</DefaultCharge>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>
<Rule>NoDefaultInterest</Rule>
<Percentage4>1.1</Percentage4>
<SpecialCode>string</SpecialCode>
</DefaultInterest>
<CurrencyInformation>
<ReferenceRate>ExchangeRate</ReferenceRate>
<Currency>string</Currency>
<PaymentRate>DueDateRate</PaymentRate>
</CurrencyInformation>
<PermitOutOfSequencePayment>true</PermitOutOfSequencePayment>
<Discount>
<IsPostRefDate>true</IsPostRefDate>
<First>
<Days>1</Days>
<Value>1.1</Value>
</First>
<FirstAmount>
<Days>1</Days>
<Value>1.1</Value>
</FirstAmount>
<Second>
<Days>1</Days>
<Value>1.1</Value>
</Second>
<SecondAmount>
<Days>1</Days>
<Value>1.1</Value>
</SecondAmount>
<ReferenceDate>DueDate</ReferenceDate>
</Discount>
<IsPartialPaymentAllowed>true</IsPartialPaymentAllowed>
<BillPresentmentSystem>
<Type>string</Type>
<Parameters>string</Parameters>
</BillPresentmentSystem>
<Printing>
<ClaimantAddress>
<Name>string</Name>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<PostalCode>string</PostalCode>
<City>string</City>
<Region>string</Region>
<Country>string</Country>
</ClaimantAddress>
<PayorAddress>
<Name>string</Name>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<PostalCode>string</PostalCode>
<City>string</City>
<Region>string</Region>
<Country>string</Country>
</PayorAddress>
<ItemRows>
<Text>string</Text>
<Amount>1.1</Amount>
</ItemRows>
<Comments>string</Comments>
</Printing>
</Bankhub.Models.Claim>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mclaims0.7514617400849983">claims</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="claims" id="mclaims0.7514617400849983"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.23364441462375019" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.23364441462375019">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Bankhub.Models.Claim {</span>
<div><span class="propName ">Key</span> (<span class="propType">Bankhub.Models.ClaimKey</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PayorID</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PayorName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ClaimantName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CancellationDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Identifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Amount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Reference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">FinalDueDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BillNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CustomerNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">NoticeAndPaymentFee</span> (<span class="propType">Bankhub.Models.NoticeAndPaymentFee</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DefaultCharge</span> (<span class="propType">Bankhub.Models.DateRestrictedCharge</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OtherCosts</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OtherDefaultCosts</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DefaultInterest</span> (<span class="propType">Bankhub.Models.DefaultInterest</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CurrencyInformation</span> (<span class="propType">Bankhub.Models.CurrencyInformation</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PermitOutOfSequencePayment</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Discount</span> (<span class="propType">Bankhub.Models.DiscountCharge</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IsPartialPaymentAllowed</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BillPresentmentSystem</span> (<span class="propType">Bankhub.Models.BillPresentmentSystem</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Printing</span> (<span class="propType">Bankhub.Models.Printing</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.ClaimKey
{</span>
<div><span class="propName ">Claimant</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Account</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DueDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.NoticeAndPaymentFee {</span>
<div><span class="propName ">Printing</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Paperless</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.DateRestrictedCharge
{</span>
<div><span class="propName ">First</span> (<span class="propType">Bankhub.Models.DiscountOrDefaultChargePercentage</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">FirstAmount</span> (<span class="propType">Bankhub.Models.DiscountOrDefaultChargeAmount</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Second</span> (<span class="propType">Bankhub.Models.DiscountOrDefaultChargePercentage</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SecondAmount</span> (<span class="propType">Bankhub.Models.DiscountOrDefaultChargeAmount</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">ReferenceDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['DueDate', 'FinalDueDate']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"DueDate", "FinalDueDate"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span><br><span class="strong">Bankhub.Models.DefaultInterest {</span>
<div><span class="propWrap"><span class="propName ">Rule</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['NoDefaultInterest', 'DefaultInterestAmount',
'DefaultInterestAmountAndDefaultCharge']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"NoDefaultInterest", "DefaultInterestAmount", "DefaultInterestAmountAndDefaultCharge"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">Percentage4</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SpecialCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.CurrencyInformation
{</span>
<div><span class="propWrap"><span class="propName ">ReferenceRate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['ExchangeRate', 'NoteRate',
'CentralBankMidRate', 'CentralBankStatutoryRate']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"ExchangeRate", "NoteRate", "CentralBankMidRate", "CentralBankStatutoryRate"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">Currency</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">PaymentRate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['DueDateRate', 'PaymentDateRate']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"DueDateRate", "PaymentDateRate"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span><br><span class="strong">Bankhub.Models.DiscountCharge {</span>
<div><span class="propName ">IsPostRefDate</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">First</span> (<span class="propType">Bankhub.Models.DiscountOrDefaultChargePercentage</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">FirstAmount</span> (<span class="propType">Bankhub.Models.DiscountOrDefaultChargeAmount</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Second</span> (<span class="propType">Bankhub.Models.DiscountOrDefaultChargePercentage</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SecondAmount</span> (<span class="propType">Bankhub.Models.DiscountOrDefaultChargeAmount</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">ReferenceDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['DueDate', 'FinalDueDate']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"DueDate", "FinalDueDate"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span><br><span class="strong">Bankhub.Models.BillPresentmentSystem {</span>
<div><span class="propName ">Type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Parameters</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.Printing {</span>
<div><span class="propName ">ClaimantAddress</span> (<span class="propType">Bankhub.Models.Address</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PayorAddress</span> (<span class="propType">Bankhub.Models.Address</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ItemRows</span> (<span class="propType">Array[Bankhub.Models.ItemRow]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Comments</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">Bankhub.Models.DiscountOrDefaultChargePercentage {</span>
<div><span class="propName ">Days</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Value</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.DiscountOrDefaultChargeAmount
{</span>
<div><span class="propName ">Days</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Value</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.Address {</span>
<div><span class="propName ">Name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AddressLine1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AddressLine2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PostalCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">City</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Region</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.ItemRow {</span>
<div><span class="propName ">Text</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Amount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>[
{
"Key": {
"Claimant": "string",
"Account": "string",
"DueDate": "2024-08-06T13:03:40.080Z"
},
"PayorID": "string",
"PayorName": "string",
"ClaimantName": "string",
"CancellationDate": "2024-08-06T13:03:40.080Z",
"Identifier": "string",
"Amount": 0,
"Reference": "string",
"FinalDueDate": "2024-08-06T13:03:40.080Z",
"BillNumber": "string",
"CustomerNumber": "string",
"NoticeAndPaymentFee": {
"Printing": 0,
"Paperless": 0
},
"DefaultCharge": {
"First": {
"Days": 0,
"Value": 0
},
"FirstAmount": {
"Days": 0,
"Value": 0
},
"Second": {
"Days": 0,
"Value": 0
},
"SecondAmount": {
"Days": 0,
"Value": 0
},
"ReferenceDate": "DueDate"
},
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": {
"Rule": "NoDefaultInterest",
"Percentage4": 0,
"SpecialCode": "string"
},
"CurrencyInformation": {
"ReferenceRate": "ExchangeRate",
"Currency": "string",
"PaymentRate": "DueDateRate"
},
"PermitOutOfSequencePayment": true,
"Discount": {
"IsPostRefDate": true,
"First": {
"Days": 0,
"Value": 0
},
"FirstAmount": {
"Days": 0,
"Value": 0
},
"Second": {
"Days": 0,
"Value": 0
},
"SecondAmount": {
"Days": 0,
"Value": 0
},
"ReferenceDate": "DueDate"
},
"IsPartialPaymentAllowed": true,
"BillPresentmentSystem": {
"Type": "string",
"Parameters": "string"
},
"Printing": {
"ClaimantAddress": {
"Name": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"PostalCode": "string",
"City": "string",
"Region": "string",
"Country": "string"
},
"PayorAddress": {
"Name": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"PostalCode": "string",
"City": "string",
"Region": "string",
"Country": "string"
},
"ItemRows": [
{
"Text": "string",
"Amount": 0
}
],
"Comments": [
"string"
]
}
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<Bankhub.Models.Claim>
<Key>
<Claimant>string</Claimant>
<Account>string</Account>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
</Key>
<PayorID>string</PayorID>
<PayorName>string</PayorName>
<ClaimantName>string</ClaimantName>
<CancellationDate>1970-01-01T00:00:00.001Z</CancellationDate>
<Identifier>string</Identifier>
<Amount>1.1</Amount>
<Reference>string</Reference>
<FinalDueDate>1970-01-01T00:00:00.001Z</FinalDueDate>
<BillNumber>string</BillNumber>
<CustomerNumber>string</CustomerNumber>
<NoticeAndPaymentFee>
<Printing>1.1</Printing>
<Paperless>1.1</Paperless>
</NoticeAndPaymentFee>
<DefaultCharge>
<First>
<Days>1</Days>
<Value>1.1</Value>
</First>
<FirstAmount>
<Days>1</Days>
<Value>1.1</Value>
</FirstAmount>
<Second>
<Days>1</Days>
<Value>1.1</Value>
</Second>
<SecondAmount>
<Days>1</Days>
<Value>1.1</Value>
</SecondAmount>
<ReferenceDate>DueDate</ReferenceDate>
</DefaultCharge>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>
<Rule>NoDefaultInterest</Rule>
<Percentage4>1.1</Percentage4>
<SpecialCode>string</SpecialCode>
</DefaultInterest>
<CurrencyInformation>
<ReferenceRate>ExchangeRate</ReferenceRate>
<Currency>string</Currency>
<PaymentRate>DueDateRate</PaymentRate>
</CurrencyInformation>
<PermitOutOfSequencePayment>true</PermitOutOfSequencePayment>
<Discount>
<IsPostRefDate>true</IsPostRefDate>
<First>
<Days>1</Days>
<Value>1.1</Value>
</First>
<FirstAmount>
<Days>1</Days>
<Value>1.1</Value>
</FirstAmount>
<Second>
<Days>1</Days>
<Value>1.1</Value>
</Second>
<SecondAmount>
<Days>1</Days>
<Value>1.1</Value>
</SecondAmount>
<ReferenceDate>DueDate</ReferenceDate>
</Discount>
<IsPartialPaymentAllowed>true</IsPartialPaymentAllowed>
<BillPresentmentSystem>
<Type>string</Type>
<Parameters>string</Parameters>
</BillPresentmentSystem>
<Printing>
<ClaimantAddress>
<Name>string</Name>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<PostalCode>string</PostalCode>
<City>string</City>
<Region>string</Region>
<Country>string</Country>
</ClaimantAddress>
<PayorAddress>
<Name>string</Name>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<PostalCode>string</PostalCode>
<City>string</City>
<Region>string</Region>
<Country>string</Country>
</PayorAddress>
<ItemRows>
<Text>string</Text>
<Amount>1.1</Amount>
</ItemRows>
<Comments>string</Comments>
</Printing>
</Bankhub.Models.Claim>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mclaimant0.6650700984555269">claimant</label></td>
<td>
<input class="parameter required" minlength="1" name="claimant" placeholder="(required)" id="mclaimant0.6650700984555269" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="maccount0.9054949814663473">account</label></td>
<td>
<input class="parameter required" minlength="1" name="account" placeholder="(required)" id="maccount0.9054949814663473" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mdueDate0.7812114293845829">dueDate</label></td>
<td>
<input class="parameter required" minlength="1" name="dueDate" placeholder="(required)" id="mdueDate0.7812114293845829" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mclaimant0.07184863703484967">claimant</label></td>
<td>
<input class="parameter required" minlength="1" name="claimant" placeholder="(required)" id="mclaimant0.07184863703484967" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mfromDate0.9666364729014276">fromDate</label></td>
<td>
<input class="parameter required" minlength="1" name="fromDate" placeholder="(required)" id="mfromDate0.9666364729014276" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
<tr>
<td class="code required"><label for="mtoDate0.20157115044355578">toDate</label></td>
<td>
<input class="parameter required" minlength="1" name="toDate" placeholder="(required)" id="mtoDate0.20157115044355578" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mclaimKeys0.6609422793081485">claimKeys</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="claimKeys" id="mclaimKeys0.6609422793081485"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.16651498412754018" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.16651498412754018">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;"> Array[<span class="strong">Bankhub.Models.ClaimKey {</span>
<div><span class="propName ">Claimant</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Account</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DueDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>]
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>[
{
"Claimant": "string",
"Account": "string",
"DueDate": "2024-08-06T13:03:40.125Z"
}
]</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<Bankhub.Models.ClaimKey>
<Claimant>string</Claimant>
<Account>string</Account>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
</Bankhub.Models.ClaimKey>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mownerId0.23537529770380883">ownerId</label></td>
<td>
<input class="parameter required" minlength="1" name="ownerId" placeholder="(required)" id="mownerId0.23537529770380883" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Owner id for the cards</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mcardId0.20209961945625854">cardId</label></td>
<td>
<input class="parameter required" minlength="1" name="cardId" placeholder="(required)" id="mcardId0.20209961945625854" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mcardId0.4318354475610482">cardId</label></td>
<td>
<input class="parameter required" minlength="1" name="cardId" placeholder="(required)" id="mcardId0.4318354475610482" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Unique identifier for the card</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mfromDate0.5173572773038111">fromDate</label></td>
<td>
<input class="parameter required" minlength="1" name="fromDate" placeholder="(required)" id="mfromDate0.5173572773038111" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Get credit card transactions from</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
<tr>
<td class="code required"><label for="mtoDate0.3500905608584963">toDate</label></td>
<td>
<input class="parameter required" minlength="1" name="toDate" placeholder="(required)" id="mtoDate0.3500905608584963" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Get credit card transactions to</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdate0.8505942063211867">date</label></td>
<td>
<input class="parameter required" minlength="1" name="date" placeholder="(required)" id="mdate0.8505942063211867" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdate0.2364381469058645">date</label></td>
<td>
<input class="parameter required" minlength="1" name="date" placeholder="(required)" id="mdate0.2364381469058645" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">date-time</span></td>
</tr>
<tr>
<td class="code required"><label for="msource0.3780140651442254">source</label></td>
<td>
<select class="parameter required " name="source" id="msource0.3780140651442254">
<option value="NoteRate"> NoteRate </option>
<option value="ExchangeRate"> ExchangeRate </option>
<option value="CustomsRate"> CustomsRate </option>
</select>
</td>
<td class="markdown">
<p><strong></strong></p>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdateFrom0.34196376328478584">dateFrom</label></td>
<td>
<input class="parameter required" minlength="1" name="dateFrom" placeholder="(required)" id="mdateFrom0.34196376328478584" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Search for document created after {dateFrom}.</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">date-time</span></td>
</tr>
<tr>
<td class="code required"><label for="mdateTo0.9680592506841139">dateTo</label></td>
<td>
<input class="parameter required" minlength="1" name="dateTo" placeholder="(required)" id="mdateTo0.9680592506841139" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Search for document created before {dateTo}.</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocumentId0.8202361149726265">documentId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" id="mdocumentId0.8202361149726265" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The id of the document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdocument0.35821675174448453">document</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="document" id="mdocument0.35821675174448453"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.430253479905643" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.430253479905643">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The document</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Bankhub.Models.Documents.UploadDocument {</span>
<div><span class="propName ">PersonId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DocumentName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DocumentType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">FileAsBase64</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"PersonId": "string",
"DocumentName": "string",
"DocumentType": "string",
"FileAsBase64": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<Bankhub.Models.Documents.UploadDocument>
<PersonId>string</PersonId>
<DocumentName>string</DocumentName>
<DocumentType>string</DocumentType>
<FileAsBase64>string</FileAsBase64>
</Bankhub.Models.Documents.UploadDocument>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpayments0.8667266724742033">payments</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="payments" id="mpayments0.8667266724742033"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7371296430896388" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7371296430896388">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The batch payments</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Bankhub.Models.Payments.Payments {</span>
<div><span class="propName ">Out</span> (<span class="propType">Bankhub.Models.Payments.PaymentOut</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">In</span> (<span class="propType">Array[Bankhub.Models.Payments.PaymentIn]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DateOfForwardPayment</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DateOfForwardPaymentSpecified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">NameOfBatch</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RollbackOnError</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IsOneToMany</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.Payments.PaymentOut
{</span>
<div><span class="propName ">Account</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AccountOwnerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CategoryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Reference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BillNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Receipt</span> (<span class="propType">Bankhub.Models.Payments.Communication</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">Bankhub.Models.Payments.PaymentIn {</span>
<div><span class="propName ">Amount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BookingId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ABGiro</span> (<span class="propType">Bankhub.Models.Payments.ABGiro</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CGiro</span> (<span class="propType">Bankhub.Models.Payments.CGiro</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PaymentClaim</span> (<span class="propType">Bankhub.Models.Payments.PaymentClaim</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Transfer</span> (<span class="propType">Bankhub.Models.Payments.Transfer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Receipt</span> (<span class="propType">Bankhub.Models.Payments.Communication</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">Bankhub.Models.Payments.Communication {</span>
<div><span class="propName ">EMail</span> (<span class="propType">Array[Bankhub.Models.Payments.CommunicationEMail]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SMS</span> (<span class="propType">Array[Bankhub.Models.Payments.CommunicationSMS]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">Bankhub.Models.Payments.ABGiro {</span>
<div><span class="propName ">Account</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Reference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BillNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CategoryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.Payments.CGiro {</span>
<div><span class="propName ">Account</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AccountOwnerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BillNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CategoryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.Payments.PaymentClaim
{</span>
<div><span class="propName ">Account</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Claimant</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PayorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DueDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IsDeposit</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AmountDue</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DefaultCosts</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OtherCosts</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OtherDefaultCosts</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DefaultInterest</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">NoticeAndPaymentFee</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Discount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CategoryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.Payments.Transfer
{</span>
<div><span class="propName ">Account</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AccountOwnerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CategoryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Reference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BillNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">Bankhub.Models.Payments.CommunicationEMail {</span>
<div><span class="propName ">EmailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Language</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.Payments.CommunicationSMS
{</span>
<div><span class="propName ">PhoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CountryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Language</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"Out": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string",
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
}
},
"In": [
{
"Amount": 0,
"Description": "string",
"BookingId": "string",
"ABGiro": {
"Account": "string",
"Reference": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"CGiro": {
"Account": "string",
"AccountOwnerId": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"PaymentClaim": {
"Account": "string",
"Claimant": "string",
"PayorId": "string",
"DueDate": "2024-08-06T13:03:40.156Z",
"IsDeposit": true,
"AmountDue": 0,
"DefaultCosts": 0,
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": 0,
"NoticeAndPaymentFee": 0,
"Discount": 0,
"CategoryCode": "string"
},
"Transfer": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string"
},
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
}
}
],
"DateOfForwardPayment": "2024-08-06T13:03:40.156Z",
"DateOfForwardPaymentSpecified": true,
"NameOfBatch": "string",
"RollbackOnError": true,
"IsOneToMany": true
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<Bankhub.Models.Payments.Payments>
<Out>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
</Out>
<In>
<Amount>1.1</Amount>
<Description>string</Description>
<BookingId>string</BookingId>
<ABGiro>
<Account>string</Account>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</ABGiro>
<CGiro>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</CGiro>
<PaymentClaim>
<Account>string</Account>
<Claimant>string</Claimant>
<PayorId>string</PayorId>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
<IsDeposit>true</IsDeposit>
<AmountDue>1.1</AmountDue>
<DefaultCosts>1.1</DefaultCosts>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>1.1</DefaultInterest>
<NoticeAndPaymentFee>1.1</NoticeAndPaymentFee>
<Discount>1.1</Discount>
<CategoryCode>string</CategoryCode>
</PaymentClaim>
<Transfer>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
</Transfer>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
</In>
<DateOfForwardPayment>1970-01-01T00:00:00.001Z</DateOfForwardPayment>
<DateOfForwardPaymentSpecified>true</DateOfForwardPaymentSpecified>
<NameOfBatch>string</NameOfBatch>
<RollbackOnError>true</RollbackOnError>
<IsOneToMany>true</IsOneToMany>
</Bankhub.Models.Payments.Payments>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpayment0.7693155184128138">payment</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="payment" id="mpayment0.7693155184128138"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.36966284266821225" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.36966284266821225">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The payment</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Bankhub.Models.Payments.Payment {</span>
<div><span class="propName ">In</span> (<span class="propType">Bankhub.Models.Payments.PaymentIn</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Out</span> (<span class="propType">Bankhub.Models.Payments.PaymentOut</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DateOfForwardPayment</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DateOfForwardPaymentSpecified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">Bankhub.Models.Payments.PaymentIn {</span>
<div><span class="propName ">Amount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BookingId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ABGiro</span> (<span class="propType">Bankhub.Models.Payments.ABGiro</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CGiro</span> (<span class="propType">Bankhub.Models.Payments.CGiro</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PaymentClaim</span> (<span class="propType">Bankhub.Models.Payments.PaymentClaim</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Transfer</span> (<span class="propType">Bankhub.Models.Payments.Transfer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Receipt</span> (<span class="propType">Bankhub.Models.Payments.Communication</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">Bankhub.Models.Payments.PaymentOut {</span>
<div><span class="propName ">Account</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AccountOwnerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CategoryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Reference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BillNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Receipt</span> (<span class="propType">Bankhub.Models.Payments.Communication</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">Bankhub.Models.Payments.ABGiro {</span>
<div><span class="propName ">Account</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Reference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BillNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CategoryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.Payments.CGiro {</span>
<div><span class="propName ">Account</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AccountOwnerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BillNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CategoryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.Payments.PaymentClaim
{</span>
<div><span class="propName ">Account</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Claimant</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PayorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DueDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IsDeposit</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AmountDue</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DefaultCosts</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OtherCosts</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OtherDefaultCosts</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DefaultInterest</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">NoticeAndPaymentFee</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Discount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CategoryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.Payments.Transfer
{</span>
<div><span class="propName ">Account</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AccountOwnerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CategoryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Reference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BillNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.Payments.Communication
{</span>
<div><span class="propName ">EMail</span> (<span class="propType">Array[Bankhub.Models.Payments.CommunicationEMail]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SMS</span> (<span class="propType">Array[Bankhub.Models.Payments.CommunicationSMS]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">Bankhub.Models.Payments.CommunicationEMail {</span>
<div><span class="propName ">EmailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Language</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.Payments.CommunicationSMS
{</span>
<div><span class="propName ">PhoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CountryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Language</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"In": {
"Amount": 0,
"Description": "string",
"BookingId": "string",
"ABGiro": {
"Account": "string",
"Reference": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"CGiro": {
"Account": "string",
"AccountOwnerId": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"PaymentClaim": {
"Account": "string",
"Claimant": "string",
"PayorId": "string",
"DueDate": "2024-08-06T13:03:40.180Z",
"IsDeposit": true,
"AmountDue": 0,
"DefaultCosts": 0,
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": 0,
"NoticeAndPaymentFee": 0,
"Discount": 0,
"CategoryCode": "string"
},
"Transfer": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string"
},
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
}
},
"Out": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string",
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
}
},
"DateOfForwardPayment": "2024-08-06T13:03:40.180Z",
"DateOfForwardPaymentSpecified": true
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<Bankhub.Models.Payments.Payment>
<In>
<Amount>1.1</Amount>
<Description>string</Description>
<BookingId>string</BookingId>
<ABGiro>
<Account>string</Account>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</ABGiro>
<CGiro>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</CGiro>
<PaymentClaim>
<Account>string</Account>
<Claimant>string</Claimant>
<PayorId>string</PayorId>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
<IsDeposit>true</IsDeposit>
<AmountDue>1.1</AmountDue>
<DefaultCosts>1.1</DefaultCosts>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>1.1</DefaultInterest>
<NoticeAndPaymentFee>1.1</NoticeAndPaymentFee>
<Discount>1.1</Discount>
<CategoryCode>string</CategoryCode>
</PaymentClaim>
<Transfer>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
</Transfer>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
</In>
<Out>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
</Out>
<DateOfForwardPayment>1970-01-01T00:00:00.001Z</DateOfForwardPayment>
<DateOfForwardPaymentSpecified>true</DateOfForwardPaymentSpecified>
</Bankhub.Models.Payments.Payment>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpaymentId0.6859788847737653">paymentId</label></td>
<td>
<input class="parameter required" minlength="1" name="paymentId" placeholder="(required)" id="mpaymentId0.6859788847737653" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The batch payment id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpayments0.9972402192107481">payments</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="payments" id="mpayments0.9972402192107481"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5403447212452226" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5403447212452226">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The batch payments</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Bankhub.Models.Payments.Payments {</span>
<div><span class="propName ">Out</span> (<span class="propType">Bankhub.Models.Payments.PaymentOut</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">In</span> (<span class="propType">Array[Bankhub.Models.Payments.PaymentIn]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DateOfForwardPayment</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DateOfForwardPaymentSpecified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">NameOfBatch</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RollbackOnError</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IsOneToMany</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.Payments.PaymentOut
{</span>
<div><span class="propName ">Account</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AccountOwnerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CategoryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Reference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BillNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Receipt</span> (<span class="propType">Bankhub.Models.Payments.Communication</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">Bankhub.Models.Payments.PaymentIn {</span>
<div><span class="propName ">Amount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BookingId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ABGiro</span> (<span class="propType">Bankhub.Models.Payments.ABGiro</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CGiro</span> (<span class="propType">Bankhub.Models.Payments.CGiro</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PaymentClaim</span> (<span class="propType">Bankhub.Models.Payments.PaymentClaim</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Transfer</span> (<span class="propType">Bankhub.Models.Payments.Transfer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Receipt</span> (<span class="propType">Bankhub.Models.Payments.Communication</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">Bankhub.Models.Payments.Communication {</span>
<div><span class="propName ">EMail</span> (<span class="propType">Array[Bankhub.Models.Payments.CommunicationEMail]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SMS</span> (<span class="propType">Array[Bankhub.Models.Payments.CommunicationSMS]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">Bankhub.Models.Payments.ABGiro {</span>
<div><span class="propName ">Account</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Reference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BillNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CategoryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.Payments.CGiro {</span>
<div><span class="propName ">Account</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AccountOwnerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BillNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CategoryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.Payments.PaymentClaim
{</span>
<div><span class="propName ">Account</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Claimant</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PayorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DueDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IsDeposit</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AmountDue</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DefaultCosts</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OtherCosts</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OtherDefaultCosts</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DefaultInterest</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">NoticeAndPaymentFee</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Discount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CategoryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.Payments.Transfer
{</span>
<div><span class="propName ">Account</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AccountOwnerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CategoryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Reference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BillNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">Bankhub.Models.Payments.CommunicationEMail {</span>
<div><span class="propName ">EmailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Language</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.Payments.CommunicationSMS
{</span>
<div><span class="propName ">PhoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CountryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Language</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"Out": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string",
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
}
},
"In": [
{
"Amount": 0,
"Description": "string",
"BookingId": "string",
"ABGiro": {
"Account": "string",
"Reference": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"CGiro": {
"Account": "string",
"AccountOwnerId": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"PaymentClaim": {
"Account": "string",
"Claimant": "string",
"PayorId": "string",
"DueDate": "2024-08-06T13:03:40.192Z",
"IsDeposit": true,
"AmountDue": 0,
"DefaultCosts": 0,
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": 0,
"NoticeAndPaymentFee": 0,
"Discount": 0,
"CategoryCode": "string"
},
"Transfer": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string"
},
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
}
}
],
"DateOfForwardPayment": "2024-08-06T13:03:40.193Z",
"DateOfForwardPaymentSpecified": true,
"NameOfBatch": "string",
"RollbackOnError": true,
"IsOneToMany": true
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<Bankhub.Models.Payments.Payments>
<Out>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
</Out>
<In>
<Amount>1.1</Amount>
<Description>string</Description>
<BookingId>string</BookingId>
<ABGiro>
<Account>string</Account>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</ABGiro>
<CGiro>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</CGiro>
<PaymentClaim>
<Account>string</Account>
<Claimant>string</Claimant>
<PayorId>string</PayorId>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
<IsDeposit>true</IsDeposit>
<AmountDue>1.1</AmountDue>
<DefaultCosts>1.1</DefaultCosts>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>1.1</DefaultInterest>
<NoticeAndPaymentFee>1.1</NoticeAndPaymentFee>
<Discount>1.1</Discount>
<CategoryCode>string</CategoryCode>
</PaymentClaim>
<Transfer>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
</Transfer>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
</In>
<DateOfForwardPayment>1970-01-01T00:00:00.001Z</DateOfForwardPayment>
<DateOfForwardPaymentSpecified>true</DateOfForwardPaymentSpecified>
<NameOfBatch>string</NameOfBatch>
<RollbackOnError>true</RollbackOnError>
<IsOneToMany>true</IsOneToMany>
</Bankhub.Models.Payments.Payments>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpayment0.3110198628930354">payment</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="payment" id="mpayment0.3110198628930354"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9012504635178049" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9012504635178049">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The payment</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Bankhub.Models.Payments.Payment {</span>
<div><span class="propName ">In</span> (<span class="propType">Bankhub.Models.Payments.PaymentIn</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Out</span> (<span class="propType">Bankhub.Models.Payments.PaymentOut</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DateOfForwardPayment</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DateOfForwardPaymentSpecified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">Bankhub.Models.Payments.PaymentIn {</span>
<div><span class="propName ">Amount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BookingId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ABGiro</span> (<span class="propType">Bankhub.Models.Payments.ABGiro</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CGiro</span> (<span class="propType">Bankhub.Models.Payments.CGiro</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PaymentClaim</span> (<span class="propType">Bankhub.Models.Payments.PaymentClaim</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Transfer</span> (<span class="propType">Bankhub.Models.Payments.Transfer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Receipt</span> (<span class="propType">Bankhub.Models.Payments.Communication</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">Bankhub.Models.Payments.PaymentOut {</span>
<div><span class="propName ">Account</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AccountOwnerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CategoryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Reference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BillNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Receipt</span> (<span class="propType">Bankhub.Models.Payments.Communication</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">Bankhub.Models.Payments.ABGiro {</span>
<div><span class="propName ">Account</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Reference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BillNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CategoryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.Payments.CGiro {</span>
<div><span class="propName ">Account</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AccountOwnerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BillNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CategoryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.Payments.PaymentClaim
{</span>
<div><span class="propName ">Account</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Claimant</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PayorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DueDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IsDeposit</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AmountDue</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DefaultCosts</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OtherCosts</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OtherDefaultCosts</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DefaultInterest</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">NoticeAndPaymentFee</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Discount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CategoryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.Payments.Transfer
{</span>
<div><span class="propName ">Account</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AccountOwnerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CategoryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Reference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BillNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.Payments.Communication
{</span>
<div><span class="propName ">EMail</span> (<span class="propType">Array[Bankhub.Models.Payments.CommunicationEMail]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SMS</span> (<span class="propType">Array[Bankhub.Models.Payments.CommunicationSMS]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">Bankhub.Models.Payments.CommunicationEMail {</span>
<div><span class="propName ">EmailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Language</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Bankhub.Models.Payments.CommunicationSMS
{</span>
<div><span class="propName ">PhoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CountryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Language</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"In": {
"Amount": 0,
"Description": "string",
"BookingId": "string",
"ABGiro": {
"Account": "string",
"Reference": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"CGiro": {
"Account": "string",
"AccountOwnerId": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"PaymentClaim": {
"Account": "string",
"Claimant": "string",
"PayorId": "string",
"DueDate": "2024-08-06T13:03:40.201Z",
"IsDeposit": true,
"AmountDue": 0,
"DefaultCosts": 0,
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": 0,
"NoticeAndPaymentFee": 0,
"Discount": 0,
"CategoryCode": "string"
},
"Transfer": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string"
},
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
}
},
"Out": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string",
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
}
},
"DateOfForwardPayment": "2024-08-06T13:03:40.201Z",
"DateOfForwardPaymentSpecified": true
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<Bankhub.Models.Payments.Payment>
<In>
<Amount>1.1</Amount>
<Description>string</Description>
<BookingId>string</BookingId>
<ABGiro>
<Account>string</Account>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</ABGiro>
<CGiro>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</CGiro>
<PaymentClaim>
<Account>string</Account>
<Claimant>string</Claimant>
<PayorId>string</PayorId>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
<IsDeposit>true</IsDeposit>
<AmountDue>1.1</AmountDue>
<DefaultCosts>1.1</DefaultCosts>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>1.1</DefaultInterest>
<NoticeAndPaymentFee>1.1</NoticeAndPaymentFee>
<Discount>1.1</Discount>
<CategoryCode>string</CategoryCode>
</PaymentClaim>
<Transfer>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
</Transfer>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
</In>
<Out>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
</Out>
<DateOfForwardPayment>1970-01-01T00:00:00.001Z</DateOfForwardPayment>
<DateOfForwardPaymentSpecified>true</DateOfForwardPaymentSpecified>
</Bankhub.Models.Payments.Payment>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpaymentId0.9138945063876067">paymentId</label></td>
<td>
<input class="parameter required" minlength="1" name="paymentId" placeholder="(required)" id="mpaymentId0.9138945063876067" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The payment id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpaymentId0.033883863432760064">paymentId</label></td>
<td>
<input class="parameter required" minlength="1" name="paymentId" placeholder="(required)" id="mpaymentId0.033883863432760064" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mquery0.5040168878423263">query</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="query" id="mquery0.5040168878423263"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9707844967038104" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9707844967038104">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Statement query parameters</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">Bankhub.Models.AccountStatementQuery {</span>
<div><span class="propName ">Account</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DateFrom</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DateTo</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RecordFrom</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RecordFromSpecified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RecordTo</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RecordToSpecified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"Account": "string",
"DateFrom": "2024-08-06T13:03:40.220Z",
"DateTo": "2024-08-06T13:03:40.220Z",
"RecordFrom": 0,
"RecordFromSpecified": true,
"RecordTo": 0,
"RecordToSpecified": true
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<Bankhub.Models.AccountStatementQuery>
<Account>string</Account>
<DateFrom>1970-01-01T00:00:00.001Z</DateFrom>
<DateTo>1970-01-01T00:00:00.001Z</DateTo>
<RecordFrom>1</RecordFrom>
<RecordFromSpecified>true</RecordFromSpecified>
<RecordTo>1</RecordTo>
<RecordToSpecified>true</RecordToSpecified>
</Bankhub.Models.AccountStatementQuery>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form>Text Content
swagger
Explore
Arionbanki Unified Banking
* ACCOUNTS
* Show/Hide
* List Operations
* Expand Operations
* * GET /BANKS/1.0/ACCOUNTS
* Get accounts
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Bank (string, optional),
Ledger (string, optional),
AccountNumber (string, optional),
Id (string, optional),
AccountType (string, optional),
OwnerName (string, optional),
OwnerPersonId (string, optional),
IsFit (boolean, optional),
Currency (string, optional),
Balance (Bankhub.Models.Amount, optional),
AccountName (string, optional),
Details (Bankhub.Models.AccountDetail, optional)
}
Bankhub.Models.Amount {
Value (number, optional),
Currency (string, optional)
}
Bankhub.Models.AccountDetail {
OwnerAddress (Bankhub.Models.Address, optional),
Swift (string, optional),
Iban (string, optional),
AvailableAmount (Bankhub.Models.Amount, optional),
InterestRate (number, optional),
EstimatedInterestAmount (Bankhub.Models.Amount, optional),
AnnualTurnover (Bankhub.Models.Amount, optional),
LastYearTurnover (Bankhub.Models.Amount, optional),
LastTransactionDate (string, optional),
InterestGroup (string, optional),
OverdraftAmount (Bankhub.Models.Amount, optional),
OverdraftInterestRate (number, optional),
OverdraftValidFrom (string, optional),
OverdraftValidTo (string, optional),
BuyingRate (number, optional),
SellingRate (number, optional),
TransactionCount (integer, optional),
AuthorizedSigner (string, optional),
Fit (Bankhub.Models.FitInfo, optional)
}
Bankhub.Models.Address {
Name (string, optional),
AddressLine1 (string, optional),
AddressLine2 (string, optional),
PostalCode (string, optional),
City (string, optional),
Region (string, optional),
Country (string, optional)
}
Bankhub.Models.FitInfo {
TotalAmount (Bankhub.Models.Amount, optional),
TotalInterests (Bankhub.Models.Amount, optional),
TotalCost (Bankhub.Models.Amount, optional)
}
[
{
"Bank": "string",
"Ledger": "string",
"AccountNumber": "string",
"Id": "string",
"AccountType": "string",
"OwnerName": "string",
"OwnerPersonId": "string",
"IsFit": true,
"Currency": "string",
"Balance": {
"Value": 0,
"Currency": "string"
},
"AccountName": "string",
"Details": {
"OwnerAddress": {
"Name": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"PostalCode": "string",
"City": "string",
"Region": "string",
"Country": "string"
},
"Swift": "string",
"Iban": "string",
"AvailableAmount": {
"Value": 0,
"Currency": "string"
},
"InterestRate": 0,
"EstimatedInterestAmount": {
"Value": 0,
"Currency": "string"
},
"AnnualTurnover": {
"Value": 0,
"Currency": "string"
},
"LastYearTurnover": {
"Value": 0,
"Currency": "string"
},
"LastTransactionDate": "2024-08-06T13:03:39.888Z",
"InterestGroup": "string",
"OverdraftAmount": {
"Value": 0,
"Currency": "string"
},
"OverdraftInterestRate": 0,
"OverdraftValidFrom": "2024-08-06T13:03:39.888Z",
"OverdraftValidTo": "2024-08-06T13:03:39.888Z",
"BuyingRate": 0,
"SellingRate": 0,
"TransactionCount": 0,
"AuthorizedSigner": "string",
"Fit": {
"TotalAmount": {
"Value": 0,
"Currency": "string"
},
"TotalInterests": {
"Value": 0,
"Currency": "string"
},
"TotalCost": {
"Value": 0,
"Currency": "string"
}
}
}
}
]
<?xml version="1.0"?>
<Inline Model>
<Bank>string</Bank>
<Ledger>string</Ledger>
<AccountNumber>string</AccountNumber>
<Id>string</Id>
<AccountType>string</AccountType>
<OwnerName>string</OwnerName>
<OwnerPersonId>string</OwnerPersonId>
<IsFit>true</IsFit>
<Currency>string</Currency>
<Balance>
<Value>1.1</Value>
<Currency>string</Currency>
</Balance>
<AccountName>string</AccountName>
<Details>
<OwnerAddress>
<Name>string</Name>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<PostalCode>string</PostalCode>
<City>string</City>
<Region>string</Region>
<Country>string</Country>
</OwnerAddress>
<Swift>string</Swift>
<Iban>string</Iban>
<AvailableAmount>
<Value>1.1</Value>
<Currency>string</Currency>
</AvailableAmount>
<InterestRate>1.1</InterestRate>
<EstimatedInterestAmount>
<Value>1.1</Value>
<Currency>string</Currency>
</EstimatedInterestAmount>
<AnnualTurnover>
<Value>1.1</Value>
<Currency>string</Currency>
</AnnualTurnover>
<LastYearTurnover>
<Value>1.1</Value>
<Currency>string</Currency>
</LastYearTurnover>
<LastTransactionDate>1970-01-01T00:00:00.001Z</LastTransactionDate>
<InterestGroup>string</InterestGroup>
<OverdraftAmount>
<Value>1.1</Value>
<Currency>string</Currency>
</OverdraftAmount>
<OverdraftInterestRate>1.1</OverdraftInterestRate>
<OverdraftValidFrom>1970-01-01T00:00:00.001Z</OverdraftValidFrom>
<OverdraftValidTo>1970-01-01T00:00:00.001Z</OverdraftValidTo>
<BuyingRate>1.1</BuyingRate>
<SellingRate>1.1</SellingRate>
<TransactionCount>1</TransactionCount>
<AuthorizedSigner>string</AuthorizedSigner>
<Fit>
<TotalAmount>
<Value>1.1</Value>
<Currency>string</Currency>
</TotalAmount>
<TotalInterests>
<Value>1.1</Value>
<Currency>string</Currency>
</TotalInterests>
<TotalCost>
<Value>1.1</Value>
<Currency>string</Currency>
</TotalCost>
</Fit>
</Details>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /BANKS/1.0/ACCOUNT/{BANK}-{LEDGER}-{ACCOUNTNUMBER}
* Get single account
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Bankhub.Models.Account {
Bank (string, optional),
Ledger (string, optional),
AccountNumber (string, optional),
Id (string, optional),
AccountType (string, optional),
OwnerName (string, optional),
OwnerPersonId (string, optional),
IsFit (boolean, optional),
Currency (string, optional),
Balance (Bankhub.Models.Amount, optional),
AccountName (string, optional),
Details (Bankhub.Models.AccountDetail, optional)
}
Bankhub.Models.Amount {
Value (number, optional),
Currency (string, optional)
}
Bankhub.Models.AccountDetail {
OwnerAddress (Bankhub.Models.Address, optional),
Swift (string, optional),
Iban (string, optional),
AvailableAmount (Bankhub.Models.Amount, optional),
InterestRate (number, optional),
EstimatedInterestAmount (Bankhub.Models.Amount, optional),
AnnualTurnover (Bankhub.Models.Amount, optional),
LastYearTurnover (Bankhub.Models.Amount, optional),
LastTransactionDate (string, optional),
InterestGroup (string, optional),
OverdraftAmount (Bankhub.Models.Amount, optional),
OverdraftInterestRate (number, optional),
OverdraftValidFrom (string, optional),
OverdraftValidTo (string, optional),
BuyingRate (number, optional),
SellingRate (number, optional),
TransactionCount (integer, optional),
AuthorizedSigner (string, optional),
Fit (Bankhub.Models.FitInfo, optional)
}
Bankhub.Models.Address {
Name (string, optional),
AddressLine1 (string, optional),
AddressLine2 (string, optional),
PostalCode (string, optional),
City (string, optional),
Region (string, optional),
Country (string, optional)
}
Bankhub.Models.FitInfo {
TotalAmount (Bankhub.Models.Amount, optional),
TotalInterests (Bankhub.Models.Amount, optional),
TotalCost (Bankhub.Models.Amount, optional)
}
{
"Bank": "string",
"Ledger": "string",
"AccountNumber": "string",
"Id": "string",
"AccountType": "string",
"OwnerName": "string",
"OwnerPersonId": "string",
"IsFit": true,
"Currency": "string",
"Balance": {
"Value": 0,
"Currency": "string"
},
"AccountName": "string",
"Details": {
"OwnerAddress": {
"Name": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"PostalCode": "string",
"City": "string",
"Region": "string",
"Country": "string"
},
"Swift": "string",
"Iban": "string",
"AvailableAmount": {
"Value": 0,
"Currency": "string"
},
"InterestRate": 0,
"EstimatedInterestAmount": {
"Value": 0,
"Currency": "string"
},
"AnnualTurnover": {
"Value": 0,
"Currency": "string"
},
"LastYearTurnover": {
"Value": 0,
"Currency": "string"
},
"LastTransactionDate": "2024-08-06T13:03:39.918Z",
"InterestGroup": "string",
"OverdraftAmount": {
"Value": 0,
"Currency": "string"
},
"OverdraftInterestRate": 0,
"OverdraftValidFrom": "2024-08-06T13:03:39.918Z",
"OverdraftValidTo": "2024-08-06T13:03:39.918Z",
"BuyingRate": 0,
"SellingRate": 0,
"TransactionCount": 0,
"AuthorizedSigner": "string",
"Fit": {
"TotalAmount": {
"Value": 0,
"Currency": "string"
},
"TotalInterests": {
"Value": 0,
"Currency": "string"
},
"TotalCost": {
"Value": 0,
"Currency": "string"
}
}
}
}
<?xml version="1.0"?>
<Bankhub.Models.Account>
<Bank>string</Bank>
<Ledger>string</Ledger>
<AccountNumber>string</AccountNumber>
<Id>string</Id>
<AccountType>string</AccountType>
<OwnerName>string</OwnerName>
<OwnerPersonId>string</OwnerPersonId>
<IsFit>true</IsFit>
<Currency>string</Currency>
<Balance>
<Value>1.1</Value>
<Currency>string</Currency>
</Balance>
<AccountName>string</AccountName>
<Details>
<OwnerAddress>
<Name>string</Name>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<PostalCode>string</PostalCode>
<City>string</City>
<Region>string</Region>
<Country>string</Country>
</OwnerAddress>
<Swift>string</Swift>
<Iban>string</Iban>
<AvailableAmount>
<Value>1.1</Value>
<Currency>string</Currency>
</AvailableAmount>
<InterestRate>1.1</InterestRate>
<EstimatedInterestAmount>
<Value>1.1</Value>
<Currency>string</Currency>
</EstimatedInterestAmount>
<AnnualTurnover>
<Value>1.1</Value>
<Currency>string</Currency>
</AnnualTurnover>
<LastYearTurnover>
<Value>1.1</Value>
<Currency>string</Currency>
</LastYearTurnover>
<LastTransactionDate>1970-01-01T00:00:00.001Z</LastTransactionDate>
<InterestGroup>string</InterestGroup>
<OverdraftAmount>
<Value>1.1</Value>
<Currency>string</Currency>
</OverdraftAmount>
<OverdraftInterestRate>1.1</OverdraftInterestRate>
<OverdraftValidFrom>1970-01-01T00:00:00.001Z</OverdraftValidFrom>
<OverdraftValidTo>1970-01-01T00:00:00.001Z</OverdraftValidTo>
<BuyingRate>1.1</BuyingRate>
<SellingRate>1.1</SellingRate>
<TransactionCount>1</TransactionCount>
<AuthorizedSigner>string</AuthorizedSigner>
<Fit>
<TotalAmount>
<Value>1.1</Value>
<Currency>string</Currency>
</TotalAmount>
<TotalInterests>
<Value>1.1</Value>
<Currency>string</Currency>
</TotalInterests>
<TotalCost>
<Value>1.1</Value>
<Currency>string</Currency>
</TotalCost>
</Fit>
</Details>
</Bankhub.Models.Account>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type bank
Bank Number
path string ledger
Ledger
path string accountNumber
Account Number
path string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* BILLS
* Show/Hide
* List Operations
* Expand Operations
* * GET /BANKS/1.0/BILLS/{SEARCHKEY}
* Get unpaid bills
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Bank (string, optional),
Ledger (string, optional),
Number (string, optional),
DueDate (string, optional),
Identifier (string, optional),
Description (string, optional),
FinalDueDate (string, optional),
AmountDue (Bankhub.Models.Amount, optional),
Claimant (Bankhub.Models.Entity, optional),
Payor (Bankhub.Models.Entity, optional),
ClaimType (string, optional) = ['Default', 'Light', 'Optional',
'LightOptional', 'Repayment', 'Revolving']
stringEnum:"Default", "Light", "Optional", "LightOptional", "Repayment",
"Revolving"
,
BillType (string, optional) = ['None', 'All', 'Claim', 'Bond',
'BillOfExchange', 'Unknown']
stringEnum:"None", "All", "Claim", "Bond", "BillOfExchange", "Unknown"
,
IsDebited (boolean, optional),
IsForwardPayment (boolean, optional),
IsSettlementFee (boolean, optional),
IsDeposit (boolean, optional),
IsInElectronicDocuments (boolean, optional),
Details (Bankhub.Models.BillDetails, optional),
IsHidden (boolean, optional)
}
Bankhub.Models.Amount {
Value (number, optional),
Currency (string, optional)
}
Bankhub.Models.Entity {
IdNumber (string, optional),
Name (string, optional),
Street (string, optional),
PostalCode (string, optional),
Town (string, optional)
}
Bankhub.Models.BillDetails {
CancellationDate (string, optional),
Amount (Bankhub.Models.Amount, optional),
DefaultInterest (Bankhub.Models.Amount, optional),
DefaultInterestPercent (number, optional),
DefaultCosts (Bankhub.Models.Amount, optional),
OtherDefaultCosts (Bankhub.Models.Amount, optional),
OtherCosts (Bankhub.Models.Amount, optional),
Discount (Bankhub.Models.Amount, optional),
CategoryCode (string, optional),
NotificationFee (Bankhub.Models.Amount, optional),
CustomerNumber (string, optional),
Reference (string, optional),
ElectronicDocumentsUrl (string, optional),
DebitBank (string, optional),
DebitLedger (string, optional),
DebitAccountNumber (string, optional),
NominalAmount (Bankhub.Models.Amount, optional),
IndexationAmount (Bankhub.Models.Amount, optional),
IndexationInterestsAmount (Bankhub.Models.Amount, optional),
NominalAmountRemainderAfterPayment (Bankhub.Models.Amount, optional),
TotalRemainderAmountAfterPayment (Bankhub.Models.Amount, optional),
InterestsAmount (Bankhub.Models.Amount, optional)
}
[
{
"Bank": "string",
"Ledger": "string",
"Number": "string",
"DueDate": "2024-08-06T13:03:39.949Z",
"Identifier": "string",
"Description": "string",
"FinalDueDate": "2024-08-06T13:03:39.949Z",
"AmountDue": {
"Value": 0,
"Currency": "string"
},
"Claimant": {
"IdNumber": "string",
"Name": "string",
"Street": "string",
"PostalCode": "string",
"Town": "string"
},
"Payor": {
"IdNumber": "string",
"Name": "string",
"Street": "string",
"PostalCode": "string",
"Town": "string"
},
"ClaimType": "Default",
"BillType": "None",
"IsDebited": true,
"IsForwardPayment": true,
"IsSettlementFee": true,
"IsDeposit": true,
"IsInElectronicDocuments": true,
"Details": {
"CancellationDate": "2024-08-06T13:03:39.949Z",
"Amount": {
"Value": 0,
"Currency": "string"
},
"DefaultInterest": {
"Value": 0,
"Currency": "string"
},
"DefaultInterestPercent": 0,
"DefaultCosts": {
"Value": 0,
"Currency": "string"
},
"OtherDefaultCosts": {
"Value": 0,
"Currency": "string"
},
"OtherCosts": {
"Value": 0,
"Currency": "string"
},
"Discount": {
"Value": 0,
"Currency": "string"
},
"CategoryCode": "string",
"NotificationFee": {
"Value": 0,
"Currency": "string"
},
"CustomerNumber": "string",
"Reference": "string",
"ElectronicDocumentsUrl": "string",
"DebitBank": "string",
"DebitLedger": "string",
"DebitAccountNumber": "string",
"NominalAmount": {
"Value": 0,
"Currency": "string"
},
"IndexationAmount": {
"Value": 0,
"Currency": "string"
},
"IndexationInterestsAmount": {
"Value": 0,
"Currency": "string"
},
"NominalAmountRemainderAfterPayment": {
"Value": 0,
"Currency": "string"
},
"TotalRemainderAmountAfterPayment": {
"Value": 0,
"Currency": "string"
},
"InterestsAmount": {
"Value": 0,
"Currency": "string"
}
},
"IsHidden": true
}
]
<?xml version="1.0"?>
<Inline Model>
<Bank>string</Bank>
<Ledger>string</Ledger>
<Number>string</Number>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
<Identifier>string</Identifier>
<Description>string</Description>
<FinalDueDate>1970-01-01T00:00:00.001Z</FinalDueDate>
<AmountDue>
<Value>1.1</Value>
<Currency>string</Currency>
</AmountDue>
<Claimant>
<IdNumber>string</IdNumber>
<Name>string</Name>
<Street>string</Street>
<PostalCode>string</PostalCode>
<Town>string</Town>
</Claimant>
<Payor>
<IdNumber>string</IdNumber>
<Name>string</Name>
<Street>string</Street>
<PostalCode>string</PostalCode>
<Town>string</Town>
</Payor>
<ClaimType>Default</ClaimType>
<BillType>None</BillType>
<IsDebited>true</IsDebited>
<IsForwardPayment>true</IsForwardPayment>
<IsSettlementFee>true</IsSettlementFee>
<IsDeposit>true</IsDeposit>
<IsInElectronicDocuments>true</IsInElectronicDocuments>
<Details>
<CancellationDate>1970-01-01T00:00:00.001Z</CancellationDate>
<Amount>
<Value>1.1</Value>
<Currency>string</Currency>
</Amount>
<DefaultInterest>
<Value>1.1</Value>
<Currency>string</Currency>
</DefaultInterest>
<DefaultInterestPercent>1.1</DefaultInterestPercent>
<DefaultCosts>
<Value>1.1</Value>
<Currency>string</Currency>
</DefaultCosts>
<OtherDefaultCosts>
<Value>1.1</Value>
<Currency>string</Currency>
</OtherDefaultCosts>
<OtherCosts>
<Value>1.1</Value>
<Currency>string</Currency>
</OtherCosts>
<Discount>
<Value>1.1</Value>
<Currency>string</Currency>
</Discount>
<CategoryCode>string</CategoryCode>
<NotificationFee>
<Value>1.1</Value>
<Currency>string</Currency>
</NotificationFee>
<CustomerNumber>string</CustomerNumber>
<Reference>string</Reference>
<ElectronicDocumentsUrl>string</ElectronicDocumentsUrl>
<DebitBank>string</DebitBank>
<DebitLedger>string</DebitLedger>
<DebitAccountNumber>string</DebitAccountNumber>
<NominalAmount>
<Value>1.1</Value>
<Currency>string</Currency>
</NominalAmount>
<IndexationAmount>
<Value>1.1</Value>
<Currency>string</Currency>
</IndexationAmount>
<IndexationInterestsAmount>
<Value>1.1</Value>
<Currency>string</Currency>
</IndexationInterestsAmount>
<NominalAmountRemainderAfterPayment>
<Value>1.1</Value>
<Currency>string</Currency>
</NominalAmountRemainderAfterPayment>
<TotalRemainderAmountAfterPayment>
<Value>1.1</Value>
<Currency>string</Currency>
</TotalRemainderAmountAfterPayment>
<InterestsAmount>
<Value>1.1</Value>
<Currency>string</Currency>
</InterestsAmount>
</Details>
<IsHidden>true</IsHidden>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type searchKey
Kennitala for the debtor
path string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CLAIMS
* Show/Hide
* List Operations
* Expand Operations
* * GET /BANKS/1.0/CLAIMS/{ID}
* Get status of claims by identification
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Bankhub.Models.ClaimOperationResult {
ID (string, optional),
Status (string, optional) = ['InProgress', 'Completed',
'CompletedWithErrors', 'NotConfirmed']
stringEnum:"InProgress", "Completed", "CompletedWithErrors",
"NotConfirmed"
,
Success (Array[Bankhub.Models.ClaimResult], optional),
Errors (Array[Bankhub.Models.ClaimError], optional)
}
Bankhub.Models.ClaimResult {
Key (Bankhub.Models.ClaimKey, optional),
Print (boolean, optional)
}
Bankhub.Models.ClaimError {
Key (Bankhub.Models.ClaimKey, optional),
Error (Bankhub.Models.Error, optional)
}
Bankhub.Models.ClaimKey {
Claimant (string, optional),
Account (string, optional),
DueDate (string, optional)
}
Bankhub.Models.Error {
Code (string, optional),
Message (string, optional)
}
{
"ID": "string",
"Status": "InProgress",
"Success": [
{
"Key": {
"Claimant": "string",
"Account": "string",
"DueDate": "2024-08-06T13:03:39.962Z"
},
"Print": true
}
],
"Errors": [
{
"Key": {
"Claimant": "string",
"Account": "string",
"DueDate": "2024-08-06T13:03:39.962Z"
},
"Error": {
"Code": "string",
"Message": "string"
}
}
]
}
<?xml version="1.0"?>
<Bankhub.Models.ClaimOperationResult>
<ID>string</ID>
<Status>InProgress</Status>
<Success>
<Key>
<Claimant>string</Claimant>
<Account>string</Account>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
</Key>
<Print>true</Print>
</Success>
<Errors>
<Key>
<Claimant>string</Claimant>
<Account>string</Account>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
</Key>
<Error>
<Code>string</Code>
<Message>string</Message>
</Error>
</Errors>
</Bankhub.Models.ClaimOperationResult>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type id path string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /BANKS/1.0/CLAIMS/DATE-FILTER
* Get multiple claims by date filter
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Status (string, optional) = ['Unpaid', 'Paid', 'Cancelled', 'Invalid',
'Unknown']
stringEnum:"Unpaid", "Paid", "Cancelled", "Invalid", "Unknown"
,
State (string, optional) = ['PrimaryCollection', 'SecondaryCollection',
'LegalCollection']
stringEnum:"PrimaryCollection", "SecondaryCollection", "LegalCollection"
,
CategoryCode (string, optional),
TotalAmountDue (number, optional),
NoticeChargeAmount (number, optional),
DefaultChargeAmount (number, optional),
OtherCostsAmount (number, optional),
OtherDefaultCostsAmount (number, optional),
DefaultInterestAmount (number, optional),
DiscountAmount (number, optional),
SecondaryCollectionIdentifier (string, optional),
LegalCollectionIdentifier (string, optional),
IsPartiallyPaid (boolean, optional),
Key (Bankhub.Models.ClaimKey, optional),
PayorID (string, optional),
PayorName (string, optional),
ClaimantName (string, optional),
CancellationDate (string, optional),
Identifier (string, optional),
Amount (number, optional),
Reference (string, optional),
FinalDueDate (string, optional),
BillNumber (string, optional),
CustomerNumber (string, optional),
NoticeAndPaymentFee (Bankhub.Models.NoticeAndPaymentFee, optional),
DefaultCharge (Bankhub.Models.DateRestrictedCharge, optional),
OtherCosts (number, optional),
OtherDefaultCosts (number, optional),
DefaultInterest (Bankhub.Models.DefaultInterest, optional),
CurrencyInformation (Bankhub.Models.CurrencyInformation, optional),
PermitOutOfSequencePayment (boolean, optional),
Discount (Bankhub.Models.DiscountCharge, optional),
IsPartialPaymentAllowed (boolean, optional),
BillPresentmentSystem (Bankhub.Models.BillPresentmentSystem, optional),
Printing (Bankhub.Models.Printing, optional)
}
Bankhub.Models.ClaimKey {
Claimant (string, optional),
Account (string, optional),
DueDate (string, optional)
}
Bankhub.Models.NoticeAndPaymentFee {
Printing (number, optional),
Paperless (number, optional)
}
Bankhub.Models.DateRestrictedCharge {
First (Bankhub.Models.DiscountOrDefaultChargePercentage, optional),
FirstAmount (Bankhub.Models.DiscountOrDefaultChargeAmount, optional),
Second (Bankhub.Models.DiscountOrDefaultChargePercentage, optional),
SecondAmount (Bankhub.Models.DiscountOrDefaultChargeAmount, optional),
ReferenceDate (string, optional) = ['DueDate', 'FinalDueDate']
stringEnum:"DueDate", "FinalDueDate"
}
Bankhub.Models.DefaultInterest {
Rule (string, optional) = ['NoDefaultInterest', 'DefaultInterestAmount',
'DefaultInterestAmountAndDefaultCharge']
stringEnum:"NoDefaultInterest", "DefaultInterestAmount",
"DefaultInterestAmountAndDefaultCharge"
,
Percentage4 (number, optional),
SpecialCode (string, optional)
}
Bankhub.Models.CurrencyInformation {
ReferenceRate (string, optional) = ['ExchangeRate', 'NoteRate',
'CentralBankMidRate', 'CentralBankStatutoryRate']
stringEnum:"ExchangeRate", "NoteRate", "CentralBankMidRate",
"CentralBankStatutoryRate"
,
Currency (string, optional),
PaymentRate (string, optional) = ['DueDateRate', 'PaymentDateRate']
stringEnum:"DueDateRate", "PaymentDateRate"
}
Bankhub.Models.DiscountCharge {
IsPostRefDate (boolean, optional),
First (Bankhub.Models.DiscountOrDefaultChargePercentage, optional),
FirstAmount (Bankhub.Models.DiscountOrDefaultChargeAmount, optional),
Second (Bankhub.Models.DiscountOrDefaultChargePercentage, optional),
SecondAmount (Bankhub.Models.DiscountOrDefaultChargeAmount, optional),
ReferenceDate (string, optional) = ['DueDate', 'FinalDueDate']
stringEnum:"DueDate", "FinalDueDate"
}
Bankhub.Models.BillPresentmentSystem {
Type (string, optional),
Parameters (string, optional)
}
Bankhub.Models.Printing {
ClaimantAddress (Bankhub.Models.Address, optional),
PayorAddress (Bankhub.Models.Address, optional),
ItemRows (Array[Bankhub.Models.ItemRow], optional),
Comments (Array[string], optional)
}
Bankhub.Models.DiscountOrDefaultChargePercentage {
Days (integer, optional),
Value (number, optional)
}
Bankhub.Models.DiscountOrDefaultChargeAmount {
Days (integer, optional),
Value (number, optional)
}
Bankhub.Models.Address {
Name (string, optional),
AddressLine1 (string, optional),
AddressLine2 (string, optional),
PostalCode (string, optional),
City (string, optional),
Region (string, optional),
Country (string, optional)
}
Bankhub.Models.ItemRow {
Text (string, optional),
Amount (number, optional)
}
[
{
"Status": "Unpaid",
"State": "PrimaryCollection",
"CategoryCode": "string",
"TotalAmountDue": 0,
"NoticeChargeAmount": 0,
"DefaultChargeAmount": 0,
"OtherCostsAmount": 0,
"OtherDefaultCostsAmount": 0,
"DefaultInterestAmount": 0,
"DiscountAmount": 0,
"SecondaryCollectionIdentifier": "string",
"LegalCollectionIdentifier": "string",
"IsPartiallyPaid": true,
"Key": {
"Claimant": "string",
"Account": "string",
"DueDate": "2024-08-06T13:03:39.971Z"
},
"PayorID": "string",
"PayorName": "string",
"ClaimantName": "string",
"CancellationDate": "2024-08-06T13:03:39.971Z",
"Identifier": "string",
"Amount": 0,
"Reference": "string",
"FinalDueDate": "2024-08-06T13:03:39.971Z",
"BillNumber": "string",
"CustomerNumber": "string",
"NoticeAndPaymentFee": {
"Printing": 0,
"Paperless": 0
},
"DefaultCharge": {
"First": {
"Days": 0,
"Value": 0
},
"FirstAmount": {
"Days": 0,
"Value": 0
},
"Second": {
"Days": 0,
"Value": 0
},
"SecondAmount": {
"Days": 0,
"Value": 0
},
"ReferenceDate": "DueDate"
},
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": {
"Rule": "NoDefaultInterest",
"Percentage4": 0,
"SpecialCode": "string"
},
"CurrencyInformation": {
"ReferenceRate": "ExchangeRate",
"Currency": "string",
"PaymentRate": "DueDateRate"
},
"PermitOutOfSequencePayment": true,
"Discount": {
"IsPostRefDate": true,
"First": {
"Days": 0,
"Value": 0
},
"FirstAmount": {
"Days": 0,
"Value": 0
},
"Second": {
"Days": 0,
"Value": 0
},
"SecondAmount": {
"Days": 0,
"Value": 0
},
"ReferenceDate": "DueDate"
},
"IsPartialPaymentAllowed": true,
"BillPresentmentSystem": {
"Type": "string",
"Parameters": "string"
},
"Printing": {
"ClaimantAddress": {
"Name": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"PostalCode": "string",
"City": "string",
"Region": "string",
"Country": "string"
},
"PayorAddress": {
"Name": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"PostalCode": "string",
"City": "string",
"Region": "string",
"Country": "string"
},
"ItemRows": [
{
"Text": "string",
"Amount": 0
}
],
"Comments": [
"string"
]
}
}
]
<?xml version="1.0"?>
<Inline Model>
<Status>Unpaid</Status>
<State>PrimaryCollection</State>
<CategoryCode>string</CategoryCode>
<TotalAmountDue>1.1</TotalAmountDue>
<NoticeChargeAmount>1.1</NoticeChargeAmount>
<DefaultChargeAmount>1.1</DefaultChargeAmount>
<OtherCostsAmount>1.1</OtherCostsAmount>
<OtherDefaultCostsAmount>1.1</OtherDefaultCostsAmount>
<DefaultInterestAmount>1.1</DefaultInterestAmount>
<DiscountAmount>1.1</DiscountAmount>
<SecondaryCollectionIdentifier>string</SecondaryCollectionIdentifier>
<LegalCollectionIdentifier>string</LegalCollectionIdentifier>
<IsPartiallyPaid>true</IsPartiallyPaid>
<Key>
<Claimant>string</Claimant>
<Account>string</Account>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
</Key>
<PayorID>string</PayorID>
<PayorName>string</PayorName>
<ClaimantName>string</ClaimantName>
<CancellationDate>1970-01-01T00:00:00.001Z</CancellationDate>
<Identifier>string</Identifier>
<Amount>1.1</Amount>
<Reference>string</Reference>
<FinalDueDate>1970-01-01T00:00:00.001Z</FinalDueDate>
<BillNumber>string</BillNumber>
<CustomerNumber>string</CustomerNumber>
<NoticeAndPaymentFee>
<Printing>1.1</Printing>
<Paperless>1.1</Paperless>
</NoticeAndPaymentFee>
<DefaultCharge>
<First>
<Days>1</Days>
<Value>1.1</Value>
</First>
<FirstAmount>
<Days>1</Days>
<Value>1.1</Value>
</FirstAmount>
<Second>
<Days>1</Days>
<Value>1.1</Value>
</Second>
<SecondAmount>
<Days>1</Days>
<Value>1.1</Value>
</SecondAmount>
<ReferenceDate>DueDate</ReferenceDate>
</DefaultCharge>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>
<Rule>NoDefaultInterest</Rule>
<Percentage4>1.1</Percentage4>
<SpecialCode>string</SpecialCode>
</DefaultInterest>
<CurrencyInformation>
<ReferenceRate>ExchangeRate</ReferenceRate>
<Currency>string</Currency>
<PaymentRate>DueDateRate</PaymentRate>
</CurrencyInformation>
<PermitOutOfSequencePayment>true</PermitOutOfSequencePayment>
<Discount>
<IsPostRefDate>true</IsPostRefDate>
<First>
<Days>1</Days>
<Value>1.1</Value>
</First>
<FirstAmount>
<Days>1</Days>
<Value>1.1</Value>
</FirstAmount>
<Second>
<Days>1</Days>
<Value>1.1</Value>
</Second>
<SecondAmount>
<Days>1</Days>
<Value>1.1</Value>
</SecondAmount>
<ReferenceDate>DueDate</ReferenceDate>
</Discount>
<IsPartialPaymentAllowed>true</IsPartialPaymentAllowed>
<BillPresentmentSystem>
<Type>string</Type>
<Parameters>string</Parameters>
</BillPresentmentSystem>
<Printing>
<ClaimantAddress>
<Name>string</Name>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<PostalCode>string</PostalCode>
<City>string</City>
<Region>string</Region>
<Country>string</Country>
</ClaimantAddress>
<PayorAddress>
<Name>string</Name>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<PostalCode>string</PostalCode>
<City>string</City>
<Region>string</Region>
<Country>string</Country>
</PayorAddress>
<ItemRows>
<Text>string</Text>
<Amount>1.1</Amount>
</ItemRows>
<Comments>string</Comments>
</Printing>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type claimant
Claim owner
query string identifier
Identifier from the bank
query string payor
Debtor
query string fromDate
Filter records from
query date-time toDate
Filter records to
query date-time onlyUnpaid true false
Only unpaid claims
query boolean
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /BANKS/1.0/CLAIMS/SINGLE
* Get single claim
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Bankhub.Models.ClaimInfo {
Status (string, optional) = ['Unpaid', 'Paid', 'Cancelled', 'Invalid',
'Unknown']
stringEnum:"Unpaid", "Paid", "Cancelled", "Invalid", "Unknown"
,
State (string, optional) = ['PrimaryCollection', 'SecondaryCollection',
'LegalCollection']
stringEnum:"PrimaryCollection", "SecondaryCollection", "LegalCollection"
,
CategoryCode (string, optional),
TotalAmountDue (number, optional),
NoticeChargeAmount (number, optional),
DefaultChargeAmount (number, optional),
OtherCostsAmount (number, optional),
OtherDefaultCostsAmount (number, optional),
DefaultInterestAmount (number, optional),
DiscountAmount (number, optional),
SecondaryCollectionIdentifier (string, optional),
LegalCollectionIdentifier (string, optional),
IsPartiallyPaid (boolean, optional),
Key (Bankhub.Models.ClaimKey, optional),
PayorID (string, optional),
PayorName (string, optional),
ClaimantName (string, optional),
CancellationDate (string, optional),
Identifier (string, optional),
Amount (number, optional),
Reference (string, optional),
FinalDueDate (string, optional),
BillNumber (string, optional),
CustomerNumber (string, optional),
NoticeAndPaymentFee (Bankhub.Models.NoticeAndPaymentFee, optional),
DefaultCharge (Bankhub.Models.DateRestrictedCharge, optional),
OtherCosts (number, optional),
OtherDefaultCosts (number, optional),
DefaultInterest (Bankhub.Models.DefaultInterest, optional),
CurrencyInformation (Bankhub.Models.CurrencyInformation, optional),
PermitOutOfSequencePayment (boolean, optional),
Discount (Bankhub.Models.DiscountCharge, optional),
IsPartialPaymentAllowed (boolean, optional),
BillPresentmentSystem (Bankhub.Models.BillPresentmentSystem, optional),
Printing (Bankhub.Models.Printing, optional)
}
Bankhub.Models.ClaimKey {
Claimant (string, optional),
Account (string, optional),
DueDate (string, optional)
}
Bankhub.Models.NoticeAndPaymentFee {
Printing (number, optional),
Paperless (number, optional)
}
Bankhub.Models.DateRestrictedCharge {
First (Bankhub.Models.DiscountOrDefaultChargePercentage, optional),
FirstAmount (Bankhub.Models.DiscountOrDefaultChargeAmount, optional),
Second (Bankhub.Models.DiscountOrDefaultChargePercentage, optional),
SecondAmount (Bankhub.Models.DiscountOrDefaultChargeAmount, optional),
ReferenceDate (string, optional) = ['DueDate', 'FinalDueDate']
stringEnum:"DueDate", "FinalDueDate"
}
Bankhub.Models.DefaultInterest {
Rule (string, optional) = ['NoDefaultInterest', 'DefaultInterestAmount',
'DefaultInterestAmountAndDefaultCharge']
stringEnum:"NoDefaultInterest", "DefaultInterestAmount",
"DefaultInterestAmountAndDefaultCharge"
,
Percentage4 (number, optional),
SpecialCode (string, optional)
}
Bankhub.Models.CurrencyInformation {
ReferenceRate (string, optional) = ['ExchangeRate', 'NoteRate',
'CentralBankMidRate', 'CentralBankStatutoryRate']
stringEnum:"ExchangeRate", "NoteRate", "CentralBankMidRate",
"CentralBankStatutoryRate"
,
Currency (string, optional),
PaymentRate (string, optional) = ['DueDateRate', 'PaymentDateRate']
stringEnum:"DueDateRate", "PaymentDateRate"
}
Bankhub.Models.DiscountCharge {
IsPostRefDate (boolean, optional),
First (Bankhub.Models.DiscountOrDefaultChargePercentage, optional),
FirstAmount (Bankhub.Models.DiscountOrDefaultChargeAmount, optional),
Second (Bankhub.Models.DiscountOrDefaultChargePercentage, optional),
SecondAmount (Bankhub.Models.DiscountOrDefaultChargeAmount, optional),
ReferenceDate (string, optional) = ['DueDate', 'FinalDueDate']
stringEnum:"DueDate", "FinalDueDate"
}
Bankhub.Models.BillPresentmentSystem {
Type (string, optional),
Parameters (string, optional)
}
Bankhub.Models.Printing {
ClaimantAddress (Bankhub.Models.Address, optional),
PayorAddress (Bankhub.Models.Address, optional),
ItemRows (Array[Bankhub.Models.ItemRow], optional),
Comments (Array[string], optional)
}
Bankhub.Models.DiscountOrDefaultChargePercentage {
Days (integer, optional),
Value (number, optional)
}
Bankhub.Models.DiscountOrDefaultChargeAmount {
Days (integer, optional),
Value (number, optional)
}
Bankhub.Models.Address {
Name (string, optional),
AddressLine1 (string, optional),
AddressLine2 (string, optional),
PostalCode (string, optional),
City (string, optional),
Region (string, optional),
Country (string, optional)
}
Bankhub.Models.ItemRow {
Text (string, optional),
Amount (number, optional)
}
{
"Status": "Unpaid",
"State": "PrimaryCollection",
"CategoryCode": "string",
"TotalAmountDue": 0,
"NoticeChargeAmount": 0,
"DefaultChargeAmount": 0,
"OtherCostsAmount": 0,
"OtherDefaultCostsAmount": 0,
"DefaultInterestAmount": 0,
"DiscountAmount": 0,
"SecondaryCollectionIdentifier": "string",
"LegalCollectionIdentifier": "string",
"IsPartiallyPaid": true,
"Key": {
"Claimant": "string",
"Account": "string",
"DueDate": "2024-08-06T13:03:39.990Z"
},
"PayorID": "string",
"PayorName": "string",
"ClaimantName": "string",
"CancellationDate": "2024-08-06T13:03:39.990Z",
"Identifier": "string",
"Amount": 0,
"Reference": "string",
"FinalDueDate": "2024-08-06T13:03:39.990Z",
"BillNumber": "string",
"CustomerNumber": "string",
"NoticeAndPaymentFee": {
"Printing": 0,
"Paperless": 0
},
"DefaultCharge": {
"First": {
"Days": 0,
"Value": 0
},
"FirstAmount": {
"Days": 0,
"Value": 0
},
"Second": {
"Days": 0,
"Value": 0
},
"SecondAmount": {
"Days": 0,
"Value": 0
},
"ReferenceDate": "DueDate"
},
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": {
"Rule": "NoDefaultInterest",
"Percentage4": 0,
"SpecialCode": "string"
},
"CurrencyInformation": {
"ReferenceRate": "ExchangeRate",
"Currency": "string",
"PaymentRate": "DueDateRate"
},
"PermitOutOfSequencePayment": true,
"Discount": {
"IsPostRefDate": true,
"First": {
"Days": 0,
"Value": 0
},
"FirstAmount": {
"Days": 0,
"Value": 0
},
"Second": {
"Days": 0,
"Value": 0
},
"SecondAmount": {
"Days": 0,
"Value": 0
},
"ReferenceDate": "DueDate"
},
"IsPartialPaymentAllowed": true,
"BillPresentmentSystem": {
"Type": "string",
"Parameters": "string"
},
"Printing": {
"ClaimantAddress": {
"Name": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"PostalCode": "string",
"City": "string",
"Region": "string",
"Country": "string"
},
"PayorAddress": {
"Name": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"PostalCode": "string",
"City": "string",
"Region": "string",
"Country": "string"
},
"ItemRows": [
{
"Text": "string",
"Amount": 0
}
],
"Comments": [
"string"
]
}
}
<?xml version="1.0"?>
<Bankhub.Models.ClaimInfo>
<Status>Unpaid</Status>
<State>PrimaryCollection</State>
<CategoryCode>string</CategoryCode>
<TotalAmountDue>1.1</TotalAmountDue>
<NoticeChargeAmount>1.1</NoticeChargeAmount>
<DefaultChargeAmount>1.1</DefaultChargeAmount>
<OtherCostsAmount>1.1</OtherCostsAmount>
<OtherDefaultCostsAmount>1.1</OtherDefaultCostsAmount>
<DefaultInterestAmount>1.1</DefaultInterestAmount>
<DiscountAmount>1.1</DiscountAmount>
<SecondaryCollectionIdentifier>string</SecondaryCollectionIdentifier>
<LegalCollectionIdentifier>string</LegalCollectionIdentifier>
<IsPartiallyPaid>true</IsPartiallyPaid>
<Key>
<Claimant>string</Claimant>
<Account>string</Account>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
</Key>
<PayorID>string</PayorID>
<PayorName>string</PayorName>
<ClaimantName>string</ClaimantName>
<CancellationDate>1970-01-01T00:00:00.001Z</CancellationDate>
<Identifier>string</Identifier>
<Amount>1.1</Amount>
<Reference>string</Reference>
<FinalDueDate>1970-01-01T00:00:00.001Z</FinalDueDate>
<BillNumber>string</BillNumber>
<CustomerNumber>string</CustomerNumber>
<NoticeAndPaymentFee>
<Printing>1.1</Printing>
<Paperless>1.1</Paperless>
</NoticeAndPaymentFee>
<DefaultCharge>
<First>
<Days>1</Days>
<Value>1.1</Value>
</First>
<FirstAmount>
<Days>1</Days>
<Value>1.1</Value>
</FirstAmount>
<Second>
<Days>1</Days>
<Value>1.1</Value>
</Second>
<SecondAmount>
<Days>1</Days>
<Value>1.1</Value>
</SecondAmount>
<ReferenceDate>DueDate</ReferenceDate>
</DefaultCharge>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>
<Rule>NoDefaultInterest</Rule>
<Percentage4>1.1</Percentage4>
<SpecialCode>string</SpecialCode>
</DefaultInterest>
<CurrencyInformation>
<ReferenceRate>ExchangeRate</ReferenceRate>
<Currency>string</Currency>
<PaymentRate>DueDateRate</PaymentRate>
</CurrencyInformation>
<PermitOutOfSequencePayment>true</PermitOutOfSequencePayment>
<Discount>
<IsPostRefDate>true</IsPostRefDate>
<First>
<Days>1</Days>
<Value>1.1</Value>
</First>
<FirstAmount>
<Days>1</Days>
<Value>1.1</Value>
</FirstAmount>
<Second>
<Days>1</Days>
<Value>1.1</Value>
</Second>
<SecondAmount>
<Days>1</Days>
<Value>1.1</Value>
</SecondAmount>
<ReferenceDate>DueDate</ReferenceDate>
</Discount>
<IsPartialPaymentAllowed>true</IsPartialPaymentAllowed>
<BillPresentmentSystem>
<Type>string</Type>
<Parameters>string</Parameters>
</BillPresentmentSystem>
<Printing>
<ClaimantAddress>
<Name>string</Name>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<PostalCode>string</PostalCode>
<City>string</City>
<Region>string</Region>
<Country>string</Country>
</ClaimantAddress>
<PayorAddress>
<Name>string</Name>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<PostalCode>string</PostalCode>
<City>string</City>
<Region>string</Region>
<Country>string</Country>
</PayorAddress>
<ItemRows>
<Text>string</Text>
<Amount>1.1</Amount>
</ItemRows>
<Comments>string</Comments>
</Printing>
</Bankhub.Models.ClaimInfo>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type claimant
Claim owner
query string account
Full claim number
query string dueDate
The claim due date
query date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /BANKS/1.0/CLAIMS
* Get multiple claims
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Status (string, optional) = ['Unpaid', 'Paid', 'Cancelled', 'Invalid',
'Unknown']
stringEnum:"Unpaid", "Paid", "Cancelled", "Invalid", "Unknown"
,
State (string, optional) = ['PrimaryCollection', 'SecondaryCollection',
'LegalCollection']
stringEnum:"PrimaryCollection", "SecondaryCollection", "LegalCollection"
,
CategoryCode (string, optional),
TotalAmountDue (number, optional),
NoticeChargeAmount (number, optional),
DefaultChargeAmount (number, optional),
OtherCostsAmount (number, optional),
OtherDefaultCostsAmount (number, optional),
DefaultInterestAmount (number, optional),
DiscountAmount (number, optional),
SecondaryCollectionIdentifier (string, optional),
LegalCollectionIdentifier (string, optional),
IsPartiallyPaid (boolean, optional),
Key (Bankhub.Models.ClaimKey, optional),
PayorID (string, optional),
PayorName (string, optional),
ClaimantName (string, optional),
CancellationDate (string, optional),
Identifier (string, optional),
Amount (number, optional),
Reference (string, optional),
FinalDueDate (string, optional),
BillNumber (string, optional),
CustomerNumber (string, optional),
NoticeAndPaymentFee (Bankhub.Models.NoticeAndPaymentFee, optional),
DefaultCharge (Bankhub.Models.DateRestrictedCharge, optional),
OtherCosts (number, optional),
OtherDefaultCosts (number, optional),
DefaultInterest (Bankhub.Models.DefaultInterest, optional),
CurrencyInformation (Bankhub.Models.CurrencyInformation, optional),
PermitOutOfSequencePayment (boolean, optional),
Discount (Bankhub.Models.DiscountCharge, optional),
IsPartialPaymentAllowed (boolean, optional),
BillPresentmentSystem (Bankhub.Models.BillPresentmentSystem, optional),
Printing (Bankhub.Models.Printing, optional)
}
Bankhub.Models.ClaimKey {
Claimant (string, optional),
Account (string, optional),
DueDate (string, optional)
}
Bankhub.Models.NoticeAndPaymentFee {
Printing (number, optional),
Paperless (number, optional)
}
Bankhub.Models.DateRestrictedCharge {
First (Bankhub.Models.DiscountOrDefaultChargePercentage, optional),
FirstAmount (Bankhub.Models.DiscountOrDefaultChargeAmount, optional),
Second (Bankhub.Models.DiscountOrDefaultChargePercentage, optional),
SecondAmount (Bankhub.Models.DiscountOrDefaultChargeAmount, optional),
ReferenceDate (string, optional) = ['DueDate', 'FinalDueDate']
stringEnum:"DueDate", "FinalDueDate"
}
Bankhub.Models.DefaultInterest {
Rule (string, optional) = ['NoDefaultInterest', 'DefaultInterestAmount',
'DefaultInterestAmountAndDefaultCharge']
stringEnum:"NoDefaultInterest", "DefaultInterestAmount",
"DefaultInterestAmountAndDefaultCharge"
,
Percentage4 (number, optional),
SpecialCode (string, optional)
}
Bankhub.Models.CurrencyInformation {
ReferenceRate (string, optional) = ['ExchangeRate', 'NoteRate',
'CentralBankMidRate', 'CentralBankStatutoryRate']
stringEnum:"ExchangeRate", "NoteRate", "CentralBankMidRate",
"CentralBankStatutoryRate"
,
Currency (string, optional),
PaymentRate (string, optional) = ['DueDateRate', 'PaymentDateRate']
stringEnum:"DueDateRate", "PaymentDateRate"
}
Bankhub.Models.DiscountCharge {
IsPostRefDate (boolean, optional),
First (Bankhub.Models.DiscountOrDefaultChargePercentage, optional),
FirstAmount (Bankhub.Models.DiscountOrDefaultChargeAmount, optional),
Second (Bankhub.Models.DiscountOrDefaultChargePercentage, optional),
SecondAmount (Bankhub.Models.DiscountOrDefaultChargeAmount, optional),
ReferenceDate (string, optional) = ['DueDate', 'FinalDueDate']
stringEnum:"DueDate", "FinalDueDate"
}
Bankhub.Models.BillPresentmentSystem {
Type (string, optional),
Parameters (string, optional)
}
Bankhub.Models.Printing {
ClaimantAddress (Bankhub.Models.Address, optional),
PayorAddress (Bankhub.Models.Address, optional),
ItemRows (Array[Bankhub.Models.ItemRow], optional),
Comments (Array[string], optional)
}
Bankhub.Models.DiscountOrDefaultChargePercentage {
Days (integer, optional),
Value (number, optional)
}
Bankhub.Models.DiscountOrDefaultChargeAmount {
Days (integer, optional),
Value (number, optional)
}
Bankhub.Models.Address {
Name (string, optional),
AddressLine1 (string, optional),
AddressLine2 (string, optional),
PostalCode (string, optional),
City (string, optional),
Region (string, optional),
Country (string, optional)
}
Bankhub.Models.ItemRow {
Text (string, optional),
Amount (number, optional)
}
[
{
"Status": "Unpaid",
"State": "PrimaryCollection",
"CategoryCode": "string",
"TotalAmountDue": 0,
"NoticeChargeAmount": 0,
"DefaultChargeAmount": 0,
"OtherCostsAmount": 0,
"OtherDefaultCostsAmount": 0,
"DefaultInterestAmount": 0,
"DiscountAmount": 0,
"SecondaryCollectionIdentifier": "string",
"LegalCollectionIdentifier": "string",
"IsPartiallyPaid": true,
"Key": {
"Claimant": "string",
"Account": "string",
"DueDate": "2024-08-06T13:03:40.031Z"
},
"PayorID": "string",
"PayorName": "string",
"ClaimantName": "string",
"CancellationDate": "2024-08-06T13:03:40.031Z",
"Identifier": "string",
"Amount": 0,
"Reference": "string",
"FinalDueDate": "2024-08-06T13:03:40.031Z",
"BillNumber": "string",
"CustomerNumber": "string",
"NoticeAndPaymentFee": {
"Printing": 0,
"Paperless": 0
},
"DefaultCharge": {
"First": {
"Days": 0,
"Value": 0
},
"FirstAmount": {
"Days": 0,
"Value": 0
},
"Second": {
"Days": 0,
"Value": 0
},
"SecondAmount": {
"Days": 0,
"Value": 0
},
"ReferenceDate": "DueDate"
},
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": {
"Rule": "NoDefaultInterest",
"Percentage4": 0,
"SpecialCode": "string"
},
"CurrencyInformation": {
"ReferenceRate": "ExchangeRate",
"Currency": "string",
"PaymentRate": "DueDateRate"
},
"PermitOutOfSequencePayment": true,
"Discount": {
"IsPostRefDate": true,
"First": {
"Days": 0,
"Value": 0
},
"FirstAmount": {
"Days": 0,
"Value": 0
},
"Second": {
"Days": 0,
"Value": 0
},
"SecondAmount": {
"Days": 0,
"Value": 0
},
"ReferenceDate": "DueDate"
},
"IsPartialPaymentAllowed": true,
"BillPresentmentSystem": {
"Type": "string",
"Parameters": "string"
},
"Printing": {
"ClaimantAddress": {
"Name": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"PostalCode": "string",
"City": "string",
"Region": "string",
"Country": "string"
},
"PayorAddress": {
"Name": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"PostalCode": "string",
"City": "string",
"Region": "string",
"Country": "string"
},
"ItemRows": [
{
"Text": "string",
"Amount": 0
}
],
"Comments": [
"string"
]
}
}
]
<?xml version="1.0"?>
<Inline Model>
<Status>Unpaid</Status>
<State>PrimaryCollection</State>
<CategoryCode>string</CategoryCode>
<TotalAmountDue>1.1</TotalAmountDue>
<NoticeChargeAmount>1.1</NoticeChargeAmount>
<DefaultChargeAmount>1.1</DefaultChargeAmount>
<OtherCostsAmount>1.1</OtherCostsAmount>
<OtherDefaultCostsAmount>1.1</OtherDefaultCostsAmount>
<DefaultInterestAmount>1.1</DefaultInterestAmount>
<DiscountAmount>1.1</DiscountAmount>
<SecondaryCollectionIdentifier>string</SecondaryCollectionIdentifier>
<LegalCollectionIdentifier>string</LegalCollectionIdentifier>
<IsPartiallyPaid>true</IsPartiallyPaid>
<Key>
<Claimant>string</Claimant>
<Account>string</Account>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
</Key>
<PayorID>string</PayorID>
<PayorName>string</PayorName>
<ClaimantName>string</ClaimantName>
<CancellationDate>1970-01-01T00:00:00.001Z</CancellationDate>
<Identifier>string</Identifier>
<Amount>1.1</Amount>
<Reference>string</Reference>
<FinalDueDate>1970-01-01T00:00:00.001Z</FinalDueDate>
<BillNumber>string</BillNumber>
<CustomerNumber>string</CustomerNumber>
<NoticeAndPaymentFee>
<Printing>1.1</Printing>
<Paperless>1.1</Paperless>
</NoticeAndPaymentFee>
<DefaultCharge>
<First>
<Days>1</Days>
<Value>1.1</Value>
</First>
<FirstAmount>
<Days>1</Days>
<Value>1.1</Value>
</FirstAmount>
<Second>
<Days>1</Days>
<Value>1.1</Value>
</Second>
<SecondAmount>
<Days>1</Days>
<Value>1.1</Value>
</SecondAmount>
<ReferenceDate>DueDate</ReferenceDate>
</DefaultCharge>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>
<Rule>NoDefaultInterest</Rule>
<Percentage4>1.1</Percentage4>
<SpecialCode>string</SpecialCode>
</DefaultInterest>
<CurrencyInformation>
<ReferenceRate>ExchangeRate</ReferenceRate>
<Currency>string</Currency>
<PaymentRate>DueDateRate</PaymentRate>
</CurrencyInformation>
<PermitOutOfSequencePayment>true</PermitOutOfSequencePayment>
<Discount>
<IsPostRefDate>true</IsPostRefDate>
<First>
<Days>1</Days>
<Value>1.1</Value>
</First>
<FirstAmount>
<Days>1</Days>
<Value>1.1</Value>
</FirstAmount>
<Second>
<Days>1</Days>
<Value>1.1</Value>
</Second>
<SecondAmount>
<Days>1</Days>
<Value>1.1</Value>
</SecondAmount>
<ReferenceDate>DueDate</ReferenceDate>
</Discount>
<IsPartialPaymentAllowed>true</IsPartialPaymentAllowed>
<BillPresentmentSystem>
<Type>string</Type>
<Parameters>string</Parameters>
</BillPresentmentSystem>
<Printing>
<ClaimantAddress>
<Name>string</Name>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<PostalCode>string</PostalCode>
<City>string</City>
<Region>string</Region>
<Country>string</Country>
</ClaimantAddress>
<PayorAddress>
<Name>string</Name>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<PostalCode>string</PostalCode>
<City>string</City>
<Region>string</Region>
<Country>string</Country>
</PayorAddress>
<ItemRows>
<Text>string</Text>
<Amount>1.1</Amount>
</ItemRows>
<Comments>string</Comments>
</Printing>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type claimant
Claim owner
query string identifier
Identifier from the bank
query string payor
Debtor
query string recordFrom query integer recordTo query integer onlyUnpaid
true false
query boolean
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /BANKS/1.0/CLAIMS
* Create single claim
RESPONSE CLASS (STATUS 200)
string
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type claims
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
Array[Bankhub.Models.Claim {
Key (Bankhub.Models.ClaimKey, optional),
PayorID (string, optional),
PayorName (string, optional),
ClaimantName (string, optional),
CancellationDate (string, optional),
Identifier (string, optional),
Amount (number, optional),
Reference (string, optional),
FinalDueDate (string, optional),
BillNumber (string, optional),
CustomerNumber (string, optional),
NoticeAndPaymentFee (Bankhub.Models.NoticeAndPaymentFee, optional),
DefaultCharge (Bankhub.Models.DateRestrictedCharge, optional),
OtherCosts (number, optional),
OtherDefaultCosts (number, optional),
DefaultInterest (Bankhub.Models.DefaultInterest, optional),
CurrencyInformation (Bankhub.Models.CurrencyInformation, optional),
PermitOutOfSequencePayment (boolean, optional),
Discount (Bankhub.Models.DiscountCharge, optional),
IsPartialPaymentAllowed (boolean, optional),
BillPresentmentSystem (Bankhub.Models.BillPresentmentSystem, optional),
Printing (Bankhub.Models.Printing, optional)
}
Bankhub.Models.ClaimKey {
Claimant (string, optional),
Account (string, optional),
DueDate (string, optional)
}
Bankhub.Models.NoticeAndPaymentFee {
Printing (number, optional),
Paperless (number, optional)
}
Bankhub.Models.DateRestrictedCharge {
First (Bankhub.Models.DiscountOrDefaultChargePercentage, optional),
FirstAmount (Bankhub.Models.DiscountOrDefaultChargeAmount, optional),
Second (Bankhub.Models.DiscountOrDefaultChargePercentage, optional),
SecondAmount (Bankhub.Models.DiscountOrDefaultChargeAmount, optional),
ReferenceDate (string, optional) = ['DueDate', 'FinalDueDate']
stringEnum:"DueDate", "FinalDueDate"
}
Bankhub.Models.DefaultInterest {
Rule (string, optional) = ['NoDefaultInterest', 'DefaultInterestAmount',
'DefaultInterestAmountAndDefaultCharge']
stringEnum:"NoDefaultInterest", "DefaultInterestAmount",
"DefaultInterestAmountAndDefaultCharge"
,
Percentage4 (number, optional),
SpecialCode (string, optional)
}
Bankhub.Models.CurrencyInformation {
ReferenceRate (string, optional) = ['ExchangeRate', 'NoteRate',
'CentralBankMidRate', 'CentralBankStatutoryRate']
stringEnum:"ExchangeRate", "NoteRate", "CentralBankMidRate",
"CentralBankStatutoryRate"
,
Currency (string, optional),
PaymentRate (string, optional) = ['DueDateRate', 'PaymentDateRate']
stringEnum:"DueDateRate", "PaymentDateRate"
}
Bankhub.Models.DiscountCharge {
IsPostRefDate (boolean, optional),
First (Bankhub.Models.DiscountOrDefaultChargePercentage, optional),
FirstAmount (Bankhub.Models.DiscountOrDefaultChargeAmount, optional),
Second (Bankhub.Models.DiscountOrDefaultChargePercentage, optional),
SecondAmount (Bankhub.Models.DiscountOrDefaultChargeAmount, optional),
ReferenceDate (string, optional) = ['DueDate', 'FinalDueDate']
stringEnum:"DueDate", "FinalDueDate"
}
Bankhub.Models.BillPresentmentSystem {
Type (string, optional),
Parameters (string, optional)
}
Bankhub.Models.Printing {
ClaimantAddress (Bankhub.Models.Address, optional),
PayorAddress (Bankhub.Models.Address, optional),
ItemRows (Array[Bankhub.Models.ItemRow], optional),
Comments (Array[string], optional)
}
Bankhub.Models.DiscountOrDefaultChargePercentage {
Days (integer, optional),
Value (number, optional)
}
Bankhub.Models.DiscountOrDefaultChargeAmount {
Days (integer, optional),
Value (number, optional)
}
Bankhub.Models.Address {
Name (string, optional),
AddressLine1 (string, optional),
AddressLine2 (string, optional),
PostalCode (string, optional),
City (string, optional),
Region (string, optional),
Country (string, optional)
}
Bankhub.Models.ItemRow {
Text (string, optional),
Amount (number, optional)
}]
[
{
"Key": {
"Claimant": "string",
"Account": "string",
"DueDate": "2024-08-06T13:03:40.064Z"
},
"PayorID": "string",
"PayorName": "string",
"ClaimantName": "string",
"CancellationDate": "2024-08-06T13:03:40.064Z",
"Identifier": "string",
"Amount": 0,
"Reference": "string",
"FinalDueDate": "2024-08-06T13:03:40.064Z",
"BillNumber": "string",
"CustomerNumber": "string",
"NoticeAndPaymentFee": {
"Printing": 0,
"Paperless": 0
},
"DefaultCharge": {
"First": {
"Days": 0,
"Value": 0
},
"FirstAmount": {
"Days": 0,
"Value": 0
},
"Second": {
"Days": 0,
"Value": 0
},
"SecondAmount": {
"Days": 0,
"Value": 0
},
"ReferenceDate": "DueDate"
},
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": {
"Rule": "NoDefaultInterest",
"Percentage4": 0,
"SpecialCode": "string"
},
"CurrencyInformation": {
"ReferenceRate": "ExchangeRate",
"Currency": "string",
"PaymentRate": "DueDateRate"
},
"PermitOutOfSequencePayment": true,
"Discount": {
"IsPostRefDate": true,
"First": {
"Days": 0,
"Value": 0
},
"FirstAmount": {
"Days": 0,
"Value": 0
},
"Second": {
"Days": 0,
"Value": 0
},
"SecondAmount": {
"Days": 0,
"Value": 0
},
"ReferenceDate": "DueDate"
},
"IsPartialPaymentAllowed": true,
"BillPresentmentSystem": {
"Type": "string",
"Parameters": "string"
},
"Printing": {
"ClaimantAddress": {
"Name": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"PostalCode": "string",
"City": "string",
"Region": "string",
"Country": "string"
},
"PayorAddress": {
"Name": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"PostalCode": "string",
"City": "string",
"Region": "string",
"Country": "string"
},
"ItemRows": [
{
"Text": "string",
"Amount": 0
}
],
"Comments": [
"string"
]
}
}
]
<?xml version="1.0"?>
<Bankhub.Models.Claim>
<Key>
<Claimant>string</Claimant>
<Account>string</Account>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
</Key>
<PayorID>string</PayorID>
<PayorName>string</PayorName>
<ClaimantName>string</ClaimantName>
<CancellationDate>1970-01-01T00:00:00.001Z</CancellationDate>
<Identifier>string</Identifier>
<Amount>1.1</Amount>
<Reference>string</Reference>
<FinalDueDate>1970-01-01T00:00:00.001Z</FinalDueDate>
<BillNumber>string</BillNumber>
<CustomerNumber>string</CustomerNumber>
<NoticeAndPaymentFee>
<Printing>1.1</Printing>
<Paperless>1.1</Paperless>
</NoticeAndPaymentFee>
<DefaultCharge>
<First>
<Days>1</Days>
<Value>1.1</Value>
</First>
<FirstAmount>
<Days>1</Days>
<Value>1.1</Value>
</FirstAmount>
<Second>
<Days>1</Days>
<Value>1.1</Value>
</Second>
<SecondAmount>
<Days>1</Days>
<Value>1.1</Value>
</SecondAmount>
<ReferenceDate>DueDate</ReferenceDate>
</DefaultCharge>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>
<Rule>NoDefaultInterest</Rule>
<Percentage4>1.1</Percentage4>
<SpecialCode>string</SpecialCode>
</DefaultInterest>
<CurrencyInformation>
<ReferenceRate>ExchangeRate</ReferenceRate>
<Currency>string</Currency>
<PaymentRate>DueDateRate</PaymentRate>
</CurrencyInformation>
<PermitOutOfSequencePayment>true</PermitOutOfSequencePayment>
<Discount>
<IsPostRefDate>true</IsPostRefDate>
<First>
<Days>1</Days>
<Value>1.1</Value>
</First>
<FirstAmount>
<Days>1</Days>
<Value>1.1</Value>
</FirstAmount>
<Second>
<Days>1</Days>
<Value>1.1</Value>
</Second>
<SecondAmount>
<Days>1</Days>
<Value>1.1</Value>
</SecondAmount>
<ReferenceDate>DueDate</ReferenceDate>
</Discount>
<IsPartialPaymentAllowed>true</IsPartialPaymentAllowed>
<BillPresentmentSystem>
<Type>string</Type>
<Parameters>string</Parameters>
</BillPresentmentSystem>
<Printing>
<ClaimantAddress>
<Name>string</Name>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<PostalCode>string</PostalCode>
<City>string</City>
<Region>string</Region>
<Country>string</Country>
</ClaimantAddress>
<PayorAddress>
<Name>string</Name>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<PostalCode>string</PostalCode>
<City>string</City>
<Region>string</Region>
<Country>string</Country>
</PayorAddress>
<ItemRows>
<Text>string</Text>
<Amount>1.1</Amount>
</ItemRows>
<Comments>string</Comments>
</Printing>
</Bankhub.Models.Claim>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /BANKS/1.0/CLAIMS
* Alter a claim
RESPONSE CLASS (STATUS 200)
string
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type claims
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
Array[Bankhub.Models.Claim {
Key (Bankhub.Models.ClaimKey, optional),
PayorID (string, optional),
PayorName (string, optional),
ClaimantName (string, optional),
CancellationDate (string, optional),
Identifier (string, optional),
Amount (number, optional),
Reference (string, optional),
FinalDueDate (string, optional),
BillNumber (string, optional),
CustomerNumber (string, optional),
NoticeAndPaymentFee (Bankhub.Models.NoticeAndPaymentFee, optional),
DefaultCharge (Bankhub.Models.DateRestrictedCharge, optional),
OtherCosts (number, optional),
OtherDefaultCosts (number, optional),
DefaultInterest (Bankhub.Models.DefaultInterest, optional),
CurrencyInformation (Bankhub.Models.CurrencyInformation, optional),
PermitOutOfSequencePayment (boolean, optional),
Discount (Bankhub.Models.DiscountCharge, optional),
IsPartialPaymentAllowed (boolean, optional),
BillPresentmentSystem (Bankhub.Models.BillPresentmentSystem, optional),
Printing (Bankhub.Models.Printing, optional)
}
Bankhub.Models.ClaimKey {
Claimant (string, optional),
Account (string, optional),
DueDate (string, optional)
}
Bankhub.Models.NoticeAndPaymentFee {
Printing (number, optional),
Paperless (number, optional)
}
Bankhub.Models.DateRestrictedCharge {
First (Bankhub.Models.DiscountOrDefaultChargePercentage, optional),
FirstAmount (Bankhub.Models.DiscountOrDefaultChargeAmount, optional),
Second (Bankhub.Models.DiscountOrDefaultChargePercentage, optional),
SecondAmount (Bankhub.Models.DiscountOrDefaultChargeAmount, optional),
ReferenceDate (string, optional) = ['DueDate', 'FinalDueDate']
stringEnum:"DueDate", "FinalDueDate"
}
Bankhub.Models.DefaultInterest {
Rule (string, optional) = ['NoDefaultInterest', 'DefaultInterestAmount',
'DefaultInterestAmountAndDefaultCharge']
stringEnum:"NoDefaultInterest", "DefaultInterestAmount",
"DefaultInterestAmountAndDefaultCharge"
,
Percentage4 (number, optional),
SpecialCode (string, optional)
}
Bankhub.Models.CurrencyInformation {
ReferenceRate (string, optional) = ['ExchangeRate', 'NoteRate',
'CentralBankMidRate', 'CentralBankStatutoryRate']
stringEnum:"ExchangeRate", "NoteRate", "CentralBankMidRate",
"CentralBankStatutoryRate"
,
Currency (string, optional),
PaymentRate (string, optional) = ['DueDateRate', 'PaymentDateRate']
stringEnum:"DueDateRate", "PaymentDateRate"
}
Bankhub.Models.DiscountCharge {
IsPostRefDate (boolean, optional),
First (Bankhub.Models.DiscountOrDefaultChargePercentage, optional),
FirstAmount (Bankhub.Models.DiscountOrDefaultChargeAmount, optional),
Second (Bankhub.Models.DiscountOrDefaultChargePercentage, optional),
SecondAmount (Bankhub.Models.DiscountOrDefaultChargeAmount, optional),
ReferenceDate (string, optional) = ['DueDate', 'FinalDueDate']
stringEnum:"DueDate", "FinalDueDate"
}
Bankhub.Models.BillPresentmentSystem {
Type (string, optional),
Parameters (string, optional)
}
Bankhub.Models.Printing {
ClaimantAddress (Bankhub.Models.Address, optional),
PayorAddress (Bankhub.Models.Address, optional),
ItemRows (Array[Bankhub.Models.ItemRow], optional),
Comments (Array[string], optional)
}
Bankhub.Models.DiscountOrDefaultChargePercentage {
Days (integer, optional),
Value (number, optional)
}
Bankhub.Models.DiscountOrDefaultChargeAmount {
Days (integer, optional),
Value (number, optional)
}
Bankhub.Models.Address {
Name (string, optional),
AddressLine1 (string, optional),
AddressLine2 (string, optional),
PostalCode (string, optional),
City (string, optional),
Region (string, optional),
Country (string, optional)
}
Bankhub.Models.ItemRow {
Text (string, optional),
Amount (number, optional)
}]
[
{
"Key": {
"Claimant": "string",
"Account": "string",
"DueDate": "2024-08-06T13:03:40.080Z"
},
"PayorID": "string",
"PayorName": "string",
"ClaimantName": "string",
"CancellationDate": "2024-08-06T13:03:40.080Z",
"Identifier": "string",
"Amount": 0,
"Reference": "string",
"FinalDueDate": "2024-08-06T13:03:40.080Z",
"BillNumber": "string",
"CustomerNumber": "string",
"NoticeAndPaymentFee": {
"Printing": 0,
"Paperless": 0
},
"DefaultCharge": {
"First": {
"Days": 0,
"Value": 0
},
"FirstAmount": {
"Days": 0,
"Value": 0
},
"Second": {
"Days": 0,
"Value": 0
},
"SecondAmount": {
"Days": 0,
"Value": 0
},
"ReferenceDate": "DueDate"
},
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": {
"Rule": "NoDefaultInterest",
"Percentage4": 0,
"SpecialCode": "string"
},
"CurrencyInformation": {
"ReferenceRate": "ExchangeRate",
"Currency": "string",
"PaymentRate": "DueDateRate"
},
"PermitOutOfSequencePayment": true,
"Discount": {
"IsPostRefDate": true,
"First": {
"Days": 0,
"Value": 0
},
"FirstAmount": {
"Days": 0,
"Value": 0
},
"Second": {
"Days": 0,
"Value": 0
},
"SecondAmount": {
"Days": 0,
"Value": 0
},
"ReferenceDate": "DueDate"
},
"IsPartialPaymentAllowed": true,
"BillPresentmentSystem": {
"Type": "string",
"Parameters": "string"
},
"Printing": {
"ClaimantAddress": {
"Name": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"PostalCode": "string",
"City": "string",
"Region": "string",
"Country": "string"
},
"PayorAddress": {
"Name": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"PostalCode": "string",
"City": "string",
"Region": "string",
"Country": "string"
},
"ItemRows": [
{
"Text": "string",
"Amount": 0
}
],
"Comments": [
"string"
]
}
}
]
<?xml version="1.0"?>
<Bankhub.Models.Claim>
<Key>
<Claimant>string</Claimant>
<Account>string</Account>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
</Key>
<PayorID>string</PayorID>
<PayorName>string</PayorName>
<ClaimantName>string</ClaimantName>
<CancellationDate>1970-01-01T00:00:00.001Z</CancellationDate>
<Identifier>string</Identifier>
<Amount>1.1</Amount>
<Reference>string</Reference>
<FinalDueDate>1970-01-01T00:00:00.001Z</FinalDueDate>
<BillNumber>string</BillNumber>
<CustomerNumber>string</CustomerNumber>
<NoticeAndPaymentFee>
<Printing>1.1</Printing>
<Paperless>1.1</Paperless>
</NoticeAndPaymentFee>
<DefaultCharge>
<First>
<Days>1</Days>
<Value>1.1</Value>
</First>
<FirstAmount>
<Days>1</Days>
<Value>1.1</Value>
</FirstAmount>
<Second>
<Days>1</Days>
<Value>1.1</Value>
</Second>
<SecondAmount>
<Days>1</Days>
<Value>1.1</Value>
</SecondAmount>
<ReferenceDate>DueDate</ReferenceDate>
</DefaultCharge>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>
<Rule>NoDefaultInterest</Rule>
<Percentage4>1.1</Percentage4>
<SpecialCode>string</SpecialCode>
</DefaultInterest>
<CurrencyInformation>
<ReferenceRate>ExchangeRate</ReferenceRate>
<Currency>string</Currency>
<PaymentRate>DueDateRate</PaymentRate>
</CurrencyInformation>
<PermitOutOfSequencePayment>true</PermitOutOfSequencePayment>
<Discount>
<IsPostRefDate>true</IsPostRefDate>
<First>
<Days>1</Days>
<Value>1.1</Value>
</First>
<FirstAmount>
<Days>1</Days>
<Value>1.1</Value>
</FirstAmount>
<Second>
<Days>1</Days>
<Value>1.1</Value>
</Second>
<SecondAmount>
<Days>1</Days>
<Value>1.1</Value>
</SecondAmount>
<ReferenceDate>DueDate</ReferenceDate>
</Discount>
<IsPartialPaymentAllowed>true</IsPartialPaymentAllowed>
<BillPresentmentSystem>
<Type>string</Type>
<Parameters>string</Parameters>
</BillPresentmentSystem>
<Printing>
<ClaimantAddress>
<Name>string</Name>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<PostalCode>string</PostalCode>
<City>string</City>
<Region>string</Region>
<Country>string</Country>
</ClaimantAddress>
<PayorAddress>
<Name>string</Name>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<PostalCode>string</PostalCode>
<City>string</City>
<Region>string</Region>
<Country>string</Country>
</PayorAddress>
<ItemRows>
<Text>string</Text>
<Amount>1.1</Amount>
</ItemRows>
<Comments>string</Comments>
</Printing>
</Bankhub.Models.Claim>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /BANKS/1.0/CLAIMS/TRANSACTIONS
* Claim transactions
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Claim (Bankhub.Models.Claim, optional),
Payment (Bankhub.Models.Payment, optional),
TransactionDate (string, optional),
TransactionType (string, optional) = ['Creation', 'Cancellation',
'Update', 'Payment', 'RefundClaimCreation', 'ReAdjustment',
'PaymentReAdjustment', 'PartialPaymentReAdjustment',
'TransferFromOldBank', 'TransferToNewBank',
'OptionalClaimCancellationByPayor', 'RefundPayment',
'CollectionReminderSentByBank']
stringEnum:"Creation", "Cancellation", "Update", "Payment",
"RefundClaimCreation", "ReAdjustment", "PaymentReAdjustment",
"PartialPaymentReAdjustment", "TransferFromOldBank", "TransferToNewBank",
"OptionalClaimCancellationByPayor", "RefundPayment",
"CollectionReminderSentByBank"
}
Bankhub.Models.Claim {
Key (Bankhub.Models.ClaimKey, optional),
PayorID (string, optional),
PayorName (string, optional),
ClaimantName (string, optional),
CancellationDate (string, optional),
Identifier (string, optional),
Amount (number, optional),
Reference (string, optional),
FinalDueDate (string, optional),
BillNumber (string, optional),
CustomerNumber (string, optional),
NoticeAndPaymentFee (Bankhub.Models.NoticeAndPaymentFee, optional),
DefaultCharge (Bankhub.Models.DateRestrictedCharge, optional),
OtherCosts (number, optional),
OtherDefaultCosts (number, optional),
DefaultInterest (Bankhub.Models.DefaultInterest, optional),
CurrencyInformation (Bankhub.Models.CurrencyInformation, optional),
PermitOutOfSequencePayment (boolean, optional),
Discount (Bankhub.Models.DiscountCharge, optional),
IsPartialPaymentAllowed (boolean, optional),
BillPresentmentSystem (Bankhub.Models.BillPresentmentSystem, optional),
Printing (Bankhub.Models.Printing, optional)
}
Bankhub.Models.Payment {
Key (Bankhub.Models.ClaimKey, optional),
PayorID (string, optional),
Amount (number, optional),
FinalDueDate (string, optional),
Identifier (string, optional),
Reference (string, optional),
CategoryCode (string, optional),
RedeemingBank (string, optional),
TransactionDate (string, optional),
BookingDate (string, optional),
ValueDate (string, optional),
PaymentType (string, optional) = ['Complete', 'Partial', 'Refund']
stringEnum:"Complete", "Partial", "Refund"
,
AmountDeposited (number, optional),
TotalAmount (number, optional),
CapitalGainsTax (number, optional),
BillNumber (string, optional),
CustomerNumber (string, optional),
NoticeChargeAmount (number, optional),
DefaultChargeAmount (number, optional),
OtherCostsAmount (number, optional),
OtherDefaultCostsAmount (number, optional),
DefaultInterestAmount (number, optional),
DiscountAmount (number, optional),
Currency (Bankhub.Models.CurrencyExchangeRate, optional),
BatchNumber (string, optional),
SecondaryCollectionIdentifier (string, optional),
LegalCollectionIdentifier (string, optional)
}
Bankhub.Models.ClaimKey {
Claimant (string, optional),
Account (string, optional),
DueDate (string, optional)
}
Bankhub.Models.NoticeAndPaymentFee {
Printing (number, optional),
Paperless (number, optional)
}
Bankhub.Models.DateRestrictedCharge {
First (Bankhub.Models.DiscountOrDefaultChargePercentage, optional),
FirstAmount (Bankhub.Models.DiscountOrDefaultChargeAmount, optional),
Second (Bankhub.Models.DiscountOrDefaultChargePercentage, optional),
SecondAmount (Bankhub.Models.DiscountOrDefaultChargeAmount, optional),
ReferenceDate (string, optional) = ['DueDate', 'FinalDueDate']
stringEnum:"DueDate", "FinalDueDate"
}
Bankhub.Models.DefaultInterest {
Rule (string, optional) = ['NoDefaultInterest', 'DefaultInterestAmount',
'DefaultInterestAmountAndDefaultCharge']
stringEnum:"NoDefaultInterest", "DefaultInterestAmount",
"DefaultInterestAmountAndDefaultCharge"
,
Percentage4 (number, optional),
SpecialCode (string, optional)
}
Bankhub.Models.CurrencyInformation {
ReferenceRate (string, optional) = ['ExchangeRate', 'NoteRate',
'CentralBankMidRate', 'CentralBankStatutoryRate']
stringEnum:"ExchangeRate", "NoteRate", "CentralBankMidRate",
"CentralBankStatutoryRate"
,
Currency (string, optional),
PaymentRate (string, optional) = ['DueDateRate', 'PaymentDateRate']
stringEnum:"DueDateRate", "PaymentDateRate"
}
Bankhub.Models.DiscountCharge {
IsPostRefDate (boolean, optional),
First (Bankhub.Models.DiscountOrDefaultChargePercentage, optional),
FirstAmount (Bankhub.Models.DiscountOrDefaultChargeAmount, optional),
Second (Bankhub.Models.DiscountOrDefaultChargePercentage, optional),
SecondAmount (Bankhub.Models.DiscountOrDefaultChargeAmount, optional),
ReferenceDate (string, optional) = ['DueDate', 'FinalDueDate']
stringEnum:"DueDate", "FinalDueDate"
}
Bankhub.Models.BillPresentmentSystem {
Type (string, optional),
Parameters (string, optional)
}
Bankhub.Models.Printing {
ClaimantAddress (Bankhub.Models.Address, optional),
PayorAddress (Bankhub.Models.Address, optional),
ItemRows (Array[Bankhub.Models.ItemRow], optional),
Comments (Array[string], optional)
}
Bankhub.Models.CurrencyExchangeRate {
Currency (string, optional),
Rate (number, optional)
}
Bankhub.Models.DiscountOrDefaultChargePercentage {
Days (integer, optional),
Value (number, optional)
}
Bankhub.Models.DiscountOrDefaultChargeAmount {
Days (integer, optional),
Value (number, optional)
}
Bankhub.Models.Address {
Name (string, optional),
AddressLine1 (string, optional),
AddressLine2 (string, optional),
PostalCode (string, optional),
City (string, optional),
Region (string, optional),
Country (string, optional)
}
Bankhub.Models.ItemRow {
Text (string, optional),
Amount (number, optional)
}
[
{
"Claim": {
"Key": {
"Claimant": "string",
"Account": "string",
"DueDate": "2024-08-06T13:03:40.087Z"
},
"PayorID": "string",
"PayorName": "string",
"ClaimantName": "string",
"CancellationDate": "2024-08-06T13:03:40.087Z",
"Identifier": "string",
"Amount": 0,
"Reference": "string",
"FinalDueDate": "2024-08-06T13:03:40.087Z",
"BillNumber": "string",
"CustomerNumber": "string",
"NoticeAndPaymentFee": {
"Printing": 0,
"Paperless": 0
},
"DefaultCharge": {
"First": {
"Days": 0,
"Value": 0
},
"FirstAmount": {
"Days": 0,
"Value": 0
},
"Second": {
"Days": 0,
"Value": 0
},
"SecondAmount": {
"Days": 0,
"Value": 0
},
"ReferenceDate": "DueDate"
},
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": {
"Rule": "NoDefaultInterest",
"Percentage4": 0,
"SpecialCode": "string"
},
"CurrencyInformation": {
"ReferenceRate": "ExchangeRate",
"Currency": "string",
"PaymentRate": "DueDateRate"
},
"PermitOutOfSequencePayment": true,
"Discount": {
"IsPostRefDate": true,
"First": {
"Days": 0,
"Value": 0
},
"FirstAmount": {
"Days": 0,
"Value": 0
},
"Second": {
"Days": 0,
"Value": 0
},
"SecondAmount": {
"Days": 0,
"Value": 0
},
"ReferenceDate": "DueDate"
},
"IsPartialPaymentAllowed": true,
"BillPresentmentSystem": {
"Type": "string",
"Parameters": "string"
},
"Printing": {
"ClaimantAddress": {
"Name": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"PostalCode": "string",
"City": "string",
"Region": "string",
"Country": "string"
},
"PayorAddress": {
"Name": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"PostalCode": "string",
"City": "string",
"Region": "string",
"Country": "string"
},
"ItemRows": [
{
"Text": "string",
"Amount": 0
}
],
"Comments": [
"string"
]
}
},
"Payment": {
"Key": {
"Claimant": "string",
"Account": "string",
"DueDate": "2024-08-06T13:03:40.088Z"
},
"PayorID": "string",
"Amount": 0,
"FinalDueDate": "2024-08-06T13:03:40.088Z",
"Identifier": "string",
"Reference": "string",
"CategoryCode": "string",
"RedeemingBank": "string",
"TransactionDate": "2024-08-06T13:03:40.088Z",
"BookingDate": "2024-08-06T13:03:40.088Z",
"ValueDate": "2024-08-06T13:03:40.088Z",
"PaymentType": "Complete",
"AmountDeposited": 0,
"TotalAmount": 0,
"CapitalGainsTax": 0,
"BillNumber": "string",
"CustomerNumber": "string",
"NoticeChargeAmount": 0,
"DefaultChargeAmount": 0,
"OtherCostsAmount": 0,
"OtherDefaultCostsAmount": 0,
"DefaultInterestAmount": 0,
"DiscountAmount": 0,
"Currency": {
"Currency": "string",
"Rate": 0
},
"BatchNumber": "string",
"SecondaryCollectionIdentifier": "string",
"LegalCollectionIdentifier": "string"
},
"TransactionDate": "2024-08-06T13:03:40.088Z",
"TransactionType": "Creation"
}
]
<?xml version="1.0"?>
<Inline Model>
<Claim>
<Key>
<Claimant>string</Claimant>
<Account>string</Account>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
</Key>
<PayorID>string</PayorID>
<PayorName>string</PayorName>
<ClaimantName>string</ClaimantName>
<CancellationDate>1970-01-01T00:00:00.001Z</CancellationDate>
<Identifier>string</Identifier>
<Amount>1.1</Amount>
<Reference>string</Reference>
<FinalDueDate>1970-01-01T00:00:00.001Z</FinalDueDate>
<BillNumber>string</BillNumber>
<CustomerNumber>string</CustomerNumber>
<NoticeAndPaymentFee>
<Printing>1.1</Printing>
<Paperless>1.1</Paperless>
</NoticeAndPaymentFee>
<DefaultCharge>
<First>
<Days>1</Days>
<Value>1.1</Value>
</First>
<FirstAmount>
<Days>1</Days>
<Value>1.1</Value>
</FirstAmount>
<Second>
<Days>1</Days>
<Value>1.1</Value>
</Second>
<SecondAmount>
<Days>1</Days>
<Value>1.1</Value>
</SecondAmount>
<ReferenceDate>DueDate</ReferenceDate>
</DefaultCharge>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>
<Rule>NoDefaultInterest</Rule>
<Percentage4>1.1</Percentage4>
<SpecialCode>string</SpecialCode>
</DefaultInterest>
<CurrencyInformation>
<ReferenceRate>ExchangeRate</ReferenceRate>
<Currency>string</Currency>
<PaymentRate>DueDateRate</PaymentRate>
</CurrencyInformation>
<PermitOutOfSequencePayment>true</PermitOutOfSequencePayment>
<Discount>
<IsPostRefDate>true</IsPostRefDate>
<First>
<Days>1</Days>
<Value>1.1</Value>
</First>
<FirstAmount>
<Days>1</Days>
<Value>1.1</Value>
</FirstAmount>
<Second>
<Days>1</Days>
<Value>1.1</Value>
</Second>
<SecondAmount>
<Days>1</Days>
<Value>1.1</Value>
</SecondAmount>
<ReferenceDate>DueDate</ReferenceDate>
</Discount>
<IsPartialPaymentAllowed>true</IsPartialPaymentAllowed>
<BillPresentmentSystem>
<Type>string</Type>
<Parameters>string</Parameters>
</BillPresentmentSystem>
<Printing>
<ClaimantAddress>
<Name>string</Name>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<PostalCode>string</PostalCode>
<City>string</City>
<Region>string</Region>
<Country>string</Country>
</ClaimantAddress>
<PayorAddress>
<Name>string</Name>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<PostalCode>string</PostalCode>
<City>string</City>
<Region>string</Region>
<Country>string</Country>
</PayorAddress>
<ItemRows>
<Text>string</Text>
<Amount>1.1</Amount>
</ItemRows>
<Comments>string</Comments>
</Printing>
</Claim>
<Payment>
<Key>
<Claimant>string</Claimant>
<Account>string</Account>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
</Key>
<PayorID>string</PayorID>
<Amount>1.1</Amount>
<FinalDueDate>1970-01-01T00:00:00.001Z</FinalDueDate>
<Identifier>string</Identifier>
<Reference>string</Reference>
<CategoryCode>string</CategoryCode>
<RedeemingBank>string</RedeemingBank>
<TransactionDate>1970-01-01T00:00:00.001Z</TransactionDate>
<BookingDate>1970-01-01T00:00:00.001Z</BookingDate>
<ValueDate>1970-01-01T00:00:00.001Z</ValueDate>
<PaymentType>Complete</PaymentType>
<AmountDeposited>1.1</AmountDeposited>
<TotalAmount>1.1</TotalAmount>
<CapitalGainsTax>1.1</CapitalGainsTax>
<BillNumber>string</BillNumber>
<CustomerNumber>string</CustomerNumber>
<NoticeChargeAmount>1.1</NoticeChargeAmount>
<DefaultChargeAmount>1.1</DefaultChargeAmount>
<OtherCostsAmount>1.1</OtherCostsAmount>
<OtherDefaultCostsAmount>1.1</OtherDefaultCostsAmount>
<DefaultInterestAmount>1.1</DefaultInterestAmount>
<DiscountAmount>1.1</DiscountAmount>
<Currency>
<Currency>string</Currency>
<Rate>1.1</Rate>
</Currency>
<BatchNumber>string</BatchNumber>
<SecondaryCollectionIdentifier>string</SecondaryCollectionIdentifier>
<LegalCollectionIdentifier>string</LegalCollectionIdentifier>
</Payment>
<TransactionDate>1970-01-01T00:00:00.001Z</TransactionDate>
<TransactionType>Creation</TransactionType>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type claimant query
string account query string dueDate query date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /BANKS/1.0/CLAIMS/PAYMENTS
* Claim payments
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Key (Bankhub.Models.ClaimKey, optional),
PayorID (string, optional),
Amount (number, optional),
FinalDueDate (string, optional),
Identifier (string, optional),
Reference (string, optional),
CategoryCode (string, optional),
RedeemingBank (string, optional),
TransactionDate (string, optional),
BookingDate (string, optional),
ValueDate (string, optional),
PaymentType (string, optional) = ['Complete', 'Partial', 'Refund']
stringEnum:"Complete", "Partial", "Refund"
,
AmountDeposited (number, optional),
TotalAmount (number, optional),
CapitalGainsTax (number, optional),
BillNumber (string, optional),
CustomerNumber (string, optional),
NoticeChargeAmount (number, optional),
DefaultChargeAmount (number, optional),
OtherCostsAmount (number, optional),
OtherDefaultCostsAmount (number, optional),
DefaultInterestAmount (number, optional),
DiscountAmount (number, optional),
Currency (Bankhub.Models.CurrencyExchangeRate, optional),
BatchNumber (string, optional),
SecondaryCollectionIdentifier (string, optional),
LegalCollectionIdentifier (string, optional)
}
Bankhub.Models.ClaimKey {
Claimant (string, optional),
Account (string, optional),
DueDate (string, optional)
}
Bankhub.Models.CurrencyExchangeRate {
Currency (string, optional),
Rate (number, optional)
}
[
{
"Key": {
"Claimant": "string",
"Account": "string",
"DueDate": "2024-08-06T13:03:40.101Z"
},
"PayorID": "string",
"Amount": 0,
"FinalDueDate": "2024-08-06T13:03:40.101Z",
"Identifier": "string",
"Reference": "string",
"CategoryCode": "string",
"RedeemingBank": "string",
"TransactionDate": "2024-08-06T13:03:40.101Z",
"BookingDate": "2024-08-06T13:03:40.101Z",
"ValueDate": "2024-08-06T13:03:40.101Z",
"PaymentType": "Complete",
"AmountDeposited": 0,
"TotalAmount": 0,
"CapitalGainsTax": 0,
"BillNumber": "string",
"CustomerNumber": "string",
"NoticeChargeAmount": 0,
"DefaultChargeAmount": 0,
"OtherCostsAmount": 0,
"OtherDefaultCostsAmount": 0,
"DefaultInterestAmount": 0,
"DiscountAmount": 0,
"Currency": {
"Currency": "string",
"Rate": 0
},
"BatchNumber": "string",
"SecondaryCollectionIdentifier": "string",
"LegalCollectionIdentifier": "string"
}
]
<?xml version="1.0"?>
<Inline Model>
<Key>
<Claimant>string</Claimant>
<Account>string</Account>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
</Key>
<PayorID>string</PayorID>
<Amount>1.1</Amount>
<FinalDueDate>1970-01-01T00:00:00.001Z</FinalDueDate>
<Identifier>string</Identifier>
<Reference>string</Reference>
<CategoryCode>string</CategoryCode>
<RedeemingBank>string</RedeemingBank>
<TransactionDate>1970-01-01T00:00:00.001Z</TransactionDate>
<BookingDate>1970-01-01T00:00:00.001Z</BookingDate>
<ValueDate>1970-01-01T00:00:00.001Z</ValueDate>
<PaymentType>Complete</PaymentType>
<AmountDeposited>1.1</AmountDeposited>
<TotalAmount>1.1</TotalAmount>
<CapitalGainsTax>1.1</CapitalGainsTax>
<BillNumber>string</BillNumber>
<CustomerNumber>string</CustomerNumber>
<NoticeChargeAmount>1.1</NoticeChargeAmount>
<DefaultChargeAmount>1.1</DefaultChargeAmount>
<OtherCostsAmount>1.1</OtherCostsAmount>
<OtherDefaultCostsAmount>1.1</OtherDefaultCostsAmount>
<DefaultInterestAmount>1.1</DefaultInterestAmount>
<DiscountAmount>1.1</DiscountAmount>
<Currency>
<Currency>string</Currency>
<Rate>1.1</Rate>
</Currency>
<BatchNumber>string</BatchNumber>
<SecondaryCollectionIdentifier>string</SecondaryCollectionIdentifier>
<LegalCollectionIdentifier>string</LegalCollectionIdentifier>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type claimant query
string fromDate query date-time toDate query date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /BANKS/1.0/CLAIMS/DELETE
* Cancel a claim
RESPONSE CLASS (STATUS 200)
string
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type claimKeys
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
Array[Bankhub.Models.ClaimKey {
Claimant (string, optional),
Account (string, optional),
DueDate (string, optional)
}]
[
{
"Claimant": "string",
"Account": "string",
"DueDate": "2024-08-06T13:03:40.125Z"
}
]
<?xml version="1.0"?>
<Bankhub.Models.ClaimKey>
<Claimant>string</Claimant>
<Account>string</Account>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
</Bankhub.Models.ClaimKey>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CREDITCARDS
* Show/Hide
* List Operations
* Expand Operations
* * GET /BANKS/1.0/CREDITCARDS
* Get list of your credit cards
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
CardId (integer, optional),
CardHolderName (string, optional),
CardOwnerName (string, optional),
CardOwnerId (string, optional),
CardHolderId (string, optional),
AmountDue (number, optional),
Balance (number, optional),
Active (boolean, optional),
CardType (string, optional),
CardBrand (string, optional),
CardRole (string, optional),
BankNumber (string, optional),
IssueDate (string, optional),
ExpiryDate (string, optional),
Limit (number, optional),
CardNumber (string, optional),
AvailableBalance (number, optional)
}
[
{
"CardId": 0,
"CardHolderName": "string",
"CardOwnerName": "string",
"CardOwnerId": "string",
"CardHolderId": "string",
"AmountDue": 0,
"Balance": 0,
"Active": true,
"CardType": "string",
"CardBrand": "string",
"CardRole": "string",
"BankNumber": "string",
"IssueDate": "2024-08-06T13:03:40.128Z",
"ExpiryDate": "2024-08-06T13:03:40.128Z",
"Limit": 0,
"CardNumber": "string",
"AvailableBalance": 0
}
]
<?xml version="1.0"?>
<Inline Model>
<CardId>1</CardId>
<CardHolderName>string</CardHolderName>
<CardOwnerName>string</CardOwnerName>
<CardOwnerId>string</CardOwnerId>
<CardHolderId>string</CardHolderId>
<AmountDue>1.1</AmountDue>
<Balance>1.1</Balance>
<Active>true</Active>
<CardType>string</CardType>
<CardBrand>string</CardBrand>
<CardRole>string</CardRole>
<BankNumber>string</BankNumber>
<IssueDate>1970-01-01T00:00:00.001Z</IssueDate>
<ExpiryDate>1970-01-01T00:00:00.001Z</ExpiryDate>
<Limit>1.1</Limit>
<CardNumber>string</CardNumber>
<AvailableBalance>1.1</AvailableBalance>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type ownerId
Owner id for the cards
query string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /BANKS/1.0/CREDITCARDS/{CARDID}
* Get creditcards
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Bankhub.Models.Cards.CreditCard {
CardId (integer, optional),
CardHolderName (string, optional),
CardOwnerName (string, optional),
CardOwnerId (string, optional),
CardHolderId (string, optional),
AmountDue (number, optional),
Balance (number, optional),
Active (boolean, optional),
CardType (string, optional),
CardBrand (string, optional),
CardRole (string, optional),
BankNumber (string, optional),
IssueDate (string, optional),
ExpiryDate (string, optional),
Limit (number, optional),
CardNumber (string, optional),
AvailableBalance (number, optional)
}
{
"CardId": 0,
"CardHolderName": "string",
"CardOwnerName": "string",
"CardOwnerId": "string",
"CardHolderId": "string",
"AmountDue": 0,
"Balance": 0,
"Active": true,
"CardType": "string",
"CardBrand": "string",
"CardRole": "string",
"BankNumber": "string",
"IssueDate": "2024-08-06T13:03:40.131Z",
"ExpiryDate": "2024-08-06T13:03:40.131Z",
"Limit": 0,
"CardNumber": "string",
"AvailableBalance": 0
}
<?xml version="1.0"?>
<Bankhub.Models.Cards.CreditCard>
<CardId>1</CardId>
<CardHolderName>string</CardHolderName>
<CardOwnerName>string</CardOwnerName>
<CardOwnerId>string</CardOwnerId>
<CardHolderId>string</CardHolderId>
<AmountDue>1.1</AmountDue>
<Balance>1.1</Balance>
<Active>true</Active>
<CardType>string</CardType>
<CardBrand>string</CardBrand>
<CardRole>string</CardRole>
<BankNumber>string</BankNumber>
<IssueDate>1970-01-01T00:00:00.001Z</IssueDate>
<ExpiryDate>1970-01-01T00:00:00.001Z</ExpiryDate>
<Limit>1.1</Limit>
<CardNumber>string</CardNumber>
<AvailableBalance>1.1</AvailableBalance>
</Bankhub.Models.Cards.CreditCard>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type cardId path string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /BANKS/1.0/CREDITCARDS/{CARDID}/TRANSACTIONS
* Get transactions for a card
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
CardId (integer, optional),
TransactionDate (string, optional),
LocalAmount (Bankhub.Models.Cards.CardAmount, optional),
Amount (Bankhub.Models.Cards.CardAmount, optional),
TransactionId (string, optional),
DueDate (string, optional),
TransactionKey (string, optional),
AuthorizationNumber (string, optional),
MerchantName (string, optional),
MerchantCity (string, optional),
MerchantCountryCode (string, optional),
IsEcardTransaction (boolean, optional)
}
Bankhub.Models.Cards.CardAmount {
Amount (number, optional),
CurrencyCode (string, optional)
}
[
{
"CardId": 0,
"TransactionDate": "2024-08-06T13:03:40.133Z",
"LocalAmount": {
"Amount": 0,
"CurrencyCode": "string"
},
"Amount": {
"Amount": 0,
"CurrencyCode": "string"
},
"TransactionId": "string",
"DueDate": "string",
"TransactionKey": "string",
"AuthorizationNumber": "string",
"MerchantName": "string",
"MerchantCity": "string",
"MerchantCountryCode": "string",
"IsEcardTransaction": true
}
]
<?xml version="1.0"?>
<Inline Model>
<CardId>1</CardId>
<TransactionDate>1970-01-01T00:00:00.001Z</TransactionDate>
<LocalAmount>
<Amount>1.1</Amount>
<CurrencyCode>string</CurrencyCode>
</LocalAmount>
<Amount>
<Amount>1.1</Amount>
<CurrencyCode>string</CurrencyCode>
</Amount>
<TransactionId>string</TransactionId>
<DueDate>string</DueDate>
<TransactionKey>string</TransactionKey>
<AuthorizationNumber>string</AuthorizationNumber>
<MerchantName>string</MerchantName>
<MerchantCity>string</MerchantCity>
<MerchantCountryCode>string</MerchantCountryCode>
<IsEcardTransaction>true</IsEcardTransaction>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type cardId
Unique identifier for the card
path integer fromDate
Get credit card transactions from
query date-time toDate
Get credit card transactions to
query date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CURRENCIES
* Show/Hide
* List Operations
* Expand Operations
* * GET /BANKS/1.0/CURRENCIES/{DATE}
* Get currencies
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Source (string, optional),
CurrencyCode (string, optional),
SellingRate (number, optional),
BuyingRate (number, optional)
}
[
{
"Source": "string",
"CurrencyCode": "string",
"SellingRate": 0,
"BuyingRate": 0
}
]
<?xml version="1.0"?>
<Inline Model>
<Source>string</Source>
<CurrencyCode>string</CurrencyCode>
<SellingRate>1.1</SellingRate>
<BuyingRate>1.1</BuyingRate>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type date path date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /BANKS/1.0/CURRENCIES/{DATE}/{SOURCE}
* Get currencies
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Source (string, optional),
CurrencyCode (string, optional),
SellingRate (number, optional),
BuyingRate (number, optional)
}
[
{
"Source": "string",
"CurrencyCode": "string",
"SellingRate": 0,
"BuyingRate": 0
}
]
<?xml version="1.0"?>
<Inline Model>
<Source>string</Source>
<CurrencyCode>string</CurrencyCode>
<SellingRate>1.1</SellingRate>
<BuyingRate>1.1</BuyingRate>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type date path date-time
source NoteRate ExchangeRate CustomsRate
path string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* DOCUMENTS
* Show/Hide
* List Operations
* Expand Operations
* * GET /BANKS/1.0/DOCUMENTS/{DATEFROM}/{DATETO}
* Get list of documents
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Id (string, optional),
Status (string, optional) = ['Open', 'Closed']
stringEnum:"Open", "Closed"
,
Info (Bankhub.Models.Documents.DocumentInfo, optional),
Date (string, optional)
}
Bankhub.Models.Documents.DocumentInfo {
OwnerSsn (string, optional),
Type (string, optional),
Name (string, optional)
}
[
{
"Id": "string",
"Status": "Open",
"Info": {
"OwnerSsn": "string",
"Type": "string",
"Name": "string"
},
"Date": "2024-08-06T13:03:40.143Z"
}
]
<?xml version="1.0"?>
<Inline Model>
<Id>string</Id>
<Status>Open</Status>
<Info>
<OwnerSsn>string</OwnerSsn>
<Type>string</Type>
<Name>string</Name>
</Info>
<Date>1970-01-01T00:00:00.001Z</Date>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type dateFrom
Search for document created after {dateFrom}.
path date-time dateTo
Search for document created before {dateTo}.
path date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /BANKS/1.0/DOCUMENTS/{DOCUMENTID}
* Get single document
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Bankhub.Models.Documents.DocumentResult {
Id (string, optional),
Status (string, optional) = ['Open', 'Closed']
stringEnum:"Open", "Closed"
,
Info (Bankhub.Models.Documents.DocumentInfo, optional),
Date (string, optional)
}
Bankhub.Models.Documents.DocumentInfo {
OwnerSsn (string, optional),
Type (string, optional),
Name (string, optional)
}
{
"Id": "string",
"Status": "Open",
"Info": {
"OwnerSsn": "string",
"Type": "string",
"Name": "string"
},
"Date": "2024-08-06T13:03:40.148Z"
}
<?xml version="1.0"?>
<Bankhub.Models.Documents.DocumentResult>
<Id>string</Id>
<Status>Open</Status>
<Info>
<OwnerSsn>string</OwnerSsn>
<Type>string</Type>
<Name>string</Name>
</Info>
<Date>1970-01-01T00:00:00.001Z</Date>
</Bankhub.Models.Documents.DocumentResult>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId
The id of the document
path string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /BANKS/1.0/DOCUMENTS
* Upload single document
RESPONSE CLASS (STATUS 200)
string
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type document
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
The document
body
* Model
* Example Value
Bankhub.Models.Documents.UploadDocument {
PersonId (string, optional),
DocumentName (string, optional),
DocumentType (string, optional),
FileAsBase64 (string, optional)
}
{
"PersonId": "string",
"DocumentName": "string",
"DocumentType": "string",
"FileAsBase64": "string"
}
<?xml version="1.0"?>
<Bankhub.Models.Documents.UploadDocument>
<PersonId>string</PersonId>
<DocumentName>string</DocumentName>
<DocumentType>string</DocumentType>
<FileAsBase64>string</FileAsBase64>
</Bankhub.Models.Documents.UploadDocument>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* FOREIGNPAYMENTS
* Show/Hide
* List Operations
* Expand Operations
* * POST /BANKS/1.0/FOREIGNPAYMENTS
* Perform payment batch where amount is transferred from account to:
1. Transfer to another account { or }
2. Pay claim { or }
3. Pay AB Giro { or }
4. Pay C Giro
RESPONSE CLASS (STATUS 200)
string
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type payments
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
The batch payments
body
* Model
* Example Value
Bankhub.Models.Payments.Payments {
Out (Bankhub.Models.Payments.PaymentOut, optional),
In (Array[Bankhub.Models.Payments.PaymentIn], optional),
DateOfForwardPayment (string, optional),
DateOfForwardPaymentSpecified (boolean, optional),
NameOfBatch (string, optional),
RollbackOnError (boolean, optional),
IsOneToMany (boolean, optional)
}
Bankhub.Models.Payments.PaymentOut {
Account (string, optional),
AccountOwnerId (string, optional),
CategoryCode (string, optional),
Reference (string, optional),
BillNumber (string, optional),
Receipt (Bankhub.Models.Payments.Communication, optional)
}
Bankhub.Models.Payments.PaymentIn {
Amount (number, optional),
Description (string, optional),
BookingId (string, optional),
ABGiro (Bankhub.Models.Payments.ABGiro, optional),
CGiro (Bankhub.Models.Payments.CGiro, optional),
PaymentClaim (Bankhub.Models.Payments.PaymentClaim, optional),
Transfer (Bankhub.Models.Payments.Transfer, optional),
Receipt (Bankhub.Models.Payments.Communication, optional)
}
Bankhub.Models.Payments.Communication {
EMail (Array[Bankhub.Models.Payments.CommunicationEMail], optional),
SMS (Array[Bankhub.Models.Payments.CommunicationSMS], optional)
}
Bankhub.Models.Payments.ABGiro {
Account (string, optional),
Reference (string, optional),
BillNumber (string, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.CGiro {
Account (string, optional),
AccountOwnerId (string, optional),
BillNumber (string, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.PaymentClaim {
Account (string, optional),
Claimant (string, optional),
PayorId (string, optional),
DueDate (string, optional),
IsDeposit (boolean, optional),
AmountDue (number, optional),
DefaultCosts (number, optional),
OtherCosts (number, optional),
OtherDefaultCosts (number, optional),
DefaultInterest (number, optional),
NoticeAndPaymentFee (number, optional),
Discount (number, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.Transfer {
Account (string, optional),
AccountOwnerId (string, optional),
CategoryCode (string, optional),
Reference (string, optional),
BillNumber (string, optional)
}
Bankhub.Models.Payments.CommunicationEMail {
EmailAddress (string, optional),
Language (string, optional)
}
Bankhub.Models.Payments.CommunicationSMS {
PhoneNumber (string, optional),
CountryCode (string, optional),
Language (string, optional)
}
{
"Out": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string",
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
}
},
"In": [
{
"Amount": 0,
"Description": "string",
"BookingId": "string",
"ABGiro": {
"Account": "string",
"Reference": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"CGiro": {
"Account": "string",
"AccountOwnerId": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"PaymentClaim": {
"Account": "string",
"Claimant": "string",
"PayorId": "string",
"DueDate": "2024-08-06T13:03:40.156Z",
"IsDeposit": true,
"AmountDue": 0,
"DefaultCosts": 0,
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": 0,
"NoticeAndPaymentFee": 0,
"Discount": 0,
"CategoryCode": "string"
},
"Transfer": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string"
},
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
}
}
],
"DateOfForwardPayment": "2024-08-06T13:03:40.156Z",
"DateOfForwardPaymentSpecified": true,
"NameOfBatch": "string",
"RollbackOnError": true,
"IsOneToMany": true
}
<?xml version="1.0"?>
<Bankhub.Models.Payments.Payments>
<Out>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
</Out>
<In>
<Amount>1.1</Amount>
<Description>string</Description>
<BookingId>string</BookingId>
<ABGiro>
<Account>string</Account>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</ABGiro>
<CGiro>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</CGiro>
<PaymentClaim>
<Account>string</Account>
<Claimant>string</Claimant>
<PayorId>string</PayorId>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
<IsDeposit>true</IsDeposit>
<AmountDue>1.1</AmountDue>
<DefaultCosts>1.1</DefaultCosts>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>1.1</DefaultInterest>
<NoticeAndPaymentFee>1.1</NoticeAndPaymentFee>
<Discount>1.1</Discount>
<CategoryCode>string</CategoryCode>
</PaymentClaim>
<Transfer>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
</Transfer>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
</In>
<DateOfForwardPayment>1970-01-01T00:00:00.001Z</DateOfForwardPayment>
<DateOfForwardPaymentSpecified>true</DateOfForwardPaymentSpecified>
<NameOfBatch>string</NameOfBatch>
<RollbackOnError>true</RollbackOnError>
<IsOneToMany>true</IsOneToMany>
</Bankhub.Models.Payments.Payments>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /BANKS/1.0/FOREIGNPAYMENTS
* Perform single payment where amount is transferred from account to:
1. Transfer to another account { or }
2. Pay claim { or }
3. Pay AB Giro { or }
4. Pay C Giro
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Bankhub.Models.Payments.PaymentResult {
Id (string, optional),
BatchStatus (string, optional) = ['InProgress', 'Completed',
'CompletedWithErrors', 'Cancelled', 'OnHold', 'NotConfirmed']
stringEnum:"InProgress", "Completed", "CompletedWithErrors", "Cancelled",
"OnHold", "NotConfirmed"
,
Success (Array[Bankhub.Models.Payments.PaymentResultDetail], optional),
Errors (Array[Bankhub.Models.Payments.PaymentError], optional),
DateOfPayment (string, optional),
DateOfPaymentSpecified (boolean, optional)
}
Bankhub.Models.Payments.PaymentResultDetail {
Amount (number, optional),
Receipt (Bankhub.Models.Payments.Communication, optional),
Description (string, optional),
BookingId (string, optional),
ABGiro (Bankhub.Models.Payments.ABGiro, optional),
CGiro (Bankhub.Models.Payments.CGiro, optional),
PaymentClaim (Bankhub.Models.Payments.PaymentClaim, optional),
Transfer (Bankhub.Models.Payments.Transfer, optional)
}
Bankhub.Models.Payments.PaymentError {
Payment (Bankhub.Models.Payments.PaymentIn, optional),
Error (Bankhub.Models.Error, optional)
}
Bankhub.Models.Payments.Communication {
EMail (Array[Bankhub.Models.Payments.CommunicationEMail], optional),
SMS (Array[Bankhub.Models.Payments.CommunicationSMS], optional)
}
Bankhub.Models.Payments.ABGiro {
Account (string, optional),
Reference (string, optional),
BillNumber (string, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.CGiro {
Account (string, optional),
AccountOwnerId (string, optional),
BillNumber (string, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.PaymentClaim {
Account (string, optional),
Claimant (string, optional),
PayorId (string, optional),
DueDate (string, optional),
IsDeposit (boolean, optional),
AmountDue (number, optional),
DefaultCosts (number, optional),
OtherCosts (number, optional),
OtherDefaultCosts (number, optional),
DefaultInterest (number, optional),
NoticeAndPaymentFee (number, optional),
Discount (number, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.Transfer {
Account (string, optional),
AccountOwnerId (string, optional),
CategoryCode (string, optional),
Reference (string, optional),
BillNumber (string, optional)
}
Bankhub.Models.Payments.PaymentIn {
Amount (number, optional),
Description (string, optional),
BookingId (string, optional),
ABGiro (Bankhub.Models.Payments.ABGiro, optional),
CGiro (Bankhub.Models.Payments.CGiro, optional),
PaymentClaim (Bankhub.Models.Payments.PaymentClaim, optional),
Transfer (Bankhub.Models.Payments.Transfer, optional),
Receipt (Bankhub.Models.Payments.Communication, optional)
}
Bankhub.Models.Error {
Code (string, optional),
Message (string, optional)
}
Bankhub.Models.Payments.CommunicationEMail {
EmailAddress (string, optional),
Language (string, optional)
}
Bankhub.Models.Payments.CommunicationSMS {
PhoneNumber (string, optional),
CountryCode (string, optional),
Language (string, optional)
}
{
"Id": "string",
"BatchStatus": "InProgress",
"Success": [
{
"Amount": 0,
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
},
"Description": "string",
"BookingId": "string",
"ABGiro": {
"Account": "string",
"Reference": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"CGiro": {
"Account": "string",
"AccountOwnerId": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"PaymentClaim": {
"Account": "string",
"Claimant": "string",
"PayorId": "string",
"DueDate": "2024-08-06T13:03:40.173Z",
"IsDeposit": true,
"AmountDue": 0,
"DefaultCosts": 0,
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": 0,
"NoticeAndPaymentFee": 0,
"Discount": 0,
"CategoryCode": "string"
},
"Transfer": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string"
}
}
],
"Errors": [
{
"Payment": {
"Amount": 0,
"Description": "string",
"BookingId": "string",
"ABGiro": {
"Account": "string",
"Reference": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"CGiro": {
"Account": "string",
"AccountOwnerId": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"PaymentClaim": {
"Account": "string",
"Claimant": "string",
"PayorId": "string",
"DueDate": "2024-08-06T13:03:40.173Z",
"IsDeposit": true,
"AmountDue": 0,
"DefaultCosts": 0,
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": 0,
"NoticeAndPaymentFee": 0,
"Discount": 0,
"CategoryCode": "string"
},
"Transfer": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string"
},
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
}
},
"Error": {
"Code": "string",
"Message": "string"
}
}
],
"DateOfPayment": "2024-08-06T13:03:40.174Z",
"DateOfPaymentSpecified": true
}
<?xml version="1.0"?>
<Bankhub.Models.Payments.PaymentResult>
<Id>string</Id>
<BatchStatus>InProgress</BatchStatus>
<Success>
<Amount>1.1</Amount>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
<Description>string</Description>
<BookingId>string</BookingId>
<ABGiro>
<Account>string</Account>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</ABGiro>
<CGiro>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</CGiro>
<PaymentClaim>
<Account>string</Account>
<Claimant>string</Claimant>
<PayorId>string</PayorId>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
<IsDeposit>true</IsDeposit>
<AmountDue>1.1</AmountDue>
<DefaultCosts>1.1</DefaultCosts>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>1.1</DefaultInterest>
<NoticeAndPaymentFee>1.1</NoticeAndPaymentFee>
<Discount>1.1</Discount>
<CategoryCode>string</CategoryCode>
</PaymentClaim>
<Transfer>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
</Transfer>
</Success>
<Errors>
<Payment>
<Amount>1.1</Amount>
<Description>string</Description>
<BookingId>string</BookingId>
<ABGiro>
<Account>string</Account>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</ABGiro>
<CGiro>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</CGiro>
<PaymentClaim>
<Account>string</Account>
<Claimant>string</Claimant>
<PayorId>string</PayorId>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
<IsDeposit>true</IsDeposit>
<AmountDue>1.1</AmountDue>
<DefaultCosts>1.1</DefaultCosts>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>1.1</DefaultInterest>
<NoticeAndPaymentFee>1.1</NoticeAndPaymentFee>
<Discount>1.1</Discount>
<CategoryCode>string</CategoryCode>
</PaymentClaim>
<Transfer>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
</Transfer>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
</Payment>
<Error>
<Code>string</Code>
<Message>string</Message>
</Error>
</Errors>
<DateOfPayment>1970-01-01T00:00:00.001Z</DateOfPayment>
<DateOfPaymentSpecified>true</DateOfPaymentSpecified>
</Bankhub.Models.Payments.PaymentResult>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type payment
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
The payment
body
* Model
* Example Value
Bankhub.Models.Payments.Payment {
In (Bankhub.Models.Payments.PaymentIn, optional),
Out (Bankhub.Models.Payments.PaymentOut, optional),
DateOfForwardPayment (string, optional),
DateOfForwardPaymentSpecified (boolean, optional)
}
Bankhub.Models.Payments.PaymentIn {
Amount (number, optional),
Description (string, optional),
BookingId (string, optional),
ABGiro (Bankhub.Models.Payments.ABGiro, optional),
CGiro (Bankhub.Models.Payments.CGiro, optional),
PaymentClaim (Bankhub.Models.Payments.PaymentClaim, optional),
Transfer (Bankhub.Models.Payments.Transfer, optional),
Receipt (Bankhub.Models.Payments.Communication, optional)
}
Bankhub.Models.Payments.PaymentOut {
Account (string, optional),
AccountOwnerId (string, optional),
CategoryCode (string, optional),
Reference (string, optional),
BillNumber (string, optional),
Receipt (Bankhub.Models.Payments.Communication, optional)
}
Bankhub.Models.Payments.ABGiro {
Account (string, optional),
Reference (string, optional),
BillNumber (string, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.CGiro {
Account (string, optional),
AccountOwnerId (string, optional),
BillNumber (string, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.PaymentClaim {
Account (string, optional),
Claimant (string, optional),
PayorId (string, optional),
DueDate (string, optional),
IsDeposit (boolean, optional),
AmountDue (number, optional),
DefaultCosts (number, optional),
OtherCosts (number, optional),
OtherDefaultCosts (number, optional),
DefaultInterest (number, optional),
NoticeAndPaymentFee (number, optional),
Discount (number, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.Transfer {
Account (string, optional),
AccountOwnerId (string, optional),
CategoryCode (string, optional),
Reference (string, optional),
BillNumber (string, optional)
}
Bankhub.Models.Payments.Communication {
EMail (Array[Bankhub.Models.Payments.CommunicationEMail], optional),
SMS (Array[Bankhub.Models.Payments.CommunicationSMS], optional)
}
Bankhub.Models.Payments.CommunicationEMail {
EmailAddress (string, optional),
Language (string, optional)
}
Bankhub.Models.Payments.CommunicationSMS {
PhoneNumber (string, optional),
CountryCode (string, optional),
Language (string, optional)
}
{
"In": {
"Amount": 0,
"Description": "string",
"BookingId": "string",
"ABGiro": {
"Account": "string",
"Reference": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"CGiro": {
"Account": "string",
"AccountOwnerId": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"PaymentClaim": {
"Account": "string",
"Claimant": "string",
"PayorId": "string",
"DueDate": "2024-08-06T13:03:40.180Z",
"IsDeposit": true,
"AmountDue": 0,
"DefaultCosts": 0,
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": 0,
"NoticeAndPaymentFee": 0,
"Discount": 0,
"CategoryCode": "string"
},
"Transfer": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string"
},
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
}
},
"Out": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string",
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
}
},
"DateOfForwardPayment": "2024-08-06T13:03:40.180Z",
"DateOfForwardPaymentSpecified": true
}
<?xml version="1.0"?>
<Bankhub.Models.Payments.Payment>
<In>
<Amount>1.1</Amount>
<Description>string</Description>
<BookingId>string</BookingId>
<ABGiro>
<Account>string</Account>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</ABGiro>
<CGiro>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</CGiro>
<PaymentClaim>
<Account>string</Account>
<Claimant>string</Claimant>
<PayorId>string</PayorId>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
<IsDeposit>true</IsDeposit>
<AmountDue>1.1</AmountDue>
<DefaultCosts>1.1</DefaultCosts>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>1.1</DefaultInterest>
<NoticeAndPaymentFee>1.1</NoticeAndPaymentFee>
<Discount>1.1</Discount>
<CategoryCode>string</CategoryCode>
</PaymentClaim>
<Transfer>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
</Transfer>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
</In>
<Out>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
</Out>
<DateOfForwardPayment>1970-01-01T00:00:00.001Z</DateOfForwardPayment>
<DateOfForwardPaymentSpecified>true</DateOfForwardPaymentSpecified>
</Bankhub.Models.Payments.Payment>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /BANKS/1.0/FOREIGNPAYMENT/{PAYMENTID}
* The call to the batch payment method returns payment id used to query
the status of the payment batch
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Bankhub.Models.Payments.PaymentResult {
Id (string, optional),
BatchStatus (string, optional) = ['InProgress', 'Completed',
'CompletedWithErrors', 'Cancelled', 'OnHold', 'NotConfirmed']
stringEnum:"InProgress", "Completed", "CompletedWithErrors", "Cancelled",
"OnHold", "NotConfirmed"
,
Success (Array[Bankhub.Models.Payments.PaymentResultDetail], optional),
Errors (Array[Bankhub.Models.Payments.PaymentError], optional),
DateOfPayment (string, optional),
DateOfPaymentSpecified (boolean, optional)
}
Bankhub.Models.Payments.PaymentResultDetail {
Amount (number, optional),
Receipt (Bankhub.Models.Payments.Communication, optional),
Description (string, optional),
BookingId (string, optional),
ABGiro (Bankhub.Models.Payments.ABGiro, optional),
CGiro (Bankhub.Models.Payments.CGiro, optional),
PaymentClaim (Bankhub.Models.Payments.PaymentClaim, optional),
Transfer (Bankhub.Models.Payments.Transfer, optional)
}
Bankhub.Models.Payments.PaymentError {
Payment (Bankhub.Models.Payments.PaymentIn, optional),
Error (Bankhub.Models.Error, optional)
}
Bankhub.Models.Payments.Communication {
EMail (Array[Bankhub.Models.Payments.CommunicationEMail], optional),
SMS (Array[Bankhub.Models.Payments.CommunicationSMS], optional)
}
Bankhub.Models.Payments.ABGiro {
Account (string, optional),
Reference (string, optional),
BillNumber (string, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.CGiro {
Account (string, optional),
AccountOwnerId (string, optional),
BillNumber (string, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.PaymentClaim {
Account (string, optional),
Claimant (string, optional),
PayorId (string, optional),
DueDate (string, optional),
IsDeposit (boolean, optional),
AmountDue (number, optional),
DefaultCosts (number, optional),
OtherCosts (number, optional),
OtherDefaultCosts (number, optional),
DefaultInterest (number, optional),
NoticeAndPaymentFee (number, optional),
Discount (number, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.Transfer {
Account (string, optional),
AccountOwnerId (string, optional),
CategoryCode (string, optional),
Reference (string, optional),
BillNumber (string, optional)
}
Bankhub.Models.Payments.PaymentIn {
Amount (number, optional),
Description (string, optional),
BookingId (string, optional),
ABGiro (Bankhub.Models.Payments.ABGiro, optional),
CGiro (Bankhub.Models.Payments.CGiro, optional),
PaymentClaim (Bankhub.Models.Payments.PaymentClaim, optional),
Transfer (Bankhub.Models.Payments.Transfer, optional),
Receipt (Bankhub.Models.Payments.Communication, optional)
}
Bankhub.Models.Error {
Code (string, optional),
Message (string, optional)
}
Bankhub.Models.Payments.CommunicationEMail {
EmailAddress (string, optional),
Language (string, optional)
}
Bankhub.Models.Payments.CommunicationSMS {
PhoneNumber (string, optional),
CountryCode (string, optional),
Language (string, optional)
}
{
"Id": "string",
"BatchStatus": "InProgress",
"Success": [
{
"Amount": 0,
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
},
"Description": "string",
"BookingId": "string",
"ABGiro": {
"Account": "string",
"Reference": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"CGiro": {
"Account": "string",
"AccountOwnerId": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"PaymentClaim": {
"Account": "string",
"Claimant": "string",
"PayorId": "string",
"DueDate": "2024-08-06T13:03:40.185Z",
"IsDeposit": true,
"AmountDue": 0,
"DefaultCosts": 0,
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": 0,
"NoticeAndPaymentFee": 0,
"Discount": 0,
"CategoryCode": "string"
},
"Transfer": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string"
}
}
],
"Errors": [
{
"Payment": {
"Amount": 0,
"Description": "string",
"BookingId": "string",
"ABGiro": {
"Account": "string",
"Reference": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"CGiro": {
"Account": "string",
"AccountOwnerId": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"PaymentClaim": {
"Account": "string",
"Claimant": "string",
"PayorId": "string",
"DueDate": "2024-08-06T13:03:40.185Z",
"IsDeposit": true,
"AmountDue": 0,
"DefaultCosts": 0,
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": 0,
"NoticeAndPaymentFee": 0,
"Discount": 0,
"CategoryCode": "string"
},
"Transfer": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string"
},
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
}
},
"Error": {
"Code": "string",
"Message": "string"
}
}
],
"DateOfPayment": "2024-08-06T13:03:40.185Z",
"DateOfPaymentSpecified": true
}
<?xml version="1.0"?>
<Bankhub.Models.Payments.PaymentResult>
<Id>string</Id>
<BatchStatus>InProgress</BatchStatus>
<Success>
<Amount>1.1</Amount>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
<Description>string</Description>
<BookingId>string</BookingId>
<ABGiro>
<Account>string</Account>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</ABGiro>
<CGiro>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</CGiro>
<PaymentClaim>
<Account>string</Account>
<Claimant>string</Claimant>
<PayorId>string</PayorId>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
<IsDeposit>true</IsDeposit>
<AmountDue>1.1</AmountDue>
<DefaultCosts>1.1</DefaultCosts>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>1.1</DefaultInterest>
<NoticeAndPaymentFee>1.1</NoticeAndPaymentFee>
<Discount>1.1</Discount>
<CategoryCode>string</CategoryCode>
</PaymentClaim>
<Transfer>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
</Transfer>
</Success>
<Errors>
<Payment>
<Amount>1.1</Amount>
<Description>string</Description>
<BookingId>string</BookingId>
<ABGiro>
<Account>string</Account>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</ABGiro>
<CGiro>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</CGiro>
<PaymentClaim>
<Account>string</Account>
<Claimant>string</Claimant>
<PayorId>string</PayorId>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
<IsDeposit>true</IsDeposit>
<AmountDue>1.1</AmountDue>
<DefaultCosts>1.1</DefaultCosts>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>1.1</DefaultInterest>
<NoticeAndPaymentFee>1.1</NoticeAndPaymentFee>
<Discount>1.1</Discount>
<CategoryCode>string</CategoryCode>
</PaymentClaim>
<Transfer>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
</Transfer>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
</Payment>
<Error>
<Code>string</Code>
<Message>string</Message>
</Error>
</Errors>
<DateOfPayment>1970-01-01T00:00:00.001Z</DateOfPayment>
<DateOfPaymentSpecified>true</DateOfPaymentSpecified>
</Bankhub.Models.Payments.PaymentResult>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type paymentId
The batch payment id
path string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* HEALTH
* Show/Hide
* List Operations
* Expand Operations
* * GET /BANKS/1.0/HEALTH
* Get health status of the service.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Bankhub.Models.Healthy.HealthStatus {
Status (string, optional),
Version (string, optional),
ReleaseId (string, optional),
Notes (Array[string], optional),
ServiceId (string, optional)
}
{
"Status": "string",
"Version": "string",
"ReleaseId": "string",
"Notes": [
"string"
],
"ServiceId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0"?>
<Bankhub.Models.Healthy.HealthStatus>
<Status>string</Status>
<Version>string</Version>
<ReleaseId>string</ReleaseId>
<Notes>string</Notes>
<ServiceId>00000000-0000-0000-0000-000000000000</ServiceId>
</Bankhub.Models.Healthy.HealthStatus>
Response Content Type application/json text/json application/xml text/xml
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PAYMENTS
* Show/Hide
* List Operations
* Expand Operations
* * POST /BANKS/1.0/PAYMENTS
* Perform payment batch where amount is transferred from account to:
1. Transfer to another account { or }
2. Pay claim { or }
3. Pay AB Giro { or }
4. Pay C Giro
RESPONSE CLASS (STATUS 200)
string
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type payments
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
The batch payments
body
* Model
* Example Value
Bankhub.Models.Payments.Payments {
Out (Bankhub.Models.Payments.PaymentOut, optional),
In (Array[Bankhub.Models.Payments.PaymentIn], optional),
DateOfForwardPayment (string, optional),
DateOfForwardPaymentSpecified (boolean, optional),
NameOfBatch (string, optional),
RollbackOnError (boolean, optional),
IsOneToMany (boolean, optional)
}
Bankhub.Models.Payments.PaymentOut {
Account (string, optional),
AccountOwnerId (string, optional),
CategoryCode (string, optional),
Reference (string, optional),
BillNumber (string, optional),
Receipt (Bankhub.Models.Payments.Communication, optional)
}
Bankhub.Models.Payments.PaymentIn {
Amount (number, optional),
Description (string, optional),
BookingId (string, optional),
ABGiro (Bankhub.Models.Payments.ABGiro, optional),
CGiro (Bankhub.Models.Payments.CGiro, optional),
PaymentClaim (Bankhub.Models.Payments.PaymentClaim, optional),
Transfer (Bankhub.Models.Payments.Transfer, optional),
Receipt (Bankhub.Models.Payments.Communication, optional)
}
Bankhub.Models.Payments.Communication {
EMail (Array[Bankhub.Models.Payments.CommunicationEMail], optional),
SMS (Array[Bankhub.Models.Payments.CommunicationSMS], optional)
}
Bankhub.Models.Payments.ABGiro {
Account (string, optional),
Reference (string, optional),
BillNumber (string, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.CGiro {
Account (string, optional),
AccountOwnerId (string, optional),
BillNumber (string, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.PaymentClaim {
Account (string, optional),
Claimant (string, optional),
PayorId (string, optional),
DueDate (string, optional),
IsDeposit (boolean, optional),
AmountDue (number, optional),
DefaultCosts (number, optional),
OtherCosts (number, optional),
OtherDefaultCosts (number, optional),
DefaultInterest (number, optional),
NoticeAndPaymentFee (number, optional),
Discount (number, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.Transfer {
Account (string, optional),
AccountOwnerId (string, optional),
CategoryCode (string, optional),
Reference (string, optional),
BillNumber (string, optional)
}
Bankhub.Models.Payments.CommunicationEMail {
EmailAddress (string, optional),
Language (string, optional)
}
Bankhub.Models.Payments.CommunicationSMS {
PhoneNumber (string, optional),
CountryCode (string, optional),
Language (string, optional)
}
{
"Out": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string",
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
}
},
"In": [
{
"Amount": 0,
"Description": "string",
"BookingId": "string",
"ABGiro": {
"Account": "string",
"Reference": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"CGiro": {
"Account": "string",
"AccountOwnerId": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"PaymentClaim": {
"Account": "string",
"Claimant": "string",
"PayorId": "string",
"DueDate": "2024-08-06T13:03:40.192Z",
"IsDeposit": true,
"AmountDue": 0,
"DefaultCosts": 0,
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": 0,
"NoticeAndPaymentFee": 0,
"Discount": 0,
"CategoryCode": "string"
},
"Transfer": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string"
},
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
}
}
],
"DateOfForwardPayment": "2024-08-06T13:03:40.193Z",
"DateOfForwardPaymentSpecified": true,
"NameOfBatch": "string",
"RollbackOnError": true,
"IsOneToMany": true
}
<?xml version="1.0"?>
<Bankhub.Models.Payments.Payments>
<Out>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
</Out>
<In>
<Amount>1.1</Amount>
<Description>string</Description>
<BookingId>string</BookingId>
<ABGiro>
<Account>string</Account>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</ABGiro>
<CGiro>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</CGiro>
<PaymentClaim>
<Account>string</Account>
<Claimant>string</Claimant>
<PayorId>string</PayorId>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
<IsDeposit>true</IsDeposit>
<AmountDue>1.1</AmountDue>
<DefaultCosts>1.1</DefaultCosts>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>1.1</DefaultInterest>
<NoticeAndPaymentFee>1.1</NoticeAndPaymentFee>
<Discount>1.1</Discount>
<CategoryCode>string</CategoryCode>
</PaymentClaim>
<Transfer>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
</Transfer>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
</In>
<DateOfForwardPayment>1970-01-01T00:00:00.001Z</DateOfForwardPayment>
<DateOfForwardPaymentSpecified>true</DateOfForwardPaymentSpecified>
<NameOfBatch>string</NameOfBatch>
<RollbackOnError>true</RollbackOnError>
<IsOneToMany>true</IsOneToMany>
</Bankhub.Models.Payments.Payments>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /BANKS/1.0/PAYMENTS
* Perform single payment where amount is transferred from account to:
1. Transfer to another account { or }
2. Pay claim { or }
3. Pay AB Giro { or }
4. Pay C Giro
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Bankhub.Models.Payments.PaymentResult {
Id (string, optional),
BatchStatus (string, optional) = ['InProgress', 'Completed',
'CompletedWithErrors', 'Cancelled', 'OnHold', 'NotConfirmed']
stringEnum:"InProgress", "Completed", "CompletedWithErrors", "Cancelled",
"OnHold", "NotConfirmed"
,
Success (Array[Bankhub.Models.Payments.PaymentResultDetail], optional),
Errors (Array[Bankhub.Models.Payments.PaymentError], optional),
DateOfPayment (string, optional),
DateOfPaymentSpecified (boolean, optional)
}
Bankhub.Models.Payments.PaymentResultDetail {
Amount (number, optional),
Receipt (Bankhub.Models.Payments.Communication, optional),
Description (string, optional),
BookingId (string, optional),
ABGiro (Bankhub.Models.Payments.ABGiro, optional),
CGiro (Bankhub.Models.Payments.CGiro, optional),
PaymentClaim (Bankhub.Models.Payments.PaymentClaim, optional),
Transfer (Bankhub.Models.Payments.Transfer, optional)
}
Bankhub.Models.Payments.PaymentError {
Payment (Bankhub.Models.Payments.PaymentIn, optional),
Error (Bankhub.Models.Error, optional)
}
Bankhub.Models.Payments.Communication {
EMail (Array[Bankhub.Models.Payments.CommunicationEMail], optional),
SMS (Array[Bankhub.Models.Payments.CommunicationSMS], optional)
}
Bankhub.Models.Payments.ABGiro {
Account (string, optional),
Reference (string, optional),
BillNumber (string, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.CGiro {
Account (string, optional),
AccountOwnerId (string, optional),
BillNumber (string, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.PaymentClaim {
Account (string, optional),
Claimant (string, optional),
PayorId (string, optional),
DueDate (string, optional),
IsDeposit (boolean, optional),
AmountDue (number, optional),
DefaultCosts (number, optional),
OtherCosts (number, optional),
OtherDefaultCosts (number, optional),
DefaultInterest (number, optional),
NoticeAndPaymentFee (number, optional),
Discount (number, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.Transfer {
Account (string, optional),
AccountOwnerId (string, optional),
CategoryCode (string, optional),
Reference (string, optional),
BillNumber (string, optional)
}
Bankhub.Models.Payments.PaymentIn {
Amount (number, optional),
Description (string, optional),
BookingId (string, optional),
ABGiro (Bankhub.Models.Payments.ABGiro, optional),
CGiro (Bankhub.Models.Payments.CGiro, optional),
PaymentClaim (Bankhub.Models.Payments.PaymentClaim, optional),
Transfer (Bankhub.Models.Payments.Transfer, optional),
Receipt (Bankhub.Models.Payments.Communication, optional)
}
Bankhub.Models.Error {
Code (string, optional),
Message (string, optional)
}
Bankhub.Models.Payments.CommunicationEMail {
EmailAddress (string, optional),
Language (string, optional)
}
Bankhub.Models.Payments.CommunicationSMS {
PhoneNumber (string, optional),
CountryCode (string, optional),
Language (string, optional)
}
{
"Id": "string",
"BatchStatus": "InProgress",
"Success": [
{
"Amount": 0,
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
},
"Description": "string",
"BookingId": "string",
"ABGiro": {
"Account": "string",
"Reference": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"CGiro": {
"Account": "string",
"AccountOwnerId": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"PaymentClaim": {
"Account": "string",
"Claimant": "string",
"PayorId": "string",
"DueDate": "2024-08-06T13:03:40.197Z",
"IsDeposit": true,
"AmountDue": 0,
"DefaultCosts": 0,
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": 0,
"NoticeAndPaymentFee": 0,
"Discount": 0,
"CategoryCode": "string"
},
"Transfer": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string"
}
}
],
"Errors": [
{
"Payment": {
"Amount": 0,
"Description": "string",
"BookingId": "string",
"ABGiro": {
"Account": "string",
"Reference": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"CGiro": {
"Account": "string",
"AccountOwnerId": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"PaymentClaim": {
"Account": "string",
"Claimant": "string",
"PayorId": "string",
"DueDate": "2024-08-06T13:03:40.197Z",
"IsDeposit": true,
"AmountDue": 0,
"DefaultCosts": 0,
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": 0,
"NoticeAndPaymentFee": 0,
"Discount": 0,
"CategoryCode": "string"
},
"Transfer": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string"
},
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
}
},
"Error": {
"Code": "string",
"Message": "string"
}
}
],
"DateOfPayment": "2024-08-06T13:03:40.197Z",
"DateOfPaymentSpecified": true
}
<?xml version="1.0"?>
<Bankhub.Models.Payments.PaymentResult>
<Id>string</Id>
<BatchStatus>InProgress</BatchStatus>
<Success>
<Amount>1.1</Amount>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
<Description>string</Description>
<BookingId>string</BookingId>
<ABGiro>
<Account>string</Account>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</ABGiro>
<CGiro>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</CGiro>
<PaymentClaim>
<Account>string</Account>
<Claimant>string</Claimant>
<PayorId>string</PayorId>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
<IsDeposit>true</IsDeposit>
<AmountDue>1.1</AmountDue>
<DefaultCosts>1.1</DefaultCosts>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>1.1</DefaultInterest>
<NoticeAndPaymentFee>1.1</NoticeAndPaymentFee>
<Discount>1.1</Discount>
<CategoryCode>string</CategoryCode>
</PaymentClaim>
<Transfer>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
</Transfer>
</Success>
<Errors>
<Payment>
<Amount>1.1</Amount>
<Description>string</Description>
<BookingId>string</BookingId>
<ABGiro>
<Account>string</Account>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</ABGiro>
<CGiro>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</CGiro>
<PaymentClaim>
<Account>string</Account>
<Claimant>string</Claimant>
<PayorId>string</PayorId>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
<IsDeposit>true</IsDeposit>
<AmountDue>1.1</AmountDue>
<DefaultCosts>1.1</DefaultCosts>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>1.1</DefaultInterest>
<NoticeAndPaymentFee>1.1</NoticeAndPaymentFee>
<Discount>1.1</Discount>
<CategoryCode>string</CategoryCode>
</PaymentClaim>
<Transfer>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
</Transfer>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
</Payment>
<Error>
<Code>string</Code>
<Message>string</Message>
</Error>
</Errors>
<DateOfPayment>1970-01-01T00:00:00.001Z</DateOfPayment>
<DateOfPaymentSpecified>true</DateOfPaymentSpecified>
</Bankhub.Models.Payments.PaymentResult>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type payment
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
The payment
body
* Model
* Example Value
Bankhub.Models.Payments.Payment {
In (Bankhub.Models.Payments.PaymentIn, optional),
Out (Bankhub.Models.Payments.PaymentOut, optional),
DateOfForwardPayment (string, optional),
DateOfForwardPaymentSpecified (boolean, optional)
}
Bankhub.Models.Payments.PaymentIn {
Amount (number, optional),
Description (string, optional),
BookingId (string, optional),
ABGiro (Bankhub.Models.Payments.ABGiro, optional),
CGiro (Bankhub.Models.Payments.CGiro, optional),
PaymentClaim (Bankhub.Models.Payments.PaymentClaim, optional),
Transfer (Bankhub.Models.Payments.Transfer, optional),
Receipt (Bankhub.Models.Payments.Communication, optional)
}
Bankhub.Models.Payments.PaymentOut {
Account (string, optional),
AccountOwnerId (string, optional),
CategoryCode (string, optional),
Reference (string, optional),
BillNumber (string, optional),
Receipt (Bankhub.Models.Payments.Communication, optional)
}
Bankhub.Models.Payments.ABGiro {
Account (string, optional),
Reference (string, optional),
BillNumber (string, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.CGiro {
Account (string, optional),
AccountOwnerId (string, optional),
BillNumber (string, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.PaymentClaim {
Account (string, optional),
Claimant (string, optional),
PayorId (string, optional),
DueDate (string, optional),
IsDeposit (boolean, optional),
AmountDue (number, optional),
DefaultCosts (number, optional),
OtherCosts (number, optional),
OtherDefaultCosts (number, optional),
DefaultInterest (number, optional),
NoticeAndPaymentFee (number, optional),
Discount (number, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.Transfer {
Account (string, optional),
AccountOwnerId (string, optional),
CategoryCode (string, optional),
Reference (string, optional),
BillNumber (string, optional)
}
Bankhub.Models.Payments.Communication {
EMail (Array[Bankhub.Models.Payments.CommunicationEMail], optional),
SMS (Array[Bankhub.Models.Payments.CommunicationSMS], optional)
}
Bankhub.Models.Payments.CommunicationEMail {
EmailAddress (string, optional),
Language (string, optional)
}
Bankhub.Models.Payments.CommunicationSMS {
PhoneNumber (string, optional),
CountryCode (string, optional),
Language (string, optional)
}
{
"In": {
"Amount": 0,
"Description": "string",
"BookingId": "string",
"ABGiro": {
"Account": "string",
"Reference": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"CGiro": {
"Account": "string",
"AccountOwnerId": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"PaymentClaim": {
"Account": "string",
"Claimant": "string",
"PayorId": "string",
"DueDate": "2024-08-06T13:03:40.201Z",
"IsDeposit": true,
"AmountDue": 0,
"DefaultCosts": 0,
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": 0,
"NoticeAndPaymentFee": 0,
"Discount": 0,
"CategoryCode": "string"
},
"Transfer": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string"
},
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
}
},
"Out": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string",
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
}
},
"DateOfForwardPayment": "2024-08-06T13:03:40.201Z",
"DateOfForwardPaymentSpecified": true
}
<?xml version="1.0"?>
<Bankhub.Models.Payments.Payment>
<In>
<Amount>1.1</Amount>
<Description>string</Description>
<BookingId>string</BookingId>
<ABGiro>
<Account>string</Account>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</ABGiro>
<CGiro>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</CGiro>
<PaymentClaim>
<Account>string</Account>
<Claimant>string</Claimant>
<PayorId>string</PayorId>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
<IsDeposit>true</IsDeposit>
<AmountDue>1.1</AmountDue>
<DefaultCosts>1.1</DefaultCosts>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>1.1</DefaultInterest>
<NoticeAndPaymentFee>1.1</NoticeAndPaymentFee>
<Discount>1.1</Discount>
<CategoryCode>string</CategoryCode>
</PaymentClaim>
<Transfer>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
</Transfer>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
</In>
<Out>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
</Out>
<DateOfForwardPayment>1970-01-01T00:00:00.001Z</DateOfForwardPayment>
<DateOfForwardPaymentSpecified>true</DateOfForwardPaymentSpecified>
</Bankhub.Models.Payments.Payment>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /BANKS/1.0/PAYMENT/{PAYMENTID}
* Query the status of single payment
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Bankhub.Models.Payments.PaymentResult {
Id (string, optional),
BatchStatus (string, optional) = ['InProgress', 'Completed',
'CompletedWithErrors', 'Cancelled', 'OnHold', 'NotConfirmed']
stringEnum:"InProgress", "Completed", "CompletedWithErrors", "Cancelled",
"OnHold", "NotConfirmed"
,
Success (Array[Bankhub.Models.Payments.PaymentResultDetail], optional),
Errors (Array[Bankhub.Models.Payments.PaymentError], optional),
DateOfPayment (string, optional),
DateOfPaymentSpecified (boolean, optional)
}
Bankhub.Models.Payments.PaymentResultDetail {
Amount (number, optional),
Receipt (Bankhub.Models.Payments.Communication, optional),
Description (string, optional),
BookingId (string, optional),
ABGiro (Bankhub.Models.Payments.ABGiro, optional),
CGiro (Bankhub.Models.Payments.CGiro, optional),
PaymentClaim (Bankhub.Models.Payments.PaymentClaim, optional),
Transfer (Bankhub.Models.Payments.Transfer, optional)
}
Bankhub.Models.Payments.PaymentError {
Payment (Bankhub.Models.Payments.PaymentIn, optional),
Error (Bankhub.Models.Error, optional)
}
Bankhub.Models.Payments.Communication {
EMail (Array[Bankhub.Models.Payments.CommunicationEMail], optional),
SMS (Array[Bankhub.Models.Payments.CommunicationSMS], optional)
}
Bankhub.Models.Payments.ABGiro {
Account (string, optional),
Reference (string, optional),
BillNumber (string, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.CGiro {
Account (string, optional),
AccountOwnerId (string, optional),
BillNumber (string, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.PaymentClaim {
Account (string, optional),
Claimant (string, optional),
PayorId (string, optional),
DueDate (string, optional),
IsDeposit (boolean, optional),
AmountDue (number, optional),
DefaultCosts (number, optional),
OtherCosts (number, optional),
OtherDefaultCosts (number, optional),
DefaultInterest (number, optional),
NoticeAndPaymentFee (number, optional),
Discount (number, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.Transfer {
Account (string, optional),
AccountOwnerId (string, optional),
CategoryCode (string, optional),
Reference (string, optional),
BillNumber (string, optional)
}
Bankhub.Models.Payments.PaymentIn {
Amount (number, optional),
Description (string, optional),
BookingId (string, optional),
ABGiro (Bankhub.Models.Payments.ABGiro, optional),
CGiro (Bankhub.Models.Payments.CGiro, optional),
PaymentClaim (Bankhub.Models.Payments.PaymentClaim, optional),
Transfer (Bankhub.Models.Payments.Transfer, optional),
Receipt (Bankhub.Models.Payments.Communication, optional)
}
Bankhub.Models.Error {
Code (string, optional),
Message (string, optional)
}
Bankhub.Models.Payments.CommunicationEMail {
EmailAddress (string, optional),
Language (string, optional)
}
Bankhub.Models.Payments.CommunicationSMS {
PhoneNumber (string, optional),
CountryCode (string, optional),
Language (string, optional)
}
{
"Id": "string",
"BatchStatus": "InProgress",
"Success": [
{
"Amount": 0,
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
},
"Description": "string",
"BookingId": "string",
"ABGiro": {
"Account": "string",
"Reference": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"CGiro": {
"Account": "string",
"AccountOwnerId": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"PaymentClaim": {
"Account": "string",
"Claimant": "string",
"PayorId": "string",
"DueDate": "2024-08-06T13:03:40.206Z",
"IsDeposit": true,
"AmountDue": 0,
"DefaultCosts": 0,
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": 0,
"NoticeAndPaymentFee": 0,
"Discount": 0,
"CategoryCode": "string"
},
"Transfer": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string"
}
}
],
"Errors": [
{
"Payment": {
"Amount": 0,
"Description": "string",
"BookingId": "string",
"ABGiro": {
"Account": "string",
"Reference": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"CGiro": {
"Account": "string",
"AccountOwnerId": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"PaymentClaim": {
"Account": "string",
"Claimant": "string",
"PayorId": "string",
"DueDate": "2024-08-06T13:03:40.206Z",
"IsDeposit": true,
"AmountDue": 0,
"DefaultCosts": 0,
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": 0,
"NoticeAndPaymentFee": 0,
"Discount": 0,
"CategoryCode": "string"
},
"Transfer": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string"
},
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
}
},
"Error": {
"Code": "string",
"Message": "string"
}
}
],
"DateOfPayment": "2024-08-06T13:03:40.206Z",
"DateOfPaymentSpecified": true
}
<?xml version="1.0"?>
<Bankhub.Models.Payments.PaymentResult>
<Id>string</Id>
<BatchStatus>InProgress</BatchStatus>
<Success>
<Amount>1.1</Amount>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
<Description>string</Description>
<BookingId>string</BookingId>
<ABGiro>
<Account>string</Account>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</ABGiro>
<CGiro>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</CGiro>
<PaymentClaim>
<Account>string</Account>
<Claimant>string</Claimant>
<PayorId>string</PayorId>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
<IsDeposit>true</IsDeposit>
<AmountDue>1.1</AmountDue>
<DefaultCosts>1.1</DefaultCosts>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>1.1</DefaultInterest>
<NoticeAndPaymentFee>1.1</NoticeAndPaymentFee>
<Discount>1.1</Discount>
<CategoryCode>string</CategoryCode>
</PaymentClaim>
<Transfer>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
</Transfer>
</Success>
<Errors>
<Payment>
<Amount>1.1</Amount>
<Description>string</Description>
<BookingId>string</BookingId>
<ABGiro>
<Account>string</Account>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</ABGiro>
<CGiro>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</CGiro>
<PaymentClaim>
<Account>string</Account>
<Claimant>string</Claimant>
<PayorId>string</PayorId>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
<IsDeposit>true</IsDeposit>
<AmountDue>1.1</AmountDue>
<DefaultCosts>1.1</DefaultCosts>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>1.1</DefaultInterest>
<NoticeAndPaymentFee>1.1</NoticeAndPaymentFee>
<Discount>1.1</Discount>
<CategoryCode>string</CategoryCode>
</PaymentClaim>
<Transfer>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
</Transfer>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
</Payment>
<Error>
<Code>string</Code>
<Message>string</Message>
</Error>
</Errors>
<DateOfPayment>1970-01-01T00:00:00.001Z</DateOfPayment>
<DateOfPaymentSpecified>true</DateOfPaymentSpecified>
</Bankhub.Models.Payments.PaymentResult>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type paymentId
The payment id
path string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /BANKS/1.0/PAYMENTS/{PAYMENTID}
* Query the status of the payment batch
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Bankhub.Models.Payments.PaymentResult {
Id (string, optional),
BatchStatus (string, optional) = ['InProgress', 'Completed',
'CompletedWithErrors', 'Cancelled', 'OnHold', 'NotConfirmed']
stringEnum:"InProgress", "Completed", "CompletedWithErrors", "Cancelled",
"OnHold", "NotConfirmed"
,
Success (Array[Bankhub.Models.Payments.PaymentResultDetail], optional),
Errors (Array[Bankhub.Models.Payments.PaymentError], optional),
DateOfPayment (string, optional),
DateOfPaymentSpecified (boolean, optional)
}
Bankhub.Models.Payments.PaymentResultDetail {
Amount (number, optional),
Receipt (Bankhub.Models.Payments.Communication, optional),
Description (string, optional),
BookingId (string, optional),
ABGiro (Bankhub.Models.Payments.ABGiro, optional),
CGiro (Bankhub.Models.Payments.CGiro, optional),
PaymentClaim (Bankhub.Models.Payments.PaymentClaim, optional),
Transfer (Bankhub.Models.Payments.Transfer, optional)
}
Bankhub.Models.Payments.PaymentError {
Payment (Bankhub.Models.Payments.PaymentIn, optional),
Error (Bankhub.Models.Error, optional)
}
Bankhub.Models.Payments.Communication {
EMail (Array[Bankhub.Models.Payments.CommunicationEMail], optional),
SMS (Array[Bankhub.Models.Payments.CommunicationSMS], optional)
}
Bankhub.Models.Payments.ABGiro {
Account (string, optional),
Reference (string, optional),
BillNumber (string, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.CGiro {
Account (string, optional),
AccountOwnerId (string, optional),
BillNumber (string, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.PaymentClaim {
Account (string, optional),
Claimant (string, optional),
PayorId (string, optional),
DueDate (string, optional),
IsDeposit (boolean, optional),
AmountDue (number, optional),
DefaultCosts (number, optional),
OtherCosts (number, optional),
OtherDefaultCosts (number, optional),
DefaultInterest (number, optional),
NoticeAndPaymentFee (number, optional),
Discount (number, optional),
CategoryCode (string, optional)
}
Bankhub.Models.Payments.Transfer {
Account (string, optional),
AccountOwnerId (string, optional),
CategoryCode (string, optional),
Reference (string, optional),
BillNumber (string, optional)
}
Bankhub.Models.Payments.PaymentIn {
Amount (number, optional),
Description (string, optional),
BookingId (string, optional),
ABGiro (Bankhub.Models.Payments.ABGiro, optional),
CGiro (Bankhub.Models.Payments.CGiro, optional),
PaymentClaim (Bankhub.Models.Payments.PaymentClaim, optional),
Transfer (Bankhub.Models.Payments.Transfer, optional),
Receipt (Bankhub.Models.Payments.Communication, optional)
}
Bankhub.Models.Error {
Code (string, optional),
Message (string, optional)
}
Bankhub.Models.Payments.CommunicationEMail {
EmailAddress (string, optional),
Language (string, optional)
}
Bankhub.Models.Payments.CommunicationSMS {
PhoneNumber (string, optional),
CountryCode (string, optional),
Language (string, optional)
}
{
"Id": "string",
"BatchStatus": "InProgress",
"Success": [
{
"Amount": 0,
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
},
"Description": "string",
"BookingId": "string",
"ABGiro": {
"Account": "string",
"Reference": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"CGiro": {
"Account": "string",
"AccountOwnerId": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"PaymentClaim": {
"Account": "string",
"Claimant": "string",
"PayorId": "string",
"DueDate": "2024-08-06T13:03:40.212Z",
"IsDeposit": true,
"AmountDue": 0,
"DefaultCosts": 0,
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": 0,
"NoticeAndPaymentFee": 0,
"Discount": 0,
"CategoryCode": "string"
},
"Transfer": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string"
}
}
],
"Errors": [
{
"Payment": {
"Amount": 0,
"Description": "string",
"BookingId": "string",
"ABGiro": {
"Account": "string",
"Reference": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"CGiro": {
"Account": "string",
"AccountOwnerId": "string",
"BillNumber": "string",
"CategoryCode": "string"
},
"PaymentClaim": {
"Account": "string",
"Claimant": "string",
"PayorId": "string",
"DueDate": "2024-08-06T13:03:40.212Z",
"IsDeposit": true,
"AmountDue": 0,
"DefaultCosts": 0,
"OtherCosts": 0,
"OtherDefaultCosts": 0,
"DefaultInterest": 0,
"NoticeAndPaymentFee": 0,
"Discount": 0,
"CategoryCode": "string"
},
"Transfer": {
"Account": "string",
"AccountOwnerId": "string",
"CategoryCode": "string",
"Reference": "string",
"BillNumber": "string"
},
"Receipt": {
"EMail": [
{
"EmailAddress": "string",
"Language": "string"
}
],
"SMS": [
{
"PhoneNumber": "string",
"CountryCode": "string",
"Language": "string"
}
]
}
},
"Error": {
"Code": "string",
"Message": "string"
}
}
],
"DateOfPayment": "2024-08-06T13:03:40.212Z",
"DateOfPaymentSpecified": true
}
<?xml version="1.0"?>
<Bankhub.Models.Payments.PaymentResult>
<Id>string</Id>
<BatchStatus>InProgress</BatchStatus>
<Success>
<Amount>1.1</Amount>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
<Description>string</Description>
<BookingId>string</BookingId>
<ABGiro>
<Account>string</Account>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</ABGiro>
<CGiro>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</CGiro>
<PaymentClaim>
<Account>string</Account>
<Claimant>string</Claimant>
<PayorId>string</PayorId>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
<IsDeposit>true</IsDeposit>
<AmountDue>1.1</AmountDue>
<DefaultCosts>1.1</DefaultCosts>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>1.1</DefaultInterest>
<NoticeAndPaymentFee>1.1</NoticeAndPaymentFee>
<Discount>1.1</Discount>
<CategoryCode>string</CategoryCode>
</PaymentClaim>
<Transfer>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
</Transfer>
</Success>
<Errors>
<Payment>
<Amount>1.1</Amount>
<Description>string</Description>
<BookingId>string</BookingId>
<ABGiro>
<Account>string</Account>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</ABGiro>
<CGiro>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
</CGiro>
<PaymentClaim>
<Account>string</Account>
<Claimant>string</Claimant>
<PayorId>string</PayorId>
<DueDate>1970-01-01T00:00:00.001Z</DueDate>
<IsDeposit>true</IsDeposit>
<AmountDue>1.1</AmountDue>
<DefaultCosts>1.1</DefaultCosts>
<OtherCosts>1.1</OtherCosts>
<OtherDefaultCosts>1.1</OtherDefaultCosts>
<DefaultInterest>1.1</DefaultInterest>
<NoticeAndPaymentFee>1.1</NoticeAndPaymentFee>
<Discount>1.1</Discount>
<CategoryCode>string</CategoryCode>
</PaymentClaim>
<Transfer>
<Account>string</Account>
<AccountOwnerId>string</AccountOwnerId>
<CategoryCode>string</CategoryCode>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
</Transfer>
<Receipt>
<EMail>
<EmailAddress>string</EmailAddress>
<Language>string</Language>
</EMail>
<SMS>
<PhoneNumber>string</PhoneNumber>
<CountryCode>string</CountryCode>
<Language>string</Language>
</SMS>
</Receipt>
</Payment>
<Error>
<Code>string</Code>
<Message>string</Message>
</Error>
</Errors>
<DateOfPayment>1970-01-01T00:00:00.001Z</DateOfPayment>
<DateOfPaymentSpecified>true</DateOfPaymentSpecified>
</Bankhub.Models.Payments.PaymentResult>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type paymentId path
string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* STATEMENTS
* Show/Hide
* List Operations
* Expand Operations
* * POST /BANKS/1.0/STATEMENTS
* Get transactions for a account
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Bankhub.Models.AccountStatement {
Account (string, optional),
Currency (string, optional),
Overdraft (number, optional),
Balance (number, optional),
AvailableAmount (number, optional),
Status (string, optional) = ['Open', 'Closed']
stringEnum:"Open", "Closed"
,
TotalAmountWaiting (number, optional),
IBAN (string, optional),
AccountOwnerId (string, optional),
CustomAccountName (string, optional),
AccountInformation (string, optional),
Transactions (Array[Bankhub.Models.AccountTransaction], optional),
NewTransactionIds (Array[string], optional)
}
Bankhub.Models.AccountTransaction {
TransactionId (string, optional),
TransactionDate (string, optional),
ValueDate (string, optional),
BatchNumber (string, optional),
RedeemingBank (string, optional),
Transaction (string, optional),
Reference (string, optional),
BillNumber (string, optional),
CategoryCode (string, optional),
Category (string, optional),
ReferenceDetail (string, optional),
PayorId (string, optional),
Amount (number, optional),
Balance (number, optional)
}
{
"Account": "string",
"Currency": "string",
"Overdraft": 0,
"Balance": 0,
"AvailableAmount": 0,
"Status": "Open",
"TotalAmountWaiting": 0,
"IBAN": "string",
"AccountOwnerId": "string",
"CustomAccountName": "string",
"AccountInformation": "string",
"Transactions": [
{
"TransactionId": "string",
"TransactionDate": "2024-08-06T13:03:40.217Z",
"ValueDate": "2024-08-06T13:03:40.217Z",
"BatchNumber": "string",
"RedeemingBank": "string",
"Transaction": "string",
"Reference": "string",
"BillNumber": "string",
"CategoryCode": "string",
"Category": "string",
"ReferenceDetail": "string",
"PayorId": "string",
"Amount": 0,
"Balance": 0
}
],
"NewTransactionIds": [
"string"
]
}
<?xml version="1.0"?>
<Bankhub.Models.AccountStatement>
<Account>string</Account>
<Currency>string</Currency>
<Overdraft>1.1</Overdraft>
<Balance>1.1</Balance>
<AvailableAmount>1.1</AvailableAmount>
<Status>Open</Status>
<TotalAmountWaiting>1.1</TotalAmountWaiting>
<IBAN>string</IBAN>
<AccountOwnerId>string</AccountOwnerId>
<CustomAccountName>string</CustomAccountName>
<AccountInformation>string</AccountInformation>
<Transactions>
<TransactionId>string</TransactionId>
<TransactionDate>1970-01-01T00:00:00.001Z</TransactionDate>
<ValueDate>1970-01-01T00:00:00.001Z</ValueDate>
<BatchNumber>string</BatchNumber>
<RedeemingBank>string</RedeemingBank>
<Transaction>string</Transaction>
<Reference>string</Reference>
<BillNumber>string</BillNumber>
<CategoryCode>string</CategoryCode>
<Category>string</Category>
<ReferenceDetail>string</ReferenceDetail>
<PayorId>string</PayorId>
<Amount>1.1</Amount>
<Balance>1.1</Balance>
</Transactions>
<NewTransactionIds>string</NewTransactionIds>
</Bankhub.Models.AccountStatement>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type query
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
Statement query parameters
body
* Model
* Example Value
Bankhub.Models.AccountStatementQuery {
Account (string, optional),
DateFrom (string, optional),
DateTo (string, optional),
RecordFrom (integer, optional),
RecordFromSpecified (boolean, optional),
RecordTo (integer, optional),
RecordToSpecified (boolean, optional)
}
{
"Account": "string",
"DateFrom": "2024-08-06T13:03:40.220Z",
"DateTo": "2024-08-06T13:03:40.220Z",
"RecordFrom": 0,
"RecordFromSpecified": true,
"RecordTo": 0,
"RecordToSpecified": true
}
<?xml version="1.0"?>
<Bankhub.Models.AccountStatementQuery>
<Account>string</Account>
<DateFrom>1970-01-01T00:00:00.001Z</DateFrom>
<DateTo>1970-01-01T00:00:00.001Z</DateTo>
<RecordFrom>1</RecordFrom>
<RecordFromSpecified>true</RecordFromSpecified>
<RecordTo>1</RecordTo>
<RecordToSpecified>true</RecordToSpecified>
</Bankhub.Models.AccountStatementQuery>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
[ BASE URL: , API VERSION: V1 ]