> 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-refererence.md).

# Claims API Refererence

Below is a documentation of the ClaimsAPI. Alternatively, you can view our redocly documentation for the service: https\://arion-iobws-claims.redoc.ly/

<a href="https://openapi.gitbook.com/o/0A1P6YvuPxpINWkYJpBX/spec/new-BAPI-Claims.yaml" class="button primary" data-icon="circle-arrow-down">Download Open API yaml file</a>

## Get a list of claim templates

> Returns a list of claim templates according to the filters provided. Claim template describes many \
> attributes of the claim process and gives the consumer key information needed.<br>

```json
{"openapi":"3.0.2","info":{"title":"IOBWS 3.0 Domestic Claims","version":"v3.2"},"tags":[{"name":"Claim Service","description":"Common Claim operations for icelandic banks"}],"servers":[{"url":"https://apigw.arionbanki.is/claims","description":"IOBWS 3.0 Claims API"}],"security":[{"oauth2":["openid","profile","b2b","claimscollection"]}],"components":{"securitySchemes":{},"parameters":{"claimantId":{"name":"claimantId","in":"query","description":"ClaimantId is the Icelandic kennitala for the claimant\n","required":false,"schema":{"$ref":"#/components/schemas/kennitala"}},"bank":{"name":"bank","in":"query","description":"Branch number\n","schema":{"$ref":"#/components/schemas/bank"}},"templateCode":{"name":"templateCode","in":"query","description":"Claim template code\n","schema":{"$ref":"#/components/schemas/templateCode"}},"isActive":{"name":"isActive","in":"query","description":"Is active state true or false.\n","schema":{"$ref":"#/components/schemas/isActive"}},"page":{"name":"page","in":"query","description":"Requested page","required":false,"schema":{"type":"integer","default":1}},"itemsPerPage":{"name":"itemsPerPage","in":"query","description":"Records per page","required":false,"schema":{"type":"integer","default":100}},"X-Request-ID":{"name":"X-Request-ID","in":"header","description":"Unique value generated by the client which the resource server uses to recognize subsequent \nretries of the same request.\n","required":true,"schema":{"type":"string","format":"uuid"}}},"schemas":{"kennitala":{"description":"Icelandic Id number (kennitala).\n","type":"string","pattern":"[0-9]{10}"},"bank":{"description":"Icelandic branch number.\n","type":"string","pattern":"[0-9]{4}"},"templateCode":{"description":"Claim template identifier.\n","type":"string","pattern":"[0-9A-Z]{3}"},"isActive":{"description":"Describes is active state.","type":"boolean"},"templateList":{"description":"List of claim templates\n","type":"array","items":{"$ref":"#/components/schemas/templateListDetails"}},"templateListDetails":{"description":"Claim template details.\n","type":"object","properties":{"templateId":{"description":"Unique Id for each template. This is specific to each bank.","type":"string"},"claimantId":{"$ref":"#/components/schemas/claimantId"},"bank":{"$ref":"#/components/schemas/bank"},"templateCode":{"$ref":"#/components/schemas/templateCode"},"collectionType":{"$ref":"#/components/schemas/collectionType"},"category":{"$ref":"#/components/schemas/claimTemplateCategory"},"claimantStatementExtendedReferenceType":{"$ref":"#/components/schemas/claimantStatementExtendedReferenceType"},"customerNumberTemplate":{"description":"Describes how the transaction number template is structured for the claim template.","type":"string","maxLength":16},"claimantStatementReferenceType":{"$ref":"#/components/schemas/claimantStatementReferenceType"},"depositAccount":{"$ref":"#/components/schemas/depositAccount"},"secondaryCollectionTemplateCode":{"description":"ID of a collection claim template to which claims are transferred.\n","type":"string","pattern":"[0-9A-Za-z]{3}"},"withdrawalAccount":{"$ref":"#/components/schemas/account"}}},"claimantId":{"description":"ClaimantId is the Icelandic kennitala for the claimant\n","type":"string","pattern":"[0-9]{10}"},"collectionType":{"type":"string","enum":["PrimaryCollection","SecondaryCollection"]},"claimTemplateCategory":{"type":"object","required":["code"],"properties":{"code":{"type":"string","maxLength":2,"minLength":2},"name":{"type":"string","maxLength":30}}},"claimantStatementExtendedReferenceType":{"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)\n","type":"string","enum":["ReferenceNumber","CustomerNumber","ClaimId","PayorId","DueDate"]},"claimantStatementReferenceType":{"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)\n","type":"string","enum":["DueDate","BillNumber","ClaimNumber"]},"depositAccount":{"description":"Information on the main disposal account.\n","properties":{"id":{"$ref":"#/components/schemas/account"},"ownerId":{"$ref":"#/components/schemas/kennitala"}}},"account":{"description":"Bank number, ledger and number.\nFor claims ledger is 66 followed by claim number\n","type":"string","pattern":"[0-9]{12}"},"Error400":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode400"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode400"}}}}}},"MessageCode400":{"description":"Message codes. HTTP Error code 400 (BAD_REQUEST).","type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED","SERVICE_INVALID","RESOURCE_UNKNOWN","RESOURCE_EXPIRED","RESOURCE_BLOCKED","TIMESTAMP_INVALID","PERIOD_INVALID","SCA_METHOD_UNKNOWN","SCA_INVALID","CONSENT_UNKNOWN","SESSIONS_NOT_SUPPORTED"]},"errorTitle":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"errorDetail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"Error401":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode401"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode401"}}}}}},"MessageCode401":{"description":"Message codes. HTTP Error code 401 (UNAUTHORIZED).","type":"string","enum":["CERTIFICATE_INVALID","ROLE_INVALID","CERTIFICATE_EXPIRED","CERTIFICATE_BLOCKED","CERTIFICATE_REVOKE","CERTIFICATE_MISSING","SIGNATURE_INVALID","SIGNATURE_MISSING","TOKEN_UNKNOWN","TOKEN_INVALID","TOKEN_EXPIRED"]},"Error403_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 403.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message403"}}}},"message403":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode403"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"messageCategory":{"description":"Category of the message category.","type":"string","enum":["ERROR","WARNING"]},"MessageCode403":{"description":"Message codes. HTTP Error code 403 (FORBIDDEN).","type":"string","enum":["CONSENT_UNKNOWN","SERVICE_BLOCKED","RESOURCE_UNKNOWN","RESOURCE_EXPIRED"]},"messageText":{"description":"Additional explaining text.","type":"string","maxLength":500},"Error403":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode403"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode403"}}}}}},"Error404_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 404.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message404"}}}},"message404":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode404"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"MessageCode404":{"description":"Message codes. HTTP Error code 404 (NOT FOUND).","type":"string","enum":["RESOURCE_UNKNOWN"]},"Error404":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode404"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode404"}}}}}},"Error405_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 405.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message405"}}}},"message405":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode405"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"MessageCode405":{"description":"Message codes. HTTP Error code 405 (METHOD NOT ALLOWED).","type":"string","enum":["SERVICE_INVALID"]},"Error405":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode405"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode405"}}}}}}},"responses":{"OK_200_ClaimListTemplate":{"description":"Claim list template.\n","headers":{"X-Paging-CurrentPage":{"description":"Current page number\n","schema":{"type":"integer"}},"X-Paging-TotalPages":{"description":"Total pages\n","schema":{"type":"integer"}},"X-Paging-TotalItems":{"description":"Total items\n","schema":{"type":"integer"}},"X-Paging-PerPage":{"description":"Items per page\n","schema":{"type":"integer"}},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateList"}}}},"BAD_REQUEST_400":{"description":"Bad Request","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error400"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error400"}}}},"UNAUTHORIZED_401":{"description":"Unauthorized","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error401"}}}},"FORBIDDEN_403":{"description":"Forbidden","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error403_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error403"}}}},"NOT_FOUND_404":{"description":"Not found","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error404_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error404"}}}},"METHOD_NOT_ALLOWED_405":{"description":"Method Not Allowed","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error405_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error405"}}}},"REQUEST_TIMEOUT_408":{"description":"Request Timeout","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"UNSUPPORTED_MEDIA_TYPE_415":{"description":"Unsupported Media Type","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"INTERNAL_SERVER_ERROR_500":{"description":"Internal Server Error","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"SERVICE_UNAVAILABLE_503":{"description":"Service Unavailable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"type":"string","format":"uuid"}},"Location":{"description":"Location of the created resource.\n","schema":{"type":"string","format":"url"},"required":false}}},"paths":{"/api/v1/templates":{"get":{"summary":"Get a list of claim templates","description":"Returns a list of claim templates according to the filters provided. Claim template describes many \nattributes of the claim process and gives the consumer key information needed.\n","operationId":"getTemplateList","tags":["Claim Service"],"parameters":[{"$ref":"#/components/parameters/claimantId"},{"$ref":"#/components/parameters/bank"},{"$ref":"#/components/parameters/templateCode"},{"$ref":"#/components/parameters/isActive"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/itemsPerPage"},{"$ref":"#/components/parameters/X-Request-ID"}],"responses":{"200":{"$ref":"#/components/responses/OK_200_ClaimListTemplate"},"400":{"$ref":"#/components/responses/BAD_REQUEST_400"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401"},"403":{"$ref":"#/components/responses/FORBIDDEN_403"},"404":{"$ref":"#/components/responses/NOT_FOUND_404"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503"}}}}}}
```

## Get a single claim template

> Returns a single claim template by the supplied templateId.<br>

```json
{"openapi":"3.0.2","info":{"title":"IOBWS 3.0 Domestic Claims","version":"v3.2"},"tags":[{"name":"Claim Service","description":"Common Claim operations for icelandic banks"}],"servers":[{"url":"https://apigw.arionbanki.is/claims","description":"IOBWS 3.0 Claims API"}],"security":[{"oauth2":["openid","profile","b2b","claimscollection"]}],"components":{"securitySchemes":{},"parameters":{"templateIdPath":{"name":"templateId","in":"path","description":"Unique template id defined by the banks.\n","required":true,"schema":{"type":"string"}},"X-Request-ID":{"name":"X-Request-ID","in":"header","description":"Unique value generated by the client which the resource server uses to recognize subsequent \nretries of the same request.\n","required":true,"schema":{"type":"string","format":"uuid"}}},"responses":{"OK_200_Template":{"description":"Claim template.\n","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/templateDetails"}}}},"BAD_REQUEST_400":{"description":"Bad Request","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error400"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error400"}}}},"UNAUTHORIZED_401":{"description":"Unauthorized","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error401"}}}},"FORBIDDEN_403":{"description":"Forbidden","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error403_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error403"}}}},"NOT_FOUND_404":{"description":"Not found","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error404_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error404"}}}},"METHOD_NOT_ALLOWED_405":{"description":"Method Not Allowed","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error405_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error405"}}}},"REQUEST_TIMEOUT_408":{"description":"Request Timeout","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"UNSUPPORTED_MEDIA_TYPE_415":{"description":"Unsupported Media Type","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"INTERNAL_SERVER_ERROR_500":{"description":"Internal Server Error","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"SERVICE_UNAVAILABLE_503":{"description":"Service Unavailable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"type":"string","format":"uuid"}},"Location":{"description":"Location of the created resource.\n","schema":{"type":"string","format":"url"},"required":false}},"schemas":{"templateDetails":{"description":"Claim template details.\n","type":"object","properties":{"templateId":{"description":"Unique Id for each template. This is specific to each bank.","type":"string"},"claimantId":{"$ref":"#/components/schemas/claimantId"},"bank":{"$ref":"#/components/schemas/bank"},"templateCode":{"$ref":"#/components/schemas/templateCode"},"collectionType":{"$ref":"#/components/schemas/collectionType"},"category":{"$ref":"#/components/schemas/claimTemplateCategory"},"claimantStatementExtendedReferenceType":{"$ref":"#/components/schemas/claimantStatementExtendedReferenceType"},"customerNumberTemplate":{"description":"Describes how the transaction number template is structured for the claim template.","type":"string","maxLength":16},"claimantStatementReferenceType":{"$ref":"#/components/schemas/claimantStatementReferenceType"},"depositAccount":{"$ref":"#/components/schemas/depositAccount"},"secondaryCollectionTemplateCode":{"description":"ID of a collection claim template to which claims are transferred.\n","type":"string","pattern":"[0-9A-Za-z]{3}"},"withdrawalAccount":{"$ref":"#/components/schemas/account"},"additionalDepositAccounts":{"type":"array","items":{"$ref":"#/components/schemas/depositAccountWithDetails"}},"isActive":{"type":"boolean"},"settings":{"$ref":"#/components/schemas/claimTemplateSettings"}}},"claimantId":{"description":"ClaimantId is the Icelandic kennitala for the claimant\n","type":"string","pattern":"[0-9]{10}"},"bank":{"description":"Icelandic branch number.\n","type":"string","pattern":"[0-9]{4}"},"templateCode":{"description":"Claim template identifier.\n","type":"string","pattern":"[0-9A-Z]{3}"},"collectionType":{"type":"string","enum":["PrimaryCollection","SecondaryCollection"]},"claimTemplateCategory":{"type":"object","required":["code"],"properties":{"code":{"type":"string","maxLength":2,"minLength":2},"name":{"type":"string","maxLength":30}}},"claimantStatementExtendedReferenceType":{"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)\n","type":"string","enum":["ReferenceNumber","CustomerNumber","ClaimId","PayorId","DueDate"]},"claimantStatementReferenceType":{"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)\n","type":"string","enum":["DueDate","BillNumber","ClaimNumber"]},"depositAccount":{"description":"Information on the main disposal account.\n","properties":{"id":{"$ref":"#/components/schemas/account"},"ownerId":{"$ref":"#/components/schemas/kennitala"}}},"account":{"description":"Bank number, ledger and number.\nFor claims ledger is 66 followed by claim number\n","type":"string","pattern":"[0-9]{12}"},"kennitala":{"description":"Icelandic Id number (kennitala).\n","type":"string","pattern":"[0-9]{10}"},"depositAccountWithDetails":{"description":"Additional disposition invoices. Used to dispose of fees, costs or part of the payment of the claim. There\ncan be a maximum of 98 accounts for each identifier.\n","properties":{"id":{"$ref":"#/components/schemas/account"},"ownerId":{"$ref":"#/components/schemas/kennitala"},"type":{"description":"Describes what type of additional deposit account this is.\n\n- \"DefaultInterest\" - Penalty 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.\n","type":"string","enum":["DefaultInterest","DefaultCharge","OtherDefaultCosts","AllDefaultCharges","OtherCosts","NoticeAndPaymentFee","AllCosts","FixedAmount","Percentage","PrincipalDetail"]},"priority":{"description":"Priority controls in which order the additional deposit is executed","type":"integer"},"depositAmount":{"$ref":"#/components/schemas/depositAccountAmount"}}},"depositAccountAmount":{"description":"Describes what kind of deposit this is (percentage based or fixed amount)\n","type":"object","properties":{"value":{"type":"number"},"valueType":{"type":"string","enum":["FixedAmount","Percentage"]}}},"claimTemplateSettings":{"description":"Default claim settings applied when creating claims for this template. \nIndividual claims may override these values where the claim schema permits.\nNote that these settings are not automatically set for claims created on templates, they still need to be set for each claims.\n","type":"object","properties":{"amount":{"description":"Default claim amount.","type":"number"},"reference":{"$ref":"#/components/schemas/reference"},"defaultInterest":{"$ref":"#/components/schemas/defaultInterest"},"defaultCharge":{"$ref":"#/components/schemas/defaultCharge"},"paymentFee":{"$ref":"#/components/schemas/paymentFee"},"discount":{"$ref":"#/components/schemas/discount"},"otherCostsAmount":{"description":"Default other costs (added to claim).","type":"number"},"otherDefaultCostsAmount":{"description":"Default other default costs (e.g. intermediate collection fee).","type":"number"},"currency":{"description":"Default ISO 4217 currency code.","type":"string","pattern":"[A-Z]{3}"},"isOutOfSequencePaymentAllowed":{"description":"Payment rule, allow paying later installments before earlier ones.","type":"boolean"},"isPartialPaymentAllowed":{"description":"Partial payment is allowed.","type":"boolean"},"claimType":{"$ref":"#/components/schemas/claimType"},"billNumber":{"description":"7 character bill number shown on payer account statement.","type":"string","maxLength":7},"dueDateRule":{"$ref":"#/components/schemas/dateRuleDayOfMonth"},"finalDueDateRule":{"$ref":"#/components/schemas/dateRuleNumberOfDays"},"cancellationDateRule":{"$ref":"#/components/schemas/dateRuleNumberOfDays"}}},"reference":{"description":"Reference number determined by creditors.\n","type":"string","maxLength":16},"defaultInterest":{"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”. \n","nullable":true,"type":"object","required":["referenceDate"],"properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"baseAmountType":{"description":"Indicates the amount by which the penalty interest is calculated.\n- Amount: Penalty interest is calculated on the basis of the amount of the claim.\n- AmountAndDefaultCharge: Penalty interest is calculated on the basis of the amount \nand arrears of the claim.\n","type":"string","enum":["Amount","AmountAndDefaultCharge"]},"baseTimeType":{"description":"Indicates at what time the basis of penalty 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 \n  used (number of days / calendar days).\n","type":"string","enum":["Daily","360","Calendar"]},"percentage":{"description":"Indicates the percentage of default interest. If this parameter is not specified or is set to “0”, the \nCentral Bank's maximum penalty interest rate is used.\nPercentage range is between 0 - 100\n","type":"number"}}},"referenceDate":{"description":"Specifies the reference date for calculations, allowing the choice between the DueDate and the FinalDueDate as the basis.\n","type":"string","enum":["DueDate","FinalDueDate"]},"defaultCharge":{"description":"Default charges configuration.\nDefines day offsets from the reference date and whether each charge is percentage-based or a fixed amount.\nFor discounts, the amount is calculated from totalAmount.\nFor defaultCharge, the charge amount is calculated from claimAmount.\n","nullable":true,"type":"object","required":["referenceDate"],"properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}}},"dayAmountItem":{"description":"For whether to use fixed amount or calculate by percentage from claimAmount when calculating discount or charge.\n","type":"object","required":["chargeType","day","value"],"properties":{"chargeType":{"type":"string","enum":["Percentage","Amount"]},"day":{"type":"integer","minimum":0,"maximum":99},"value":{"type":"number"}}},"paymentFee":{"description":"Additional fee that adds to the claim amount.\n","nullable":true,"type":"object","required":["printingFee","paperlessFee"],"properties":{"printingFee":{"description":"A fee that is applied if the claim is printed.","type":"number"},"paperlessFee":{"description":"A fee that is applied if the claim is paperless.\nThis fee applies to payors who have opted out of receiving printed letters and to direct debit claims.\n","type":"number"}}},"discount":{"description":"Contains detail information about claim discount\n","nullable":true,"type":"object","required":["referenceDate"],"properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}}},"claimType":{"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).\n","type":"string","enum":["NormalClaim","OptionalPaymentClaim","RefundClaim","BalanceClaim"]},"dateRuleDayOfMonth":{"description":"Rule that sets a date to a fixed day within the calendar month (e.g. 15th of each month).\n","type":"object","required":["dayOfMonth"],"properties":{"dayOfMonth":{"description":"Day of month (1-31). If a month has fewer days, business logic decides adjustment.","type":"integer","minimum":1,"maximum":31}}},"dateRuleNumberOfDays":{"description":"Rule that calculates a target date by adding an offset in days to another base date (e.g. +10 days from dueDate).\n","type":"object","required":["daysOffset"],"properties":{"daysOffset":{"description":"Number of days to add (0 means same day).","type":"integer","minimum":0,"maximum":365}}},"Error400":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode400"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode400"}}}}}},"MessageCode400":{"description":"Message codes. HTTP Error code 400 (BAD_REQUEST).","type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED","SERVICE_INVALID","RESOURCE_UNKNOWN","RESOURCE_EXPIRED","RESOURCE_BLOCKED","TIMESTAMP_INVALID","PERIOD_INVALID","SCA_METHOD_UNKNOWN","SCA_INVALID","CONSENT_UNKNOWN","SESSIONS_NOT_SUPPORTED"]},"errorTitle":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"errorDetail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"Error401":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode401"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode401"}}}}}},"MessageCode401":{"description":"Message codes. HTTP Error code 401 (UNAUTHORIZED).","type":"string","enum":["CERTIFICATE_INVALID","ROLE_INVALID","CERTIFICATE_EXPIRED","CERTIFICATE_BLOCKED","CERTIFICATE_REVOKE","CERTIFICATE_MISSING","SIGNATURE_INVALID","SIGNATURE_MISSING","TOKEN_UNKNOWN","TOKEN_INVALID","TOKEN_EXPIRED"]},"Error403_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 403.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message403"}}}},"message403":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode403"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"messageCategory":{"description":"Category of the message category.","type":"string","enum":["ERROR","WARNING"]},"MessageCode403":{"description":"Message codes. HTTP Error code 403 (FORBIDDEN).","type":"string","enum":["CONSENT_UNKNOWN","SERVICE_BLOCKED","RESOURCE_UNKNOWN","RESOURCE_EXPIRED"]},"messageText":{"description":"Additional explaining text.","type":"string","maxLength":500},"Error403":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode403"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode403"}}}}}},"Error404_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 404.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message404"}}}},"message404":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode404"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"MessageCode404":{"description":"Message codes. HTTP Error code 404 (NOT FOUND).","type":"string","enum":["RESOURCE_UNKNOWN"]},"Error404":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode404"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode404"}}}}}},"Error405_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 405.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message405"}}}},"message405":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode405"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"MessageCode405":{"description":"Message codes. HTTP Error code 405 (METHOD NOT ALLOWED).","type":"string","enum":["SERVICE_INVALID"]},"Error405":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode405"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode405"}}}}}}}},"paths":{"/api/v1/templates/{templateId}":{"get":{"summary":"Get a single claim template","description":"Returns a single claim template by the supplied templateId.\n","operationId":"getTemplate","tags":["Claim Service"],"parameters":[{"$ref":"#/components/parameters/templateIdPath"},{"$ref":"#/components/parameters/X-Request-ID"}],"responses":{"200":{"$ref":"#/components/responses/OK_200_Template"},"400":{"$ref":"#/components/responses/BAD_REQUEST_400"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401"},"403":{"$ref":"#/components/responses/FORBIDDEN_403"},"404":{"$ref":"#/components/responses/NOT_FOUND_404"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503"}}}}}}
```

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

