> For the complete documentation index, see [llms.txt](https://apidocs.arionbanki.is/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.arionbanki.is/business-apis/claims-api/claims-api-reference.md).

# Claims API Reference

<a href="https://openapi.gitbook.com/o/0A1P6YvuPxpINWkYJpBX/spec/auto-BAPI-claims.yaml" class="button primary" data-icon="circle-down">Download OpenAPI yaml file</a>

## Creates a batch. Batch is a list of actions defined in the body

> Accepts one of five request bodies that indicate the action type:\
> &#x20;           \
> \*\*batchCreateInitiation\*\* - Initiates a batch with a list of claims to be created.\
> &#x20;           \
> \*\*batchAlterInitiation\*\* - Initiates a batch with a list of claims to be altered.\
> &#x20;           \
> \*\*batchCancelInitiation\*\* - Initiates a batch with a list of claims to be cancelled.\
> &#x20;           \
> \*\*batchSecondaryCollectionInitiation\*\* - Initiates a batch with a list of claims to be moved to secondary collection.\
> &#x20;           \
> \*\*batchReturnSecondaryCollectionInitiation\*\* - Initiates a batch with a list of claims to be returned from secondary collection back to primary collection.\
> &#x20;           \
> Claim handling guidelines:\
> &#x20; Claim is modified by submitting the complete claim object with all intended values. Partial updates are not supported.\
> &#x20; Fields that must remain unchanged need to be included.\
> &#x20;           \
> &#x20; Recreating a previously cancelled claim must be done by calling the create operation.\
> &#x20;           \
> \> \*\*⚠️ Scope requirements\*\*\
> \>\
> \> All batch operations require the \*\*\`b2b\`\*\* scope.\
> \>\
> \> The \*\*\`returnSecondaryCollection\`\*\* action additionally requires the \*\*\`claimscollection\`\*\* scope (secondary-collection agencies only).

```json
{"openapi":"3.0.4","info":{"title":"IOBWS 3.0 Claims","version":"v3.2"},"tags":[{"name":"Batch Operations","description":"Submit and monitor batched claim actions (create, alter, cancel, secondary collection)."}],"servers":[{"url":"https://apigwsandbox.arionbanki.is/claims","description":"IOBWS 3.0 Claims API - Sandbox"},{"url":"https://apigw.arionbanki.is/claims","description":"IOBWS 3.0 Claims API - Production"}],"security":[{"oauth2":["b2b"],"SubscriptionKey":[]}],"components":{"securitySchemes":{"oauth2":{"type":"http","description":"Authorization header using the Bearer scheme. The Curity-issued OAuth2 access token, sent as `Bearer <token>`. Required on every request.\n\nToken URL: https://apigw.arionbanki.is/oauth/v2/oauth-token","scheme":"bearer"}},"schemas":{"batchAlterInitiation":{"required":["alterList"],"type":"object","allOf":[{"$ref":"#/components/schemas/batchInitiation"}],"properties":{"actionType":{"$ref":"#/components/schemas/actionType"},"alterList":{"type":"array","items":{"$ref":"#/components/schemas/alterClaimDetails"},"description":"List of claims to be altered","nullable":true}},"additionalProperties":false,"description":"Alter batch definition."},"batchInitiation":{"required":["actionType"],"type":"object","properties":{"actionType":{"type":"string"}},"additionalProperties":false,"description":"This is a Batch Initiation abstraciton used by PostBatch endpoint.","discriminator":{"propertyName":"actionType","mapping":{"alter":"#/components/schemas/batchAlterInitiation","cancel":"#/components/schemas/batchCancelInitiation","create":"#/components/schemas/batchCreateInitiation","returnSecondaryCollection":"#/components/schemas/batchReturnSecondaryCollectionInitiation","secondaryCollection":"#/components/schemas/batchSecondaryCollectionInitiation"}}},"actionType":{"enum":["create","alter","cancel","secondaryCollection","returnSecondaryCollection"],"type":"string","description":"The type of batch action to perform."},"alterClaimDetails":{"required":["amount","claimKey","expirationDate","finalDueDate","templateCode"],"type":"object","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"expirationDate":{"type":"string","format":"date-time"},"templateCode":{"minLength":1,"pattern":"[0-9A-Z]{3}","type":"string","description":"Claim template identifier."},"amount":{"type":"number","format":"double"},"finalDueDate":{"type":"string","format":"date-time"},"reference":{"maxLength":16,"type":"string","description":"Reference number determined by creditors.","nullable":true},"billNumber":{"maxLength":7,"type":"string","description":"7-character reference id set by claimant. This ID will be visible on the payer's account statement","nullable":true},"customerNumber":{"maxLength":16,"type":"string","description":"16-character reference id set by claimant. Payer's transaction number. Unique key to the payer of the claim with the creditor. Necessary if a direct payment agreement is to be established","nullable":true},"paymentFee":{"$ref":"#/components/schemas/paymentFee"},"otherCostsAmount":{"type":"number","format":"double","nullable":true},"otherDefaultCostsAmount":{"type":"number","format":"double","nullable":true},"defaultCharge":{"$ref":"#/components/schemas/defaultCharge"},"defaultInterest":{"$ref":"#/components/schemas/defaultInterest"},"discount":{"$ref":"#/components/schemas/discount"},"isOutOfSequencePaymentAllowed":{"type":"boolean","nullable":true},"isPartialPaymentAllowed":{"type":"boolean","nullable":true},"currency":{"pattern":"[A-Z]{3}","type":"string","nullable":true},"additionalInformation":{"maxLength":200,"type":"string","nullable":true},"claimStatus":{"$ref":"#/components/schemas/claimStatus"},"collectionStatus":{"$ref":"#/components/schemas/collectionStatus"},"printing":{"$ref":"#/components/schemas/printing"}},"additionalProperties":false,"description":"Full replacement object for batch alter operations.\nUsage:\n  - Client fetches the current claim, updates one or more values (e.g. amount, finalDueDate, expirationDate), and submits the full object.\n  - All required fields MUST be present.\n  - Optional fields that are omitted are treated as intentionally cleared (removed/reset) if allowed by business rules. To avoid accidental clearing always send the full current state.\nNotes:\n  - claimKey identifies the claim and cannot change.\n  - Fields not listed as required may still be mandatory under specific business rules (validation occurs server-side).\n  - If a field cannot be cleared but is omitted, the server may reject the request."},"claimKey":{"required":["account","claimantId","dueDate"],"type":"object","properties":{"claimantId":{"minLength":1,"pattern":"[0-9]{10}","type":"string","description":"Icelandic Id number (kennitala)."},"account":{"minLength":1,"pattern":"[0-9]{12}","type":"string","description":"Bank number, ledger and number.\nFor claims ledger is 66 followed by claim number"},"dueDate":{"type":"string","description":"Due date","format":"date-time"}},"additionalProperties":false,"description":"Claim key is a composite key of kennitala, account and due date."},"paymentFee":{"required":["paperlessFee","printingFee"],"type":"object","properties":{"printingFee":{"type":"number","description":"A fee that is applied if the claim is printed.","format":"double"},"paperlessFee":{"type":"number","description":"A fee that is applied if the claim is paperless. This fee applies to payors who have opted out of receiving printed letters and to direct debit claims.","format":"double"}},"additionalProperties":false,"description":"Additional fee that adds to the claim amount."},"defaultCharge":{"required":["referenceDate"],"type":"object","properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}},"additionalProperties":false,"description":"Default charges configuration. Defines day offsets from the reference date and whether each charge is percentage-based or a fixed amount. For discounts, the amount is calculated from totalAmount. For defaultCharge, the charge amount is calculated from claimAmount."},"referenceDate":{"enum":["DueDate","FinalDueDate"],"type":"string","description":"Specifies the reference date for calculations, allowing the choice between the DueDate and the FinalDueDate as the basis."},"dayAmountItem":{"required":["chargeType","day","value"],"type":"object","properties":{"chargeType":{"$ref":"#/components/schemas/chargeType"},"day":{"maximum":99,"minimum":0,"type":"integer","format":"int32"},"value":{"type":"number","format":"double"}},"additionalProperties":false,"description":"For whether to use fixed amount or calculate by percentage from claimAmount when calculating discount or charge."},"chargeType":{"enum":["Percentage","Amount"],"type":"string"},"defaultInterest":{"required":["referenceDate"],"type":"object","properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"baseAmountType":{"$ref":"#/components/schemas/baseAmountType"},"baseTimeType":{"$ref":"#/components/schemas/baseTimeType"},"percentage":{"type":"number","description":"Indicates the percentage of default interest. If this parameter is not specified or is set to \"0\", the Central Bank's maximum default interest rate is used. Percentage range is between 0 - 100","format":"double","nullable":true}},"additionalProperties":false,"description":"Contains information on how default interest is calculated.\nIf claim should not have default interest, do not send in this object or send it in as \"null\"."},"baseAmountType":{"enum":["Amount","AmountAndDefaultCharge"],"type":"string","description":"Indicates the amount by which the default interest is calculated.\n- Amount: Default interest is calculated on the basis of the amount of the claim.\n- AmountAndDefaultCharge: Default interest is calculated on the basis of the amount and arrears of the claim."},"baseTimeType":{"enum":["Daily","360","Calendar"],"type":"string","description":"Indicates at what time the basis of default interest is calculated. Time = (number of days/time basis)\n- Daily: Daily interest. Time is used = (number of days / 1), Only for the state.\n- 360: Annual interest rate where the year is calculated as 360 days. Time is used = (number of days / 360).\n- Calendar: Annual interest where the year is calculated with calendar days. Time = is used (number of days / calendar days)."},"discount":{"required":["referenceDate"],"type":"object","properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}},"additionalProperties":false,"description":"Contains detail information about claim discount"},"claimStatus":{"enum":["Unpaid","Paid","Cancelled"],"type":"string","description":"Claim status"},"collectionStatus":{"enum":["PrimaryCollection","SecondaryCollection","LegalCollection"],"type":"string","description":"Claim billing process status."},"printing":{"type":"object","properties":{"payorAddress":{"$ref":"#/components/schemas/address"},"itemRows":{"type":"array","items":{"$ref":"#/components/schemas/itemRow"},"description":"Contains information on the breakdown of the collection claim.","nullable":true},"comments":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"description":"Contains information if a collection claim is printed at a bank / savings bank to manage the printout of the collection claim. Changing a printout to a change entry after printing a note does not result in it being reprinted"},"address":{"required":["addressLine","city","country","name","postalCode"],"type":"object","properties":{"name":{"minLength":1,"type":"string"},"addressLine":{"minLength":1,"type":"string"},"postalCode":{"minLength":1,"type":"string"},"city":{"minLength":1,"type":"string"},"country":{"minLength":1,"pattern":"[A-Z]{2}","type":"string"}},"additionalProperties":false,"description":"Address or legal address of a legal entity"},"itemRow":{"type":"object","properties":{"text":{"type":"string","nullable":true},"amount":{"type":"number","format":"double","nullable":true}},"additionalProperties":false,"description":"Contains information on the breakdown of the collection claim."},"batchCancelInitiation":{"required":["cancelList"],"type":"object","allOf":[{"$ref":"#/components/schemas/batchInitiation"}],"properties":{"actionType":{"$ref":"#/components/schemas/actionType"},"cancelList":{"type":"array","items":{"$ref":"#/components/schemas/claimKey"},"description":"List of claims to be cancelled. Each array item is the composite claimKey (claimantId, account, dueDate). Only identification data is supplied.","nullable":true}},"additionalProperties":false,"description":"Cancel batch definition."},"batchCreateInitiation":{"required":["createList"],"type":"object","allOf":[{"$ref":"#/components/schemas/batchInitiation"}],"properties":{"actionType":{"$ref":"#/components/schemas/actionType"},"createList":{"type":"array","items":{"$ref":"#/components/schemas/createClaimDetails"},"description":"List of claims to be created","nullable":true}},"additionalProperties":false,"description":"This is the request body for batch create endpoint. It contains the list of claims to be created."},"createClaimDetails":{"required":["amount","claimKey","expirationDate","finalDueDate","payorId","templateCode"],"type":"object","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"payorId":{"minLength":1,"pattern":"[0-9]{10}","type":"string","description":"PayorId is the Icelandic kennitala for the payor."},"expirationDate":{"type":"string","format":"date-time"},"templateCode":{"minLength":1,"pattern":"[0-9A-Z]{3}","type":"string","description":"Claim template identifier."},"amount":{"type":"number","format":"double"},"finalDueDate":{"type":"string","format":"date-time"},"reference":{"maxLength":16,"type":"string","description":"Reference number determined by creditors.","nullable":true},"billNumber":{"maxLength":7,"type":"string","description":"7-character reference id set by claimant. This ID will be visible on the payer's account statement","nullable":true},"customerNumber":{"maxLength":16,"type":"string","description":"16-character reference id set by claimant. Payer's transaction number. Unique key to the payer of the  claim with the creditor. Necessary if a direct payment agreement is to be established","nullable":true},"paymentFee":{"$ref":"#/components/schemas/paymentFee"},"otherCostsAmount":{"type":"number","description":"Other costs, including determined fees paid by the payer of a collection claim.","format":"double","nullable":true},"otherDefaultCostsAmount":{"type":"number","description":"Determined fees, e.g. intermediate collection fee.","format":"double","nullable":true},"defaultCharge":{"$ref":"#/components/schemas/defaultCharge"},"defaultInterest":{"$ref":"#/components/schemas/defaultInterest"},"discount":{"$ref":"#/components/schemas/discount"},"isOutOfSequencePaymentAllowed":{"type":"boolean","description":"Payment rule, is it allowed to pay the last payment if previous has not been paid","nullable":true},"isPartialPaymentAllowed":{"type":"boolean","nullable":true},"currency":{"pattern":"[A-Z]{3}","type":"string","nullable":true},"additionalInformation":{"maxLength":200,"type":"string","description":"Free text that will be displayed on the claim","nullable":true},"printing":{"$ref":"#/components/schemas/printing"},"claimType":{"$ref":"#/components/schemas/claimType"}},"additionalProperties":false,"description":"Create claim object"},"claimType":{"enum":["NormalClaim","OptionalPaymentClaim","RefundClaim","BalanceClaim"],"type":"string","description":"The type of the claim which is to be created.\n  - NormalClaim: A regular claim.\n  - OptionalPaymentClaim: An optional payment claim.\n  - RefundClaim: A refund claim.\n  - BalanceClaim: A government balance claim (only for government entities)."},"batchReturnSecondaryCollectionInitiation":{"required":["secondaryCollectionList"],"type":"object","allOf":[{"$ref":"#/components/schemas/batchInitiation"}],"properties":{"actionType":{"$ref":"#/components/schemas/actionType"},"secondaryCollectionList":{"type":"array","items":{"$ref":"#/components/schemas/secondaryCollection"},"description":"List of items to return from secondary collection.","nullable":true}},"additionalProperties":false,"description":"Return batch of claims from Secondary Collection."},"secondaryCollection":{"required":["claimKey"],"type":"object","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"templateCode":{"pattern":"[0-9A-Z]{3}","type":"string","description":"Claim template identifier.","nullable":true},"otherDefaultCostsAmount":{"type":"number","description":"Additional other default costs to apply when moving to secondary collection.","format":"double","nullable":true}},"additionalProperties":false,"description":"This object represents one claim that is being sent to secondary collection.\n- claimKey: identifies the claim (required)\n- templateCode: optional target secondary collection template (overrides default if supplied)\n- otherDefaultCostsAmount: optional additional other default costs applied during transfer"},"batchSecondaryCollectionInitiation":{"required":["secondaryCollectionList"],"type":"object","allOf":[{"$ref":"#/components/schemas/batchInitiation"}],"properties":{"actionType":{"$ref":"#/components/schemas/actionType"},"secondaryCollectionList":{"type":"array","items":{"$ref":"#/components/schemas/secondaryCollection"},"description":"List of items to move to secondary collection.","nullable":true}},"additionalProperties":false,"description":"Send batch of claims to Secondary Collection."},"batchStatus":{"type":"object","properties":{"batchId":{"maxLength":36,"minLength":36,"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string","description":"Batch identifier for a list of claims","nullable":true},"success":{"type":"integer","description":"Number of successful items processed","format":"int32","nullable":true},"failed":{"type":"integer","description":"Number of failed items","format":"int32","nullable":true},"pending":{"type":"integer","description":"Number of waiting claims","format":"int32","nullable":true},"actionType":{"$ref":"#/components/schemas/actionType"},"actions":{"$ref":"#/components/schemas/claimStatusResponse"}},"additionalProperties":false,"description":"Status of a batch initiation. success + failed + pending should equal the total number of submitted items."},"claimStatusResponse":{"type":"object","properties":{"successes":{"type":"array","items":{"$ref":"#/components/schemas/claimStatusSuccess"},"nullable":true},"errors":{"type":"array","items":{"$ref":"#/components/schemas/claimStatusError"},"nullable":true}},"additionalProperties":false,"description":"Batch status object."},"claimStatusSuccess":{"type":"object","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"claimId":{"type":"string","description":"ClaimId is a composite string key for a claim made of kennitala, account and due date\n  - ClaimantId\n  - Branch number\n  - 66\n  - Claim no\n  - +\n  - Date in the form of YYYYMMDD","nullable":true},"directPaymentClaim":{"type":"boolean","nullable":true},"print":{"type":"boolean","nullable":true}},"additionalProperties":false,"description":"Success status item."},"claimStatusError":{"type":"object","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"claimId":{"type":"string","description":"ClaimId is a composite string key for a claim made of kennitala, account and due date\n  - ClaimantId\n  - Branch number\n  - 66\n  - Claim no\n  - +\n  - Date in the form of YYYYMMDD","nullable":true},"resultCode":{"$ref":"#/components/schemas/resultCode"},"resultSubCode":{"type":"string","nullable":true},"resultMessage":{"type":"string","nullable":true}},"additionalProperties":false,"description":"Error status item."},"resultCode":{"enum":["CLAIM_EXISTS","CLAIM_IS_PAID","CLAIM_NOT_FOUND","CLAIM_IS_CANCELLED","CLAIM_NOT_IN_SECONDARY_STATE","CLAIM_OTHERS"],"type":"string"},"errorResponse":{"required":["code","type"],"type":"object","properties":{"type":{"maxLength":70,"minLength":1,"type":"string","description":"A URI reference [RFC3986] that identifies the problem type."},"title":{"maxLength":70,"type":"string","description":"Short human readable description of error type. Could be in local language. To be provided by ASPSPs.","nullable":true},"detail":{"maxLength":500,"type":"string","description":"Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.","nullable":true},"code":{"minLength":1,"type":"string","description":"Error code as a string to support different error code types."},"additionalErrors":{"type":"array","items":{"$ref":"#/components/schemas/additionalError"},"description":"Array of Error Information Blocks. Might be used if more than one error is to be communicated.","nullable":true}},"additionalProperties":false,"description":"Standardised definition of reporting error information according to [RFC7807]."},"additionalError":{"required":["code"],"type":"object","properties":{"title":{"maxLength":70,"type":"string","description":"Short human readable description of error type. Could be in local language.","nullable":true},"detail":{"maxLength":500,"type":"string","description":"Detailed human readable text specific to this instance of the error.","nullable":true},"code":{"minLength":1,"type":"string","description":"Error code as a string to support different error code types."}},"additionalProperties":false,"description":"A data element to support the declaration of additional errors in the context of [RFC7807]."},"problemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"httpValidationProblemDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/problemDetails"}],"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"nullable":true}},"additionalProperties":{}}}},"paths":{"/api/v1/batches":{"post":{"tags":["Batch Operations"],"summary":"Creates a batch. Batch is a list of actions defined in the body","description":"Accepts one of five request bodies that indicate the action type:\n            \n**batchCreateInitiation** - Initiates a batch with a list of claims to be created.\n            \n**batchAlterInitiation** - Initiates a batch with a list of claims to be altered.\n            \n**batchCancelInitiation** - Initiates a batch with a list of claims to be cancelled.\n            \n**batchSecondaryCollectionInitiation** - Initiates a batch with a list of claims to be moved to secondary collection.\n            \n**batchReturnSecondaryCollectionInitiation** - Initiates a batch with a list of claims to be returned from secondary collection back to primary collection.\n            \nClaim handling guidelines:\n  Claim is modified by submitting the complete claim object with all intended values. Partial updates are not supported.\n  Fields that must remain unchanged need to be included.\n            \n  Recreating a previously cancelled claim must be done by calling the create operation.\n            \n> **⚠️ Scope requirements**\n>\n> All batch operations require the **`b2b`** scope.\n>\n> The **`returnSecondaryCollection`** action additionally requires the **`claimscollection`** scope (secondary-collection agencies only).","operationId":"PostBatch","parameters":[{"name":"X-Request-ID","in":"header","description":"Unique value generated by the client which the resource server uses to recognize subsequent retries of the same request.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Idempotency-Key","in":"header","description":"Idempotency key.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"JSON request body for a list of create or alter actions initiation request message","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/batchAlterInitiation"},{"$ref":"#/components/schemas/batchCancelInitiation"},{"$ref":"#/components/schemas/batchCreateInitiation"},{"$ref":"#/components/schemas/batchReturnSecondaryCollectionInitiation"},{"$ref":"#/components/schemas/batchSecondaryCollectionInitiation"}],"description":"This is a Batch Initiation abstraciton used by PostBatch endpoint.","discriminator":{"propertyName":"actionType","mapping":{"alter":"#/components/schemas/batchAlterInitiation","cancel":"#/components/schemas/batchCancelInitiation","create":"#/components/schemas/batchCreateInitiation","returnSecondaryCollection":"#/components/schemas/batchReturnSecondaryCollectionInitiation","secondaryCollection":"#/components/schemas/batchSecondaryCollectionInitiation"}}}}},"required":true},"responses":{"201":{"description":"Batch created","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/batchStatus"}}}},"400":{"description":"Bad Request","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"401":{"description":"Unauthorized","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"403":{"description":"Forbidden","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"404":{"description":"Not found","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"405":{"description":"Method Not Allowed","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"408":{"description":"Request Timeout","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/problemDetails"},{"$ref":"#/components/schemas/httpValidationProblemDetails"}]}}}},"415":{"description":"Unsupported Media Type","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/problemDetails"},{"$ref":"#/components/schemas/httpValidationProblemDetails"}]}}}},"500":{"description":"Internal Server Error","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}}},"503":{"description":"Service Unavailable","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}}}}}}}}
```

## Get a status of previously created batch

> Get status of a batch. The status contains number of claims processed under the following categories:\
> \- Success: Number of successful processed claims\
> \- Failed: Number of failed claims\
> \- Pending: Number of waiting claims

```json
{"openapi":"3.0.4","info":{"title":"IOBWS 3.0 Claims","version":"v3.2"},"tags":[{"name":"Batch Operations","description":"Submit and monitor batched claim actions (create, alter, cancel, secondary collection)."}],"servers":[{"url":"https://apigwsandbox.arionbanki.is/claims","description":"IOBWS 3.0 Claims API - Sandbox"},{"url":"https://apigw.arionbanki.is/claims","description":"IOBWS 3.0 Claims API - Production"}],"security":[{"oauth2":["b2b"],"SubscriptionKey":[]}],"components":{"securitySchemes":{"oauth2":{"type":"http","description":"Authorization header using the Bearer scheme. The Curity-issued OAuth2 access token, sent as `Bearer <token>`. Required on every request.\n\nToken URL: https://apigw.arionbanki.is/oauth/v2/oauth-token","scheme":"bearer"}},"schemas":{"batchStatus":{"type":"object","properties":{"batchId":{"maxLength":36,"minLength":36,"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string","description":"Batch identifier for a list of claims","nullable":true},"success":{"type":"integer","description":"Number of successful items processed","format":"int32","nullable":true},"failed":{"type":"integer","description":"Number of failed items","format":"int32","nullable":true},"pending":{"type":"integer","description":"Number of waiting claims","format":"int32","nullable":true},"actionType":{"$ref":"#/components/schemas/actionType"},"actions":{"$ref":"#/components/schemas/claimStatusResponse"}},"additionalProperties":false,"description":"Status of a batch initiation. success + failed + pending should equal the total number of submitted items."},"actionType":{"enum":["create","alter","cancel","secondaryCollection","returnSecondaryCollection"],"type":"string","description":"The type of batch action to perform."},"claimStatusResponse":{"type":"object","properties":{"successes":{"type":"array","items":{"$ref":"#/components/schemas/claimStatusSuccess"},"nullable":true},"errors":{"type":"array","items":{"$ref":"#/components/schemas/claimStatusError"},"nullable":true}},"additionalProperties":false,"description":"Batch status object."},"claimStatusSuccess":{"type":"object","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"claimId":{"type":"string","description":"ClaimId is a composite string key for a claim made of kennitala, account and due date\n  - ClaimantId\n  - Branch number\n  - 66\n  - Claim no\n  - +\n  - Date in the form of YYYYMMDD","nullable":true},"directPaymentClaim":{"type":"boolean","nullable":true},"print":{"type":"boolean","nullable":true}},"additionalProperties":false,"description":"Success status item."},"claimKey":{"required":["account","claimantId","dueDate"],"type":"object","properties":{"claimantId":{"minLength":1,"pattern":"[0-9]{10}","type":"string","description":"Icelandic Id number (kennitala)."},"account":{"minLength":1,"pattern":"[0-9]{12}","type":"string","description":"Bank number, ledger and number.\nFor claims ledger is 66 followed by claim number"},"dueDate":{"type":"string","description":"Due date","format":"date-time"}},"additionalProperties":false,"description":"Claim key is a composite key of kennitala, account and due date."},"claimStatusError":{"type":"object","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"claimId":{"type":"string","description":"ClaimId is a composite string key for a claim made of kennitala, account and due date\n  - ClaimantId\n  - Branch number\n  - 66\n  - Claim no\n  - +\n  - Date in the form of YYYYMMDD","nullable":true},"resultCode":{"$ref":"#/components/schemas/resultCode"},"resultSubCode":{"type":"string","nullable":true},"resultMessage":{"type":"string","nullable":true}},"additionalProperties":false,"description":"Error status item."},"resultCode":{"enum":["CLAIM_EXISTS","CLAIM_IS_PAID","CLAIM_NOT_FOUND","CLAIM_IS_CANCELLED","CLAIM_NOT_IN_SECONDARY_STATE","CLAIM_OTHERS"],"type":"string"},"errorResponse":{"required":["code","type"],"type":"object","properties":{"type":{"maxLength":70,"minLength":1,"type":"string","description":"A URI reference [RFC3986] that identifies the problem type."},"title":{"maxLength":70,"type":"string","description":"Short human readable description of error type. Could be in local language. To be provided by ASPSPs.","nullable":true},"detail":{"maxLength":500,"type":"string","description":"Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.","nullable":true},"code":{"minLength":1,"type":"string","description":"Error code as a string to support different error code types."},"additionalErrors":{"type":"array","items":{"$ref":"#/components/schemas/additionalError"},"description":"Array of Error Information Blocks. Might be used if more than one error is to be communicated.","nullable":true}},"additionalProperties":false,"description":"Standardised definition of reporting error information according to [RFC7807]."},"additionalError":{"required":["code"],"type":"object","properties":{"title":{"maxLength":70,"type":"string","description":"Short human readable description of error type. Could be in local language.","nullable":true},"detail":{"maxLength":500,"type":"string","description":"Detailed human readable text specific to this instance of the error.","nullable":true},"code":{"minLength":1,"type":"string","description":"Error code as a string to support different error code types."}},"additionalProperties":false,"description":"A data element to support the declaration of additional errors in the context of [RFC7807]."},"problemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"httpValidationProblemDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/problemDetails"}],"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"nullable":true}},"additionalProperties":{}}}},"paths":{"/api/v1/batches/{batchId}":{"get":{"tags":["Batch Operations"],"summary":"Get a status of previously created batch","description":"Get status of a batch. The status contains number of claims processed under the following categories:\n- Success: Number of successful processed claims\n- Failed: Number of failed claims\n- Pending: Number of waiting claims","operationId":"GetBatchStatus","parameters":[{"name":"batchId","in":"path","description":"Unique identifier for a batch of claims","required":true,"schema":{"type":"string"}},{"name":"X-Request-ID","in":"header","description":"Unique value generated by the client which the resource server uses to recognize subsequent retries of the same request.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"itemsPerPage","in":"query","description":"Number of displayed items. Maximum is 500.","schema":{"maximum":500,"minimum":1,"type":"integer","format":"int32","default":500}},{"name":"page","in":"query","description":"Page number in the result","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32","default":1}}],"responses":{"200":{"description":"Batch created","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/batchStatus"}}}},"400":{"description":"Bad Request","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"401":{"description":"Unauthorized","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"403":{"description":"Forbidden","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"404":{"description":"Not found","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"405":{"description":"Method Not Allowed","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"408":{"description":"Request Timeout","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/problemDetails"},{"$ref":"#/components/schemas/httpValidationProblemDetails"}]}}}},"415":{"description":"Unsupported Media Type","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/problemDetails"},{"$ref":"#/components/schemas/httpValidationProblemDetails"}]}}}},"500":{"description":"Internal Server Error","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}}},"503":{"description":"Service Unavailable","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}}}}}}}}
```

## Get a single claim template.

> Returns one claim template identified by templateId.

```json
{"openapi":"3.0.4","info":{"title":"IOBWS 3.0 Claims","version":"v3.2"},"tags":[{"name":"Claim Templates","description":"Discover and inspect claim templates."}],"servers":[{"url":"https://apigwsandbox.arionbanki.is/claims","description":"IOBWS 3.0 Claims API - Sandbox"},{"url":"https://apigw.arionbanki.is/claims","description":"IOBWS 3.0 Claims API - Production"}],"security":[{"oauth2":["b2b"],"SubscriptionKey":[]}],"components":{"securitySchemes":{"oauth2":{"type":"http","description":"Authorization header using the Bearer scheme. The Curity-issued OAuth2 access token, sent as `Bearer <token>`. Required on every request.\n\nToken URL: https://apigw.arionbanki.is/oauth/v2/oauth-token","scheme":"bearer"}},"schemas":{"templateDetails":{"type":"object","properties":{"templateId":{"type":"string","description":"Unique Id for each template. This is specific to each bank.","nullable":true},"claimantId":{"pattern":"[0-9]{10}","type":"string","description":"ClaimantId is the Icelandic kennitala for the claimant.","nullable":true},"bank":{"pattern":"[0-9]{4}","type":"string","description":"Icelandic branch number.","nullable":true},"templateCode":{"pattern":"[0-9A-Z]{3}","type":"string","description":"Claim template identifier.","nullable":true},"collectionType":{"$ref":"#/components/schemas/collectionType"},"category":{"$ref":"#/components/schemas/claimTemplateCategory"},"claimantStatementExtendedReferenceType":{"$ref":"#/components/schemas/claimantStatementExtendedReferenceType"},"customerNumberTemplate":{"maxLength":16,"type":"string","description":"Describes how the transaction number template is structured for the claim template.","nullable":true},"claimantStatementReferenceType":{"$ref":"#/components/schemas/claimantStatementReferenceType"},"depositAccount":{"$ref":"#/components/schemas/depositAccount"},"secondaryCollectionTemplateCode":{"pattern":"[0-9A-Za-z]{3}","type":"string","description":"ID of a collection claim template to which claims are transferred.","nullable":true},"withdrawalAccount":{"pattern":"[0-9]{12}","type":"string","description":"Bank number, ledger and number. For claims ledger is 66 followed by claim number.","nullable":true},"additionalDepositAccounts":{"type":"array","items":{"$ref":"#/components/schemas/depositAccountWithDetails"},"description":"Additional disposition accounts used to dispose of fees, costs or part of the payment of the claim. There can be a maximum of 98 accounts for each identifier.","nullable":true},"isActive":{"type":"boolean","description":"Indicates whether the template is currently active.","nullable":true},"settings":{"$ref":"#/components/schemas/claimTemplateSettings"}},"additionalProperties":false,"description":"Claim template details."},"collectionType":{"enum":["PrimaryCollection","SecondaryCollection"],"type":"string","description":"Collection type of the claim template."},"claimTemplateCategory":{"required":["code"],"type":"object","properties":{"code":{"maxLength":2,"minLength":2,"type":"string","description":"Two-character category code."},"name":{"maxLength":30,"type":"string","description":"Category name.","nullable":true}},"additionalProperties":false,"description":""},"claimantStatementExtendedReferenceType":{"enum":["ReferenceNumber","CustomerNumber","ClaimId","PayorId","DueDate"],"type":"string","description":"Indicates which value appears in the reference area of the creditor's account statement.\nThis can be one of the following values:\n- ReferenceNumber - The first 12 letters of the reference number.\n- CustomerNumber - The first 12 letters of the transaction number.\n- ClaimId - Branch number, ledger and claim number.\n- PayorId - Id (kennitala) of the payor\n- DueDate - Due date of the claim in the format (yyyymmdd)"},"claimantStatementReferenceType":{"enum":["DueDate","BillNumber","ClaimNumber"],"type":"string","description":"Indicates which value appears in the bill area on the creditor's account statement.\nThis can be one of the following values:\n- DueDate - Due date of the claim in the format (yyyymmdd)\n- BillNumber - Bill number of the claim\n- ClaimNumber - Claimnumber (last 6 digits)"},"depositAccount":{"type":"object","properties":{"id":{"pattern":"[0-9]{12}","type":"string","description":"Bank number, ledger and number. For claims ledger is 66 followed by claim number.","nullable":true},"ownerId":{"pattern":"[0-9]{10}","type":"string","description":"Icelandic Id number (kennitala).","nullable":true}},"additionalProperties":false,"description":"Information on the main disposal account."},"depositAccountWithDetails":{"type":"object","properties":{"id":{"pattern":"[0-9]{12}","type":"string","description":"Bank number, ledger and number. For claims ledger is 66 followed by claim number.","nullable":true},"ownerId":{"pattern":"[0-9]{10}","type":"string","description":"Icelandic Id number (kennitala).","nullable":true},"type":{"$ref":"#/components/schemas/type"},"priority":{"type":"integer","description":"Priority controls in which order the additional deposit is executed","format":"int32","nullable":true},"depositAmount":{"$ref":"#/components/schemas/depositAccountAmount"}},"additionalProperties":false,"description":"Additional disposition invoices. Used to dispose of fees, costs or part of the payment of the claim. There can be a maximum of 98 accounts for each identifier."},"type":{"enum":["DefaultInterest","DefaultCharge","OtherDefaultCosts","AllDefaultCharges","OtherCosts","NoticeAndPaymentFee","AllCosts","FixedAmount","Percentage","PrincipalDetail"],"type":"string","description":"Describes what type of additional deposit account this is.\n- \"DefaultInterest\" - Default interest.\n- \"DefaultCharge\" - Default cost.\n- \"OtherDefaultCosts\" - Other default costs.\n- \"AllDefaultCharges\" - All default costs.\n- \"OtherCosts\" - Other costs.\n- \"NoticeAndPaymentFee\" - Notification fee.\n- \"AllCosts\" - All costs and fees imposed on the claim.\n- \"FixedAmount\" - A fixed amount is deducted from the amount of the payment and deposited in a disposable account.\n- \"Percentage\" - Percentage of the amount of the payment deposited in the disposable account.\n- \"PrincipalDetail\" - Amount of the principal of the payment deposited in a disposable account."},"depositAccountAmount":{"type":"object","properties":{"value":{"type":"number","format":"double","nullable":true},"valueType":{"$ref":"#/components/schemas/valueType"}},"additionalProperties":false,"description":"Describes what kind of deposit this is (percentage based or fixed amount)"},"valueType":{"enum":["FixedAmount","Percentage"],"type":"string"},"claimTemplateSettings":{"type":"object","properties":{"amount":{"type":"number","description":"Default claim amount.","format":"double","nullable":true},"reference":{"maxLength":16,"type":"string","description":"Reference number determined by creditors.","nullable":true},"defaultInterest":{"$ref":"#/components/schemas/defaultInterest"},"defaultCharge":{"$ref":"#/components/schemas/defaultCharge"},"paymentFee":{"$ref":"#/components/schemas/paymentFee"},"discount":{"$ref":"#/components/schemas/discount"},"otherCostsAmount":{"type":"number","description":"Default other costs (added to claim).","format":"double","nullable":true},"otherDefaultCostsAmount":{"type":"number","description":"Default other default costs (e.g. intermediate collection fee).","format":"double","nullable":true},"currency":{"pattern":"[A-Z]{3}","type":"string","description":"Default ISO 4217 currency code.","nullable":true},"isOutOfSequencePaymentAllowed":{"type":"boolean","description":"Payment rule, allow paying later installments before earlier ones.","nullable":true},"isPartialPaymentAllowed":{"type":"boolean","description":"Partial payment is allowed.","nullable":true},"claimType":{"$ref":"#/components/schemas/claimType"},"billNumber":{"maxLength":7,"type":"string","description":"7 character bill number shown on payer account statement.","nullable":true},"dueDateRule":{"$ref":"#/components/schemas/dateRuleDayOfMonth"},"finalDueDateRule":{"$ref":"#/components/schemas/dateRuleNumberOfDays"},"cancellationDateRule":{"$ref":"#/components/schemas/dateRuleNumberOfDays"}},"additionalProperties":false,"description":"Default claim settings applied when creating claims for this template.  Individual claims may override these values where the claim schema permits. Note that these settings are not automatically set for claims created on templates, they still need to be set for each claims."},"defaultInterest":{"required":["referenceDate"],"type":"object","properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"baseAmountType":{"$ref":"#/components/schemas/baseAmountType"},"baseTimeType":{"$ref":"#/components/schemas/baseTimeType"},"percentage":{"type":"number","description":"Indicates the percentage of default interest. If this parameter is not specified or is set to \"0\", the Central Bank's maximum default interest rate is used. Percentage range is between 0 - 100","format":"double","nullable":true}},"additionalProperties":false,"description":"Contains information on how default interest is calculated.\nIf claim should not have default interest, do not send in this object or send it in as \"null\"."},"referenceDate":{"enum":["DueDate","FinalDueDate"],"type":"string","description":"Specifies the reference date for calculations, allowing the choice between the DueDate and the FinalDueDate as the basis."},"baseAmountType":{"enum":["Amount","AmountAndDefaultCharge"],"type":"string","description":"Indicates the amount by which the default interest is calculated.\n- Amount: Default interest is calculated on the basis of the amount of the claim.\n- AmountAndDefaultCharge: Default interest is calculated on the basis of the amount and arrears of the claim."},"baseTimeType":{"enum":["Daily","360","Calendar"],"type":"string","description":"Indicates at what time the basis of default interest is calculated. Time = (number of days/time basis)\n- Daily: Daily interest. Time is used = (number of days / 1), Only for the state.\n- 360: Annual interest rate where the year is calculated as 360 days. Time is used = (number of days / 360).\n- Calendar: Annual interest where the year is calculated with calendar days. Time = is used (number of days / calendar days)."},"defaultCharge":{"required":["referenceDate"],"type":"object","properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}},"additionalProperties":false,"description":"Default charges configuration. Defines day offsets from the reference date and whether each charge is percentage-based or a fixed amount. For discounts, the amount is calculated from totalAmount. For defaultCharge, the charge amount is calculated from claimAmount."},"dayAmountItem":{"required":["chargeType","day","value"],"type":"object","properties":{"chargeType":{"$ref":"#/components/schemas/chargeType"},"day":{"maximum":99,"minimum":0,"type":"integer","format":"int32"},"value":{"type":"number","format":"double"}},"additionalProperties":false,"description":"For whether to use fixed amount or calculate by percentage from claimAmount when calculating discount or charge."},"chargeType":{"enum":["Percentage","Amount"],"type":"string"},"paymentFee":{"required":["paperlessFee","printingFee"],"type":"object","properties":{"printingFee":{"type":"number","description":"A fee that is applied if the claim is printed.","format":"double"},"paperlessFee":{"type":"number","description":"A fee that is applied if the claim is paperless. This fee applies to payors who have opted out of receiving printed letters and to direct debit claims.","format":"double"}},"additionalProperties":false,"description":"Additional fee that adds to the claim amount."},"discount":{"required":["referenceDate"],"type":"object","properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}},"additionalProperties":false,"description":"Contains detail information about claim discount"},"claimType":{"enum":["NormalClaim","OptionalPaymentClaim","RefundClaim","BalanceClaim"],"type":"string","description":"The type of the claim which is to be created.\n  - NormalClaim: A regular claim.\n  - OptionalPaymentClaim: An optional payment claim.\n  - RefundClaim: A refund claim.\n  - BalanceClaim: A government balance claim (only for government entities)."},"dateRuleDayOfMonth":{"required":["dayOfMonth"],"type":"object","properties":{"dayOfMonth":{"maximum":31,"minimum":1,"type":"integer","description":"Day of month (1-31). If a month has fewer days, business logic decides adjustment.","format":"int32"}},"additionalProperties":false,"description":"Rule that sets a date to a fixed day within the calendar month (e.g. 15th of each month)."},"dateRuleNumberOfDays":{"required":["daysOffset"],"type":"object","properties":{"daysOffset":{"maximum":365,"minimum":0,"type":"integer","description":"Number of days to add (0 means same day).","format":"int32"}},"additionalProperties":false,"description":"Rule that calculates a target date by adding an offset in days to another base date (e.g. +10 days from dueDate)."},"errorResponse":{"required":["code","type"],"type":"object","properties":{"type":{"maxLength":70,"minLength":1,"type":"string","description":"A URI reference [RFC3986] that identifies the problem type."},"title":{"maxLength":70,"type":"string","description":"Short human readable description of error type. Could be in local language. To be provided by ASPSPs.","nullable":true},"detail":{"maxLength":500,"type":"string","description":"Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.","nullable":true},"code":{"minLength":1,"type":"string","description":"Error code as a string to support different error code types."},"additionalErrors":{"type":"array","items":{"$ref":"#/components/schemas/additionalError"},"description":"Array of Error Information Blocks. Might be used if more than one error is to be communicated.","nullable":true}},"additionalProperties":false,"description":"Standardised definition of reporting error information according to [RFC7807]."},"additionalError":{"required":["code"],"type":"object","properties":{"title":{"maxLength":70,"type":"string","description":"Short human readable description of error type. Could be in local language.","nullable":true},"detail":{"maxLength":500,"type":"string","description":"Detailed human readable text specific to this instance of the error.","nullable":true},"code":{"minLength":1,"type":"string","description":"Error code as a string to support different error code types."}},"additionalProperties":false,"description":"A data element to support the declaration of additional errors in the context of [RFC7807]."},"problemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"httpValidationProblemDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/problemDetails"}],"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"nullable":true}},"additionalProperties":{}}}},"paths":{"/api/v1/templates/{templateId}":{"get":{"tags":["Claim Templates"],"summary":"Get a single claim template.","description":"Returns one claim template identified by templateId.","operationId":"GetTemplate","parameters":[{"name":"templateId","in":"path","description":"Unique template identifier.","required":true,"schema":{"type":"string"}},{"name":"X-Request-ID","in":"header","description":"Unique value generated by the client which the resource server uses to recognize subsequent retries of the same request.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Claim template.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateDetails"}}}},"400":{"description":"Bad Request.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"401":{"description":"Unauthorized.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"403":{"description":"Forbidden.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"404":{"description":"Not found.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"405":{"description":"Method Not Allowed.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"408":{"description":"Request Timeout.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/problemDetails"},{"$ref":"#/components/schemas/httpValidationProblemDetails"}]}}}},"415":{"description":"Unsupported Media Type.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/problemDetails"},{"$ref":"#/components/schemas/httpValidationProblemDetails"}]}}}},"500":{"description":"Internal Server Error.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}}},"503":{"description":"Service Unavailable.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}}}}}}}}
```

## Get a list of claim templates.

> Returns a paginated list of claim templates filtered by optional query parameters.\
> Filters:\
> \- claimantId: kennitala.\
> \- bank: Branch number.\
> \- templateCode: Template code.\
> \- isActive: true/false.\
> Omitted filters broaden the result set.\
> Example:\
> \`GET /v1/templates?claimantId=0208715009\&templateCode=001\&page=1\&itemsPerPage=50\`

```json
{"openapi":"3.0.4","info":{"title":"IOBWS 3.0 Claims","version":"v3.2"},"tags":[{"name":"Claim Templates","description":"Discover and inspect claim templates."}],"servers":[{"url":"https://apigwsandbox.arionbanki.is/claims","description":"IOBWS 3.0 Claims API - Sandbox"},{"url":"https://apigw.arionbanki.is/claims","description":"IOBWS 3.0 Claims API - Production"}],"security":[{"oauth2":["b2b"],"SubscriptionKey":[]}],"components":{"securitySchemes":{"oauth2":{"type":"http","description":"Authorization header using the Bearer scheme. The Curity-issued OAuth2 access token, sent as `Bearer <token>`. Required on every request.\n\nToken URL: https://apigw.arionbanki.is/oauth/v2/oauth-token","scheme":"bearer"}},"schemas":{"templateListDetails":{"type":"object","properties":{"templateId":{"type":"string","description":"Unique Id for each template. This is specific to each bank.","nullable":true},"claimantId":{"pattern":"[0-9]{10}","type":"string","nullable":true},"bank":{"pattern":"[0-9]{4}","type":"string","nullable":true},"templateCode":{"pattern":"[0-9A-Z]{3}","type":"string","nullable":true},"collectionType":{"$ref":"#/components/schemas/collectionType"},"category":{"$ref":"#/components/schemas/claimTemplateCategory"},"claimantStatementExtendedReferenceType":{"$ref":"#/components/schemas/claimantStatementExtendedReferenceType"},"customerNumberTemplate":{"maxLength":16,"type":"string","description":"Describes how the transaction number template is structured for the claim template.","nullable":true},"claimantStatementReferenceType":{"$ref":"#/components/schemas/claimantStatementReferenceType"},"depositAccount":{"$ref":"#/components/schemas/depositAccount"},"secondaryCollectionTemplateCode":{"pattern":"[0-9A-Za-z]{3}","type":"string","description":"ID of a collection claim template to which claims are transferred.","nullable":true},"withdrawalAccount":{"pattern":"[0-9]{12}","type":"string","nullable":true}},"additionalProperties":false,"description":"Claim template details."},"collectionType":{"enum":["PrimaryCollection","SecondaryCollection"],"type":"string","description":"Collection type of the claim template."},"claimTemplateCategory":{"required":["code"],"type":"object","properties":{"code":{"maxLength":2,"minLength":2,"type":"string","description":"Two-character category code."},"name":{"maxLength":30,"type":"string","description":"Category name.","nullable":true}},"additionalProperties":false,"description":""},"claimantStatementExtendedReferenceType":{"enum":["ReferenceNumber","CustomerNumber","ClaimId","PayorId","DueDate"],"type":"string","description":"Indicates which value appears in the reference area of the creditor's account statement.\nThis can be one of the following values:\n- ReferenceNumber - The first 12 letters of the reference number.\n- CustomerNumber - The first 12 letters of the transaction number.\n- ClaimId - Branch number, ledger and claim number.\n- PayorId - Id (kennitala) of the payor\n- DueDate - Due date of the claim in the format (yyyymmdd)"},"claimantStatementReferenceType":{"enum":["DueDate","BillNumber","ClaimNumber"],"type":"string","description":"Indicates which value appears in the bill area on the creditor's account statement.\nThis can be one of the following values:\n- DueDate - Due date of the claim in the format (yyyymmdd)\n- BillNumber - Bill number of the claim\n- ClaimNumber - Claimnumber (last 6 digits)"},"depositAccount":{"type":"object","properties":{"id":{"pattern":"[0-9]{12}","type":"string","description":"Bank number, ledger and number. For claims ledger is 66 followed by claim number.","nullable":true},"ownerId":{"pattern":"[0-9]{10}","type":"string","description":"Icelandic Id number (kennitala).","nullable":true}},"additionalProperties":false,"description":"Information on the main disposal account."},"errorResponse":{"required":["code","type"],"type":"object","properties":{"type":{"maxLength":70,"minLength":1,"type":"string","description":"A URI reference [RFC3986] that identifies the problem type."},"title":{"maxLength":70,"type":"string","description":"Short human readable description of error type. Could be in local language. To be provided by ASPSPs.","nullable":true},"detail":{"maxLength":500,"type":"string","description":"Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.","nullable":true},"code":{"minLength":1,"type":"string","description":"Error code as a string to support different error code types."},"additionalErrors":{"type":"array","items":{"$ref":"#/components/schemas/additionalError"},"description":"Array of Error Information Blocks. Might be used if more than one error is to be communicated.","nullable":true}},"additionalProperties":false,"description":"Standardised definition of reporting error information according to [RFC7807]."},"additionalError":{"required":["code"],"type":"object","properties":{"title":{"maxLength":70,"type":"string","description":"Short human readable description of error type. Could be in local language.","nullable":true},"detail":{"maxLength":500,"type":"string","description":"Detailed human readable text specific to this instance of the error.","nullable":true},"code":{"minLength":1,"type":"string","description":"Error code as a string to support different error code types."}},"additionalProperties":false,"description":"A data element to support the declaration of additional errors in the context of [RFC7807]."},"problemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"httpValidationProblemDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/problemDetails"}],"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"nullable":true}},"additionalProperties":{}}}},"paths":{"/api/v1/templates":{"get":{"tags":["Claim Templates"],"summary":"Get a list of claim templates.","description":"Returns a paginated list of claim templates filtered by optional query parameters.\nFilters:\n- claimantId: kennitala.\n- bank: Branch number.\n- templateCode: Template code.\n- isActive: true/false.\nOmitted filters broaden the result set.\nExample:\n`GET /v1/templates?claimantId=0208715009&templateCode=001&page=1&itemsPerPage=50`","operationId":"GetTemplates","parameters":[{"name":"claimantId","in":"query","description":"Creditor's kennitala","schema":{"pattern":"[0-9]{10}","type":"string"}},{"name":"bank","in":"query","description":"Bank or branch number","schema":{"pattern":"[0-9]{4}","type":"string"}},{"name":"templateCode","in":"query","description":"Claim template code","schema":{"pattern":"[0-9A-Z]{3}","type":"string"}},{"name":"isActive","in":"query","description":"Specifies whether active or inactive claim forms should be submitted. The default value is true","schema":{"type":"boolean"}},{"name":"X-Request-ID","in":"header","description":"Unique value generated by the client which the resource server uses to recognize subsequent retries of the same request.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"itemsPerPage","in":"query","description":"Number of displayed items. Maximum is 500.","schema":{"maximum":500,"minimum":1,"type":"integer","format":"int32","default":500}},{"name":"page","in":"query","description":"Page number in the result","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32","default":1}}],"responses":{"200":{"description":"Claim list template.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}},"X-Paging-CurrentPage":{"description":"Current page number.","schema":{"type":"integer","description":"Current page number.","format":""}},"X-Paging-TotalPages":{"description":"Total number of pages.","schema":{"type":"integer","description":"Total number of pages.","format":""}},"X-Paging-TotalItems":{"description":"Total number of items.","schema":{"type":"integer","description":"Total number of items.","format":""}},"X-Paging-PerPage":{"description":"Number of items per page.","schema":{"type":"integer","description":"Number of items per page.","format":""}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/templateListDetails"},"description":"List of claim templates"}}}},"400":{"description":"Bad Request.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"401":{"description":"Unauthorized.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"403":{"description":"Forbidden.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"404":{"description":"Not found.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"405":{"description":"Method Not Allowed.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"408":{"description":"Request Timeout.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/problemDetails"},{"$ref":"#/components/schemas/httpValidationProblemDetails"}]}}}},"415":{"description":"Unsupported Media Type.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/problemDetails"},{"$ref":"#/components/schemas/httpValidationProblemDetails"}]}}}},"500":{"description":"Internal Server Error.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}}},"503":{"description":"Service Unavailable.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}}}}}}}}
```

## Get a list of claims as defined by the query parameters

> Returns a paginated list of claims filtered by supplied query parameters.\
> &#x20;           \
> Behavior:\
> \- DateFrom and DateTo must be supplied together; both are required.\
> \- If DateType is omitted, business rules determine default (typically DueDate).\
> \- Omitting optional filters broadens result set.

```json
{"openapi":"3.0.4","info":{"title":"IOBWS 3.0 Claims","version":"v3.2"},"tags":[{"name":"Claims Management","description":"Create, retrieve, modify and track claims."}],"servers":[{"url":"https://apigwsandbox.arionbanki.is/claims","description":"IOBWS 3.0 Claims API - Sandbox"},{"url":"https://apigw.arionbanki.is/claims","description":"IOBWS 3.0 Claims API - Production"}],"security":[{"oauth2":["b2b"],"SubscriptionKey":[]}],"components":{"securitySchemes":{"oauth2":{"type":"http","description":"Authorization header using the Bearer scheme. The Curity-issued OAuth2 access token, sent as `Bearer <token>`. Required on every request.\n\nToken URL: https://apigw.arionbanki.is/oauth/v2/oauth-token","scheme":"bearer"}},"schemas":{"dateSpanReferenceDate":{"enum":["DueDate","FinalDueDate","ExpirationDate","ClosingDate","CreationDate","LastChangeDate","PaymentDate","TemplateTransferDate"],"type":"string","description":"Types of dates are as follows:\n- DueDate: The claim's due date\n- FinalDueDate: The claim's final due date\n- ExpirationDate: The claim cancellation date\n- ClosingDate: Date when the claim was paid, cancelled or transferred.\n- CreationDate: When the claim was created\n- LastChangeDate: Last claim change event date\n- PaymentDate: Date when claim was paid\n- TemplateTransferDate: When claim was moved to another template"},"claimStatus":{"enum":["Unpaid","Paid","Cancelled"],"type":"string","description":"Claim status"},"collectionStatus":{"enum":["PrimaryCollection","SecondaryCollection","LegalCollection"],"type":"string","description":"Claim billing process status."},"claimDetails":{"required":["amount","claimKey","expirationDate","finalDueDate","payorId","templateCode"],"type":"object","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"payorId":{"minLength":1,"pattern":"[0-9]{10}","type":"string","description":"Icelandic Id number (kennitala)."},"claimStatus":{"$ref":"#/components/schemas/claimStatus"},"collectionStatus":{"$ref":"#/components/schemas/collectionStatus"},"expirationDate":{"type":"string","format":"date-time"},"closingDate":{"type":"string","description":"Date when the claim was paid, cancelled or transferred.","format":"date-time","nullable":true},"templateCode":{"minLength":1,"pattern":"[0-9A-Z]{3}","type":"string","description":"Claim template identifier."},"templateId":{"type":"string","description":"Unique Id for each template. This is specific to each bank.","nullable":true},"secondaryCollectionTemplateCode":{"pattern":"[0-9A-Z]{3}","type":"string","description":"Claim template identifier.","nullable":true},"secondaryCollectionTemplateId":{"type":"string","description":"Unique Id for each template. This is specific to each bank.","nullable":true},"categoryCode":{"maxLength":2,"pattern":"[0-9]{2}","type":"string","description":"Creditors' text key, explanation of payment. Optional attribute on claim","nullable":true},"categoryDescription":{"type":"string","description":"Description of the categoryCode","nullable":true},"amount":{"type":"number","description":"Claim amount","format":"double"},"defaultChargeAmountDue":{"type":"number","description":"Amount of default charge to be paid","format":"double","nullable":true},"defaultInterestAmountDue":{"type":"number","description":"Amount of accrued default interests to be paid","format":"double","nullable":true},"discountAmountOffered":{"type":"number","description":"Discount that will be granted when a collection claim is paid based on status","format":"double","nullable":true},"noticeChargeAmountDue":{"type":"number","description":"Amount of notification charge to be paid.","format":"double","nullable":true},"otherCostsAmountDue":{"type":"number","description":"Current other costs to be paid","format":"double","nullable":true},"otherDefaultCostsAmountDue":{"type":"number","description":"Current other default costs to be paid","format":"double","nullable":true},"totalAmountDue":{"type":"number","description":"Total amount to be paid","format":"double","nullable":true},"reference":{"maxLength":16,"type":"string","description":"Reference number determined by creditors.","nullable":true},"finalDueDate":{"type":"string","format":"date-time"},"billNumber":{"maxLength":7,"type":"string","description":"7-character reference id set by claimant. This ID will be visible on the payer's account statement","nullable":true},"customerNumber":{"maxLength":16,"type":"string","description":"16-character reference id set by claimant. Payer's transaction number. Unique key to the payer of the  claim with the creditor. Necessary if a direct payment agreement is to be established","nullable":true},"paymentFee":{"$ref":"#/components/schemas/paymentFee"},"otherCostsAmount":{"type":"number","description":"Other costs, including determined fees paid by the payer of a collection claim.","format":"double","nullable":true},"otherDefaultCostsAmount":{"type":"number","description":"Determined fees, e.g. intermediate collection fee.","format":"double","nullable":true},"defaultCharge":{"$ref":"#/components/schemas/defaultCharge"},"defaultInterest":{"$ref":"#/components/schemas/defaultInterest"},"discount":{"$ref":"#/components/schemas/discount"},"isOutOfSequencePaymentAllowed":{"type":"boolean","description":"Payment rule, is it allowed to pay the last payment if previous has not been paid","nullable":true},"isPartialPaymentAllowed":{"type":"boolean","nullable":true},"isPartiallyPaid":{"type":"boolean","description":"Indicates whether payment has been made on the collection claim","nullable":true},"currency":{"pattern":"[A-Z]{3}","type":"string","nullable":true},"currencyPaymentRate":{"$ref":"#/components/schemas/currencyPaymentRate"},"additionalInformation":{"maxLength":200,"type":"string","description":"Free text that will be displayed on the claim","nullable":true},"printing":{"$ref":"#/components/schemas/printing"},"directPaymentClaim":{"type":"boolean","description":"Is the claim registered as direct payment claim","nullable":true},"print":{"type":"boolean","description":"Indicates whether a claim should be printed","nullable":true},"lastChangeDate":{"type":"string","description":"Last claim change event date.","format":"date-time","nullable":true},"createdDate":{"type":"string","description":"The creation date of the claim.","format":"date-time","nullable":true},"claimType":{"$ref":"#/components/schemas/claimType"}},"additionalProperties":false,"description":"Detailed information for a single claim. May include discount information (fixed amount or percentage) for early payment. A claim includes detailed billing information. After any payment certain monetary fields (including amount) cannot be changed."},"claimKey":{"required":["account","claimantId","dueDate"],"type":"object","properties":{"claimantId":{"minLength":1,"pattern":"[0-9]{10}","type":"string","description":"Icelandic Id number (kennitala)."},"account":{"minLength":1,"pattern":"[0-9]{12}","type":"string","description":"Bank number, ledger and number.\nFor claims ledger is 66 followed by claim number"},"dueDate":{"type":"string","description":"Due date","format":"date-time"}},"additionalProperties":false,"description":"Claim key is a composite key of kennitala, account and due date."},"paymentFee":{"required":["paperlessFee","printingFee"],"type":"object","properties":{"printingFee":{"type":"number","description":"A fee that is applied if the claim is printed.","format":"double"},"paperlessFee":{"type":"number","description":"A fee that is applied if the claim is paperless. This fee applies to payors who have opted out of receiving printed letters and to direct debit claims.","format":"double"}},"additionalProperties":false,"description":"Additional fee that adds to the claim amount."},"defaultCharge":{"required":["referenceDate"],"type":"object","properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}},"additionalProperties":false,"description":"Default charges configuration. Defines day offsets from the reference date and whether each charge is percentage-based or a fixed amount. For discounts, the amount is calculated from totalAmount. For defaultCharge, the charge amount is calculated from claimAmount."},"referenceDate":{"enum":["DueDate","FinalDueDate"],"type":"string","description":"Specifies the reference date for calculations, allowing the choice between the DueDate and the FinalDueDate as the basis."},"dayAmountItem":{"required":["chargeType","day","value"],"type":"object","properties":{"chargeType":{"$ref":"#/components/schemas/chargeType"},"day":{"maximum":99,"minimum":0,"type":"integer","format":"int32"},"value":{"type":"number","format":"double"}},"additionalProperties":false,"description":"For whether to use fixed amount or calculate by percentage from claimAmount when calculating discount or charge."},"chargeType":{"enum":["Percentage","Amount"],"type":"string"},"defaultInterest":{"required":["referenceDate"],"type":"object","properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"baseAmountType":{"$ref":"#/components/schemas/baseAmountType"},"baseTimeType":{"$ref":"#/components/schemas/baseTimeType"},"percentage":{"type":"number","description":"Indicates the percentage of default interest. If this parameter is not specified or is set to \"0\", the Central Bank's maximum default interest rate is used. Percentage range is between 0 - 100","format":"double","nullable":true}},"additionalProperties":false,"description":"Contains information on how default interest is calculated.\nIf claim should not have default interest, do not send in this object or send it in as \"null\"."},"baseAmountType":{"enum":["Amount","AmountAndDefaultCharge"],"type":"string","description":"Indicates the amount by which the default interest is calculated.\n- Amount: Default interest is calculated on the basis of the amount of the claim.\n- AmountAndDefaultCharge: Default interest is calculated on the basis of the amount and arrears of the claim."},"baseTimeType":{"enum":["Daily","360","Calendar"],"type":"string","description":"Indicates at what time the basis of default interest is calculated. Time = (number of days/time basis)\n- Daily: Daily interest. Time is used = (number of days / 1), Only for the state.\n- 360: Annual interest rate where the year is calculated as 360 days. Time is used = (number of days / 360).\n- Calendar: Annual interest where the year is calculated with calendar days. Time = is used (number of days / calendar days)."},"discount":{"required":["referenceDate"],"type":"object","properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}},"additionalProperties":false,"description":"Contains detail information about claim discount"},"currencyPaymentRate":{"enum":["PaymentDateRate"],"type":"string"},"printing":{"type":"object","properties":{"payorAddress":{"$ref":"#/components/schemas/address"},"itemRows":{"type":"array","items":{"$ref":"#/components/schemas/itemRow"},"description":"Contains information on the breakdown of the collection claim.","nullable":true},"comments":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"description":"Contains information if a collection claim is printed at a bank / savings bank to manage the printout of the collection claim. Changing a printout to a change entry after printing a note does not result in it being reprinted"},"address":{"required":["addressLine","city","country","name","postalCode"],"type":"object","properties":{"name":{"minLength":1,"type":"string"},"addressLine":{"minLength":1,"type":"string"},"postalCode":{"minLength":1,"type":"string"},"city":{"minLength":1,"type":"string"},"country":{"minLength":1,"pattern":"[A-Z]{2}","type":"string"}},"additionalProperties":false,"description":"Address or legal address of a legal entity"},"itemRow":{"type":"object","properties":{"text":{"type":"string","nullable":true},"amount":{"type":"number","format":"double","nullable":true}},"additionalProperties":false,"description":"Contains information on the breakdown of the collection claim."},"claimType":{"enum":["NormalClaim","OptionalPaymentClaim","RefundClaim","BalanceClaim"],"type":"string","description":"The type of the claim which is to be created.\n  - NormalClaim: A regular claim.\n  - OptionalPaymentClaim: An optional payment claim.\n  - RefundClaim: A refund claim.\n  - BalanceClaim: A government balance claim (only for government entities)."},"errorResponse":{"required":["code","type"],"type":"object","properties":{"type":{"maxLength":70,"minLength":1,"type":"string","description":"A URI reference [RFC3986] that identifies the problem type."},"title":{"maxLength":70,"type":"string","description":"Short human readable description of error type. Could be in local language. To be provided by ASPSPs.","nullable":true},"detail":{"maxLength":500,"type":"string","description":"Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.","nullable":true},"code":{"minLength":1,"type":"string","description":"Error code as a string to support different error code types."},"additionalErrors":{"type":"array","items":{"$ref":"#/components/schemas/additionalError"},"description":"Array of Error Information Blocks. Might be used if more than one error is to be communicated.","nullable":true}},"additionalProperties":false,"description":"Standardised definition of reporting error information according to [RFC7807]."},"additionalError":{"required":["code"],"type":"object","properties":{"title":{"maxLength":70,"type":"string","description":"Short human readable description of error type. Could be in local language.","nullable":true},"detail":{"maxLength":500,"type":"string","description":"Detailed human readable text specific to this instance of the error.","nullable":true},"code":{"minLength":1,"type":"string","description":"Error code as a string to support different error code types."}},"additionalProperties":false,"description":"A data element to support the declaration of additional errors in the context of [RFC7807]."},"problemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"httpValidationProblemDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/problemDetails"}],"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"nullable":true}},"additionalProperties":{}}}},"paths":{"/api/v1/claims":{"get":{"tags":["Claims Management"],"summary":"Get a list of claims as defined by the query parameters","description":"Returns a paginated list of claims filtered by supplied query parameters.\n            \nBehavior:\n- DateFrom and DateTo must be supplied together; both are required.\n- If DateType is omitted, business rules determine default (typically DueDate).\n- Omitting optional filters broadens result set.","operationId":"GetClaims","parameters":[{"name":"dateFrom","in":"query","description":"Date from (inclusive) to search for","required":true,"schema":{"type":"string","format":"date"}},{"name":"dateTo","in":"query","description":"Date to (inclusive) to search for","required":true,"schema":{"type":"string","format":"date"}},{"name":"dateType","in":"query","description":"Date type to search for","schema":{"$ref":"#/components/schemas/dateSpanReferenceDate"}},{"name":"claimantId","in":"query","description":"Icelandic kennitala for the claimant","schema":{"pattern":"[0-9]{10}","type":"string"}},{"name":"payorId","in":"query","description":"Icelandic kennitala for the payor","schema":{"pattern":"[0-9]{10}","type":"string"}},{"name":"status","in":"query","description":"The claim status to search for","schema":{"$ref":"#/components/schemas/claimStatus"}},{"name":"collectionStatus","in":"query","description":"Claim billing process status.\nThe value 'LegalCollection' is not supported","schema":{"$ref":"#/components/schemas/collectionStatus"}},{"name":"templateCode","in":"query","description":"Claim template identifier","schema":{"pattern":"[0-9A-Z]{3}","type":"string"}},{"name":"templateId","in":"query","description":"Filter claims by templateId (exact match).","schema":{"type":"string"}},{"name":"X-Request-ID","in":"header","description":"Unique value generated by the client which the resource server uses to recognize subsequent retries of the same request.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"itemsPerPage","in":"query","description":"Number of displayed items. Maximum is 500.","schema":{"maximum":500,"minimum":1,"type":"integer","format":"int32","default":500}},{"name":"page","in":"query","description":"Page number in the result","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32","default":1}}],"responses":{"200":{"description":"Query claim list information.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}},"X-Paging-CurrentPage":{"description":"Current page number.","schema":{"type":"integer","description":"Current page number.","format":""}},"X-Paging-TotalPages":{"description":"Total number of pages.","schema":{"type":"integer","description":"Total number of pages.","format":""}},"X-Paging-TotalItems":{"description":"Total number of items.","schema":{"type":"integer","description":"Total number of items.","format":""}},"X-Paging-PerPage":{"description":"Number of items per page.","schema":{"type":"integer","description":"Number of items per page.","format":""}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/claimDetails"},"description":"List of claims"}}}},"400":{"description":"Bad Request","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"401":{"description":"Unauthorized","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"403":{"description":"Forbidden","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"404":{"description":"Not found","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"405":{"description":"Method Not Allowed","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"408":{"description":"Request Timeout","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/problemDetails"},{"$ref":"#/components/schemas/httpValidationProblemDetails"}]}}}},"415":{"description":"Unsupported Media Type","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/problemDetails"},{"$ref":"#/components/schemas/httpValidationProblemDetails"}]}}}},"500":{"description":"Internal Server Error","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}}},"503":{"description":"Service Unavailable","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}}}}}}}}
```

## Create a single claim

> Creates a new claim and returns an immediate status response.

```json
{"openapi":"3.0.4","info":{"title":"IOBWS 3.0 Claims","version":"v3.2"},"tags":[{"name":"Claims Management","description":"Create, retrieve, modify and track claims."}],"servers":[{"url":"https://apigwsandbox.arionbanki.is/claims","description":"IOBWS 3.0 Claims API - Sandbox"},{"url":"https://apigw.arionbanki.is/claims","description":"IOBWS 3.0 Claims API - Production"}],"security":[{"oauth2":["b2b"],"SubscriptionKey":[]}],"components":{"securitySchemes":{"oauth2":{"type":"http","description":"Authorization header using the Bearer scheme. The Curity-issued OAuth2 access token, sent as `Bearer <token>`. Required on every request.\n\nToken URL: https://apigw.arionbanki.is/oauth/v2/oauth-token","scheme":"bearer"}},"schemas":{"createClaimDetails":{"required":["amount","claimKey","expirationDate","finalDueDate","payorId","templateCode"],"type":"object","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"payorId":{"minLength":1,"pattern":"[0-9]{10}","type":"string","description":"PayorId is the Icelandic kennitala for the payor."},"expirationDate":{"type":"string","format":"date-time"},"templateCode":{"minLength":1,"pattern":"[0-9A-Z]{3}","type":"string","description":"Claim template identifier."},"amount":{"type":"number","format":"double"},"finalDueDate":{"type":"string","format":"date-time"},"reference":{"maxLength":16,"type":"string","description":"Reference number determined by creditors.","nullable":true},"billNumber":{"maxLength":7,"type":"string","description":"7-character reference id set by claimant. This ID will be visible on the payer's account statement","nullable":true},"customerNumber":{"maxLength":16,"type":"string","description":"16-character reference id set by claimant. Payer's transaction number. Unique key to the payer of the  claim with the creditor. Necessary if a direct payment agreement is to be established","nullable":true},"paymentFee":{"$ref":"#/components/schemas/paymentFee"},"otherCostsAmount":{"type":"number","description":"Other costs, including determined fees paid by the payer of a collection claim.","format":"double","nullable":true},"otherDefaultCostsAmount":{"type":"number","description":"Determined fees, e.g. intermediate collection fee.","format":"double","nullable":true},"defaultCharge":{"$ref":"#/components/schemas/defaultCharge"},"defaultInterest":{"$ref":"#/components/schemas/defaultInterest"},"discount":{"$ref":"#/components/schemas/discount"},"isOutOfSequencePaymentAllowed":{"type":"boolean","description":"Payment rule, is it allowed to pay the last payment if previous has not been paid","nullable":true},"isPartialPaymentAllowed":{"type":"boolean","nullable":true},"currency":{"pattern":"[A-Z]{3}","type":"string","nullable":true},"additionalInformation":{"maxLength":200,"type":"string","description":"Free text that will be displayed on the claim","nullable":true},"printing":{"$ref":"#/components/schemas/printing"},"claimType":{"$ref":"#/components/schemas/claimType"}},"additionalProperties":false,"description":"Create claim object"},"claimKey":{"required":["account","claimantId","dueDate"],"type":"object","properties":{"claimantId":{"minLength":1,"pattern":"[0-9]{10}","type":"string","description":"Icelandic Id number (kennitala)."},"account":{"minLength":1,"pattern":"[0-9]{12}","type":"string","description":"Bank number, ledger and number.\nFor claims ledger is 66 followed by claim number"},"dueDate":{"type":"string","description":"Due date","format":"date-time"}},"additionalProperties":false,"description":"Claim key is a composite key of kennitala, account and due date."},"paymentFee":{"required":["paperlessFee","printingFee"],"type":"object","properties":{"printingFee":{"type":"number","description":"A fee that is applied if the claim is printed.","format":"double"},"paperlessFee":{"type":"number","description":"A fee that is applied if the claim is paperless. This fee applies to payors who have opted out of receiving printed letters and to direct debit claims.","format":"double"}},"additionalProperties":false,"description":"Additional fee that adds to the claim amount."},"defaultCharge":{"required":["referenceDate"],"type":"object","properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}},"additionalProperties":false,"description":"Default charges configuration. Defines day offsets from the reference date and whether each charge is percentage-based or a fixed amount. For discounts, the amount is calculated from totalAmount. For defaultCharge, the charge amount is calculated from claimAmount."},"referenceDate":{"enum":["DueDate","FinalDueDate"],"type":"string","description":"Specifies the reference date for calculations, allowing the choice between the DueDate and the FinalDueDate as the basis."},"dayAmountItem":{"required":["chargeType","day","value"],"type":"object","properties":{"chargeType":{"$ref":"#/components/schemas/chargeType"},"day":{"maximum":99,"minimum":0,"type":"integer","format":"int32"},"value":{"type":"number","format":"double"}},"additionalProperties":false,"description":"For whether to use fixed amount or calculate by percentage from claimAmount when calculating discount or charge."},"chargeType":{"enum":["Percentage","Amount"],"type":"string"},"defaultInterest":{"required":["referenceDate"],"type":"object","properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"baseAmountType":{"$ref":"#/components/schemas/baseAmountType"},"baseTimeType":{"$ref":"#/components/schemas/baseTimeType"},"percentage":{"type":"number","description":"Indicates the percentage of default interest. If this parameter is not specified or is set to \"0\", the Central Bank's maximum default interest rate is used. Percentage range is between 0 - 100","format":"double","nullable":true}},"additionalProperties":false,"description":"Contains information on how default interest is calculated.\nIf claim should not have default interest, do not send in this object or send it in as \"null\"."},"baseAmountType":{"enum":["Amount","AmountAndDefaultCharge"],"type":"string","description":"Indicates the amount by which the default interest is calculated.\n- Amount: Default interest is calculated on the basis of the amount of the claim.\n- AmountAndDefaultCharge: Default interest is calculated on the basis of the amount and arrears of the claim."},"baseTimeType":{"enum":["Daily","360","Calendar"],"type":"string","description":"Indicates at what time the basis of default interest is calculated. Time = (number of days/time basis)\n- Daily: Daily interest. Time is used = (number of days / 1), Only for the state.\n- 360: Annual interest rate where the year is calculated as 360 days. Time is used = (number of days / 360).\n- Calendar: Annual interest where the year is calculated with calendar days. Time = is used (number of days / calendar days)."},"discount":{"required":["referenceDate"],"type":"object","properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}},"additionalProperties":false,"description":"Contains detail information about claim discount"},"printing":{"type":"object","properties":{"payorAddress":{"$ref":"#/components/schemas/address"},"itemRows":{"type":"array","items":{"$ref":"#/components/schemas/itemRow"},"description":"Contains information on the breakdown of the collection claim.","nullable":true},"comments":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"description":"Contains information if a collection claim is printed at a bank / savings bank to manage the printout of the collection claim. Changing a printout to a change entry after printing a note does not result in it being reprinted"},"address":{"required":["addressLine","city","country","name","postalCode"],"type":"object","properties":{"name":{"minLength":1,"type":"string"},"addressLine":{"minLength":1,"type":"string"},"postalCode":{"minLength":1,"type":"string"},"city":{"minLength":1,"type":"string"},"country":{"minLength":1,"pattern":"[A-Z]{2}","type":"string"}},"additionalProperties":false,"description":"Address or legal address of a legal entity"},"itemRow":{"type":"object","properties":{"text":{"type":"string","nullable":true},"amount":{"type":"number","format":"double","nullable":true}},"additionalProperties":false,"description":"Contains information on the breakdown of the collection claim."},"claimType":{"enum":["NormalClaim","OptionalPaymentClaim","RefundClaim","BalanceClaim"],"type":"string","description":"The type of the claim which is to be created.\n  - NormalClaim: A regular claim.\n  - OptionalPaymentClaim: An optional payment claim.\n  - RefundClaim: A refund claim.\n  - BalanceClaim: A government balance claim (only for government entities)."},"claimStatusSingleResponse":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/claimStatusSuccess"},"error":{"$ref":"#/components/schemas/claimStatusError"}},"additionalProperties":false,"description":"Claim status object."},"claimStatusSuccess":{"type":"object","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"claimId":{"type":"string","description":"ClaimId is a composite string key for a claim made of kennitala, account and due date\n  - ClaimantId\n  - Branch number\n  - 66\n  - Claim no\n  - +\n  - Date in the form of YYYYMMDD","nullable":true},"directPaymentClaim":{"type":"boolean","nullable":true},"print":{"type":"boolean","nullable":true}},"additionalProperties":false,"description":"Success status item."},"claimStatusError":{"type":"object","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"claimId":{"type":"string","description":"ClaimId is a composite string key for a claim made of kennitala, account and due date\n  - ClaimantId\n  - Branch number\n  - 66\n  - Claim no\n  - +\n  - Date in the form of YYYYMMDD","nullable":true},"resultCode":{"$ref":"#/components/schemas/resultCode"},"resultSubCode":{"type":"string","nullable":true},"resultMessage":{"type":"string","nullable":true}},"additionalProperties":false,"description":"Error status item."},"resultCode":{"enum":["CLAIM_EXISTS","CLAIM_IS_PAID","CLAIM_NOT_FOUND","CLAIM_IS_CANCELLED","CLAIM_NOT_IN_SECONDARY_STATE","CLAIM_OTHERS"],"type":"string"},"errorResponse":{"required":["code","type"],"type":"object","properties":{"type":{"maxLength":70,"minLength":1,"type":"string","description":"A URI reference [RFC3986] that identifies the problem type."},"title":{"maxLength":70,"type":"string","description":"Short human readable description of error type. Could be in local language. To be provided by ASPSPs.","nullable":true},"detail":{"maxLength":500,"type":"string","description":"Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.","nullable":true},"code":{"minLength":1,"type":"string","description":"Error code as a string to support different error code types."},"additionalErrors":{"type":"array","items":{"$ref":"#/components/schemas/additionalError"},"description":"Array of Error Information Blocks. Might be used if more than one error is to be communicated.","nullable":true}},"additionalProperties":false,"description":"Standardised definition of reporting error information according to [RFC7807]."},"additionalError":{"required":["code"],"type":"object","properties":{"title":{"maxLength":70,"type":"string","description":"Short human readable description of error type. Could be in local language.","nullable":true},"detail":{"maxLength":500,"type":"string","description":"Detailed human readable text specific to this instance of the error.","nullable":true},"code":{"minLength":1,"type":"string","description":"Error code as a string to support different error code types."}},"additionalProperties":false,"description":"A data element to support the declaration of additional errors in the context of [RFC7807]."},"problemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"httpValidationProblemDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/problemDetails"}],"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"nullable":true}},"additionalProperties":{}}}},"paths":{"/api/v1/claims":{"post":{"tags":["Claims Management"],"summary":"Create a single claim","description":"Creates a new claim and returns an immediate status response.","operationId":"CreateClaim","parameters":[{"name":"X-Request-ID","in":"header","description":"Unique value generated by the client which the resource server uses to recognize subsequent retries of the same request.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Idempotency-Key","in":"header","description":"Optional idempotency key.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Create claim payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/createClaimDetails"}}},"required":true},"responses":{"201":{"description":"Claim created (single item response).","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/claimStatusSingleResponse"}}}},"400":{"description":"Bad Request.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"401":{"description":"Unauthorized.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"403":{"description":"Forbidden.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"404":{"description":"Not found.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"405":{"description":"Method Not Allowed.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"408":{"description":"Request Timeout.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/problemDetails"},{"$ref":"#/components/schemas/httpValidationProblemDetails"}]}}}},"415":{"description":"Unsupported Media Type.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/problemDetails"},{"$ref":"#/components/schemas/httpValidationProblemDetails"}]}}}},"500":{"description":"Internal Server Error.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}}},"503":{"description":"Service Unavailable.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}}}}}}}}
```

## Patch a single claim

> Modifies a previously created claim (JSON Merge Patch).

```json
{"openapi":"3.0.4","info":{"title":"IOBWS 3.0 Claims","version":"v3.2"},"tags":[{"name":"Claims Management","description":"Create, retrieve, modify and track claims."}],"servers":[{"url":"https://apigwsandbox.arionbanki.is/claims","description":"IOBWS 3.0 Claims API - Sandbox"},{"url":"https://apigw.arionbanki.is/claims","description":"IOBWS 3.0 Claims API - Production"}],"security":[{"oauth2":["b2b"],"SubscriptionKey":[]}],"components":{"securitySchemes":{"oauth2":{"type":"http","description":"Authorization header using the Bearer scheme. The Curity-issued OAuth2 access token, sent as `Bearer <token>`. Required on every request.\n\nToken URL: https://apigw.arionbanki.is/oauth/v2/oauth-token","scheme":"bearer"}},"schemas":{"mergeClaimDetails":{"type":"object","properties":{"expirationDate":{"type":"string","description":"The (new) expiration date of the claim","format":"date-time","nullable":true},"templateCode":{"type":"string","description":"Code of a predefined template from which default values are derived.","nullable":true},"amount":{"type":"number","description":"Principal amount of the claim (without fees, interest, discounts).","format":"double","nullable":true},"reference":{"type":"string","description":"External or business reference identifier displayed to the payor.","nullable":true},"finalDueDate":{"type":"string","description":"Final due date after which escalation (e.g. default interest or collection transition) begins.","format":"date-time","nullable":true},"billNumber":{"type":"string","description":"Bill number tied to the claim","nullable":true},"customerNumber":{"type":"string","description":"Customer number / identifier of the debtor.","nullable":true},"paymentFee":{"allOf":[{"$ref":"#/components/schemas/paymentFee"}],"description":"Configuration for payment fees (printing vs paperless).","nullable":true},"otherCostsAmount":{"type":"number","description":"Additional costs (non-default) added to the claim amount.","format":"double","nullable":true},"otherDefaultCostsAmount":{"type":"number","description":"Additional costs related to default or late payment (excluding interest).","format":"double","nullable":true},"defaultCharge":{"allOf":[{"$ref":"#/components/schemas/defaultCharge"}],"description":"Configuration of default (late) charges applied after specified day offsets.","nullable":true},"defaultInterest":{"allOf":[{"$ref":"#/components/schemas/defaultInterest"}],"description":"Default interest configuration (basis, time calculation, percentage).","nullable":true},"discount":{"allOf":[{"$ref":"#/components/schemas/discount"}],"description":"Discount schedule definition (day offsets and amounts/percentages).","nullable":true},"isOutOfSequencePaymentAllowed":{"type":"boolean","description":"Indicates if payments out of chronological sequence are permitted.","nullable":true},"isPartialPaymentAllowed":{"type":"boolean","description":"Indicates if partial payments are allowed.","nullable":true},"currency":{"type":"string","description":"ISO 4217 currency code (e.g. ISK, EUR).","nullable":true},"additionalInformation":{"type":"string","description":"Free-form additional information presented or stored with the claim.","nullable":true},"claimStatus":{"allOf":[{"$ref":"#/components/schemas/claimStatus"}],"description":"Explicit claim status (e.g. Unpaid, Paid, Cancelled).","nullable":true},"collectionStatus":{"allOf":[{"$ref":"#/components/schemas/collectionStatus"}],"description":"Stage of collection processing (primary, secondary, legal).","nullable":true},"printing":{"allOf":[{"$ref":"#/components/schemas/printing"}],"description":"Printing and presentation details (address, item rows, comments).","nullable":true}},"additionalProperties":false,"description":"Represents a set of claim fields to be merged (patched) into an existing claim.\nEach property is wrapped to distinguish between:\n1) Not supplied (no change),\n2) Supplied with a value (update to that value),\n3) Supplied with explicit null (clear the value, if nullable)."},"paymentFee":{"required":["paperlessFee","printingFee"],"type":"object","properties":{"printingFee":{"type":"number","description":"A fee that is applied if the claim is printed.","format":"double"},"paperlessFee":{"type":"number","description":"A fee that is applied if the claim is paperless. This fee applies to payors who have opted out of receiving printed letters and to direct debit claims.","format":"double"}},"additionalProperties":false,"description":"Additional fee that adds to the claim amount."},"defaultCharge":{"required":["referenceDate"],"type":"object","properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}},"additionalProperties":false,"description":"Default charges configuration. Defines day offsets from the reference date and whether each charge is percentage-based or a fixed amount. For discounts, the amount is calculated from totalAmount. For defaultCharge, the charge amount is calculated from claimAmount."},"referenceDate":{"enum":["DueDate","FinalDueDate"],"type":"string","description":"Specifies the reference date for calculations, allowing the choice between the DueDate and the FinalDueDate as the basis."},"dayAmountItem":{"required":["chargeType","day","value"],"type":"object","properties":{"chargeType":{"$ref":"#/components/schemas/chargeType"},"day":{"maximum":99,"minimum":0,"type":"integer","format":"int32"},"value":{"type":"number","format":"double"}},"additionalProperties":false,"description":"For whether to use fixed amount or calculate by percentage from claimAmount when calculating discount or charge."},"chargeType":{"enum":["Percentage","Amount"],"type":"string"},"defaultInterest":{"required":["referenceDate"],"type":"object","properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"baseAmountType":{"$ref":"#/components/schemas/baseAmountType"},"baseTimeType":{"$ref":"#/components/schemas/baseTimeType"},"percentage":{"type":"number","description":"Indicates the percentage of default interest. If this parameter is not specified or is set to \"0\", the Central Bank's maximum default interest rate is used. Percentage range is between 0 - 100","format":"double","nullable":true}},"additionalProperties":false,"description":"Contains information on how default interest is calculated.\nIf claim should not have default interest, do not send in this object or send it in as \"null\"."},"baseAmountType":{"enum":["Amount","AmountAndDefaultCharge"],"type":"string","description":"Indicates the amount by which the default interest is calculated.\n- Amount: Default interest is calculated on the basis of the amount of the claim.\n- AmountAndDefaultCharge: Default interest is calculated on the basis of the amount and arrears of the claim."},"baseTimeType":{"enum":["Daily","360","Calendar"],"type":"string","description":"Indicates at what time the basis of default interest is calculated. Time = (number of days/time basis)\n- Daily: Daily interest. Time is used = (number of days / 1), Only for the state.\n- 360: Annual interest rate where the year is calculated as 360 days. Time is used = (number of days / 360).\n- Calendar: Annual interest where the year is calculated with calendar days. Time = is used (number of days / calendar days)."},"discount":{"required":["referenceDate"],"type":"object","properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}},"additionalProperties":false,"description":"Contains detail information about claim discount"},"claimStatus":{"enum":["Unpaid","Paid","Cancelled"],"type":"string","description":"Claim status"},"collectionStatus":{"enum":["PrimaryCollection","SecondaryCollection","LegalCollection"],"type":"string","description":"Claim billing process status."},"printing":{"type":"object","properties":{"payorAddress":{"$ref":"#/components/schemas/address"},"itemRows":{"type":"array","items":{"$ref":"#/components/schemas/itemRow"},"description":"Contains information on the breakdown of the collection claim.","nullable":true},"comments":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"description":"Contains information if a collection claim is printed at a bank / savings bank to manage the printout of the collection claim. Changing a printout to a change entry after printing a note does not result in it being reprinted"},"address":{"required":["addressLine","city","country","name","postalCode"],"type":"object","properties":{"name":{"minLength":1,"type":"string"},"addressLine":{"minLength":1,"type":"string"},"postalCode":{"minLength":1,"type":"string"},"city":{"minLength":1,"type":"string"},"country":{"minLength":1,"pattern":"[A-Z]{2}","type":"string"}},"additionalProperties":false,"description":"Address or legal address of a legal entity"},"itemRow":{"type":"object","properties":{"text":{"type":"string","nullable":true},"amount":{"type":"number","format":"double","nullable":true}},"additionalProperties":false,"description":"Contains information on the breakdown of the collection claim."},"claimStatusSingleResponse":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/claimStatusSuccess"},"error":{"$ref":"#/components/schemas/claimStatusError"}},"additionalProperties":false,"description":"Claim status object."},"claimStatusSuccess":{"type":"object","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"claimId":{"type":"string","description":"ClaimId is a composite string key for a claim made of kennitala, account and due date\n  - ClaimantId\n  - Branch number\n  - 66\n  - Claim no\n  - +\n  - Date in the form of YYYYMMDD","nullable":true},"directPaymentClaim":{"type":"boolean","nullable":true},"print":{"type":"boolean","nullable":true}},"additionalProperties":false,"description":"Success status item."},"claimKey":{"required":["account","claimantId","dueDate"],"type":"object","properties":{"claimantId":{"minLength":1,"pattern":"[0-9]{10}","type":"string","description":"Icelandic Id number (kennitala)."},"account":{"minLength":1,"pattern":"[0-9]{12}","type":"string","description":"Bank number, ledger and number.\nFor claims ledger is 66 followed by claim number"},"dueDate":{"type":"string","description":"Due date","format":"date-time"}},"additionalProperties":false,"description":"Claim key is a composite key of kennitala, account and due date."},"claimStatusError":{"type":"object","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"claimId":{"type":"string","description":"ClaimId is a composite string key for a claim made of kennitala, account and due date\n  - ClaimantId\n  - Branch number\n  - 66\n  - Claim no\n  - +\n  - Date in the form of YYYYMMDD","nullable":true},"resultCode":{"$ref":"#/components/schemas/resultCode"},"resultSubCode":{"type":"string","nullable":true},"resultMessage":{"type":"string","nullable":true}},"additionalProperties":false,"description":"Error status item."},"resultCode":{"enum":["CLAIM_EXISTS","CLAIM_IS_PAID","CLAIM_NOT_FOUND","CLAIM_IS_CANCELLED","CLAIM_NOT_IN_SECONDARY_STATE","CLAIM_OTHERS"],"type":"string"},"errorResponse":{"required":["code","type"],"type":"object","properties":{"type":{"maxLength":70,"minLength":1,"type":"string","description":"A URI reference [RFC3986] that identifies the problem type."},"title":{"maxLength":70,"type":"string","description":"Short human readable description of error type. Could be in local language. To be provided by ASPSPs.","nullable":true},"detail":{"maxLength":500,"type":"string","description":"Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.","nullable":true},"code":{"minLength":1,"type":"string","description":"Error code as a string to support different error code types."},"additionalErrors":{"type":"array","items":{"$ref":"#/components/schemas/additionalError"},"description":"Array of Error Information Blocks. Might be used if more than one error is to be communicated.","nullable":true}},"additionalProperties":false,"description":"Standardised definition of reporting error information according to [RFC7807]."},"additionalError":{"required":["code"],"type":"object","properties":{"title":{"maxLength":70,"type":"string","description":"Short human readable description of error type. Could be in local language.","nullable":true},"detail":{"maxLength":500,"type":"string","description":"Detailed human readable text specific to this instance of the error.","nullable":true},"code":{"minLength":1,"type":"string","description":"Error code as a string to support different error code types."}},"additionalProperties":false,"description":"A data element to support the declaration of additional errors in the context of [RFC7807]."},"problemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"httpValidationProblemDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/problemDetails"}],"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"nullable":true}},"additionalProperties":{}}}},"paths":{"/api/v1/claims/{claimId}":{"patch":{"tags":["Claims Management"],"summary":"Patch a single claim","description":"Modifies a previously created claim (JSON Merge Patch).","operationId":"PatchClaim","parameters":[{"name":"claimId","in":"path","description":"ClaimId is a composite string key for a claim made of kennitala, account and due date\n  - ClaimantId\n  - Branch number\n  - 66\n  - Claim no\n  - \\+\n  - Date in the form of YYYYMMDD","required":true,"schema":{"type":"string"}},{"name":"X-Request-ID","in":"header","description":"Unique value generated by the client which the resource server uses to recognize subsequent retries of the same request.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Merge patch payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/mergeClaimDetails"}}},"required":true},"responses":{"200":{"description":"Claim updated (single item response).","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/claimStatusSingleResponse"}}}},"400":{"description":"Bad Request.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"401":{"description":"Unauthorized.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"403":{"description":"Forbidden.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"404":{"description":"Not found.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"405":{"description":"Method Not Allowed.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"408":{"description":"Request Timeout.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/problemDetails"},{"$ref":"#/components/schemas/httpValidationProblemDetails"}]}}}},"415":{"description":"Unsupported Media Type.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/problemDetails"},{"$ref":"#/components/schemas/httpValidationProblemDetails"}]}}}},"500":{"description":"Internal Server Error.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}}},"503":{"description":"Service Unavailable.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}}}}}}}}
```

## Get single claim

> Fetch detailed information for a single claim identified by its claimId.

```json
{"openapi":"3.0.4","info":{"title":"IOBWS 3.0 Claims","version":"v3.2"},"tags":[{"name":"Claims Management","description":"Create, retrieve, modify and track claims."}],"servers":[{"url":"https://apigwsandbox.arionbanki.is/claims","description":"IOBWS 3.0 Claims API - Sandbox"},{"url":"https://apigw.arionbanki.is/claims","description":"IOBWS 3.0 Claims API - Production"}],"security":[{"oauth2":["b2b"],"SubscriptionKey":[]}],"components":{"securitySchemes":{"oauth2":{"type":"http","description":"Authorization header using the Bearer scheme. The Curity-issued OAuth2 access token, sent as `Bearer <token>`. Required on every request.\n\nToken URL: https://apigw.arionbanki.is/oauth/v2/oauth-token","scheme":"bearer"}},"schemas":{"claimDetails":{"required":["amount","claimKey","expirationDate","finalDueDate","payorId","templateCode"],"type":"object","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"payorId":{"minLength":1,"pattern":"[0-9]{10}","type":"string","description":"Icelandic Id number (kennitala)."},"claimStatus":{"$ref":"#/components/schemas/claimStatus"},"collectionStatus":{"$ref":"#/components/schemas/collectionStatus"},"expirationDate":{"type":"string","format":"date-time"},"closingDate":{"type":"string","description":"Date when the claim was paid, cancelled or transferred.","format":"date-time","nullable":true},"templateCode":{"minLength":1,"pattern":"[0-9A-Z]{3}","type":"string","description":"Claim template identifier."},"templateId":{"type":"string","description":"Unique Id for each template. This is specific to each bank.","nullable":true},"secondaryCollectionTemplateCode":{"pattern":"[0-9A-Z]{3}","type":"string","description":"Claim template identifier.","nullable":true},"secondaryCollectionTemplateId":{"type":"string","description":"Unique Id for each template. This is specific to each bank.","nullable":true},"categoryCode":{"maxLength":2,"pattern":"[0-9]{2}","type":"string","description":"Creditors' text key, explanation of payment. Optional attribute on claim","nullable":true},"categoryDescription":{"type":"string","description":"Description of the categoryCode","nullable":true},"amount":{"type":"number","description":"Claim amount","format":"double"},"defaultChargeAmountDue":{"type":"number","description":"Amount of default charge to be paid","format":"double","nullable":true},"defaultInterestAmountDue":{"type":"number","description":"Amount of accrued default interests to be paid","format":"double","nullable":true},"discountAmountOffered":{"type":"number","description":"Discount that will be granted when a collection claim is paid based on status","format":"double","nullable":true},"noticeChargeAmountDue":{"type":"number","description":"Amount of notification charge to be paid.","format":"double","nullable":true},"otherCostsAmountDue":{"type":"number","description":"Current other costs to be paid","format":"double","nullable":true},"otherDefaultCostsAmountDue":{"type":"number","description":"Current other default costs to be paid","format":"double","nullable":true},"totalAmountDue":{"type":"number","description":"Total amount to be paid","format":"double","nullable":true},"reference":{"maxLength":16,"type":"string","description":"Reference number determined by creditors.","nullable":true},"finalDueDate":{"type":"string","format":"date-time"},"billNumber":{"maxLength":7,"type":"string","description":"7-character reference id set by claimant. This ID will be visible on the payer's account statement","nullable":true},"customerNumber":{"maxLength":16,"type":"string","description":"16-character reference id set by claimant. Payer's transaction number. Unique key to the payer of the  claim with the creditor. Necessary if a direct payment agreement is to be established","nullable":true},"paymentFee":{"$ref":"#/components/schemas/paymentFee"},"otherCostsAmount":{"type":"number","description":"Other costs, including determined fees paid by the payer of a collection claim.","format":"double","nullable":true},"otherDefaultCostsAmount":{"type":"number","description":"Determined fees, e.g. intermediate collection fee.","format":"double","nullable":true},"defaultCharge":{"$ref":"#/components/schemas/defaultCharge"},"defaultInterest":{"$ref":"#/components/schemas/defaultInterest"},"discount":{"$ref":"#/components/schemas/discount"},"isOutOfSequencePaymentAllowed":{"type":"boolean","description":"Payment rule, is it allowed to pay the last payment if previous has not been paid","nullable":true},"isPartialPaymentAllowed":{"type":"boolean","nullable":true},"isPartiallyPaid":{"type":"boolean","description":"Indicates whether payment has been made on the collection claim","nullable":true},"currency":{"pattern":"[A-Z]{3}","type":"string","nullable":true},"currencyPaymentRate":{"$ref":"#/components/schemas/currencyPaymentRate"},"additionalInformation":{"maxLength":200,"type":"string","description":"Free text that will be displayed on the claim","nullable":true},"printing":{"$ref":"#/components/schemas/printing"},"directPaymentClaim":{"type":"boolean","description":"Is the claim registered as direct payment claim","nullable":true},"print":{"type":"boolean","description":"Indicates whether a claim should be printed","nullable":true},"lastChangeDate":{"type":"string","description":"Last claim change event date.","format":"date-time","nullable":true},"createdDate":{"type":"string","description":"The creation date of the claim.","format":"date-time","nullable":true},"claimType":{"$ref":"#/components/schemas/claimType"}},"additionalProperties":false,"description":"Detailed information for a single claim. May include discount information (fixed amount or percentage) for early payment. A claim includes detailed billing information. After any payment certain monetary fields (including amount) cannot be changed."},"claimKey":{"required":["account","claimantId","dueDate"],"type":"object","properties":{"claimantId":{"minLength":1,"pattern":"[0-9]{10}","type":"string","description":"Icelandic Id number (kennitala)."},"account":{"minLength":1,"pattern":"[0-9]{12}","type":"string","description":"Bank number, ledger and number.\nFor claims ledger is 66 followed by claim number"},"dueDate":{"type":"string","description":"Due date","format":"date-time"}},"additionalProperties":false,"description":"Claim key is a composite key of kennitala, account and due date."},"claimStatus":{"enum":["Unpaid","Paid","Cancelled"],"type":"string","description":"Claim status"},"collectionStatus":{"enum":["PrimaryCollection","SecondaryCollection","LegalCollection"],"type":"string","description":"Claim billing process status."},"paymentFee":{"required":["paperlessFee","printingFee"],"type":"object","properties":{"printingFee":{"type":"number","description":"A fee that is applied if the claim is printed.","format":"double"},"paperlessFee":{"type":"number","description":"A fee that is applied if the claim is paperless. This fee applies to payors who have opted out of receiving printed letters and to direct debit claims.","format":"double"}},"additionalProperties":false,"description":"Additional fee that adds to the claim amount."},"defaultCharge":{"required":["referenceDate"],"type":"object","properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}},"additionalProperties":false,"description":"Default charges configuration. Defines day offsets from the reference date and whether each charge is percentage-based or a fixed amount. For discounts, the amount is calculated from totalAmount. For defaultCharge, the charge amount is calculated from claimAmount."},"referenceDate":{"enum":["DueDate","FinalDueDate"],"type":"string","description":"Specifies the reference date for calculations, allowing the choice between the DueDate and the FinalDueDate as the basis."},"dayAmountItem":{"required":["chargeType","day","value"],"type":"object","properties":{"chargeType":{"$ref":"#/components/schemas/chargeType"},"day":{"maximum":99,"minimum":0,"type":"integer","format":"int32"},"value":{"type":"number","format":"double"}},"additionalProperties":false,"description":"For whether to use fixed amount or calculate by percentage from claimAmount when calculating discount or charge."},"chargeType":{"enum":["Percentage","Amount"],"type":"string"},"defaultInterest":{"required":["referenceDate"],"type":"object","properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"baseAmountType":{"$ref":"#/components/schemas/baseAmountType"},"baseTimeType":{"$ref":"#/components/schemas/baseTimeType"},"percentage":{"type":"number","description":"Indicates the percentage of default interest. If this parameter is not specified or is set to \"0\", the Central Bank's maximum default interest rate is used. Percentage range is between 0 - 100","format":"double","nullable":true}},"additionalProperties":false,"description":"Contains information on how default interest is calculated.\nIf claim should not have default interest, do not send in this object or send it in as \"null\"."},"baseAmountType":{"enum":["Amount","AmountAndDefaultCharge"],"type":"string","description":"Indicates the amount by which the default interest is calculated.\n- Amount: Default interest is calculated on the basis of the amount of the claim.\n- AmountAndDefaultCharge: Default interest is calculated on the basis of the amount and arrears of the claim."},"baseTimeType":{"enum":["Daily","360","Calendar"],"type":"string","description":"Indicates at what time the basis of default interest is calculated. Time = (number of days/time basis)\n- Daily: Daily interest. Time is used = (number of days / 1), Only for the state.\n- 360: Annual interest rate where the year is calculated as 360 days. Time is used = (number of days / 360).\n- Calendar: Annual interest where the year is calculated with calendar days. Time = is used (number of days / calendar days)."},"discount":{"required":["referenceDate"],"type":"object","properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}},"additionalProperties":false,"description":"Contains detail information about claim discount"},"currencyPaymentRate":{"enum":["PaymentDateRate"],"type":"string"},"printing":{"type":"object","properties":{"payorAddress":{"$ref":"#/components/schemas/address"},"itemRows":{"type":"array","items":{"$ref":"#/components/schemas/itemRow"},"description":"Contains information on the breakdown of the collection claim.","nullable":true},"comments":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"description":"Contains information if a collection claim is printed at a bank / savings bank to manage the printout of the collection claim. Changing a printout to a change entry after printing a note does not result in it being reprinted"},"address":{"required":["addressLine","city","country","name","postalCode"],"type":"object","properties":{"name":{"minLength":1,"type":"string"},"addressLine":{"minLength":1,"type":"string"},"postalCode":{"minLength":1,"type":"string"},"city":{"minLength":1,"type":"string"},"country":{"minLength":1,"pattern":"[A-Z]{2}","type":"string"}},"additionalProperties":false,"description":"Address or legal address of a legal entity"},"itemRow":{"type":"object","properties":{"text":{"type":"string","nullable":true},"amount":{"type":"number","format":"double","nullable":true}},"additionalProperties":false,"description":"Contains information on the breakdown of the collection claim."},"claimType":{"enum":["NormalClaim","OptionalPaymentClaim","RefundClaim","BalanceClaim"],"type":"string","description":"The type of the claim which is to be created.\n  - NormalClaim: A regular claim.\n  - OptionalPaymentClaim: An optional payment claim.\n  - RefundClaim: A refund claim.\n  - BalanceClaim: A government balance claim (only for government entities)."},"errorResponse":{"required":["code","type"],"type":"object","properties":{"type":{"maxLength":70,"minLength":1,"type":"string","description":"A URI reference [RFC3986] that identifies the problem type."},"title":{"maxLength":70,"type":"string","description":"Short human readable description of error type. Could be in local language. To be provided by ASPSPs.","nullable":true},"detail":{"maxLength":500,"type":"string","description":"Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.","nullable":true},"code":{"minLength":1,"type":"string","description":"Error code as a string to support different error code types."},"additionalErrors":{"type":"array","items":{"$ref":"#/components/schemas/additionalError"},"description":"Array of Error Information Blocks. Might be used if more than one error is to be communicated.","nullable":true}},"additionalProperties":false,"description":"Standardised definition of reporting error information according to [RFC7807]."},"additionalError":{"required":["code"],"type":"object","properties":{"title":{"maxLength":70,"type":"string","description":"Short human readable description of error type. Could be in local language.","nullable":true},"detail":{"maxLength":500,"type":"string","description":"Detailed human readable text specific to this instance of the error.","nullable":true},"code":{"minLength":1,"type":"string","description":"Error code as a string to support different error code types."}},"additionalProperties":false,"description":"A data element to support the declaration of additional errors in the context of [RFC7807]."},"problemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"httpValidationProblemDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/problemDetails"}],"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"nullable":true}},"additionalProperties":{}}}},"paths":{"/api/v1/claims/{claimId}":{"get":{"tags":["Claims Management"],"summary":"Get single claim","description":"Fetch detailed information for a single claim identified by its claimId.","operationId":"GetClaim","parameters":[{"name":"claimId","in":"path","description":"ClaimId is a composite string key for a claim made of kennitala, account and due date\n  - ClaimantId\n  - Branch number\n  - 66\n  - Claim no\n  - \\+\n  - Date in the form of YYYYMMDD","required":true,"schema":{"type":"string"}},{"name":"X-Request-ID","in":"header","description":"Unique value generated by the client which the resource server uses to recognize subsequent retries of the same request.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Claim details returned.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/claimDetails"}}}},"400":{"description":"Bad Request.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"401":{"description":"Unauthorized.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"403":{"description":"Forbidden.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"404":{"description":"Not found.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"405":{"description":"Method Not Allowed.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"408":{"description":"Request Timeout.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/problemDetails"},{"$ref":"#/components/schemas/httpValidationProblemDetails"}]}}}},"415":{"description":"Unsupported Media Type.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/problemDetails"},{"$ref":"#/components/schemas/httpValidationProblemDetails"}]}}}},"500":{"description":"Internal Server Error.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}}},"503":{"description":"Service Unavailable.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}}}}}}}}
```

## Get single claim history

> Returns the chronological list of events for the claim from its creation onward.\
> Each history entry may include:\
> \- claim: Snapshot of the claim state after the event.\
> \- payment: Payment information if the event relates to a payment.

```json
{"openapi":"3.0.4","info":{"title":"IOBWS 3.0 Claims","version":"v3.2"},"tags":[{"name":"Claims Management","description":"Create, retrieve, modify and track claims."}],"servers":[{"url":"https://apigwsandbox.arionbanki.is/claims","description":"IOBWS 3.0 Claims API - Sandbox"},{"url":"https://apigw.arionbanki.is/claims","description":"IOBWS 3.0 Claims API - Production"}],"security":[{"oauth2":["b2b"],"SubscriptionKey":[]}],"components":{"securitySchemes":{"oauth2":{"type":"http","description":"Authorization header using the Bearer scheme. The Curity-issued OAuth2 access token, sent as `Bearer <token>`. Required on every request.\n\nToken URL: https://apigw.arionbanki.is/oauth/v2/oauth-token","scheme":"bearer"}},"schemas":{"claimHistoryEvent":{"required":["claim","transactionDate","transactionType"],"type":"object","properties":{"claim":{"$ref":"#/components/schemas/claimEvent"},"payment":{"$ref":"#/components/schemas/claimTransaction"},"transactionDate":{"type":"string","format":"date-time"},"transactionType":{"$ref":"#/components/schemas/transactionType"},"userName":{"type":"string","nullable":true},"updatedFields":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"description":"Contains the Claim and Payment class as well as basic information on financial actions and changes to a claim, but the daily account of the Claim Pot's expense items is not shown. The Claim class contains the appearance of the claim as it was after the movement. If payment information is related to the movement, it is returned in the Payment class."},"claimEvent":{"type":"object","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"payorId":{"pattern":"[0-9]{10}","type":"string","description":"Icelandic Id number (kennitala).","nullable":true},"expirationDate":{"type":"string","format":"date-time","nullable":true},"templateCode":{"pattern":"[0-9A-Z]{3}","type":"string","description":"Claim template identifier.","nullable":true},"templateId":{"type":"string","description":"Unique Id for each template. This is specific to each bank.","nullable":true},"amount":{"type":"number","description":"Claim amount","format":"double","nullable":true},"reference":{"maxLength":16,"type":"string","description":"Reference number determined by creditors.","nullable":true},"categoryCode":{"maxLength":2,"pattern":"[0-9]{2}","type":"string","description":"Creditors' text key, explanation of payment. Optional attribute on claim","nullable":true},"finalDueDate":{"type":"string","format":"date-time","nullable":true},"billNumber":{"maxLength":7,"type":"string","description":"7 character reference shown on payer statement","nullable":true},"customerNumber":{"maxLength":16,"type":"string","description":"Payer transaction number (unique per claimant, needed for direct payment agreements)","nullable":true},"paymentFee":{"$ref":"#/components/schemas/paymentFee"},"otherCostsAmount":{"type":"number","description":"Other costs, including determined fees paid by the payer of a collection claim.","format":"double","nullable":true},"otherDefaultCostsAmount":{"type":"number","description":"Determined fees, e.g. intermediate collection fee.","format":"double","nullable":true},"defaultCharge":{"$ref":"#/components/schemas/defaultCharge"},"defaultInterest":{"$ref":"#/components/schemas/defaultInterest"},"discount":{"$ref":"#/components/schemas/discount"},"isOutOfSequencePaymentAllowed":{"type":"boolean","description":"Allow last payment if previous is unpaid","nullable":true},"isPartialPaymentAllowed":{"type":"boolean","description":"Partial payment is allowed.","nullable":true},"currency":{"pattern":"^[A-Z]{3}","type":"string","description":"ISO 4217 currency code.","nullable":true},"additionalInformation":{"maxLength":200,"type":"string","description":"Free text displayed on the claim","nullable":true},"printing":{"$ref":"#/components/schemas/printing"},"claimType":{"$ref":"#/components/schemas/claimType"}},"additionalProperties":false,"description":"Describes an event related to a claim.  Contains optional details about the claim state, changes,  or other relevant information captured at the time of the event."},"claimKey":{"required":["account","claimantId","dueDate"],"type":"object","properties":{"claimantId":{"minLength":1,"pattern":"[0-9]{10}","type":"string","description":"Icelandic Id number (kennitala)."},"account":{"minLength":1,"pattern":"[0-9]{12}","type":"string","description":"Bank number, ledger and number.\nFor claims ledger is 66 followed by claim number"},"dueDate":{"type":"string","description":"Due date","format":"date-time"}},"additionalProperties":false,"description":"Claim key is a composite key of kennitala, account and due date."},"paymentFee":{"required":["paperlessFee","printingFee"],"type":"object","properties":{"printingFee":{"type":"number","description":"A fee that is applied if the claim is printed.","format":"double"},"paperlessFee":{"type":"number","description":"A fee that is applied if the claim is paperless. This fee applies to payors who have opted out of receiving printed letters and to direct debit claims.","format":"double"}},"additionalProperties":false,"description":"Additional fee that adds to the claim amount."},"defaultCharge":{"required":["referenceDate"],"type":"object","properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}},"additionalProperties":false,"description":"Default charges configuration. Defines day offsets from the reference date and whether each charge is percentage-based or a fixed amount. For discounts, the amount is calculated from totalAmount. For defaultCharge, the charge amount is calculated from claimAmount."},"referenceDate":{"enum":["DueDate","FinalDueDate"],"type":"string","description":"Specifies the reference date for calculations, allowing the choice between the DueDate and the FinalDueDate as the basis."},"dayAmountItem":{"required":["chargeType","day","value"],"type":"object","properties":{"chargeType":{"$ref":"#/components/schemas/chargeType"},"day":{"maximum":99,"minimum":0,"type":"integer","format":"int32"},"value":{"type":"number","format":"double"}},"additionalProperties":false,"description":"For whether to use fixed amount or calculate by percentage from claimAmount when calculating discount or charge."},"chargeType":{"enum":["Percentage","Amount"],"type":"string"},"defaultInterest":{"required":["referenceDate"],"type":"object","properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"baseAmountType":{"$ref":"#/components/schemas/baseAmountType"},"baseTimeType":{"$ref":"#/components/schemas/baseTimeType"},"percentage":{"type":"number","description":"Indicates the percentage of default interest. If this parameter is not specified or is set to \"0\", the Central Bank's maximum default interest rate is used. Percentage range is between 0 - 100","format":"double","nullable":true}},"additionalProperties":false,"description":"Contains information on how default interest is calculated.\nIf claim should not have default interest, do not send in this object or send it in as \"null\"."},"baseAmountType":{"enum":["Amount","AmountAndDefaultCharge"],"type":"string","description":"Indicates the amount by which the default interest is calculated.\n- Amount: Default interest is calculated on the basis of the amount of the claim.\n- AmountAndDefaultCharge: Default interest is calculated on the basis of the amount and arrears of the claim."},"baseTimeType":{"enum":["Daily","360","Calendar"],"type":"string","description":"Indicates at what time the basis of default interest is calculated. Time = (number of days/time basis)\n- Daily: Daily interest. Time is used = (number of days / 1), Only for the state.\n- 360: Annual interest rate where the year is calculated as 360 days. Time is used = (number of days / 360).\n- Calendar: Annual interest where the year is calculated with calendar days. Time = is used (number of days / calendar days)."},"discount":{"required":["referenceDate"],"type":"object","properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}},"additionalProperties":false,"description":"Contains detail information about claim discount"},"printing":{"type":"object","properties":{"payorAddress":{"$ref":"#/components/schemas/address"},"itemRows":{"type":"array","items":{"$ref":"#/components/schemas/itemRow"},"description":"Contains information on the breakdown of the collection claim.","nullable":true},"comments":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false,"description":"Contains information if a collection claim is printed at a bank / savings bank to manage the printout of the collection claim. Changing a printout to a change entry after printing a note does not result in it being reprinted"},"address":{"required":["addressLine","city","country","name","postalCode"],"type":"object","properties":{"name":{"minLength":1,"type":"string"},"addressLine":{"minLength":1,"type":"string"},"postalCode":{"minLength":1,"type":"string"},"city":{"minLength":1,"type":"string"},"country":{"minLength":1,"pattern":"[A-Z]{2}","type":"string"}},"additionalProperties":false,"description":"Address or legal address of a legal entity"},"itemRow":{"type":"object","properties":{"text":{"type":"string","nullable":true},"amount":{"type":"number","format":"double","nullable":true}},"additionalProperties":false,"description":"Contains information on the breakdown of the collection claim."},"claimType":{"enum":["NormalClaim","OptionalPaymentClaim","RefundClaim","BalanceClaim"],"type":"string","description":"The type of the claim which is to be created.\n  - NormalClaim: A regular claim.\n  - OptionalPaymentClaim: An optional payment claim.\n  - RefundClaim: A refund claim.\n  - BalanceClaim: A government balance claim (only for government entities)."},"claimTransaction":{"type":"object","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"payorId":{"pattern":"[0-9]{10}","type":"string","description":"Icelandic Id number (kennitala).","nullable":true},"amount":{"type":"number","description":"Principal amount","format":"double","nullable":true},"finalDueDate":{"type":"string","format":"date-time","nullable":true},"templateCode":{"pattern":"[0-9A-Z]{3}","type":"string","description":"Claim template identifier.","nullable":true},"templateId":{"type":"string","description":"Unique Id for each template. This is specific to each bank.","nullable":true},"secondaryCollectionTemplateCode":{"pattern":"[0-9A-Z]{3}","type":"string","description":"Claim template identifier.","nullable":true},"secondaryCollectionTemplateId":{"type":"string","description":"Unique Id for each template. This is specific to each bank.","nullable":true},"reference":{"maxLength":16,"type":"string","description":"Reference number determined by creditors.","nullable":true},"categoryCode":{"maxLength":2,"pattern":"[0-9]{2}","type":"string","description":"Creditors' text key, explanation of payment. Optional attribute on claim","nullable":true},"categoryDescription":{"type":"string","description":"Description of the categoryCode","nullable":true},"transactionBank":{"pattern":"^[0-9]{4}$","type":"string","description":"The bank from which the transaction originates.","nullable":true},"transactionTimestamp":{"type":"string","description":"Timestamp when payment is performed.","format":"date-time","nullable":true},"bookingDate":{"type":"string","description":"Date of settlement.","format":"date-time","nullable":true},"valueDate":{"type":"string","description":"Legal date of the date on which the effective date or interest date of payment is based, a maximum  of 10 calendar days back in time. If the date is not specified, blank, then it is based on the  transaction date.  Payment of a claim is the interest date of the effective date of default interest.","format":"date-time","nullable":true},"paymentType":{"$ref":"#/components/schemas/paymentType"},"depositedAmount":{"type":"number","description":"The amount deposited at the creditor's account.","format":"double","nullable":true},"totalAmountPaid":{"type":"number","description":"Total amount paid with accrued interests and fees.","format":"double","nullable":true},"capitalGainsTax":{"type":"number","description":"Deducted capital gains tax.","format":"double","nullable":true},"billNumber":{"maxLength":7,"type":"string","description":"7-character reference id set by claimant. This ID will be visible on the payer's account statement","nullable":true},"customerNumber":{"maxLength":16,"type":"string","description":"16-character reference id set by claimant. Payer's transaction number. Unique key to the payer of the  claim with the creditor. Necessary if a direct payment agreement is to be established","nullable":true},"noticeChargeAmountPaid":{"type":"number","description":"Notice charge paid.","format":"double","nullable":true},"defaultChargeAmountPaid":{"type":"number","description":"Default charge paid.","format":"double","nullable":true},"otherCostsAmountPaid":{"type":"number","description":"Other costs paid.","format":"double","nullable":true},"otherDefaultCostsAmountPaid":{"type":"number","description":"Other default costs paid.","format":"double","nullable":true},"defaultInterestAmountPaid":{"type":"number","description":"Amount of accrued default interests paid.","format":"double","nullable":true},"discountAmountGiven":{"type":"number","description":"Discount that was granted when the claim was paid.","format":"double","nullable":true},"currency":{"pattern":"[A-Z]{3}","type":"string","nullable":true},"currencyExchange":{"$ref":"#/components/schemas/currencyExchangeRate"},"transactionBatchId":{"type":"string","description":"The identifier of the batch from which the transaction originates.","nullable":true}},"additionalProperties":false,"description":"Contains individual claim transaction information."},"paymentType":{"enum":["Complete","Partial","Refund"],"type":"string","description":"Type of payment, full payment, deposit, refund."},"currencyExchangeRate":{"type":"object","properties":{"currency":{"type":"string","nullable":true},"rate":{"type":"number","format":"double","nullable":true}},"additionalProperties":false,"description":"Currency contains exchange rate information. Used for collection claims in foreign currency."},"transactionType":{"enum":["Creation","Update","Cancellation","CancellationByPayor","Payment","PartialPayment","RefundPayment","ReversedPayment","ReversedPartialPayment","ReversedClaim","TransferFromBank","TransferToBank"],"type":"string","description":"One of:\n- Creation: Creation of a claim.\n- Update: Change of claim.\n- Cancellation: Cancellation of a claim by a creditor or according to the applicable rule.\n- CancellationByPayor: Cancellation by the creditor of the optional payment.\n- Payment: Full payment of a claim.\n- PartialPayment: Deposit on demand.\n- RefundPayment: Payment of repayment claim.\n- ReversedPayment: Reversed payment. When reversing a full payment, the payment entry is marked as ReAdjustment in the transaction type, but the reversal itself is given this meaning.\n- ReversedPartialPayment: Reversed deposit. When reversing a deposit, the payment entry is marked as ReAdjustment in the transaction type, but the reversal itself is given this meaning.\n- ReversedClaim: A reversal of a claim due to a reversal of a payment.\n- TransferFromBank: Transfer of a claim from one bank (see ClaimId) to another bank.\n- TransferToBank: Transfer of a claim to a bank (see ClaimId) from another bank."},"errorResponse":{"required":["code","type"],"type":"object","properties":{"type":{"maxLength":70,"minLength":1,"type":"string","description":"A URI reference [RFC3986] that identifies the problem type."},"title":{"maxLength":70,"type":"string","description":"Short human readable description of error type. Could be in local language. To be provided by ASPSPs.","nullable":true},"detail":{"maxLength":500,"type":"string","description":"Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.","nullable":true},"code":{"minLength":1,"type":"string","description":"Error code as a string to support different error code types."},"additionalErrors":{"type":"array","items":{"$ref":"#/components/schemas/additionalError"},"description":"Array of Error Information Blocks. Might be used if more than one error is to be communicated.","nullable":true}},"additionalProperties":false,"description":"Standardised definition of reporting error information according to [RFC7807]."},"additionalError":{"required":["code"],"type":"object","properties":{"title":{"maxLength":70,"type":"string","description":"Short human readable description of error type. Could be in local language.","nullable":true},"detail":{"maxLength":500,"type":"string","description":"Detailed human readable text specific to this instance of the error.","nullable":true},"code":{"minLength":1,"type":"string","description":"Error code as a string to support different error code types."}},"additionalProperties":false,"description":"A data element to support the declaration of additional errors in the context of [RFC7807]."},"problemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"httpValidationProblemDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/problemDetails"}],"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"nullable":true}},"additionalProperties":{}}}},"paths":{"/api/v1/claims/{claimId}/history":{"get":{"tags":["Claims Management"],"summary":"Get single claim history","description":"Returns the chronological list of events for the claim from its creation onward.\nEach history entry may include:\n- claim: Snapshot of the claim state after the event.\n- payment: Payment information if the event relates to a payment.","operationId":"GetClaimHistory","parameters":[{"name":"claimId","in":"path","description":"ClaimId is a composite string key for a claim made of kennitala, account and due date\n  - ClaimantId\n  - Branch number\n  - 66\n  - Claim no\n  - \\+\n  - Date in the form of YYYYMMDD","required":true,"schema":{"type":"string"}},{"name":"X-Request-ID","in":"header","description":"Unique value generated by the client which the resource server uses to recognize subsequent retries of the same request.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"itemsPerPage","in":"query","description":"Number of displayed items. Maximum is 500.","schema":{"maximum":500,"minimum":1,"type":"integer","format":"int32","default":500}},{"name":"page","in":"query","description":"Page number in the result","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32","default":1}}],"responses":{"200":{"description":"Claim history list information response.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}},"X-Paging-CurrentPage":{"description":"Current page number.","schema":{"type":"integer","description":"Current page number.","format":""}},"X-Paging-TotalPages":{"description":"Total number of pages.","schema":{"type":"integer","description":"Total number of pages.","format":""}},"X-Paging-TotalItems":{"description":"Total number of items.","schema":{"type":"integer","description":"Total number of items.","format":""}},"X-Paging-PerPage":{"description":"Number of items per page.","schema":{"type":"integer","description":"Number of items per page.","format":""}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/claimHistoryEvent"},"description":"Claim history"}}}},"400":{"description":"Bad Request.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"401":{"description":"Unauthorized.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"403":{"description":"Forbidden.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"404":{"description":"Not found.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"405":{"description":"Method Not Allowed.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"408":{"description":"Request Timeout.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/problemDetails"},{"$ref":"#/components/schemas/httpValidationProblemDetails"}]}}}},"415":{"description":"Unsupported Media Type.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/problemDetails"},{"$ref":"#/components/schemas/httpValidationProblemDetails"}]}}}},"500":{"description":"Internal Server Error.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}}},"503":{"description":"Service Unavailable.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}}}}}}}}
```

## Get payments for a single claim

> Returns all payment transactions for the specified claim in near real-time.

```json
{"openapi":"3.0.4","info":{"title":"IOBWS 3.0 Claims","version":"v3.2"},"tags":[{"name":"Claims Management","description":"Create, retrieve, modify and track claims."}],"servers":[{"url":"https://apigwsandbox.arionbanki.is/claims","description":"IOBWS 3.0 Claims API - Sandbox"},{"url":"https://apigw.arionbanki.is/claims","description":"IOBWS 3.0 Claims API - Production"}],"security":[{"oauth2":["b2b"],"SubscriptionKey":[]}],"components":{"securitySchemes":{"oauth2":{"type":"http","description":"Authorization header using the Bearer scheme. The Curity-issued OAuth2 access token, sent as `Bearer <token>`. Required on every request.\n\nToken URL: https://apigw.arionbanki.is/oauth/v2/oauth-token","scheme":"bearer"}},"schemas":{"claimTransaction":{"type":"object","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"payorId":{"pattern":"[0-9]{10}","type":"string","description":"Icelandic Id number (kennitala).","nullable":true},"amount":{"type":"number","description":"Principal amount","format":"double","nullable":true},"finalDueDate":{"type":"string","format":"date-time","nullable":true},"templateCode":{"pattern":"[0-9A-Z]{3}","type":"string","description":"Claim template identifier.","nullable":true},"templateId":{"type":"string","description":"Unique Id for each template. This is specific to each bank.","nullable":true},"secondaryCollectionTemplateCode":{"pattern":"[0-9A-Z]{3}","type":"string","description":"Claim template identifier.","nullable":true},"secondaryCollectionTemplateId":{"type":"string","description":"Unique Id for each template. This is specific to each bank.","nullable":true},"reference":{"maxLength":16,"type":"string","description":"Reference number determined by creditors.","nullable":true},"categoryCode":{"maxLength":2,"pattern":"[0-9]{2}","type":"string","description":"Creditors' text key, explanation of payment. Optional attribute on claim","nullable":true},"categoryDescription":{"type":"string","description":"Description of the categoryCode","nullable":true},"transactionBank":{"pattern":"^[0-9]{4}$","type":"string","description":"The bank from which the transaction originates.","nullable":true},"transactionTimestamp":{"type":"string","description":"Timestamp when payment is performed.","format":"date-time","nullable":true},"bookingDate":{"type":"string","description":"Date of settlement.","format":"date-time","nullable":true},"valueDate":{"type":"string","description":"Legal date of the date on which the effective date or interest date of payment is based, a maximum  of 10 calendar days back in time. If the date is not specified, blank, then it is based on the  transaction date.  Payment of a claim is the interest date of the effective date of default interest.","format":"date-time","nullable":true},"paymentType":{"$ref":"#/components/schemas/paymentType"},"depositedAmount":{"type":"number","description":"The amount deposited at the creditor's account.","format":"double","nullable":true},"totalAmountPaid":{"type":"number","description":"Total amount paid with accrued interests and fees.","format":"double","nullable":true},"capitalGainsTax":{"type":"number","description":"Deducted capital gains tax.","format":"double","nullable":true},"billNumber":{"maxLength":7,"type":"string","description":"7-character reference id set by claimant. This ID will be visible on the payer's account statement","nullable":true},"customerNumber":{"maxLength":16,"type":"string","description":"16-character reference id set by claimant. Payer's transaction number. Unique key to the payer of the  claim with the creditor. Necessary if a direct payment agreement is to be established","nullable":true},"noticeChargeAmountPaid":{"type":"number","description":"Notice charge paid.","format":"double","nullable":true},"defaultChargeAmountPaid":{"type":"number","description":"Default charge paid.","format":"double","nullable":true},"otherCostsAmountPaid":{"type":"number","description":"Other costs paid.","format":"double","nullable":true},"otherDefaultCostsAmountPaid":{"type":"number","description":"Other default costs paid.","format":"double","nullable":true},"defaultInterestAmountPaid":{"type":"number","description":"Amount of accrued default interests paid.","format":"double","nullable":true},"discountAmountGiven":{"type":"number","description":"Discount that was granted when the claim was paid.","format":"double","nullable":true},"currency":{"pattern":"[A-Z]{3}","type":"string","nullable":true},"currencyExchange":{"$ref":"#/components/schemas/currencyExchangeRate"},"transactionBatchId":{"type":"string","description":"The identifier of the batch from which the transaction originates.","nullable":true}},"additionalProperties":false,"description":"Contains individual claim transaction information."},"claimKey":{"required":["account","claimantId","dueDate"],"type":"object","properties":{"claimantId":{"minLength":1,"pattern":"[0-9]{10}","type":"string","description":"Icelandic Id number (kennitala)."},"account":{"minLength":1,"pattern":"[0-9]{12}","type":"string","description":"Bank number, ledger and number.\nFor claims ledger is 66 followed by claim number"},"dueDate":{"type":"string","description":"Due date","format":"date-time"}},"additionalProperties":false,"description":"Claim key is a composite key of kennitala, account and due date."},"paymentType":{"enum":["Complete","Partial","Refund"],"type":"string","description":"Type of payment, full payment, deposit, refund."},"currencyExchangeRate":{"type":"object","properties":{"currency":{"type":"string","nullable":true},"rate":{"type":"number","format":"double","nullable":true}},"additionalProperties":false,"description":"Currency contains exchange rate information. Used for collection claims in foreign currency."},"errorResponse":{"required":["code","type"],"type":"object","properties":{"type":{"maxLength":70,"minLength":1,"type":"string","description":"A URI reference [RFC3986] that identifies the problem type."},"title":{"maxLength":70,"type":"string","description":"Short human readable description of error type. Could be in local language. To be provided by ASPSPs.","nullable":true},"detail":{"maxLength":500,"type":"string","description":"Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.","nullable":true},"code":{"minLength":1,"type":"string","description":"Error code as a string to support different error code types."},"additionalErrors":{"type":"array","items":{"$ref":"#/components/schemas/additionalError"},"description":"Array of Error Information Blocks. Might be used if more than one error is to be communicated.","nullable":true}},"additionalProperties":false,"description":"Standardised definition of reporting error information according to [RFC7807]."},"additionalError":{"required":["code"],"type":"object","properties":{"title":{"maxLength":70,"type":"string","description":"Short human readable description of error type. Could be in local language.","nullable":true},"detail":{"maxLength":500,"type":"string","description":"Detailed human readable text specific to this instance of the error.","nullable":true},"code":{"minLength":1,"type":"string","description":"Error code as a string to support different error code types."}},"additionalProperties":false,"description":"A data element to support the declaration of additional errors in the context of [RFC7807]."},"problemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"httpValidationProblemDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/problemDetails"}],"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"nullable":true}},"additionalProperties":{}}}},"paths":{"/api/v1/claims/{claimId}/transactions":{"get":{"tags":["Claims Management"],"summary":"Get payments for a single claim","description":"Returns all payment transactions for the specified claim in near real-time.","operationId":"GetClaimTransactions","parameters":[{"name":"claimId","in":"path","description":"ClaimId is a composite string key for a claim made of kennitala, account and due date\n  - ClaimantId\n  - Branch number\n  - 66\n  - Claim no\n  - \\+\n  - Date in the form of YYYYMMDD","required":true,"schema":{"type":"string"}},{"name":"X-Request-ID","in":"header","description":"Unique value generated by the client which the resource server uses to recognize subsequent retries of the same request.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"itemsPerPage","in":"query","description":"Number of displayed items. Maximum is 500.","schema":{"maximum":500,"minimum":1,"type":"integer","format":"int32","default":500}},{"name":"page","in":"query","description":"Page number in the result","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32","default":1}}],"responses":{"200":{"description":"Claim transaction list information.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}},"X-Paging-CurrentPage":{"description":"Current page number.","schema":{"type":"integer","description":"Current page number.","format":""}},"X-Paging-TotalPages":{"description":"Total number of pages.","schema":{"type":"integer","description":"Total number of pages.","format":""}},"X-Paging-TotalItems":{"description":"Total number of items.","schema":{"type":"integer","description":"Total number of items.","format":""}},"X-Paging-PerPage":{"description":"Number of items per page.","schema":{"type":"integer","description":"Number of items per page.","format":""}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/claimTransaction"},"description":"List of claim payments"}}}},"400":{"description":"Bad Request.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"401":{"description":"Unauthorized.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"403":{"description":"Forbidden.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"404":{"description":"Not found.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"405":{"description":"Method Not Allowed.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"408":{"description":"Request Timeout.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/problemDetails"},{"$ref":"#/components/schemas/httpValidationProblemDetails"}]}}}},"415":{"description":"Unsupported Media Type.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/problemDetails"},{"$ref":"#/components/schemas/httpValidationProblemDetails"}]}}}},"500":{"description":"Internal Server Error.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}}},"503":{"description":"Service Unavailable.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}}}}}}}}
```

## Get payments for multiple claims

> Returns a paginated list of payment transactions filtered by optional query parameters.\
> Omitted filters broaden the result set.

```json
{"openapi":"3.0.4","info":{"title":"IOBWS 3.0 Claims","version":"v3.2"},"tags":[{"name":"Claims Management","description":"Create, retrieve, modify and track claims."}],"servers":[{"url":"https://apigwsandbox.arionbanki.is/claims","description":"IOBWS 3.0 Claims API - Sandbox"},{"url":"https://apigw.arionbanki.is/claims","description":"IOBWS 3.0 Claims API - Production"}],"security":[{"oauth2":["b2b"],"SubscriptionKey":[]}],"components":{"securitySchemes":{"oauth2":{"type":"http","description":"Authorization header using the Bearer scheme. The Curity-issued OAuth2 access token, sent as `Bearer <token>`. Required on every request.\n\nToken URL: https://apigw.arionbanki.is/oauth/v2/oauth-token","scheme":"bearer"}},"schemas":{"claimTransaction":{"type":"object","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"payorId":{"pattern":"[0-9]{10}","type":"string","description":"Icelandic Id number (kennitala).","nullable":true},"amount":{"type":"number","description":"Principal amount","format":"double","nullable":true},"finalDueDate":{"type":"string","format":"date-time","nullable":true},"templateCode":{"pattern":"[0-9A-Z]{3}","type":"string","description":"Claim template identifier.","nullable":true},"templateId":{"type":"string","description":"Unique Id for each template. This is specific to each bank.","nullable":true},"secondaryCollectionTemplateCode":{"pattern":"[0-9A-Z]{3}","type":"string","description":"Claim template identifier.","nullable":true},"secondaryCollectionTemplateId":{"type":"string","description":"Unique Id for each template. This is specific to each bank.","nullable":true},"reference":{"maxLength":16,"type":"string","description":"Reference number determined by creditors.","nullable":true},"categoryCode":{"maxLength":2,"pattern":"[0-9]{2}","type":"string","description":"Creditors' text key, explanation of payment. Optional attribute on claim","nullable":true},"categoryDescription":{"type":"string","description":"Description of the categoryCode","nullable":true},"transactionBank":{"pattern":"^[0-9]{4}$","type":"string","description":"The bank from which the transaction originates.","nullable":true},"transactionTimestamp":{"type":"string","description":"Timestamp when payment is performed.","format":"date-time","nullable":true},"bookingDate":{"type":"string","description":"Date of settlement.","format":"date-time","nullable":true},"valueDate":{"type":"string","description":"Legal date of the date on which the effective date or interest date of payment is based, a maximum  of 10 calendar days back in time. If the date is not specified, blank, then it is based on the  transaction date.  Payment of a claim is the interest date of the effective date of default interest.","format":"date-time","nullable":true},"paymentType":{"$ref":"#/components/schemas/paymentType"},"depositedAmount":{"type":"number","description":"The amount deposited at the creditor's account.","format":"double","nullable":true},"totalAmountPaid":{"type":"number","description":"Total amount paid with accrued interests and fees.","format":"double","nullable":true},"capitalGainsTax":{"type":"number","description":"Deducted capital gains tax.","format":"double","nullable":true},"billNumber":{"maxLength":7,"type":"string","description":"7-character reference id set by claimant. This ID will be visible on the payer's account statement","nullable":true},"customerNumber":{"maxLength":16,"type":"string","description":"16-character reference id set by claimant. Payer's transaction number. Unique key to the payer of the  claim with the creditor. Necessary if a direct payment agreement is to be established","nullable":true},"noticeChargeAmountPaid":{"type":"number","description":"Notice charge paid.","format":"double","nullable":true},"defaultChargeAmountPaid":{"type":"number","description":"Default charge paid.","format":"double","nullable":true},"otherCostsAmountPaid":{"type":"number","description":"Other costs paid.","format":"double","nullable":true},"otherDefaultCostsAmountPaid":{"type":"number","description":"Other default costs paid.","format":"double","nullable":true},"defaultInterestAmountPaid":{"type":"number","description":"Amount of accrued default interests paid.","format":"double","nullable":true},"discountAmountGiven":{"type":"number","description":"Discount that was granted when the claim was paid.","format":"double","nullable":true},"currency":{"pattern":"[A-Z]{3}","type":"string","nullable":true},"currencyExchange":{"$ref":"#/components/schemas/currencyExchangeRate"},"transactionBatchId":{"type":"string","description":"The identifier of the batch from which the transaction originates.","nullable":true}},"additionalProperties":false,"description":"Contains individual claim transaction information."},"claimKey":{"required":["account","claimantId","dueDate"],"type":"object","properties":{"claimantId":{"minLength":1,"pattern":"[0-9]{10}","type":"string","description":"Icelandic Id number (kennitala)."},"account":{"minLength":1,"pattern":"[0-9]{12}","type":"string","description":"Bank number, ledger and number.\nFor claims ledger is 66 followed by claim number"},"dueDate":{"type":"string","description":"Due date","format":"date-time"}},"additionalProperties":false,"description":"Claim key is a composite key of kennitala, account and due date."},"paymentType":{"enum":["Complete","Partial","Refund"],"type":"string","description":"Type of payment, full payment, deposit, refund."},"currencyExchangeRate":{"type":"object","properties":{"currency":{"type":"string","nullable":true},"rate":{"type":"number","format":"double","nullable":true}},"additionalProperties":false,"description":"Currency contains exchange rate information. Used for collection claims in foreign currency."},"errorResponse":{"required":["code","type"],"type":"object","properties":{"type":{"maxLength":70,"minLength":1,"type":"string","description":"A URI reference [RFC3986] that identifies the problem type."},"title":{"maxLength":70,"type":"string","description":"Short human readable description of error type. Could be in local language. To be provided by ASPSPs.","nullable":true},"detail":{"maxLength":500,"type":"string","description":"Detailed human readable text specific to this instance of the error. XPath might be used to point to the issue generating the error in addition.\nRemark for Future: In future, a dedicated field might be introduced for the XPath.","nullable":true},"code":{"minLength":1,"type":"string","description":"Error code as a string to support different error code types."},"additionalErrors":{"type":"array","items":{"$ref":"#/components/schemas/additionalError"},"description":"Array of Error Information Blocks. Might be used if more than one error is to be communicated.","nullable":true}},"additionalProperties":false,"description":"Standardised definition of reporting error information according to [RFC7807]."},"additionalError":{"required":["code"],"type":"object","properties":{"title":{"maxLength":70,"type":"string","description":"Short human readable description of error type. Could be in local language.","nullable":true},"detail":{"maxLength":500,"type":"string","description":"Detailed human readable text specific to this instance of the error.","nullable":true},"code":{"minLength":1,"type":"string","description":"Error code as a string to support different error code types."}},"additionalProperties":false,"description":"A data element to support the declaration of additional errors in the context of [RFC7807]."},"problemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"httpValidationProblemDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/problemDetails"}],"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"nullable":true}},"additionalProperties":{}}}},"paths":{"/api/v1/claims/transactions":{"get":{"tags":["Claims Management"],"summary":"Get payments for multiple claims","description":"Returns a paginated list of payment transactions filtered by optional query parameters.\nOmitted filters broaden the result set.","operationId":"GetClaimsTransactions","parameters":[{"name":"claimantId","in":"query","description":"Claimant id","schema":{"pattern":"[0-9]{10}","type":"string"}},{"name":"dateFrom","in":"query","description":"Date from","required":true,"schema":{"type":"string","format":"date"}},{"name":"dateTo","in":"query","description":"Date to","required":true,"schema":{"type":"string","format":"date"}},{"name":"templateCode","in":"query","description":"Template code","schema":{"pattern":"[0-9A-Z]{3}","type":"string"}},{"name":"depositAccount","in":"query","description":"Deposit account","schema":{"pattern":"[0-9]{12}","type":"string"}},{"name":"payorId","in":"query","description":"Payor id","schema":{"pattern":"[0-9]{10}","type":"string"}},{"name":"X-Request-ID","in":"header","description":"Unique value generated by the client which the resource server uses to recognize subsequent retries of the same request.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"itemsPerPage","in":"query","description":"Number of displayed items. Maximum is 500.","schema":{"maximum":500,"minimum":1,"type":"integer","format":"int32","default":500}},{"name":"page","in":"query","description":"Page number in the result","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32","default":1}}],"responses":{"200":{"description":"Claim transaction list information.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}},"X-Paging-CurrentPage":{"description":"Current page number.","schema":{"type":"integer","description":"Current page number.","format":""}},"X-Paging-TotalPages":{"description":"Total number of pages.","schema":{"type":"integer","description":"Total number of pages.","format":""}},"X-Paging-TotalItems":{"description":"Total number of items.","schema":{"type":"integer","description":"Total number of items.","format":""}},"X-Paging-PerPage":{"description":"Number of items per page.","schema":{"type":"integer","description":"Number of items per page.","format":""}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/claimTransaction"},"description":"List of claim payments"}}}},"400":{"description":"Bad Request.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"401":{"description":"Unauthorized.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"403":{"description":"Forbidden.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"404":{"description":"Not found.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"405":{"description":"Method Not Allowed.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}},"408":{"description":"Request Timeout.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/problemDetails"},{"$ref":"#/components/schemas/httpValidationProblemDetails"}]}}}},"415":{"description":"Unsupported Media Type.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/problemDetails"},{"$ref":"#/components/schemas/httpValidationProblemDetails"}]}}}},"500":{"description":"Internal Server Error.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}}},"503":{"description":"Service Unavailable.","headers":{"X-Request-ID":{"description":"Unique request identifier, echoed from the request.","required":true,"schema":{"type":"string","description":"Unique request identifier, echoed from the request.","format":""}}}}}}}}}
```