> A list of claims can be filtered by multiple query parameters to obtain a focused result.\
> The function returns a paginated list of claims; use page and itemsPerPage for paging.\
> Parameters:\
> \- dateFrom: Search starting date\
> \- dateTo: Search end date\
> \- dateSpanReferenceDate: When a date range (from/to) is defined this indicates which date field the range applies to. Possible values are:\
> &#x20; \- DueDate: The claim's due date\
> &#x20; \- FinalDueDate: The claim's final due date\
> &#x20; \- ExpirationDate: The claim cancellation date\
> &#x20; \- ClosingDate: Date when the claim was paid, cancelled or transferred.\
> &#x20; \- CreationDate: When the claim was created\
> &#x20; \- LastChangeDate: Last claim change event date\
> &#x20; \- PaymentDate: Date when claim was paid\
> &#x20; \- TemplateTransferDate: When claim was moved to another template\
> \- claimantId: The claim claimant\
> \- payorId: The claim payor\
> \- status: Claim status is one of \["Unpaid", "Paid", "Cancelled"]\
> \- collectionStatus: Claim collection process state:\
> &#x20; \- PrimaryCollection      \
> &#x20; \- SecondaryCollection\
> &#x20; \- LegalCollection\
> \- templateCode: Bank claim template code        <br>

```json
{"openapi":"3.0.2","info":{"title":"IOBWS 3.0 Domestic Claims","version":"v3.2"},"tags":[{"name":"Claim Service","description":"Common Claim operations for icelandic banks"}],"servers":[{"url":"https://apigw.arionbanki.is/claims","description":"IOBWS 3.0 Claims API"}],"security":[{"oauth2":["openid","profile","b2b","claimscollection"]}],"components":{"securitySchemes":{},"parameters":{"dateFrom":{"name":"dateFrom","in":"query","required":true,"schema":{"type":"string","format":"date"}},"dateTo":{"name":"dateTo","in":"query","required":true,"schema":{"type":"string","format":"date"}},"dateSpanReferenceDate":{"name":"dateType","in":"query","description":"Date type to search for\n","schema":{"$ref":"#/components/schemas/dateSpanReferenceDate"}},"claimantId":{"name":"claimantId","in":"query","description":"ClaimantId is the Icelandic kennitala for the claimant\n","required":false,"schema":{"$ref":"#/components/schemas/kennitala"}},"payorId":{"name":"payorId","in":"query","description":"PayorId is the Icelandic kennitala for the payor\n","schema":{"$ref":"#/components/schemas/kennitala"}},"status":{"name":"status","in":"query","description":"The claim status to search for\n","schema":{"$ref":"#/components/schemas/claimStatus"}},"collectionStatus":{"name":"collectionStatus","in":"query","description":"The collection status to search for\n","schema":{"$ref":"#/components/schemas/collectionStatus"}},"templateCode":{"name":"templateCode","in":"query","description":"Claim template code\n","schema":{"$ref":"#/components/schemas/templateCode"}},"templateId":{"name":"templateId","in":"query","description":"Filter claims by templateId (exact match). Optional.\n","required":false,"schema":{"type":"string"}},"page":{"name":"page","in":"query","description":"Requested page","required":false,"schema":{"type":"integer","default":1}},"itemsPerPage":{"name":"itemsPerPage","in":"query","description":"Records per page","required":false,"schema":{"type":"integer","default":100}},"X-Request-ID":{"name":"X-Request-ID","in":"header","description":"Unique value generated by the client which the resource server uses to recognize subsequent \nretries of the same request.\n","required":true,"schema":{"type":"string","format":"uuid"}}},"schemas":{"dateSpanReferenceDate":{"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\n","type":"string","enum":["DueDate","FinalDueDate","ExpirationDate","ClosingDate","CreationDate","LastChangeDate","PaymentDate","TemplateTransferDate"]},"kennitala":{"description":"Icelandic Id number (kennitala).\n","type":"string","pattern":"[0-9]{10}"},"claimStatus":{"description":"Claim status","type":"string","enum":["Unpaid","Paid","Cancelled"]},"collectionStatus":{"description":"Claim billing process status","type":"string","enum":["PrimaryCollection","SecondaryCollection","LegalCollection"]},"templateCode":{"description":"Claim template identifier.\n","type":"string","pattern":"[0-9A-Z]{3}"},"claimListDetails":{"description":"List of claims\n","type":"array","items":{"$ref":"#/components/schemas/claimDetails"}},"claimDetails":{"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.\n","type":"object","required":["claimKey","payorId","templateCode","amount","finalDueDate","expirationDate"],"properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"payorId":{"$ref":"#/components/schemas/kennitala"},"claimStatus":{"$ref":"#/components/schemas/claimStatus"},"collectionStatus":{"$ref":"#/components/schemas/collectionStatus"},"expirationDate":{"type":"string","format":"date"},"closingDate":{"description":"Date when the claim was paid, cancelled or transferred.","type":"string","format":"date"},"templateCode":{"$ref":"#/components/schemas/templateCode"},"templateId":{"description":"Unique Id for each template. This is specific to each bank.","type":"string"},"secondaryCollectionTemplateCode":{"$ref":"#/components/schemas/templateCode"},"secondaryCollectionTemplateId":{"description":"Unique Id for each template. This is specific to each bank.","type":"string"},"categoryCode":{"$ref":"#/components/schemas/categoryCode"},"categoryDescription":{"description":"Description of the categoryCode\n","type":"string"},"amount":{"description":"Claim amount","type":"number","minimum":0},"defaultChargeAmountDue":{"description":"Amount of default charge to be paid","type":"number","minimum":0},"defaultInterestAmountDue":{"description":"Amount of accrued penalty interests to be paid","type":"number","minimum":0},"discountAmountOffered":{"description":"Discount that will be granted when a collection claim is paid based on status","type":"number","minimum":0},"noticeChargeAmountDue":{"description":"Amount of notification charge to be paid.","type":"number","minimum":0},"otherCostsAmountDue":{"description":"Current other costs to be paid","type":"number","minimum":0},"otherDefaultCostsAmountDue":{"description":"Current other default costs to be paid","type":"number","minimum":0},"totalAmountDue":{"description":"Total amount to be paid","type":"number","minimum":0},"reference":{"$ref":"#/components/schemas/reference"},"finalDueDate":{"type":"string","format":"date"},"billNumber":{"description":"7-character reference id set by claimant. This ID will be visible on the payer's account statement\n","type":"string","maxLength":7},"customerNumber":{"description":"16-character reference id set by claimant. Payer's transaction number. Unique key to the payer of the \nclaim with the creditor. Necessary if a direct payment agreement is to be established\n","type":"string","maxLength":16},"paymentFee":{"$ref":"#/components/schemas/paymentFee"},"otherCostsAmount":{"description":"Other costs, including determined fees paid by the payer of a collection claim.","type":"number","minimum":0},"otherDefaultCostsAmount":{"description":"Determined fees, e.g. intermediate collection fee.","type":"number","minimum":0},"defaultCharge":{"$ref":"#/components/schemas/defaultCharge"},"defaultInterest":{"$ref":"#/components/schemas/defaultInterest"},"discount":{"$ref":"#/components/schemas/discount"},"isOutOfSequencePaymentAllowed":{"description":"Payment rule, is it allowed to pay the last payment if previous has not been paid","type":"boolean"},"isPartialPaymentAllowed":{"type":"boolean"},"isPartiallyPaid":{"description":"Indicates whether payment has been made on the collection claim","type":"boolean"},"currency":{"type":"string","pattern":"[A-Z]{3}"},"currencyPaymentRate":{"type":"string","enum":["PaymentDateRate"]},"additionalInformation":{"description":"Free text that will be displayed on the claim","type":"string","maxLength":200},"printing":{"$ref":"#/components/schemas/printing"},"directPaymentClaim":{"description":"Is the claim registered as direct payment claim","type":"boolean"},"print":{"description":"Indicates whether a claim should be printed","type":"boolean"},"lastChangeDate":{"description":"Last claim change event date.\n","type":"string","format":"date-time"},"createdDate":{"description":"The creation date of the claim.","type":"string","format":"date-time"},"claimType":{"$ref":"#/components/schemas/claimType"}}},"claimKey":{"description":"Claim key is a composite key of kennitala, account and due date.\n","type":"object","required":["claimantId","account","dueDate"],"properties":{"claimantId":{"$ref":"#/components/schemas/kennitala"},"account":{"$ref":"#/components/schemas/account"},"dueDate":{"$ref":"#/components/schemas/dueDate"}}},"account":{"description":"Bank number, ledger and number.\nFor claims ledger is 66 followed by claim number\n","type":"string","pattern":"[0-9]{12}"},"dueDate":{"description":"Due date","type":"string","format":"date"},"categoryCode":{"description":"Creditors' text key, explanation of payment. Optional attribute on claim\n","type":"string","maxLength":2,"pattern":"[0-9]{2}"},"reference":{"description":"Reference number determined by creditors.\n","type":"string","maxLength":16},"paymentFee":{"description":"Additional fee that adds to the claim amount.\n","nullable":true,"type":"object","required":["printingFee","paperlessFee"],"properties":{"printingFee":{"description":"A fee that is applied if the claim is printed.","type":"number"},"paperlessFee":{"description":"A fee that is applied if the claim is paperless.\nThis fee applies to payors who have opted out of receiving printed letters and to direct debit claims.\n","type":"number"}}},"defaultCharge":{"description":"Default charges configuration.\nDefines day offsets from the reference date and whether each charge is percentage-based or a fixed amount.\nFor discounts, the amount is calculated from totalAmount.\nFor defaultCharge, the charge amount is calculated from claimAmount.\n","nullable":true,"type":"object","required":["referenceDate"],"properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}}},"referenceDate":{"description":"Specifies the reference date for calculations, allowing the choice between the DueDate and the FinalDueDate as the basis.\n","type":"string","enum":["DueDate","FinalDueDate"]},"dayAmountItem":{"description":"For whether to use fixed amount or calculate by percentage from claimAmount when calculating discount or charge.\n","type":"object","required":["chargeType","day","value"],"properties":{"chargeType":{"type":"string","enum":["Percentage","Amount"]},"day":{"type":"integer","minimum":0,"maximum":99},"value":{"type":"number"}}},"defaultInterest":{"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”. \n","nullable":true,"type":"object","required":["referenceDate"],"properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"baseAmountType":{"description":"Indicates the amount by which the penalty interest is calculated.\n- Amount: Penalty interest is calculated on the basis of the amount of the claim.\n- AmountAndDefaultCharge: Penalty interest is calculated on the basis of the amount \nand arrears of the claim.\n","type":"string","enum":["Amount","AmountAndDefaultCharge"]},"baseTimeType":{"description":"Indicates at what time the basis of penalty 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 \n  used (number of days / calendar days).\n","type":"string","enum":["Daily","360","Calendar"]},"percentage":{"description":"Indicates the percentage of default interest. If this parameter is not specified or is set to “0”, the \nCentral Bank's maximum penalty interest rate is used.\nPercentage range is between 0 - 100\n","type":"number"}}},"discount":{"description":"Contains detail information about claim discount\n","nullable":true,"type":"object","required":["referenceDate"],"properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}}},"printing":{"description":"Contains information if a collection claim is printed at a bank / savings bank to manage the\nprintout of the collection claim. Changing a printout to a change entry after printing a note\ndoes not result in it being reprinted\n","nullable":true,"type":"object","properties":{"payorAddress":{"$ref":"#/components/schemas/address"},"itemRows":{"type":"array","items":{"$ref":"#/components/schemas/itemRow"}},"comments":{"type":"array","items":{"type":"string"}}}},"address":{"description":"Address or legal address of a legal entity\n","type":"object","required":["name","addressLine","postalCode","city","country"],"properties":{"name":{"type":"string"},"addressLine":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"country":{"type":"string","pattern":"[A-Z]{2}"}}},"itemRow":{"description":"Contains information on the breakdown of the collection claim.\n","type":"object","properties":{"text":{"type":"string"},"amount":{"type":"number"}}},"claimType":{"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).\n","type":"string","enum":["NormalClaim","OptionalPaymentClaim","RefundClaim","BalanceClaim"]},"Error400":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode400"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode400"}}}}}},"MessageCode400":{"description":"Message codes. HTTP Error code 400 (BAD_REQUEST).","type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED","SERVICE_INVALID","RESOURCE_UNKNOWN","RESOURCE_EXPIRED","RESOURCE_BLOCKED","TIMESTAMP_INVALID","PERIOD_INVALID","SCA_METHOD_UNKNOWN","SCA_INVALID","CONSENT_UNKNOWN","SESSIONS_NOT_SUPPORTED"]},"errorTitle":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"errorDetail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"Error401":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode401"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode401"}}}}}},"MessageCode401":{"description":"Message codes. HTTP Error code 401 (UNAUTHORIZED).","type":"string","enum":["CERTIFICATE_INVALID","ROLE_INVALID","CERTIFICATE_EXPIRED","CERTIFICATE_BLOCKED","CERTIFICATE_REVOKE","CERTIFICATE_MISSING","SIGNATURE_INVALID","SIGNATURE_MISSING","TOKEN_UNKNOWN","TOKEN_INVALID","TOKEN_EXPIRED"]},"Error403_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 403.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message403"}}}},"message403":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode403"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"messageCategory":{"description":"Category of the message category.","type":"string","enum":["ERROR","WARNING"]},"MessageCode403":{"description":"Message codes. HTTP Error code 403 (FORBIDDEN).","type":"string","enum":["CONSENT_UNKNOWN","SERVICE_BLOCKED","RESOURCE_UNKNOWN","RESOURCE_EXPIRED"]},"messageText":{"description":"Additional explaining text.","type":"string","maxLength":500},"Error403":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode403"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode403"}}}}}},"Error404_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 404.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message404"}}}},"message404":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode404"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"MessageCode404":{"description":"Message codes. HTTP Error code 404 (NOT FOUND).","type":"string","enum":["RESOURCE_UNKNOWN"]},"Error404":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode404"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode404"}}}}}},"Error405_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 405.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message405"}}}},"message405":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode405"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"MessageCode405":{"description":"Message codes. HTTP Error code 405 (METHOD NOT ALLOWED).","type":"string","enum":["SERVICE_INVALID"]},"Error405":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode405"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode405"}}}}}}},"responses":{"OK_200_QueryClaimListInformation":{"description":"Query claim list information.\n","headers":{"X-Paging-CurrentPage":{"description":"Current page number\n","schema":{"type":"integer"}},"X-Paging-TotalPages":{"description":"Total pages\n","schema":{"type":"integer"}},"X-Paging-TotalItems":{"description":"Total items\n","schema":{"type":"integer"}},"X-Paging-PerPage":{"description":"Items per page\n","schema":{"type":"integer"}},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/claimListDetails"}}}},"BAD_REQUEST_400":{"description":"Bad Request","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error400"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error400"}}}},"UNAUTHORIZED_401":{"description":"Unauthorized","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error401"}}}},"FORBIDDEN_403":{"description":"Forbidden","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error403_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error403"}}}},"NOT_FOUND_404":{"description":"Not found","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error404_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error404"}}}},"METHOD_NOT_ALLOWED_405":{"description":"Method Not Allowed","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error405_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error405"}}}},"REQUEST_TIMEOUT_408":{"description":"Request Timeout","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"UNSUPPORTED_MEDIA_TYPE_415":{"description":"Unsupported Media Type","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"INTERNAL_SERVER_ERROR_500":{"description":"Internal Server Error","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"SERVICE_UNAVAILABLE_503":{"description":"Service Unavailable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"type":"string","format":"uuid"}},"Location":{"description":"Location of the created resource.\n","schema":{"type":"string","format":"url"},"required":false}}},"paths":{"/api/v1/claims":{"get":{"summary":"Get a list of claims as defined by the query parameters.","description":"A list of claims can be filtered by multiple query parameters to obtain a focused result.\nThe function returns a paginated list of claims; use page and itemsPerPage for paging.\nParameters:\n- dateFrom: Search starting date\n- dateTo: Search end date\n- dateSpanReferenceDate: When a date range (from/to) is defined this indicates which date field the range applies to. Possible values are:\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\n- claimantId: The claim claimant\n- payorId: The claim payor\n- status: Claim status is one of [\"Unpaid\", \"Paid\", \"Cancelled\"]\n- collectionStatus: Claim collection process state:\n  - PrimaryCollection      \n  - SecondaryCollection\n  - LegalCollection\n- templateCode: Bank claim template code        \n","operationId":"getClaims","tags":["Claim Service"],"parameters":[{"$ref":"#/components/parameters/dateFrom"},{"$ref":"#/components/parameters/dateTo"},{"$ref":"#/components/parameters/dateSpanReferenceDate"},{"$ref":"#/components/parameters/claimantId"},{"$ref":"#/components/parameters/payorId"},{"$ref":"#/components/parameters/status"},{"$ref":"#/components/parameters/collectionStatus"},{"$ref":"#/components/parameters/templateCode"},{"$ref":"#/components/parameters/templateId"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/itemsPerPage"},{"$ref":"#/components/parameters/X-Request-ID"}],"responses":{"200":{"$ref":"#/components/responses/OK_200_QueryClaimListInformation"},"400":{"$ref":"#/components/responses/BAD_REQUEST_400"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401"},"403":{"$ref":"#/components/responses/FORBIDDEN_403"},"404":{"$ref":"#/components/responses/NOT_FOUND_404"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503"}}}}}}
```

## Create a single claim

> Claim creation returns an immediate response: if successful, claimKey, claimId, and directPaymentClaim are included; otherwise, an error is returned.<br>

```json
{"openapi":"3.0.2","info":{"title":"IOBWS 3.0 Domestic Claims","version":"v3.2"},"tags":[{"name":"Claim Service","description":"Common Claim operations for icelandic banks"}],"servers":[{"url":"https://apigw.arionbanki.is/claims","description":"IOBWS 3.0 Claims API"}],"security":[{"oauth2":["openid","profile","b2b","claimscollection"]}],"components":{"securitySchemes":{},"parameters":{"X-Request-ID":{"name":"X-Request-ID","in":"header","description":"Unique value generated by the client which the resource server uses to recognize subsequent \nretries of the same request.\n","required":true,"schema":{"type":"string","format":"uuid"}},"X-Idempotency-Key":{"name":"X-Idempotency-Key","in":"header","description":"Idempotency key","required":false,"schema":{"type":"string","format":"uuid"}}},"requestBodies":{"createClaim":{"description":"JSON request body for a create claim request message\n","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createClaimDetails"}}}}},"schemas":{"createClaimDetails":{"description":"Create claim object\n\nDescription:\n\n* discount: Contains information about discount as constant or percent\n* defaultCharge: Contains information on the default fee, either in a fixed amount or in percentages. Note that\n  the amount must be within the rules that apply according to Regulation 37/2009.\n* defaultInterest: Contains Information on how default interest is calculated. If claim should not have default interest, do not send in this object or send it in as “null”. \n* isOutOfSequencePaymentAllowed: Out of sequence payment allowed\n* isPartialPaymentAllowed: Partial payment is allowed\n","type":"object","required":["claimKey","payorId","templateCode","amount","finalDueDate","expirationDate"],"properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"payorId":{"$ref":"#/components/schemas/kennitala"},"expirationDate":{"type":"string","format":"date"},"templateCode":{"$ref":"#/components/schemas/templateCode"},"amount":{"type":"number","minimum":0},"reference":{"$ref":"#/components/schemas/reference"},"finalDueDate":{"type":"string","format":"date"},"billNumber":{"description":"7-character reference id set by claimant. This ID will be visible on the payer's account statement\n","type":"string","maxLength":7},"customerNumber":{"description":"16-character reference id set by claimant. Payer's transaction number. Unique key to the payer of the \nclaim with the creditor. Necessary if a direct payment agreement is to be established\n","type":"string","maxLength":16},"paymentFee":{"$ref":"#/components/schemas/paymentFee"},"otherCostsAmount":{"description":"Other costs, including determined fees paid by the payer of a collection claim.","type":"number","minimum":0},"otherDefaultCostsAmount":{"description":"Determined fees, e.g. intermediate collection fee.","type":"number","minimum":0},"defaultCharge":{"$ref":"#/components/schemas/defaultCharge"},"defaultInterest":{"$ref":"#/components/schemas/defaultInterest"},"discount":{"$ref":"#/components/schemas/discount"},"isOutOfSequencePaymentAllowed":{"description":"Payment rule, is it allowed to pay the last payment if previous has not been paid","type":"boolean"},"isPartialPaymentAllowed":{"type":"boolean"},"currency":{"type":"string","pattern":"[A-Z]{3}"},"additionalInformation":{"description":"Free text that will be displayed on the claim","type":"string","maxLength":200},"printing":{"$ref":"#/components/schemas/printing"},"claimType":{"$ref":"#/components/schemas/claimType"}}},"claimKey":{"description":"Claim key is a composite key of kennitala, account and due date.\n","type":"object","required":["claimantId","account","dueDate"],"properties":{"claimantId":{"$ref":"#/components/schemas/kennitala"},"account":{"$ref":"#/components/schemas/account"},"dueDate":{"$ref":"#/components/schemas/dueDate"}}},"kennitala":{"description":"Icelandic Id number (kennitala).\n","type":"string","pattern":"[0-9]{10}"},"account":{"description":"Bank number, ledger and number.\nFor claims ledger is 66 followed by claim number\n","type":"string","pattern":"[0-9]{12}"},"dueDate":{"description":"Due date","type":"string","format":"date"},"templateCode":{"description":"Claim template identifier.\n","type":"string","pattern":"[0-9A-Z]{3}"},"reference":{"description":"Reference number determined by creditors.\n","type":"string","maxLength":16},"paymentFee":{"description":"Additional fee that adds to the claim amount.\n","nullable":true,"type":"object","required":["printingFee","paperlessFee"],"properties":{"printingFee":{"description":"A fee that is applied if the claim is printed.","type":"number"},"paperlessFee":{"description":"A fee that is applied if the claim is paperless.\nThis fee applies to payors who have opted out of receiving printed letters and to direct debit claims.\n","type":"number"}}},"defaultCharge":{"description":"Default charges configuration.\nDefines day offsets from the reference date and whether each charge is percentage-based or a fixed amount.\nFor discounts, the amount is calculated from totalAmount.\nFor defaultCharge, the charge amount is calculated from claimAmount.\n","nullable":true,"type":"object","required":["referenceDate"],"properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}}},"referenceDate":{"description":"Specifies the reference date for calculations, allowing the choice between the DueDate and the FinalDueDate as the basis.\n","type":"string","enum":["DueDate","FinalDueDate"]},"dayAmountItem":{"description":"For whether to use fixed amount or calculate by percentage from claimAmount when calculating discount or charge.\n","type":"object","required":["chargeType","day","value"],"properties":{"chargeType":{"type":"string","enum":["Percentage","Amount"]},"day":{"type":"integer","minimum":0,"maximum":99},"value":{"type":"number"}}},"defaultInterest":{"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”. \n","nullable":true,"type":"object","required":["referenceDate"],"properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"baseAmountType":{"description":"Indicates the amount by which the penalty interest is calculated.\n- Amount: Penalty interest is calculated on the basis of the amount of the claim.\n- AmountAndDefaultCharge: Penalty interest is calculated on the basis of the amount \nand arrears of the claim.\n","type":"string","enum":["Amount","AmountAndDefaultCharge"]},"baseTimeType":{"description":"Indicates at what time the basis of penalty 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 \n  used (number of days / calendar days).\n","type":"string","enum":["Daily","360","Calendar"]},"percentage":{"description":"Indicates the percentage of default interest. If this parameter is not specified or is set to “0”, the \nCentral Bank's maximum penalty interest rate is used.\nPercentage range is between 0 - 100\n","type":"number"}}},"discount":{"description":"Contains detail information about claim discount\n","nullable":true,"type":"object","required":["referenceDate"],"properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}}},"printing":{"description":"Contains information if a collection claim is printed at a bank / savings bank to manage the\nprintout of the collection claim. Changing a printout to a change entry after printing a note\ndoes not result in it being reprinted\n","nullable":true,"type":"object","properties":{"payorAddress":{"$ref":"#/components/schemas/address"},"itemRows":{"type":"array","items":{"$ref":"#/components/schemas/itemRow"}},"comments":{"type":"array","items":{"type":"string"}}}},"address":{"description":"Address or legal address of a legal entity\n","type":"object","required":["name","addressLine","postalCode","city","country"],"properties":{"name":{"type":"string"},"addressLine":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"country":{"type":"string","pattern":"[A-Z]{2}"}}},"itemRow":{"description":"Contains information on the breakdown of the collection claim.\n","type":"object","properties":{"text":{"type":"string"},"amount":{"type":"number"}}},"claimType":{"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).\n","type":"string","enum":["NormalClaim","OptionalPaymentClaim","RefundClaim","BalanceClaim"]},"claimStatusSingleResponse":{"description":"Batch status object.\n","properties":{"success":{"$ref":"#/components/schemas/claimStatusSuccess"},"error":{"$ref":"#/components/schemas/claimStatusError"}}},"claimStatusSuccess":{"description":"Batch success status item.\n","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"claimId":{"$ref":"#/components/schemas/claimId"},"directPaymentClaim":{"type":"boolean"},"print":{"type":"boolean"}}},"claimId":{"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\n","type":"string"},"claimStatusError":{"description":"Batch error status item.\n","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"claimId":{"$ref":"#/components/schemas/claimId"},"resultCode":{"type":"string","enum":["CLAIM_EXISTS","CLAIM_IS_PAID","CLAIM_NOT_FOUND","CLAIM_IS_CANCELLED","CLAIM_NOT_IN_SECONDARY_STATE","CLAIM_OTHERS"]},"resultSubCode":{"type":"string"},"resultMessage":{"type":"string"}}},"Error400":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode400"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode400"}}}}}},"MessageCode400":{"description":"Message codes. HTTP Error code 400 (BAD_REQUEST).","type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED","SERVICE_INVALID","RESOURCE_UNKNOWN","RESOURCE_EXPIRED","RESOURCE_BLOCKED","TIMESTAMP_INVALID","PERIOD_INVALID","SCA_METHOD_UNKNOWN","SCA_INVALID","CONSENT_UNKNOWN","SESSIONS_NOT_SUPPORTED"]},"errorTitle":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"errorDetail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"Error401":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode401"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode401"}}}}}},"MessageCode401":{"description":"Message codes. HTTP Error code 401 (UNAUTHORIZED).","type":"string","enum":["CERTIFICATE_INVALID","ROLE_INVALID","CERTIFICATE_EXPIRED","CERTIFICATE_BLOCKED","CERTIFICATE_REVOKE","CERTIFICATE_MISSING","SIGNATURE_INVALID","SIGNATURE_MISSING","TOKEN_UNKNOWN","TOKEN_INVALID","TOKEN_EXPIRED"]},"Error403_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 403.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message403"}}}},"message403":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode403"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"messageCategory":{"description":"Category of the message category.","type":"string","enum":["ERROR","WARNING"]},"MessageCode403":{"description":"Message codes. HTTP Error code 403 (FORBIDDEN).","type":"string","enum":["CONSENT_UNKNOWN","SERVICE_BLOCKED","RESOURCE_UNKNOWN","RESOURCE_EXPIRED"]},"messageText":{"description":"Additional explaining text.","type":"string","maxLength":500},"Error403":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode403"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode403"}}}}}},"Error404_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 404.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message404"}}}},"message404":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode404"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"MessageCode404":{"description":"Message codes. HTTP Error code 404 (NOT FOUND).","type":"string","enum":["RESOURCE_UNKNOWN"]},"Error404":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode404"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode404"}}}}}},"Error405_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 405.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message405"}}}},"message405":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode405"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"MessageCode405":{"description":"Message codes. HTTP Error code 405 (METHOD NOT ALLOWED).","type":"string","enum":["SERVICE_INVALID"]},"Error405":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode405"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode405"}}}}}}},"responses":{"OK_201_ActionSingleResponse":{"description":"Claim created (single item response)","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/claimStatusSingleResponse"}}}},"BAD_REQUEST_400":{"description":"Bad Request","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error400"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error400"}}}},"UNAUTHORIZED_401":{"description":"Unauthorized","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error401"}}}},"FORBIDDEN_403":{"description":"Forbidden","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error403_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error403"}}}},"NOT_FOUND_404":{"description":"Not found","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error404_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error404"}}}},"METHOD_NOT_ALLOWED_405":{"description":"Method Not Allowed","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error405_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error405"}}}},"REQUEST_TIMEOUT_408":{"description":"Request Timeout","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"UNSUPPORTED_MEDIA_TYPE_415":{"description":"Unsupported Media Type","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"INTERNAL_SERVER_ERROR_500":{"description":"Internal Server Error","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"SERVICE_UNAVAILABLE_503":{"description":"Service Unavailable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"type":"string","format":"uuid"}},"Location":{"description":"Location of the created resource.\n","schema":{"type":"string","format":"url"},"required":false}}},"paths":{"/api/v1/claims":{"post":{"summary":"Create a single claim","description":"Claim creation returns an immediate response: if successful, claimKey, claimId, and directPaymentClaim are included; otherwise, an error is returned.\n","operationId":"createClaim","tags":["Claim Service"],"parameters":[{"$ref":"#/components/parameters/X-Request-ID"},{"$ref":"#/components/parameters/X-Idempotency-Key"}],"requestBody":{"$ref":"#/components/requestBodies/createClaim"},"responses":{"201":{"$ref":"#/components/responses/OK_201_ActionSingleResponse"},"400":{"$ref":"#/components/responses/BAD_REQUEST_400"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401"},"403":{"$ref":"#/components/responses/FORBIDDEN_403"},"404":{"$ref":"#/components/responses/NOT_FOUND_404"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503"}}}}}}
```

## Get single claim

> Fetch detail information for a single claim by claimID. Detailed information on fields in claimDetails.<br>

```json
{"openapi":"3.0.2","info":{"title":"IOBWS 3.0 Domestic Claims","version":"v3.2"},"tags":[{"name":"Claim Service","description":"Common Claim operations for icelandic banks"}],"servers":[{"url":"https://apigw.arionbanki.is/claims","description":"IOBWS 3.0 Claims API"}],"security":[{"oauth2":["openid","profile","b2b","claimscollection"]}],"components":{"securitySchemes":{},"parameters":{"claimId":{"name":"claimId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/claimId"}},"X-Request-ID":{"name":"X-Request-ID","in":"header","description":"Unique value generated by the client which the resource server uses to recognize subsequent \nretries of the same request.\n","required":true,"schema":{"type":"string","format":"uuid"}}},"schemas":{"claimId":{"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\n","type":"string"},"claimDetails":{"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.\n","type":"object","required":["claimKey","payorId","templateCode","amount","finalDueDate","expirationDate"],"properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"payorId":{"$ref":"#/components/schemas/kennitala"},"claimStatus":{"$ref":"#/components/schemas/claimStatus"},"collectionStatus":{"$ref":"#/components/schemas/collectionStatus"},"expirationDate":{"type":"string","format":"date"},"closingDate":{"description":"Date when the claim was paid, cancelled or transferred.","type":"string","format":"date"},"templateCode":{"$ref":"#/components/schemas/templateCode"},"templateId":{"description":"Unique Id for each template. This is specific to each bank.","type":"string"},"secondaryCollectionTemplateCode":{"$ref":"#/components/schemas/templateCode"},"secondaryCollectionTemplateId":{"description":"Unique Id for each template. This is specific to each bank.","type":"string"},"categoryCode":{"$ref":"#/components/schemas/categoryCode"},"categoryDescription":{"description":"Description of the categoryCode\n","type":"string"},"amount":{"description":"Claim amount","type":"number","minimum":0},"defaultChargeAmountDue":{"description":"Amount of default charge to be paid","type":"number","minimum":0},"defaultInterestAmountDue":{"description":"Amount of accrued penalty interests to be paid","type":"number","minimum":0},"discountAmountOffered":{"description":"Discount that will be granted when a collection claim is paid based on status","type":"number","minimum":0},"noticeChargeAmountDue":{"description":"Amount of notification charge to be paid.","type":"number","minimum":0},"otherCostsAmountDue":{"description":"Current other costs to be paid","type":"number","minimum":0},"otherDefaultCostsAmountDue":{"description":"Current other default costs to be paid","type":"number","minimum":0},"totalAmountDue":{"description":"Total amount to be paid","type":"number","minimum":0},"reference":{"$ref":"#/components/schemas/reference"},"finalDueDate":{"type":"string","format":"date"},"billNumber":{"description":"7-character reference id set by claimant. This ID will be visible on the payer's account statement\n","type":"string","maxLength":7},"customerNumber":{"description":"16-character reference id set by claimant. Payer's transaction number. Unique key to the payer of the \nclaim with the creditor. Necessary if a direct payment agreement is to be established\n","type":"string","maxLength":16},"paymentFee":{"$ref":"#/components/schemas/paymentFee"},"otherCostsAmount":{"description":"Other costs, including determined fees paid by the payer of a collection claim.","type":"number","minimum":0},"otherDefaultCostsAmount":{"description":"Determined fees, e.g. intermediate collection fee.","type":"number","minimum":0},"defaultCharge":{"$ref":"#/components/schemas/defaultCharge"},"defaultInterest":{"$ref":"#/components/schemas/defaultInterest"},"discount":{"$ref":"#/components/schemas/discount"},"isOutOfSequencePaymentAllowed":{"description":"Payment rule, is it allowed to pay the last payment if previous has not been paid","type":"boolean"},"isPartialPaymentAllowed":{"type":"boolean"},"isPartiallyPaid":{"description":"Indicates whether payment has been made on the collection claim","type":"boolean"},"currency":{"type":"string","pattern":"[A-Z]{3}"},"currencyPaymentRate":{"type":"string","enum":["PaymentDateRate"]},"additionalInformation":{"description":"Free text that will be displayed on the claim","type":"string","maxLength":200},"printing":{"$ref":"#/components/schemas/printing"},"directPaymentClaim":{"description":"Is the claim registered as direct payment claim","type":"boolean"},"print":{"description":"Indicates whether a claim should be printed","type":"boolean"},"lastChangeDate":{"description":"Last claim change event date.\n","type":"string","format":"date-time"},"createdDate":{"description":"The creation date of the claim.","type":"string","format":"date-time"},"claimType":{"$ref":"#/components/schemas/claimType"}}},"claimKey":{"description":"Claim key is a composite key of kennitala, account and due date.\n","type":"object","required":["claimantId","account","dueDate"],"properties":{"claimantId":{"$ref":"#/components/schemas/kennitala"},"account":{"$ref":"#/components/schemas/account"},"dueDate":{"$ref":"#/components/schemas/dueDate"}}},"kennitala":{"description":"Icelandic Id number (kennitala).\n","type":"string","pattern":"[0-9]{10}"},"account":{"description":"Bank number, ledger and number.\nFor claims ledger is 66 followed by claim number\n","type":"string","pattern":"[0-9]{12}"},"dueDate":{"description":"Due date","type":"string","format":"date"},"claimStatus":{"description":"Claim status","type":"string","enum":["Unpaid","Paid","Cancelled"]},"collectionStatus":{"description":"Claim billing process status","type":"string","enum":["PrimaryCollection","SecondaryCollection","LegalCollection"]},"templateCode":{"description":"Claim template identifier.\n","type":"string","pattern":"[0-9A-Z]{3}"},"categoryCode":{"description":"Creditors' text key, explanation of payment. Optional attribute on claim\n","type":"string","maxLength":2,"pattern":"[0-9]{2}"},"reference":{"description":"Reference number determined by creditors.\n","type":"string","maxLength":16},"paymentFee":{"description":"Additional fee that adds to the claim amount.\n","nullable":true,"type":"object","required":["printingFee","paperlessFee"],"properties":{"printingFee":{"description":"A fee that is applied if the claim is printed.","type":"number"},"paperlessFee":{"description":"A fee that is applied if the claim is paperless.\nThis fee applies to payors who have opted out of receiving printed letters and to direct debit claims.\n","type":"number"}}},"defaultCharge":{"description":"Default charges configuration.\nDefines day offsets from the reference date and whether each charge is percentage-based or a fixed amount.\nFor discounts, the amount is calculated from totalAmount.\nFor defaultCharge, the charge amount is calculated from claimAmount.\n","nullable":true,"type":"object","required":["referenceDate"],"properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}}},"referenceDate":{"description":"Specifies the reference date for calculations, allowing the choice between the DueDate and the FinalDueDate as the basis.\n","type":"string","enum":["DueDate","FinalDueDate"]},"dayAmountItem":{"description":"For whether to use fixed amount or calculate by percentage from claimAmount when calculating discount or charge.\n","type":"object","required":["chargeType","day","value"],"properties":{"chargeType":{"type":"string","enum":["Percentage","Amount"]},"day":{"type":"integer","minimum":0,"maximum":99},"value":{"type":"number"}}},"defaultInterest":{"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”. \n","nullable":true,"type":"object","required":["referenceDate"],"properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"baseAmountType":{"description":"Indicates the amount by which the penalty interest is calculated.\n- Amount: Penalty interest is calculated on the basis of the amount of the claim.\n- AmountAndDefaultCharge: Penalty interest is calculated on the basis of the amount \nand arrears of the claim.\n","type":"string","enum":["Amount","AmountAndDefaultCharge"]},"baseTimeType":{"description":"Indicates at what time the basis of penalty 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 \n  used (number of days / calendar days).\n","type":"string","enum":["Daily","360","Calendar"]},"percentage":{"description":"Indicates the percentage of default interest. If this parameter is not specified or is set to “0”, the \nCentral Bank's maximum penalty interest rate is used.\nPercentage range is between 0 - 100\n","type":"number"}}},"discount":{"description":"Contains detail information about claim discount\n","nullable":true,"type":"object","required":["referenceDate"],"properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}}},"printing":{"description":"Contains information if a collection claim is printed at a bank / savings bank to manage the\nprintout of the collection claim. Changing a printout to a change entry after printing a note\ndoes not result in it being reprinted\n","nullable":true,"type":"object","properties":{"payorAddress":{"$ref":"#/components/schemas/address"},"itemRows":{"type":"array","items":{"$ref":"#/components/schemas/itemRow"}},"comments":{"type":"array","items":{"type":"string"}}}},"address":{"description":"Address or legal address of a legal entity\n","type":"object","required":["name","addressLine","postalCode","city","country"],"properties":{"name":{"type":"string"},"addressLine":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"country":{"type":"string","pattern":"[A-Z]{2}"}}},"itemRow":{"description":"Contains information on the breakdown of the collection claim.\n","type":"object","properties":{"text":{"type":"string"},"amount":{"type":"number"}}},"claimType":{"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).\n","type":"string","enum":["NormalClaim","OptionalPaymentClaim","RefundClaim","BalanceClaim"]},"Error400":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode400"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode400"}}}}}},"MessageCode400":{"description":"Message codes. HTTP Error code 400 (BAD_REQUEST).","type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED","SERVICE_INVALID","RESOURCE_UNKNOWN","RESOURCE_EXPIRED","RESOURCE_BLOCKED","TIMESTAMP_INVALID","PERIOD_INVALID","SCA_METHOD_UNKNOWN","SCA_INVALID","CONSENT_UNKNOWN","SESSIONS_NOT_SUPPORTED"]},"errorTitle":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"errorDetail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"Error401":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode401"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode401"}}}}}},"MessageCode401":{"description":"Message codes. HTTP Error code 401 (UNAUTHORIZED).","type":"string","enum":["CERTIFICATE_INVALID","ROLE_INVALID","CERTIFICATE_EXPIRED","CERTIFICATE_BLOCKED","CERTIFICATE_REVOKE","CERTIFICATE_MISSING","SIGNATURE_INVALID","SIGNATURE_MISSING","TOKEN_UNKNOWN","TOKEN_INVALID","TOKEN_EXPIRED"]},"Error403_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 403.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message403"}}}},"message403":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode403"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"messageCategory":{"description":"Category of the message category.","type":"string","enum":["ERROR","WARNING"]},"MessageCode403":{"description":"Message codes. HTTP Error code 403 (FORBIDDEN).","type":"string","enum":["CONSENT_UNKNOWN","SERVICE_BLOCKED","RESOURCE_UNKNOWN","RESOURCE_EXPIRED"]},"messageText":{"description":"Additional explaining text.","type":"string","maxLength":500},"Error403":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode403"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode403"}}}}}},"Error404_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 404.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message404"}}}},"message404":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode404"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"MessageCode404":{"description":"Message codes. HTTP Error code 404 (NOT FOUND).","type":"string","enum":["RESOURCE_UNKNOWN"]},"Error404":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode404"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode404"}}}}}},"Error405_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 405.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message405"}}}},"message405":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode405"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"MessageCode405":{"description":"Message codes. HTTP Error code 405 (METHOD NOT ALLOWED).","type":"string","enum":["SERVICE_INVALID"]},"Error405":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode405"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode405"}}}}}}},"responses":{"OK_200_QueryClaimInformation":{"description":"Query claim information.\n","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/claimDetails"}}}},"BAD_REQUEST_400":{"description":"Bad Request","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error400"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error400"}}}},"UNAUTHORIZED_401":{"description":"Unauthorized","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error401"}}}},"FORBIDDEN_403":{"description":"Forbidden","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error403_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error403"}}}},"NOT_FOUND_404":{"description":"Not found","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error404_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error404"}}}},"METHOD_NOT_ALLOWED_405":{"description":"Method Not Allowed","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error405_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error405"}}}},"REQUEST_TIMEOUT_408":{"description":"Request Timeout","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"UNSUPPORTED_MEDIA_TYPE_415":{"description":"Unsupported Media Type","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"INTERNAL_SERVER_ERROR_500":{"description":"Internal Server Error","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"SERVICE_UNAVAILABLE_503":{"description":"Service Unavailable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"type":"string","format":"uuid"}},"Location":{"description":"Location of the created resource.\n","schema":{"type":"string","format":"url"},"required":false}}},"paths":{"/api/v1/claims/{claimId}":{"get":{"summary":"Get single claim","description":"Fetch detail information for a single claim by claimID. Detailed information on fields in claimDetails.\n","operationId":"getClaim","tags":["Claim Service"],"parameters":[{"$ref":"#/components/parameters/claimId"},{"$ref":"#/components/parameters/X-Request-ID"}],"responses":{"200":{"$ref":"#/components/responses/OK_200_QueryClaimInformation"},"400":{"$ref":"#/components/responses/BAD_REQUEST_400"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401"},"403":{"$ref":"#/components/responses/FORBIDDEN_403"},"404":{"$ref":"#/components/responses/NOT_FOUND_404"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503"}}}}}}
```

## Patch a single claim

> The patch claim method modifies a previously created claim.\
> \
> A cancelled claim is recreated by changing its status from "Cancelled" back to "Unpaid". Recreating a claim keeps existing history.\
> \
> To cancel a claim change status to "Cancelled".\
> \
> To move a claim between collection phases change collectionStatus:\
> \- SecondaryCollection (for secondary)\
> \- PrimaryCollection (for primary)\
> \
> For further input parameter descriptions, see the mergeClaimDetails request object.<br>

```json
{"openapi":"3.0.2","info":{"title":"IOBWS 3.0 Domestic Claims","version":"v3.2"},"tags":[{"name":"Claim Service","description":"Common Claim operations for icelandic banks"}],"servers":[{"url":"https://apigw.arionbanki.is/claims","description":"IOBWS 3.0 Claims API"}],"security":[{"oauth2":["openid","profile","b2b","claimscollection"]}],"components":{"securitySchemes":{},"parameters":{"claimId":{"name":"claimId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/claimId"}},"X-Request-ID":{"name":"X-Request-ID","in":"header","description":"Unique value generated by the client which the resource server uses to recognize subsequent \nretries of the same request.\n","required":true,"schema":{"type":"string","format":"uuid"}}},"schemas":{"claimId":{"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\n","type":"string"},"mergeClaimDetails":{"description":"Merge patch claim object\n","type":"object","additionalProperties":false,"properties":{"expirationDate":{"type":"string","format":"date"},"templateCode":{"$ref":"#/components/schemas/templateCode"},"amount":{"description":"Claim amount","type":"number","minimum":0},"reference":{"$ref":"#/components/schemas/reference"},"finalDueDate":{"type":"string","format":"date"},"billNumber":{"description":"7-character reference id set by claimant. This ID will be visible on the payer's account statement\n","type":"string","maxLength":7,"nullable":true},"customerNumber":{"description":"16-character reference id set by claimant. Payer's transaction number. Payer's transaction number. Unique key to the payer of the \nclaim with the creditor. Necessary if a direct payment agreement is to be established\n","type":"string","maxLength":16,"nullable":true},"paymentFee":{"$ref":"#/components/schemas/paymentFee"},"otherCostsAmount":{"description":"Other costs, including determined fees paid by the payer of a collection claim.","type":"number","nullable":true,"minimum":0},"otherDefaultCostsAmount":{"description":"Determined fees, e.g. intermediate collection fee.","type":"number","nullable":true,"minimum":0},"defaultCharge":{"$ref":"#/components/schemas/defaultCharge"},"defaultInterest":{"$ref":"#/components/schemas/defaultInterest"},"discount":{"$ref":"#/components/schemas/discount"},"isOutOfSequencePaymentAllowed":{"description":"Payment rule, is it allowed to pay the last payment if previous has not been paid","type":"boolean"},"isPartialPaymentAllowed":{"description":"Partial payment is allowed","type":"boolean"},"currency":{"description":"Claim currency (ISO 4217)","type":"string","pattern":"[A-Z]{3}","nullable":true},"additionalInformation":{"description":"Free text that will be displayed on the claim","type":"string","maxLength":200},"claimStatus":{"$ref":"#/components/schemas/claimStatus"},"collectionStatus":{"$ref":"#/components/schemas/collectionStatus"},"printing":{"$ref":"#/components/schemas/printing"}}},"templateCode":{"description":"Claim template identifier.\n","type":"string","pattern":"[0-9A-Z]{3}"},"reference":{"description":"Reference number determined by creditors.\n","type":"string","maxLength":16},"paymentFee":{"description":"Additional fee that adds to the claim amount.\n","nullable":true,"type":"object","required":["printingFee","paperlessFee"],"properties":{"printingFee":{"description":"A fee that is applied if the claim is printed.","type":"number"},"paperlessFee":{"description":"A fee that is applied if the claim is paperless.\nThis fee applies to payors who have opted out of receiving printed letters and to direct debit claims.\n","type":"number"}}},"defaultCharge":{"description":"Default charges configuration.\nDefines day offsets from the reference date and whether each charge is percentage-based or a fixed amount.\nFor discounts, the amount is calculated from totalAmount.\nFor defaultCharge, the charge amount is calculated from claimAmount.\n","nullable":true,"type":"object","required":["referenceDate"],"properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}}},"referenceDate":{"description":"Specifies the reference date for calculations, allowing the choice between the DueDate and the FinalDueDate as the basis.\n","type":"string","enum":["DueDate","FinalDueDate"]},"dayAmountItem":{"description":"For whether to use fixed amount or calculate by percentage from claimAmount when calculating discount or charge.\n","type":"object","required":["chargeType","day","value"],"properties":{"chargeType":{"type":"string","enum":["Percentage","Amount"]},"day":{"type":"integer","minimum":0,"maximum":99},"value":{"type":"number"}}},"defaultInterest":{"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”. \n","nullable":true,"type":"object","required":["referenceDate"],"properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"baseAmountType":{"description":"Indicates the amount by which the penalty interest is calculated.\n- Amount: Penalty interest is calculated on the basis of the amount of the claim.\n- AmountAndDefaultCharge: Penalty interest is calculated on the basis of the amount \nand arrears of the claim.\n","type":"string","enum":["Amount","AmountAndDefaultCharge"]},"baseTimeType":{"description":"Indicates at what time the basis of penalty 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 \n  used (number of days / calendar days).\n","type":"string","enum":["Daily","360","Calendar"]},"percentage":{"description":"Indicates the percentage of default interest. If this parameter is not specified or is set to “0”, the \nCentral Bank's maximum penalty interest rate is used.\nPercentage range is between 0 - 100\n","type":"number"}}},"discount":{"description":"Contains detail information about claim discount\n","nullable":true,"type":"object","required":["referenceDate"],"properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}}},"claimStatus":{"description":"Claim status","type":"string","enum":["Unpaid","Paid","Cancelled"]},"collectionStatus":{"description":"Claim billing process status","type":"string","enum":["PrimaryCollection","SecondaryCollection","LegalCollection"]},"printing":{"description":"Contains information if a collection claim is printed at a bank / savings bank to manage the\nprintout of the collection claim. Changing a printout to a change entry after printing a note\ndoes not result in it being reprinted\n","nullable":true,"type":"object","properties":{"payorAddress":{"$ref":"#/components/schemas/address"},"itemRows":{"type":"array","items":{"$ref":"#/components/schemas/itemRow"}},"comments":{"type":"array","items":{"type":"string"}}}},"address":{"description":"Address or legal address of a legal entity\n","type":"object","required":["name","addressLine","postalCode","city","country"],"properties":{"name":{"type":"string"},"addressLine":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"country":{"type":"string","pattern":"[A-Z]{2}"}}},"itemRow":{"description":"Contains information on the breakdown of the collection claim.\n","type":"object","properties":{"text":{"type":"string"},"amount":{"type":"number"}}},"claimStatusSingleResponse":{"description":"Batch status object.\n","properties":{"success":{"$ref":"#/components/schemas/claimStatusSuccess"},"error":{"$ref":"#/components/schemas/claimStatusError"}}},"claimStatusSuccess":{"description":"Batch success status item.\n","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"claimId":{"$ref":"#/components/schemas/claimId"},"directPaymentClaim":{"type":"boolean"},"print":{"type":"boolean"}}},"claimKey":{"description":"Claim key is a composite key of kennitala, account and due date.\n","type":"object","required":["claimantId","account","dueDate"],"properties":{"claimantId":{"$ref":"#/components/schemas/kennitala"},"account":{"$ref":"#/components/schemas/account"},"dueDate":{"$ref":"#/components/schemas/dueDate"}}},"kennitala":{"description":"Icelandic Id number (kennitala).\n","type":"string","pattern":"[0-9]{10}"},"account":{"description":"Bank number, ledger and number.\nFor claims ledger is 66 followed by claim number\n","type":"string","pattern":"[0-9]{12}"},"dueDate":{"description":"Due date","type":"string","format":"date"},"claimStatusError":{"description":"Batch error status item.\n","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"claimId":{"$ref":"#/components/schemas/claimId"},"resultCode":{"type":"string","enum":["CLAIM_EXISTS","CLAIM_IS_PAID","CLAIM_NOT_FOUND","CLAIM_IS_CANCELLED","CLAIM_NOT_IN_SECONDARY_STATE","CLAIM_OTHERS"]},"resultSubCode":{"type":"string"},"resultMessage":{"type":"string"}}},"Error400":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode400"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode400"}}}}}},"MessageCode400":{"description":"Message codes. HTTP Error code 400 (BAD_REQUEST).","type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED","SERVICE_INVALID","RESOURCE_UNKNOWN","RESOURCE_EXPIRED","RESOURCE_BLOCKED","TIMESTAMP_INVALID","PERIOD_INVALID","SCA_METHOD_UNKNOWN","SCA_INVALID","CONSENT_UNKNOWN","SESSIONS_NOT_SUPPORTED"]},"errorTitle":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"errorDetail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"Error401":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode401"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode401"}}}}}},"MessageCode401":{"description":"Message codes. HTTP Error code 401 (UNAUTHORIZED).","type":"string","enum":["CERTIFICATE_INVALID","ROLE_INVALID","CERTIFICATE_EXPIRED","CERTIFICATE_BLOCKED","CERTIFICATE_REVOKE","CERTIFICATE_MISSING","SIGNATURE_INVALID","SIGNATURE_MISSING","TOKEN_UNKNOWN","TOKEN_INVALID","TOKEN_EXPIRED"]},"Error403_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 403.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message403"}}}},"message403":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode403"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"messageCategory":{"description":"Category of the message category.","type":"string","enum":["ERROR","WARNING"]},"MessageCode403":{"description":"Message codes. HTTP Error code 403 (FORBIDDEN).","type":"string","enum":["CONSENT_UNKNOWN","SERVICE_BLOCKED","RESOURCE_UNKNOWN","RESOURCE_EXPIRED"]},"messageText":{"description":"Additional explaining text.","type":"string","maxLength":500},"Error403":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode403"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode403"}}}}}},"Error404_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 404.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message404"}}}},"message404":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode404"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"MessageCode404":{"description":"Message codes. HTTP Error code 404 (NOT FOUND).","type":"string","enum":["RESOURCE_UNKNOWN"]},"Error404":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode404"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode404"}}}}}},"Error405_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 405.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message405"}}}},"message405":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode405"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"MessageCode405":{"description":"Message codes. HTTP Error code 405 (METHOD NOT ALLOWED).","type":"string","enum":["SERVICE_INVALID"]},"Error405":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode405"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode405"}}}}}}},"requestBodies":{"mergeClaim":{"description":"JSON request body for a create claim request message\n","required":true,"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/mergeClaimDetails"}}}}},"responses":{"OK_200_ActionSingleResponse":{"description":"Claim updated (single item response)","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/claimStatusSingleResponse"}}}},"BAD_REQUEST_400":{"description":"Bad Request","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error400"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error400"}}}},"UNAUTHORIZED_401":{"description":"Unauthorized","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error401"}}}},"FORBIDDEN_403":{"description":"Forbidden","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error403_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error403"}}}},"NOT_FOUND_404":{"description":"Not found","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error404_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error404"}}}},"METHOD_NOT_ALLOWED_405":{"description":"Method Not Allowed","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error405_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error405"}}}},"REQUEST_TIMEOUT_408":{"description":"Request Timeout","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"UNSUPPORTED_MEDIA_TYPE_415":{"description":"Unsupported Media Type","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"INTERNAL_SERVER_ERROR_500":{"description":"Internal Server Error","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"SERVICE_UNAVAILABLE_503":{"description":"Service Unavailable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"type":"string","format":"uuid"}},"Location":{"description":"Location of the created resource.\n","schema":{"type":"string","format":"url"},"required":false}}},"paths":{"/api/v1/claims/{claimId}":{"patch":{"summary":"Patch a single claim","description":"The patch claim method modifies a previously created claim.\n\nA cancelled claim is recreated by changing its status from \"Cancelled\" back to \"Unpaid\". Recreating a claim keeps existing history.\n\nTo cancel a claim change status to \"Cancelled\".\n\nTo move a claim between collection phases change collectionStatus:\n- SecondaryCollection (for secondary)\n- PrimaryCollection (for primary)\n\nFor further input parameter descriptions, see the mergeClaimDetails request object.\n","operationId":"patchClaim","tags":["Claim Service"],"parameters":[{"$ref":"#/components/parameters/claimId"},{"$ref":"#/components/parameters/X-Request-ID"}],"requestBody":{"$ref":"#/components/requestBodies/mergeClaim"},"responses":{"200":{"$ref":"#/components/responses/OK_200_ActionSingleResponse"},"400":{"$ref":"#/components/responses/BAD_REQUEST_400"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401"},"403":{"$ref":"#/components/responses/FORBIDDEN_403"},"404":{"$ref":"#/components/responses/NOT_FOUND_404"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503"}}}}}}
```

## Get payments for a single claim

> Returns all claim payments. When claim is paid by debtor the claim payment is visible in near real-time.<br>

```json
{"openapi":"3.0.2","info":{"title":"IOBWS 3.0 Domestic Claims","version":"v3.2"},"tags":[{"name":"Claim Service","description":"Common Claim operations for icelandic banks"}],"servers":[{"url":"https://apigw.arionbanki.is/claims","description":"IOBWS 3.0 Claims API"}],"security":[{"oauth2":["openid","profile","b2b","claimscollection"]}],"components":{"securitySchemes":{},"parameters":{"claimId":{"name":"claimId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/claimId"}},"page":{"name":"page","in":"query","description":"Requested page","required":false,"schema":{"type":"integer","default":1}},"itemsPerPage":{"name":"itemsPerPage","in":"query","description":"Records per page","required":false,"schema":{"type":"integer","default":100}},"X-Request-ID":{"name":"X-Request-ID","in":"header","description":"Unique value generated by the client which the resource server uses to recognize subsequent \nretries of the same request.\n","required":true,"schema":{"type":"string","format":"uuid"}}},"schemas":{"claimId":{"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\n","type":"string"},"claimTransactionList":{"description":"List of claim payments\n","type":"array","items":{"$ref":"#/components/schemas/claimTransaction"}},"claimTransaction":{"description":"Contains individual claim transaction information.\n","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"payorId":{"$ref":"#/components/schemas/kennitala"},"amount":{"description":"Principal amount\n","type":"number"},"finalDueDate":{"type":"string","format":"date"},"templateCode":{"$ref":"#/components/schemas/templateCode"},"templateId":{"description":"Unique Id for each template. This is specific to each bank.","type":"string"},"secondaryCollectionTemplateCode":{"$ref":"#/components/schemas/templateCode"},"secondaryCollectionTemplateId":{"description":"Unique Id for each template. This is specific to each bank.","type":"string"},"reference":{"$ref":"#/components/schemas/reference"},"categoryCode":{"$ref":"#/components/schemas/categoryCode"},"categoryDescription":{"description":"Description of the categoryCode\n","type":"string"},"transactionBank":{"description":"The bank from which the transaction originates.","type":"string","pattern":"^[0-9]{4}$"},"transactionTimestamp":{"description":"Timestamp when payment is performed.","type":"string","format":"date-time"},"bookingDate":{"description":"Date of settlement.","type":"string","format":"date"},"valueDate":{"description":"Legal date of the date on which the effective date or interest date of payment is based, a maximum \nof 10 calendar days back in time. If the date is not specified, blank, then it is based on the \ntransaction date. \nPayment of a claim is the interest date of the effective date of penalty interest.\n","type":"string","format":"date"},"paymentType":{"description":"Type of payment, full payment, deposit, refund.","type":"string","enum":["Complete","Partial","Refund"]},"depositedAmount":{"description":"The amount deposited at the creditor's account.","type":"number"},"totalAmountPaid":{"description":"Total amount paid with accrued interests and fees.","type":"number"},"capitalGainsTax":{"description":"Deducted capital gains tax.","type":"number"},"billNumber":{"description":"7-character reference id set by claimant. This ID will be visible on the payer's account statement\n","type":"string","maxLength":7},"customerNumber":{"description":"16-character reference id set by claimant. Payer's transaction number. Unique key to the payer of the \nclaim with the creditor. Necessary if a direct payment agreement is to be established\n","type":"string","maxLength":16},"noticeChargeAmountPaid":{"description":"Notice charge paid.","type":"number"},"defaultChargeAmountPaid":{"description":"Default charge paid.","type":"number"},"otherCostsAmountPaid":{"description":"Other costs paid.","type":"number"},"otherDefaultCostsAmountPaid":{"description":"Other default costs paid.","type":"number"},"defaultInterestAmountPaid":{"description":"Amount of accrued penalty interests paid.","type":"number","minimum":0},"discountAmountGiven":{"description":"Discount that was granted when the claim was paid.","type":"number","minimum":0},"currency":{"type":"string","pattern":"[A-Z]{3}"},"currencyExchange":{"$ref":"#/components/schemas/currencyExchangeRate"},"transactionBatchId":{"description":"The identifier of the batch from which the transaction originates.","type":"string"}}},"claimKey":{"description":"Claim key is a composite key of kennitala, account and due date.\n","type":"object","required":["claimantId","account","dueDate"],"properties":{"claimantId":{"$ref":"#/components/schemas/kennitala"},"account":{"$ref":"#/components/schemas/account"},"dueDate":{"$ref":"#/components/schemas/dueDate"}}},"kennitala":{"description":"Icelandic Id number (kennitala).\n","type":"string","pattern":"[0-9]{10}"},"account":{"description":"Bank number, ledger and number.\nFor claims ledger is 66 followed by claim number\n","type":"string","pattern":"[0-9]{12}"},"dueDate":{"description":"Due date","type":"string","format":"date"},"templateCode":{"description":"Claim template identifier.\n","type":"string","pattern":"[0-9A-Z]{3}"},"reference":{"description":"Reference number determined by creditors.\n","type":"string","maxLength":16},"categoryCode":{"description":"Creditors' text key, explanation of payment. Optional attribute on claim\n","type":"string","maxLength":2,"pattern":"[0-9]{2}"},"currencyExchangeRate":{"description":"Currency contains exchange rate information. Used for collection claims in foreign currency.\n","type":"object","properties":{"currency":{"type":"string"},"rate":{"type":"number"}}},"Error400":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode400"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode400"}}}}}},"MessageCode400":{"description":"Message codes. HTTP Error code 400 (BAD_REQUEST).","type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED","SERVICE_INVALID","RESOURCE_UNKNOWN","RESOURCE_EXPIRED","RESOURCE_BLOCKED","TIMESTAMP_INVALID","PERIOD_INVALID","SCA_METHOD_UNKNOWN","SCA_INVALID","CONSENT_UNKNOWN","SESSIONS_NOT_SUPPORTED"]},"errorTitle":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"errorDetail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"Error401":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode401"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode401"}}}}}},"MessageCode401":{"description":"Message codes. HTTP Error code 401 (UNAUTHORIZED).","type":"string","enum":["CERTIFICATE_INVALID","ROLE_INVALID","CERTIFICATE_EXPIRED","CERTIFICATE_BLOCKED","CERTIFICATE_REVOKE","CERTIFICATE_MISSING","SIGNATURE_INVALID","SIGNATURE_MISSING","TOKEN_UNKNOWN","TOKEN_INVALID","TOKEN_EXPIRED"]},"Error403_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 403.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message403"}}}},"message403":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode403"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"messageCategory":{"description":"Category of the message category.","type":"string","enum":["ERROR","WARNING"]},"MessageCode403":{"description":"Message codes. HTTP Error code 403 (FORBIDDEN).","type":"string","enum":["CONSENT_UNKNOWN","SERVICE_BLOCKED","RESOURCE_UNKNOWN","RESOURCE_EXPIRED"]},"messageText":{"description":"Additional explaining text.","type":"string","maxLength":500},"Error403":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode403"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode403"}}}}}},"Error404_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 404.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message404"}}}},"message404":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode404"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"MessageCode404":{"description":"Message codes. HTTP Error code 404 (NOT FOUND).","type":"string","enum":["RESOURCE_UNKNOWN"]},"Error404":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode404"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode404"}}}}}},"Error405_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 405.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message405"}}}},"message405":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode405"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"MessageCode405":{"description":"Message codes. HTTP Error code 405 (METHOD NOT ALLOWED).","type":"string","enum":["SERVICE_INVALID"]},"Error405":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode405"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode405"}}}}}}},"responses":{"OK_200_ClaimTransactionListInformation":{"description":"Claim transaction list information.\n","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"X-Paging-CurrentPage":{"description":"Current page number\n","schema":{"type":"integer"}},"X-Paging-TotalPages":{"description":"Total pages\n","schema":{"type":"integer"}},"X-Paging-TotalItems":{"description":"Total items\n","schema":{"type":"integer"}},"X-Paging-PerPage":{"description":"Items per page\n","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/claimTransactionList"}}}},"BAD_REQUEST_400":{"description":"Bad Request","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error400"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error400"}}}},"UNAUTHORIZED_401":{"description":"Unauthorized","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error401"}}}},"FORBIDDEN_403":{"description":"Forbidden","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error403_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error403"}}}},"NOT_FOUND_404":{"description":"Not found","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error404_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error404"}}}},"METHOD_NOT_ALLOWED_405":{"description":"Method Not Allowed","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error405_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error405"}}}},"REQUEST_TIMEOUT_408":{"description":"Request Timeout","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"UNSUPPORTED_MEDIA_TYPE_415":{"description":"Unsupported Media Type","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"INTERNAL_SERVER_ERROR_500":{"description":"Internal Server Error","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"SERVICE_UNAVAILABLE_503":{"description":"Service Unavailable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"type":"string","format":"uuid"}},"Location":{"description":"Location of the created resource.\n","schema":{"type":"string","format":"url"},"required":false}}},"paths":{"/api/v1/claims/{claimId}/transactions":{"get":{"summary":"Get payments for a single claim","description":"Returns all claim payments. When claim is paid by debtor the claim payment is visible in near real-time.\n","operationId":"getClaimTransactions","tags":["Claim Service"],"parameters":[{"$ref":"#/components/parameters/claimId"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/itemsPerPage"},{"$ref":"#/components/parameters/X-Request-ID"}],"responses":{"200":{"$ref":"#/components/responses/OK_200_ClaimTransactionListInformation"},"400":{"$ref":"#/components/responses/BAD_REQUEST_400"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401"},"403":{"$ref":"#/components/responses/FORBIDDEN_403"},"404":{"$ref":"#/components/responses/NOT_FOUND_404"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503"}}}}}}
```

## Get single claim history

> Claim history contains every event for the claim from the beginning, i.e., all changes that\
> have been made to the claim together with information about the claim itself.<br>

```json
{"openapi":"3.0.2","info":{"title":"IOBWS 3.0 Domestic Claims","version":"v3.2"},"tags":[{"name":"Claim Service","description":"Common Claim operations for icelandic banks"}],"servers":[{"url":"https://apigw.arionbanki.is/claims","description":"IOBWS 3.0 Claims API"}],"security":[{"oauth2":["openid","profile","b2b","claimscollection"]}],"components":{"securitySchemes":{},"parameters":{"claimId":{"name":"claimId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/claimId"}},"page":{"name":"page","in":"query","description":"Requested page","required":false,"schema":{"type":"integer","default":1}},"itemsPerPage":{"name":"itemsPerPage","in":"query","description":"Records per page","required":false,"schema":{"type":"integer","default":100}},"X-Request-ID":{"name":"X-Request-ID","in":"header","description":"Unique value generated by the client which the resource server uses to recognize subsequent \nretries of the same request.\n","required":true,"schema":{"type":"string","format":"uuid"}}},"schemas":{"claimId":{"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\n","type":"string"},"claimHistoryList":{"description":"Claim history\n","type":"array","items":{"$ref":"#/components/schemas/claimHistoryEvent"}},"claimHistoryEvent":{"description":"Contains the Claim and Payment class as well as basic information on financial actions and changes to a claim,\nbut the daily account of the Claim Pot's expense items is not shown. The Claim class contains the appearance\nof the claim as it was after the movement. If payment information is related to the movement, it is returned\nin the Payment class.\n","type":"object","required":["claim","transactionDate","transactionType"],"properties":{"claim":{"$ref":"#/components/schemas/claimEvent"},"payment":{"$ref":"#/components/schemas/claimTransaction"},"transactionDate":{"type":"string","format":"date-time"},"transactionType":{"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.\n","type":"string","enum":["Creation","Update","Cancellation","CancellationByPayor","Payment","PartialPayment","RefundPayment","ReversedPayment","ReversedPartialPayment","ReversedClaim","TransferFromBank","TransferToBank"]},"userName":{"type":"string"},"updatedFields":{"type":"array","items":{"type":"string"}}}},"claimEvent":{"description":"Describes an event related to a claim. \nContains optional details about the claim state, changes, \nor other relevant information captured at the time of the event.\n","type":"object","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"payorId":{"$ref":"#/components/schemas/kennitala"},"expirationDate":{"type":"string","format":"date"},"templateCode":{"$ref":"#/components/schemas/templateCode"},"templateId":{"description":"Unique Id for each template. This is specific to each bank.","type":"string"},"amount":{"type":"number","minimum":0},"reference":{"$ref":"#/components/schemas/reference"},"categoryCode":{"$ref":"#/components/schemas/categoryCode"},"finalDueDate":{"type":"string","format":"date"},"billNumber":{"description":"7 character reference shown on payer statement","type":"string","maxLength":7},"customerNumber":{"description":"Payer transaction number (unique per claimant, needed for direct payment agreements)","type":"string","maxLength":16},"paymentFee":{"$ref":"#/components/schemas/paymentFee"},"otherCostsAmount":{"description":"Other costs, including determined fees paid by the payer of a collection claim.","type":"number","minimum":0},"otherDefaultCostsAmount":{"description":"Determined fees, e.g. intermediate collection fee.","type":"number","minimum":0},"defaultCharge":{"$ref":"#/components/schemas/defaultCharge"},"defaultInterest":{"$ref":"#/components/schemas/defaultInterest"},"discount":{"$ref":"#/components/schemas/discount"},"isOutOfSequencePaymentAllowed":{"description":"Allow last payment if previous is unpaid","type":"boolean"},"isPartialPaymentAllowed":{"type":"boolean"},"currency":{"type":"string","pattern":"^[A-Z]{3}"},"additionalInformation":{"description":"Free text displayed on the claim","type":"string","maxLength":200},"printing":{"$ref":"#/components/schemas/printing"},"claimType":{"$ref":"#/components/schemas/claimType"}}},"claimKey":{"description":"Claim key is a composite key of kennitala, account and due date.\n","type":"object","required":["claimantId","account","dueDate"],"properties":{"claimantId":{"$ref":"#/components/schemas/kennitala"},"account":{"$ref":"#/components/schemas/account"},"dueDate":{"$ref":"#/components/schemas/dueDate"}}},"kennitala":{"description":"Icelandic Id number (kennitala).\n","type":"string","pattern":"[0-9]{10}"},"account":{"description":"Bank number, ledger and number.\nFor claims ledger is 66 followed by claim number\n","type":"string","pattern":"[0-9]{12}"},"dueDate":{"description":"Due date","type":"string","format":"date"},"templateCode":{"description":"Claim template identifier.\n","type":"string","pattern":"[0-9A-Z]{3}"},"reference":{"description":"Reference number determined by creditors.\n","type":"string","maxLength":16},"categoryCode":{"description":"Creditors' text key, explanation of payment. Optional attribute on claim\n","type":"string","maxLength":2,"pattern":"[0-9]{2}"},"paymentFee":{"description":"Additional fee that adds to the claim amount.\n","nullable":true,"type":"object","required":["printingFee","paperlessFee"],"properties":{"printingFee":{"description":"A fee that is applied if the claim is printed.","type":"number"},"paperlessFee":{"description":"A fee that is applied if the claim is paperless.\nThis fee applies to payors who have opted out of receiving printed letters and to direct debit claims.\n","type":"number"}}},"defaultCharge":{"description":"Default charges configuration.\nDefines day offsets from the reference date and whether each charge is percentage-based or a fixed amount.\nFor discounts, the amount is calculated from totalAmount.\nFor defaultCharge, the charge amount is calculated from claimAmount.\n","nullable":true,"type":"object","required":["referenceDate"],"properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}}},"referenceDate":{"description":"Specifies the reference date for calculations, allowing the choice between the DueDate and the FinalDueDate as the basis.\n","type":"string","enum":["DueDate","FinalDueDate"]},"dayAmountItem":{"description":"For whether to use fixed amount or calculate by percentage from claimAmount when calculating discount or charge.\n","type":"object","required":["chargeType","day","value"],"properties":{"chargeType":{"type":"string","enum":["Percentage","Amount"]},"day":{"type":"integer","minimum":0,"maximum":99},"value":{"type":"number"}}},"defaultInterest":{"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”. \n","nullable":true,"type":"object","required":["referenceDate"],"properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"baseAmountType":{"description":"Indicates the amount by which the penalty interest is calculated.\n- Amount: Penalty interest is calculated on the basis of the amount of the claim.\n- AmountAndDefaultCharge: Penalty interest is calculated on the basis of the amount \nand arrears of the claim.\n","type":"string","enum":["Amount","AmountAndDefaultCharge"]},"baseTimeType":{"description":"Indicates at what time the basis of penalty 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 \n  used (number of days / calendar days).\n","type":"string","enum":["Daily","360","Calendar"]},"percentage":{"description":"Indicates the percentage of default interest. If this parameter is not specified or is set to “0”, the \nCentral Bank's maximum penalty interest rate is used.\nPercentage range is between 0 - 100\n","type":"number"}}},"discount":{"description":"Contains detail information about claim discount\n","nullable":true,"type":"object","required":["referenceDate"],"properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}}},"printing":{"description":"Contains information if a collection claim is printed at a bank / savings bank to manage the\nprintout of the collection claim. Changing a printout to a change entry after printing a note\ndoes not result in it being reprinted\n","nullable":true,"type":"object","properties":{"payorAddress":{"$ref":"#/components/schemas/address"},"itemRows":{"type":"array","items":{"$ref":"#/components/schemas/itemRow"}},"comments":{"type":"array","items":{"type":"string"}}}},"address":{"description":"Address or legal address of a legal entity\n","type":"object","required":["name","addressLine","postalCode","city","country"],"properties":{"name":{"type":"string"},"addressLine":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"country":{"type":"string","pattern":"[A-Z]{2}"}}},"itemRow":{"description":"Contains information on the breakdown of the collection claim.\n","type":"object","properties":{"text":{"type":"string"},"amount":{"type":"number"}}},"claimType":{"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).\n","type":"string","enum":["NormalClaim","OptionalPaymentClaim","RefundClaim","BalanceClaim"]},"claimTransaction":{"description":"Contains individual claim transaction information.\n","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"payorId":{"$ref":"#/components/schemas/kennitala"},"amount":{"description":"Principal amount\n","type":"number"},"finalDueDate":{"type":"string","format":"date"},"templateCode":{"$ref":"#/components/schemas/templateCode"},"templateId":{"description":"Unique Id for each template. This is specific to each bank.","type":"string"},"secondaryCollectionTemplateCode":{"$ref":"#/components/schemas/templateCode"},"secondaryCollectionTemplateId":{"description":"Unique Id for each template. This is specific to each bank.","type":"string"},"reference":{"$ref":"#/components/schemas/reference"},"categoryCode":{"$ref":"#/components/schemas/categoryCode"},"categoryDescription":{"description":"Description of the categoryCode\n","type":"string"},"transactionBank":{"description":"The bank from which the transaction originates.","type":"string","pattern":"^[0-9]{4}$"},"transactionTimestamp":{"description":"Timestamp when payment is performed.","type":"string","format":"date-time"},"bookingDate":{"description":"Date of settlement.","type":"string","format":"date"},"valueDate":{"description":"Legal date of the date on which the effective date or interest date of payment is based, a maximum \nof 10 calendar days back in time. If the date is not specified, blank, then it is based on the \ntransaction date. \nPayment of a claim is the interest date of the effective date of penalty interest.\n","type":"string","format":"date"},"paymentType":{"description":"Type of payment, full payment, deposit, refund.","type":"string","enum":["Complete","Partial","Refund"]},"depositedAmount":{"description":"The amount deposited at the creditor's account.","type":"number"},"totalAmountPaid":{"description":"Total amount paid with accrued interests and fees.","type":"number"},"capitalGainsTax":{"description":"Deducted capital gains tax.","type":"number"},"billNumber":{"description":"7-character reference id set by claimant. This ID will be visible on the payer's account statement\n","type":"string","maxLength":7},"customerNumber":{"description":"16-character reference id set by claimant. Payer's transaction number. Unique key to the payer of the \nclaim with the creditor. Necessary if a direct payment agreement is to be established\n","type":"string","maxLength":16},"noticeChargeAmountPaid":{"description":"Notice charge paid.","type":"number"},"defaultChargeAmountPaid":{"description":"Default charge paid.","type":"number"},"otherCostsAmountPaid":{"description":"Other costs paid.","type":"number"},"otherDefaultCostsAmountPaid":{"description":"Other default costs paid.","type":"number"},"defaultInterestAmountPaid":{"description":"Amount of accrued penalty interests paid.","type":"number","minimum":0},"discountAmountGiven":{"description":"Discount that was granted when the claim was paid.","type":"number","minimum":0},"currency":{"type":"string","pattern":"[A-Z]{3}"},"currencyExchange":{"$ref":"#/components/schemas/currencyExchangeRate"},"transactionBatchId":{"description":"The identifier of the batch from which the transaction originates.","type":"string"}}},"currencyExchangeRate":{"description":"Currency contains exchange rate information. Used for collection claims in foreign currency.\n","type":"object","properties":{"currency":{"type":"string"},"rate":{"type":"number"}}},"Error400":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode400"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode400"}}}}}},"MessageCode400":{"description":"Message codes. HTTP Error code 400 (BAD_REQUEST).","type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED","SERVICE_INVALID","RESOURCE_UNKNOWN","RESOURCE_EXPIRED","RESOURCE_BLOCKED","TIMESTAMP_INVALID","PERIOD_INVALID","SCA_METHOD_UNKNOWN","SCA_INVALID","CONSENT_UNKNOWN","SESSIONS_NOT_SUPPORTED"]},"errorTitle":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"errorDetail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"Error401":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode401"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode401"}}}}}},"MessageCode401":{"description":"Message codes. HTTP Error code 401 (UNAUTHORIZED).","type":"string","enum":["CERTIFICATE_INVALID","ROLE_INVALID","CERTIFICATE_EXPIRED","CERTIFICATE_BLOCKED","CERTIFICATE_REVOKE","CERTIFICATE_MISSING","SIGNATURE_INVALID","SIGNATURE_MISSING","TOKEN_UNKNOWN","TOKEN_INVALID","TOKEN_EXPIRED"]},"Error403_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 403.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message403"}}}},"message403":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode403"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"messageCategory":{"description":"Category of the message category.","type":"string","enum":["ERROR","WARNING"]},"MessageCode403":{"description":"Message codes. HTTP Error code 403 (FORBIDDEN).","type":"string","enum":["CONSENT_UNKNOWN","SERVICE_BLOCKED","RESOURCE_UNKNOWN","RESOURCE_EXPIRED"]},"messageText":{"description":"Additional explaining text.","type":"string","maxLength":500},"Error403":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode403"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode403"}}}}}},"Error404_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 404.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message404"}}}},"message404":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode404"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"MessageCode404":{"description":"Message codes. HTTP Error code 404 (NOT FOUND).","type":"string","enum":["RESOURCE_UNKNOWN"]},"Error404":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode404"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode404"}}}}}},"Error405_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 405.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message405"}}}},"message405":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode405"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"MessageCode405":{"description":"Message codes. HTTP Error code 405 (METHOD NOT ALLOWED).","type":"string","enum":["SERVICE_INVALID"]},"Error405":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode405"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode405"}}}}}}},"responses":{"OK_200_ClaimHistoryListInformation":{"description":"Claim history list information response.\n","headers":{"X-Paging-CurrentPage":{"description":"Current page number\n","schema":{"type":"integer"}},"X-Paging-TotalPages":{"description":"Total pages\n","schema":{"type":"integer"}},"X-Paging-TotalItems":{"description":"Total items\n","schema":{"type":"integer"}},"X-Paging-PerPage":{"description":"Items per page\n","schema":{"type":"integer"}},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/claimHistoryList"}}}},"BAD_REQUEST_400":{"description":"Bad Request","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error400"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error400"}}}},"UNAUTHORIZED_401":{"description":"Unauthorized","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error401"}}}},"FORBIDDEN_403":{"description":"Forbidden","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error403_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error403"}}}},"NOT_FOUND_404":{"description":"Not found","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error404_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error404"}}}},"METHOD_NOT_ALLOWED_405":{"description":"Method Not Allowed","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error405_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error405"}}}},"REQUEST_TIMEOUT_408":{"description":"Request Timeout","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"UNSUPPORTED_MEDIA_TYPE_415":{"description":"Unsupported Media Type","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"INTERNAL_SERVER_ERROR_500":{"description":"Internal Server Error","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"SERVICE_UNAVAILABLE_503":{"description":"Service Unavailable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"type":"string","format":"uuid"}},"Location":{"description":"Location of the created resource.\n","schema":{"type":"string","format":"url"},"required":false}}},"paths":{"/api/v1/claims/{claimId}/history":{"get":{"summary":"Get single claim history","description":"Claim history contains every event for the claim from the beginning, i.e., all changes that\nhave been made to the claim together with information about the claim itself.\n","operationId":"getClaimHistory","tags":["Claim Service"],"parameters":[{"$ref":"#/components/parameters/claimId"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/itemsPerPage"},{"$ref":"#/components/parameters/X-Request-ID"}],"responses":{"200":{"$ref":"#/components/responses/OK_200_ClaimHistoryListInformation"},"400":{"$ref":"#/components/responses/BAD_REQUEST_400"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401"},"403":{"$ref":"#/components/responses/FORBIDDEN_403"},"404":{"$ref":"#/components/responses/NOT_FOUND_404"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503"}}}}}}
```

## Get payments for multiple claims

> Returns all payments for a given claim.  Payment information is accessible near real-time.<br>

```json
{"openapi":"3.0.2","info":{"title":"IOBWS 3.0 Domestic Claims","version":"v3.2"},"tags":[{"name":"Claim Service","description":"Common Claim operations for icelandic banks"}],"servers":[{"url":"https://apigw.arionbanki.is/claims","description":"IOBWS 3.0 Claims API"}],"security":[{"oauth2":["openid","profile","b2b","claimscollection"]}],"components":{"securitySchemes":{},"parameters":{"claimantId":{"name":"claimantId","in":"query","description":"ClaimantId is the Icelandic kennitala for the claimant\n","required":false,"schema":{"$ref":"#/components/schemas/kennitala"}},"dateFrom":{"name":"dateFrom","in":"query","required":true,"schema":{"type":"string","format":"date"}},"dateTo":{"name":"dateTo","in":"query","required":true,"schema":{"type":"string","format":"date"}},"templateCode":{"name":"templateCode","in":"query","description":"Claim template code\n","schema":{"$ref":"#/components/schemas/templateCode"}},"depositAccount":{"name":"depositAccount","in":"query","description":"Deposit account filter\n","schema":{"$ref":"#/components/schemas/account"}},"payorId":{"name":"payorId","in":"query","description":"PayorId is the Icelandic kennitala for the payor\n","schema":{"$ref":"#/components/schemas/kennitala"}},"page":{"name":"page","in":"query","description":"Requested page","required":false,"schema":{"type":"integer","default":1}},"itemsPerPage":{"name":"itemsPerPage","in":"query","description":"Records per page","required":false,"schema":{"type":"integer","default":100}},"X-Request-ID":{"name":"X-Request-ID","in":"header","description":"Unique value generated by the client which the resource server uses to recognize subsequent \nretries of the same request.\n","required":true,"schema":{"type":"string","format":"uuid"}}},"schemas":{"kennitala":{"description":"Icelandic Id number (kennitala).\n","type":"string","pattern":"[0-9]{10}"},"templateCode":{"description":"Claim template identifier.\n","type":"string","pattern":"[0-9A-Z]{3}"},"account":{"description":"Bank number, ledger and number.\nFor claims ledger is 66 followed by claim number\n","type":"string","pattern":"[0-9]{12}"},"claimTransactionList":{"description":"List of claim payments\n","type":"array","items":{"$ref":"#/components/schemas/claimTransaction"}},"claimTransaction":{"description":"Contains individual claim transaction information.\n","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"payorId":{"$ref":"#/components/schemas/kennitala"},"amount":{"description":"Principal amount\n","type":"number"},"finalDueDate":{"type":"string","format":"date"},"templateCode":{"$ref":"#/components/schemas/templateCode"},"templateId":{"description":"Unique Id for each template. This is specific to each bank.","type":"string"},"secondaryCollectionTemplateCode":{"$ref":"#/components/schemas/templateCode"},"secondaryCollectionTemplateId":{"description":"Unique Id for each template. This is specific to each bank.","type":"string"},"reference":{"$ref":"#/components/schemas/reference"},"categoryCode":{"$ref":"#/components/schemas/categoryCode"},"categoryDescription":{"description":"Description of the categoryCode\n","type":"string"},"transactionBank":{"description":"The bank from which the transaction originates.","type":"string","pattern":"^[0-9]{4}$"},"transactionTimestamp":{"description":"Timestamp when payment is performed.","type":"string","format":"date-time"},"bookingDate":{"description":"Date of settlement.","type":"string","format":"date"},"valueDate":{"description":"Legal date of the date on which the effective date or interest date of payment is based, a maximum \nof 10 calendar days back in time. If the date is not specified, blank, then it is based on the \ntransaction date. \nPayment of a claim is the interest date of the effective date of penalty interest.\n","type":"string","format":"date"},"paymentType":{"description":"Type of payment, full payment, deposit, refund.","type":"string","enum":["Complete","Partial","Refund"]},"depositedAmount":{"description":"The amount deposited at the creditor's account.","type":"number"},"totalAmountPaid":{"description":"Total amount paid with accrued interests and fees.","type":"number"},"capitalGainsTax":{"description":"Deducted capital gains tax.","type":"number"},"billNumber":{"description":"7-character reference id set by claimant. This ID will be visible on the payer's account statement\n","type":"string","maxLength":7},"customerNumber":{"description":"16-character reference id set by claimant. Payer's transaction number. Unique key to the payer of the \nclaim with the creditor. Necessary if a direct payment agreement is to be established\n","type":"string","maxLength":16},"noticeChargeAmountPaid":{"description":"Notice charge paid.","type":"number"},"defaultChargeAmountPaid":{"description":"Default charge paid.","type":"number"},"otherCostsAmountPaid":{"description":"Other costs paid.","type":"number"},"otherDefaultCostsAmountPaid":{"description":"Other default costs paid.","type":"number"},"defaultInterestAmountPaid":{"description":"Amount of accrued penalty interests paid.","type":"number","minimum":0},"discountAmountGiven":{"description":"Discount that was granted when the claim was paid.","type":"number","minimum":0},"currency":{"type":"string","pattern":"[A-Z]{3}"},"currencyExchange":{"$ref":"#/components/schemas/currencyExchangeRate"},"transactionBatchId":{"description":"The identifier of the batch from which the transaction originates.","type":"string"}}},"claimKey":{"description":"Claim key is a composite key of kennitala, account and due date.\n","type":"object","required":["claimantId","account","dueDate"],"properties":{"claimantId":{"$ref":"#/components/schemas/kennitala"},"account":{"$ref":"#/components/schemas/account"},"dueDate":{"$ref":"#/components/schemas/dueDate"}}},"dueDate":{"description":"Due date","type":"string","format":"date"},"reference":{"description":"Reference number determined by creditors.\n","type":"string","maxLength":16},"categoryCode":{"description":"Creditors' text key, explanation of payment. Optional attribute on claim\n","type":"string","maxLength":2,"pattern":"[0-9]{2}"},"currencyExchangeRate":{"description":"Currency contains exchange rate information. Used for collection claims in foreign currency.\n","type":"object","properties":{"currency":{"type":"string"},"rate":{"type":"number"}}},"Error400":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode400"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode400"}}}}}},"MessageCode400":{"description":"Message codes. HTTP Error code 400 (BAD_REQUEST).","type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED","SERVICE_INVALID","RESOURCE_UNKNOWN","RESOURCE_EXPIRED","RESOURCE_BLOCKED","TIMESTAMP_INVALID","PERIOD_INVALID","SCA_METHOD_UNKNOWN","SCA_INVALID","CONSENT_UNKNOWN","SESSIONS_NOT_SUPPORTED"]},"errorTitle":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"errorDetail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"Error401":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode401"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode401"}}}}}},"MessageCode401":{"description":"Message codes. HTTP Error code 401 (UNAUTHORIZED).","type":"string","enum":["CERTIFICATE_INVALID","ROLE_INVALID","CERTIFICATE_EXPIRED","CERTIFICATE_BLOCKED","CERTIFICATE_REVOKE","CERTIFICATE_MISSING","SIGNATURE_INVALID","SIGNATURE_MISSING","TOKEN_UNKNOWN","TOKEN_INVALID","TOKEN_EXPIRED"]},"Error403_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 403.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message403"}}}},"message403":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode403"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"messageCategory":{"description":"Category of the message category.","type":"string","enum":["ERROR","WARNING"]},"MessageCode403":{"description":"Message codes. HTTP Error code 403 (FORBIDDEN).","type":"string","enum":["CONSENT_UNKNOWN","SERVICE_BLOCKED","RESOURCE_UNKNOWN","RESOURCE_EXPIRED"]},"messageText":{"description":"Additional explaining text.","type":"string","maxLength":500},"Error403":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode403"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode403"}}}}}},"Error404_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 404.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message404"}}}},"message404":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode404"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"MessageCode404":{"description":"Message codes. HTTP Error code 404 (NOT FOUND).","type":"string","enum":["RESOURCE_UNKNOWN"]},"Error404":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode404"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode404"}}}}}},"Error405_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 405.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message405"}}}},"message405":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode405"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"MessageCode405":{"description":"Message codes. HTTP Error code 405 (METHOD NOT ALLOWED).","type":"string","enum":["SERVICE_INVALID"]},"Error405":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode405"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode405"}}}}}}},"responses":{"OK_200_ClaimTransactionListInformation":{"description":"Claim transaction list information.\n","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"},"X-Paging-CurrentPage":{"description":"Current page number\n","schema":{"type":"integer"}},"X-Paging-TotalPages":{"description":"Total pages\n","schema":{"type":"integer"}},"X-Paging-TotalItems":{"description":"Total items\n","schema":{"type":"integer"}},"X-Paging-PerPage":{"description":"Items per page\n","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/claimTransactionList"}}}},"BAD_REQUEST_400":{"description":"Bad Request","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error400"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error400"}}}},"UNAUTHORIZED_401":{"description":"Unauthorized","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error401"}}}},"FORBIDDEN_403":{"description":"Forbidden","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error403_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error403"}}}},"NOT_FOUND_404":{"description":"Not found","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error404_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error404"}}}},"METHOD_NOT_ALLOWED_405":{"description":"Method Not Allowed","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error405_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error405"}}}},"REQUEST_TIMEOUT_408":{"description":"Request Timeout","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"UNSUPPORTED_MEDIA_TYPE_415":{"description":"Unsupported Media Type","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"INTERNAL_SERVER_ERROR_500":{"description":"Internal Server Error","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"SERVICE_UNAVAILABLE_503":{"description":"Service Unavailable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"type":"string","format":"uuid"}},"Location":{"description":"Location of the created resource.\n","schema":{"type":"string","format":"url"},"required":false}}},"paths":{"/api/v1/claims/transactions":{"get":{"summary":"Get payments for multiple claims","description":"Returns all payments for a given claim.  Payment information is accessible near real-time.\n","operationId":"getClaimsTransactions","tags":["Claim Service"],"parameters":[{"$ref":"#/components/parameters/claimantId"},{"$ref":"#/components/parameters/dateFrom"},{"$ref":"#/components/parameters/dateTo"},{"$ref":"#/components/parameters/templateCode"},{"$ref":"#/components/parameters/depositAccount"},{"$ref":"#/components/parameters/payorId"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/itemsPerPage"},{"$ref":"#/components/parameters/X-Request-ID"}],"responses":{"200":{"$ref":"#/components/responses/OK_200_ClaimTransactionListInformation"},"400":{"$ref":"#/components/responses/BAD_REQUEST_400"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401"},"403":{"$ref":"#/components/responses/FORBIDDEN_403"},"404":{"$ref":"#/components/responses/NOT_FOUND_404"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503"}}}}}}
```

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

> Accepts one of five request bodies that indicate the action type:\
> \
> \*\*batchCreateInitiation\*\* - Initiates a batch with a list of claims to be created.\
> \
> \*\*batchAlterInitiation\*\* - Initiates a batch with a list of claims to be altered.\
> \
> \*\*batchCancelInitiation\*\* - Initiates a batch with a list of claims to be cancelled.\
> \
> \*\*batchSecondaryCollectionInitiation\*\* - Initiates a batch with a list of claims to be moved to secondary collection.\
> \
> \*\*batchReturnSecondaryCollectionInitiation\*\* - Initiates a batch with a list of claims to be returned from secondary collection back to primary collection.\
> \
> 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;         <br>

```json
{"openapi":"3.0.2","info":{"title":"IOBWS 3.0 Domestic Claims","version":"v3.2"},"tags":[{"name":"Claim Service","description":"Common Claim operations for icelandic banks"}],"servers":[{"url":"https://apigw.arionbanki.is/claims","description":"IOBWS 3.0 Claims API"}],"security":[{"oauth2":["openid","profile","b2b","claimscollection"]}],"components":{"securitySchemes":{},"parameters":{"X-Request-ID":{"name":"X-Request-ID","in":"header","description":"Unique value generated by the client which the resource server uses to recognize subsequent \nretries of the same request.\n","required":true,"schema":{"type":"string","format":"uuid"}},"X-Idempotency-Key":{"name":"X-Idempotency-Key","in":"header","description":"Idempotency key","required":false,"schema":{"type":"string","format":"uuid"}}},"requestBodies":{"batchInitiation":{"description":"JSON request body for a list of create or alter actions initiation request message\n","required":true,"content":{"application/json":{"schema":{"discriminator":{"propertyName":"actionType","mapping":{"create":"#/components/schemas/batchCreateInitiation","alter":"#/components/schemas/batchAlterInitiation","cancel":"#/components/schemas/batchCancelInitiation","secondaryCollection":"#/components/schemas/batchSecondaryCollectionInitiation","returnSecondaryCollection":"#/components/schemas/batchReturnSecondaryCollectionInitiation"}},"oneOf":[{"$ref":"#/components/schemas/batchCreateInitiation"},{"$ref":"#/components/schemas/batchAlterInitiation"},{"$ref":"#/components/schemas/batchCancelInitiation"},{"$ref":"#/components/schemas/batchSecondaryCollectionInitiation"},{"$ref":"#/components/schemas/batchReturnSecondaryCollectionInitiation"}]}}}}},"schemas":{"batchCreateInitiation":{"properties":{"actionType":{"$ref":"#/components/schemas/actionType"},"createList":{"$ref":"#/components/schemas/createClaimDetailList"}}},"actionType":{"type":"string","enum":["create","alter","cancel","secondaryCollection","returnSecondaryCollection"]},"createClaimDetailList":{"description":"List of claims to be created\n","type":"array","items":{"$ref":"#/components/schemas/createClaimDetails"}},"createClaimDetails":{"description":"Create claim object\n\nDescription:\n\n* discount: Contains information about discount as constant or percent\n* defaultCharge: Contains information on the default fee, either in a fixed amount or in percentages. Note that\n  the amount must be within the rules that apply according to Regulation 37/2009.\n* defaultInterest: Contains Information on how default interest is calculated. If claim should not have default interest, do not send in this object or send it in as “null”. \n* isOutOfSequencePaymentAllowed: Out of sequence payment allowed\n* isPartialPaymentAllowed: Partial payment is allowed\n","type":"object","required":["claimKey","payorId","templateCode","amount","finalDueDate","expirationDate"],"properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"payorId":{"$ref":"#/components/schemas/kennitala"},"expirationDate":{"type":"string","format":"date"},"templateCode":{"$ref":"#/components/schemas/templateCode"},"amount":{"type":"number","minimum":0},"reference":{"$ref":"#/components/schemas/reference"},"finalDueDate":{"type":"string","format":"date"},"billNumber":{"description":"7-character reference id set by claimant. This ID will be visible on the payer's account statement\n","type":"string","maxLength":7},"customerNumber":{"description":"16-character reference id set by claimant. Payer's transaction number. Unique key to the payer of the \nclaim with the creditor. Necessary if a direct payment agreement is to be established\n","type":"string","maxLength":16},"paymentFee":{"$ref":"#/components/schemas/paymentFee"},"otherCostsAmount":{"description":"Other costs, including determined fees paid by the payer of a collection claim.","type":"number","minimum":0},"otherDefaultCostsAmount":{"description":"Determined fees, e.g. intermediate collection fee.","type":"number","minimum":0},"defaultCharge":{"$ref":"#/components/schemas/defaultCharge"},"defaultInterest":{"$ref":"#/components/schemas/defaultInterest"},"discount":{"$ref":"#/components/schemas/discount"},"isOutOfSequencePaymentAllowed":{"description":"Payment rule, is it allowed to pay the last payment if previous has not been paid","type":"boolean"},"isPartialPaymentAllowed":{"type":"boolean"},"currency":{"type":"string","pattern":"[A-Z]{3}"},"additionalInformation":{"description":"Free text that will be displayed on the claim","type":"string","maxLength":200},"printing":{"$ref":"#/components/schemas/printing"},"claimType":{"$ref":"#/components/schemas/claimType"}}},"claimKey":{"description":"Claim key is a composite key of kennitala, account and due date.\n","type":"object","required":["claimantId","account","dueDate"],"properties":{"claimantId":{"$ref":"#/components/schemas/kennitala"},"account":{"$ref":"#/components/schemas/account"},"dueDate":{"$ref":"#/components/schemas/dueDate"}}},"kennitala":{"description":"Icelandic Id number (kennitala).\n","type":"string","pattern":"[0-9]{10}"},"account":{"description":"Bank number, ledger and number.\nFor claims ledger is 66 followed by claim number\n","type":"string","pattern":"[0-9]{12}"},"dueDate":{"description":"Due date","type":"string","format":"date"},"templateCode":{"description":"Claim template identifier.\n","type":"string","pattern":"[0-9A-Z]{3}"},"reference":{"description":"Reference number determined by creditors.\n","type":"string","maxLength":16},"paymentFee":{"description":"Additional fee that adds to the claim amount.\n","nullable":true,"type":"object","required":["printingFee","paperlessFee"],"properties":{"printingFee":{"description":"A fee that is applied if the claim is printed.","type":"number"},"paperlessFee":{"description":"A fee that is applied if the claim is paperless.\nThis fee applies to payors who have opted out of receiving printed letters and to direct debit claims.\n","type":"number"}}},"defaultCharge":{"description":"Default charges configuration.\nDefines day offsets from the reference date and whether each charge is percentage-based or a fixed amount.\nFor discounts, the amount is calculated from totalAmount.\nFor defaultCharge, the charge amount is calculated from claimAmount.\n","nullable":true,"type":"object","required":["referenceDate"],"properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}}},"referenceDate":{"description":"Specifies the reference date for calculations, allowing the choice between the DueDate and the FinalDueDate as the basis.\n","type":"string","enum":["DueDate","FinalDueDate"]},"dayAmountItem":{"description":"For whether to use fixed amount or calculate by percentage from claimAmount when calculating discount or charge.\n","type":"object","required":["chargeType","day","value"],"properties":{"chargeType":{"type":"string","enum":["Percentage","Amount"]},"day":{"type":"integer","minimum":0,"maximum":99},"value":{"type":"number"}}},"defaultInterest":{"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”. \n","nullable":true,"type":"object","required":["referenceDate"],"properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"baseAmountType":{"description":"Indicates the amount by which the penalty interest is calculated.\n- Amount: Penalty interest is calculated on the basis of the amount of the claim.\n- AmountAndDefaultCharge: Penalty interest is calculated on the basis of the amount \nand arrears of the claim.\n","type":"string","enum":["Amount","AmountAndDefaultCharge"]},"baseTimeType":{"description":"Indicates at what time the basis of penalty 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 \n  used (number of days / calendar days).\n","type":"string","enum":["Daily","360","Calendar"]},"percentage":{"description":"Indicates the percentage of default interest. If this parameter is not specified or is set to “0”, the \nCentral Bank's maximum penalty interest rate is used.\nPercentage range is between 0 - 100\n","type":"number"}}},"discount":{"description":"Contains detail information about claim discount\n","nullable":true,"type":"object","required":["referenceDate"],"properties":{"referenceDate":{"$ref":"#/components/schemas/referenceDate"},"first":{"$ref":"#/components/schemas/dayAmountItem"},"second":{"$ref":"#/components/schemas/dayAmountItem"}}},"printing":{"description":"Contains information if a collection claim is printed at a bank / savings bank to manage the\nprintout of the collection claim. Changing a printout to a change entry after printing a note\ndoes not result in it being reprinted\n","nullable":true,"type":"object","properties":{"payorAddress":{"$ref":"#/components/schemas/address"},"itemRows":{"type":"array","items":{"$ref":"#/components/schemas/itemRow"}},"comments":{"type":"array","items":{"type":"string"}}}},"address":{"description":"Address or legal address of a legal entity\n","type":"object","required":["name","addressLine","postalCode","city","country"],"properties":{"name":{"type":"string"},"addressLine":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"country":{"type":"string","pattern":"[A-Z]{2}"}}},"itemRow":{"description":"Contains information on the breakdown of the collection claim.\n","type":"object","properties":{"text":{"type":"string"},"amount":{"type":"number"}}},"claimType":{"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).\n","type":"string","enum":["NormalClaim","OptionalPaymentClaim","RefundClaim","BalanceClaim"]},"batchAlterInitiation":{"properties":{"actionType":{"$ref":"#/components/schemas/actionType"},"alterList":{"$ref":"#/components/schemas/alterClaimDetailsList"}}},"alterClaimDetailsList":{"description":"List of claims to be altered\n","type":"array","items":{"$ref":"#/components/schemas/alterClaimDetails"}},"alterClaimDetails":{"description":"Full replacement object for batch alter operations.\n\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.\n\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.\n","type":"object","required":["claimKey","templateCode","amount","finalDueDate","expirationDate"],"properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"expirationDate":{"type":"string","format":"date"},"templateCode":{"$ref":"#/components/schemas/templateCode"},"amount":{"type":"number","minimum":0},"reference":{"$ref":"#/components/schemas/reference"},"finalDueDate":{"type":"string","format":"date"},"billNumber":{"type":"string","maxLength":7},"customerNumber":{"type":"string","maxLength":16},"paymentFee":{"$ref":"#/components/schemas/paymentFee"},"otherCostsAmount":{"type":"number","minimum":0},"otherDefaultCostsAmount":{"type":"number","minimum":0},"defaultCharge":{"$ref":"#/components/schemas/defaultCharge"},"defaultInterest":{"$ref":"#/components/schemas/defaultInterest"},"discount":{"$ref":"#/components/schemas/discount"},"isOutOfSequencePaymentAllowed":{"type":"boolean"},"isPartialPaymentAllowed":{"type":"boolean"},"currency":{"type":"string","pattern":"[A-Z]{3}"},"additionalInformation":{"type":"string","maxLength":200},"claimStatus":{"$ref":"#/components/schemas/claimStatus"},"collectionStatus":{"$ref":"#/components/schemas/collectionStatus"},"printing":{"$ref":"#/components/schemas/printing"}}},"claimStatus":{"description":"Claim status","type":"string","enum":["Unpaid","Paid","Cancelled"]},"collectionStatus":{"description":"Claim billing process status","type":"string","enum":["PrimaryCollection","SecondaryCollection","LegalCollection"]},"batchCancelInitiation":{"properties":{"actionType":{"$ref":"#/components/schemas/actionType"},"cancelList":{"$ref":"#/components/schemas/cancelList"}}},"cancelList":{"description":"List of claims to be cancelled. Each array item is the composite claimKey\n(claimantId, account, dueDate). Only identification data is supplied.\n","type":"array","items":{"$ref":"#/components/schemas/claimKey"}},"batchSecondaryCollectionInitiation":{"properties":{"actionType":{"$ref":"#/components/schemas/actionType"},"secondaryCollectionList":{"$ref":"#/components/schemas/secondaryCollectionList"}}},"secondaryCollectionList":{"description":"List of items to move to secondary collection.\n","type":"array","items":{"$ref":"#/components/schemas/secondaryCollection"}},"secondaryCollection":{"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\n","type":"object","required":["claimKey"],"properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"templateCode":{"$ref":"#/components/schemas/templateCode"},"otherDefaultCostsAmount":{"description":"Additional other default costs to apply when moving to secondary collection.","type":"number"}}},"batchReturnSecondaryCollectionInitiation":{"properties":{"actionType":{"$ref":"#/components/schemas/actionType"},"secondaryCollectionList":{"$ref":"#/components/schemas/secondaryCollectionList"}}},"batchStatus":{"description":"Status of a batch initiation. success + failed + pending should equal the total number of submitted items.\n","properties":{"batchId":{"$ref":"#/components/schemas/batchId"},"success":{"type":"integer","description":"Number of successful items processed"},"failed":{"type":"integer","description":"Number of failed items"},"pending":{"type":"integer","description":"Number of waiting claims"},"actionType":{"$ref":"#/components/schemas/actionType"},"actions":{"$ref":"#/components/schemas/claimStatusResponse"}}},"batchId":{"description":"Batch identifier for a list of claims\n","type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","minLength":36,"maxLength":36},"claimStatusResponse":{"description":"Batch status object.\n","properties":{"successes":{"type":"array","items":{"$ref":"#/components/schemas/claimStatusSuccess"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/claimStatusError"}}}},"claimStatusSuccess":{"description":"Batch success status item.\n","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"claimId":{"$ref":"#/components/schemas/claimId"},"directPaymentClaim":{"type":"boolean"},"print":{"type":"boolean"}}},"claimId":{"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\n","type":"string"},"claimStatusError":{"description":"Batch error status item.\n","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"claimId":{"$ref":"#/components/schemas/claimId"},"resultCode":{"type":"string","enum":["CLAIM_EXISTS","CLAIM_IS_PAID","CLAIM_NOT_FOUND","CLAIM_IS_CANCELLED","CLAIM_NOT_IN_SECONDARY_STATE","CLAIM_OTHERS"]},"resultSubCode":{"type":"string"},"resultMessage":{"type":"string"}}},"Error400":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode400"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode400"}}}}}},"MessageCode400":{"description":"Message codes. HTTP Error code 400 (BAD_REQUEST).","type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED","SERVICE_INVALID","RESOURCE_UNKNOWN","RESOURCE_EXPIRED","RESOURCE_BLOCKED","TIMESTAMP_INVALID","PERIOD_INVALID","SCA_METHOD_UNKNOWN","SCA_INVALID","CONSENT_UNKNOWN","SESSIONS_NOT_SUPPORTED"]},"errorTitle":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"errorDetail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"Error401":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode401"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode401"}}}}}},"MessageCode401":{"description":"Message codes. HTTP Error code 401 (UNAUTHORIZED).","type":"string","enum":["CERTIFICATE_INVALID","ROLE_INVALID","CERTIFICATE_EXPIRED","CERTIFICATE_BLOCKED","CERTIFICATE_REVOKE","CERTIFICATE_MISSING","SIGNATURE_INVALID","SIGNATURE_MISSING","TOKEN_UNKNOWN","TOKEN_INVALID","TOKEN_EXPIRED"]},"Error403_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 403.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message403"}}}},"message403":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode403"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"messageCategory":{"description":"Category of the message category.","type":"string","enum":["ERROR","WARNING"]},"MessageCode403":{"description":"Message codes. HTTP Error code 403 (FORBIDDEN).","type":"string","enum":["CONSENT_UNKNOWN","SERVICE_BLOCKED","RESOURCE_UNKNOWN","RESOURCE_EXPIRED"]},"messageText":{"description":"Additional explaining text.","type":"string","maxLength":500},"Error403":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode403"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode403"}}}}}},"Error404_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 404.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message404"}}}},"message404":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode404"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"MessageCode404":{"description":"Message codes. HTTP Error code 404 (NOT FOUND).","type":"string","enum":["RESOURCE_UNKNOWN"]},"Error404":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode404"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode404"}}}}}},"Error405_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 405.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message405"}}}},"message405":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode405"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"MessageCode405":{"description":"Message codes. HTTP Error code 405 (METHOD NOT ALLOWED).","type":"string","enum":["SERVICE_INVALID"]},"Error405":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode405"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode405"}}}}}}},"responses":{"OK_20x_ActionResponse":{"description":"Batch created","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/batchStatus"}}}},"BAD_REQUEST_400":{"description":"Bad Request","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error400"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error400"}}}},"UNAUTHORIZED_401":{"description":"Unauthorized","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error401"}}}},"FORBIDDEN_403":{"description":"Forbidden","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error403_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error403"}}}},"NOT_FOUND_404":{"description":"Not found","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error404_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error404"}}}},"METHOD_NOT_ALLOWED_405":{"description":"Method Not Allowed","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error405_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error405"}}}},"REQUEST_TIMEOUT_408":{"description":"Request Timeout","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"UNSUPPORTED_MEDIA_TYPE_415":{"description":"Unsupported Media Type","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"INTERNAL_SERVER_ERROR_500":{"description":"Internal Server Error","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"SERVICE_UNAVAILABLE_503":{"description":"Service Unavailable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"type":"string","format":"uuid"}},"Location":{"description":"Location of the created resource.\n","schema":{"type":"string","format":"url"},"required":false}}},"paths":{"/api/v1/batches":{"post":{"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","operationId":"postBatch","tags":["Claim Service"],"parameters":[{"$ref":"#/components/parameters/X-Request-ID"},{"$ref":"#/components/parameters/X-Idempotency-Key"}],"requestBody":{"$ref":"#/components/requestBodies/batchInitiation"},"responses":{"201":{"$ref":"#/components/responses/OK_20x_ActionResponse"},"400":{"$ref":"#/components/responses/BAD_REQUEST_400"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401"},"403":{"$ref":"#/components/responses/FORBIDDEN_403"},"404":{"$ref":"#/components/responses/NOT_FOUND_404"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503"}}}}}}
```

## 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<br>

```json
{"openapi":"3.0.2","info":{"title":"IOBWS 3.0 Domestic Claims","version":"v3.2"},"tags":[{"name":"Claim Service","description":"Common Claim operations for icelandic banks"}],"servers":[{"url":"https://apigw.arionbanki.is/claims","description":"IOBWS 3.0 Claims API"}],"security":[{"oauth2":["openid","profile","b2b","claimscollection"]}],"components":{"securitySchemes":{},"parameters":{"batchId":{"name":"batchId","in":"path","required":true,"description":"Unique identifier for a batch of claims\n","schema":{"$ref":"#/components/schemas/batchId"}},"page":{"name":"page","in":"query","description":"Requested page","required":false,"schema":{"type":"integer","default":1}},"itemsPerPage":{"name":"itemsPerPage","in":"query","description":"Records per page","required":false,"schema":{"type":"integer","default":100}},"X-Request-ID":{"name":"X-Request-ID","in":"header","description":"Unique value generated by the client which the resource server uses to recognize subsequent \nretries of the same request.\n","required":true,"schema":{"type":"string","format":"uuid"}}},"schemas":{"batchId":{"description":"Batch identifier for a list of claims\n","type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","minLength":36,"maxLength":36},"batchStatus":{"description":"Status of a batch initiation. success + failed + pending should equal the total number of submitted items.\n","properties":{"batchId":{"$ref":"#/components/schemas/batchId"},"success":{"type":"integer","description":"Number of successful items processed"},"failed":{"type":"integer","description":"Number of failed items"},"pending":{"type":"integer","description":"Number of waiting claims"},"actionType":{"$ref":"#/components/schemas/actionType"},"actions":{"$ref":"#/components/schemas/claimStatusResponse"}}},"actionType":{"type":"string","enum":["create","alter","cancel","secondaryCollection","returnSecondaryCollection"]},"claimStatusResponse":{"description":"Batch status object.\n","properties":{"successes":{"type":"array","items":{"$ref":"#/components/schemas/claimStatusSuccess"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/claimStatusError"}}}},"claimStatusSuccess":{"description":"Batch success status item.\n","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"claimId":{"$ref":"#/components/schemas/claimId"},"directPaymentClaim":{"type":"boolean"},"print":{"type":"boolean"}}},"claimKey":{"description":"Claim key is a composite key of kennitala, account and due date.\n","type":"object","required":["claimantId","account","dueDate"],"properties":{"claimantId":{"$ref":"#/components/schemas/kennitala"},"account":{"$ref":"#/components/schemas/account"},"dueDate":{"$ref":"#/components/schemas/dueDate"}}},"kennitala":{"description":"Icelandic Id number (kennitala).\n","type":"string","pattern":"[0-9]{10}"},"account":{"description":"Bank number, ledger and number.\nFor claims ledger is 66 followed by claim number\n","type":"string","pattern":"[0-9]{12}"},"dueDate":{"description":"Due date","type":"string","format":"date"},"claimId":{"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\n","type":"string"},"claimStatusError":{"description":"Batch error status item.\n","properties":{"claimKey":{"$ref":"#/components/schemas/claimKey"},"claimId":{"$ref":"#/components/schemas/claimId"},"resultCode":{"type":"string","enum":["CLAIM_EXISTS","CLAIM_IS_PAID","CLAIM_NOT_FOUND","CLAIM_IS_CANCELLED","CLAIM_NOT_IN_SECONDARY_STATE","CLAIM_OTHERS"]},"resultSubCode":{"type":"string"},"resultMessage":{"type":"string"}}},"Error400":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode400"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode400"}}}}}},"MessageCode400":{"description":"Message codes. HTTP Error code 400 (BAD_REQUEST).","type":"string","enum":["FORMAT_ERROR","PARAMETER_NOT_CONSISTENT","PARAMETER_NOT_SUPPORTED","SERVICE_INVALID","RESOURCE_UNKNOWN","RESOURCE_EXPIRED","RESOURCE_BLOCKED","TIMESTAMP_INVALID","PERIOD_INVALID","SCA_METHOD_UNKNOWN","SCA_INVALID","CONSENT_UNKNOWN","SESSIONS_NOT_SUPPORTED"]},"errorTitle":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"errorDetail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"Error401":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode401"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode401"}}}}}},"MessageCode401":{"description":"Message codes. HTTP Error code 401 (UNAUTHORIZED).","type":"string","enum":["CERTIFICATE_INVALID","ROLE_INVALID","CERTIFICATE_EXPIRED","CERTIFICATE_BLOCKED","CERTIFICATE_REVOKE","CERTIFICATE_MISSING","SIGNATURE_INVALID","SIGNATURE_MISSING","TOKEN_UNKNOWN","TOKEN_INVALID","TOKEN_EXPIRED"]},"Error403_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 403.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message403"}}}},"message403":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode403"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"messageCategory":{"description":"Category of the message category.","type":"string","enum":["ERROR","WARNING"]},"MessageCode403":{"description":"Message codes. HTTP Error code 403 (FORBIDDEN).","type":"string","enum":["CONSENT_UNKNOWN","SERVICE_BLOCKED","RESOURCE_UNKNOWN","RESOURCE_EXPIRED"]},"messageText":{"description":"Additional explaining text.","type":"string","maxLength":500},"Error403":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode403"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode403"}}}}}},"Error404_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 404.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message404"}}}},"message404":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode404"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"MessageCode404":{"description":"Message codes. HTTP Error code 404 (NOT FOUND).","type":"string","enum":["RESOURCE_UNKNOWN"]},"Error404":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode404"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode404"}}}}}},"Error405_NG":{"description":"IOBWS specific definition of reporting error information in case of a HTTP error code 405.\n","type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/message405"}}}},"message405":{"type":"object","required":["category","code"],"properties":{"category":{"$ref":"#/components/schemas/messageCategory"},"code":{"$ref":"#/components/schemas/MessageCode405"},"path":{"type":"string"},"text":{"$ref":"#/components/schemas/messageText"}}},"MessageCode405":{"description":"Message codes. HTTP Error code 405 (METHOD NOT ALLOWED).","type":"string","enum":["SERVICE_INVALID"]},"Error405":{"description":"Standardised definition of reporting error information according to [RFC7807].\n","type":"object","required":["type","code"],"properties":{"type":{"description":"A URI reference [RFC3986] that identifies the problem type.\n","type":"string","format":"uri","maxLength":70},"title":{"description":"Short human readable description of error type.\nCould be in local language.\nTo be provided by ASPSPs.\n","type":"string","maxLength":70},"detail":{"description":"Detailed human readable text specific to this instance of the error.\nXPath 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.\n","type":"string","maxLength":500},"code":{"$ref":"#/components/schemas/MessageCode405"},"additionalErrors":{"description":"Array of Error Information Blocks.\n\nMight be used if more than one error is to be communicated\n","type":"array","items":{"description":"This is a data element to support the declaration of additional errors in the context of [RFC7807].","type":"object","required":["code"],"properties":{"title":{"$ref":"#/components/schemas/errorTitle"},"detail":{"$ref":"#/components/schemas/errorDetail"},"code":{"$ref":"#/components/schemas/MessageCode405"}}}}}}},"responses":{"OK_20x_ActionResponse":{"description":"Batch created","headers":{"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/batchStatus"}}}},"BAD_REQUEST_400":{"description":"Bad Request","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error400"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error400"}}}},"UNAUTHORIZED_401":{"description":"Unauthorized","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error401"}}}},"FORBIDDEN_403":{"description":"Forbidden","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error403_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error403"}}}},"NOT_FOUND_404":{"description":"Not found","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error404_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error404"}}}},"METHOD_NOT_ALLOWED_405":{"description":"Method Not Allowed","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error405_NG"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error405"}}}},"REQUEST_TIMEOUT_408":{"description":"Request Timeout","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"UNSUPPORTED_MEDIA_TYPE_415":{"description":"Unsupported Media Type","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"INTERNAL_SERVER_ERROR_500":{"description":"Internal Server Error","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}},"SERVICE_UNAVAILABLE_503":{"description":"Service Unavailable","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-ID"}}}},"headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","required":true,"schema":{"type":"string","format":"uuid"}},"Location":{"description":"Location of the created resource.\n","schema":{"type":"string","format":"url"},"required":false}}},"paths":{"/api/v1/batches/{batchId}":{"get":{"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\n","operationId":"getBatchStatus","tags":["Claim Service"],"parameters":[{"$ref":"#/components/parameters/batchId"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/itemsPerPage"},{"$ref":"#/components/parameters/X-Request-ID"}],"responses":{"200":{"$ref":"#/components/responses/OK_20x_ActionResponse"},"400":{"$ref":"#/components/responses/BAD_REQUEST_400"},"401":{"$ref":"#/components/responses/UNAUTHORIZED_401"},"403":{"$ref":"#/components/responses/FORBIDDEN_403"},"404":{"$ref":"#/components/responses/NOT_FOUND_404"},"405":{"$ref":"#/components/responses/METHOD_NOT_ALLOWED_405"},"408":{"$ref":"#/components/responses/REQUEST_TIMEOUT_408"},"415":{"$ref":"#/components/responses/UNSUPPORTED_MEDIA_TYPE_415"},"500":{"$ref":"#/components/responses/INTERNAL_SERVER_ERROR_500"},"503":{"$ref":"#/components/responses/SERVICE_UNAVAILABLE_503"}}}}}}
```