Claim object

Claims refer to formal requests between financial institutions to resolve payment issues. They specifically include a Claim Non-Receipt to address missing funds not credited as expected and a Claim for Value-Date Correction to correct the date on which funds were or should have been credited. This feature is only available to financial institution customers.

Attribute	Description
id string	The claim ID.
object string	Always `claim`.
type string	Either `sepa_non_receipt` or `sepa_value_date_correction`.
status string	The status of the claim. See Claim lifecycle for a comprehensive list of claim statuses.
status_details string	Additional information related to the claim. For instance, the message sent by the originating bank.
reason string	The reason code behind the acceptance/rejection of the claim.
value_date date	The claim’s value date.
connected_account_id string	The ID of the connected account on which the claim has been received or sent.
related_payment_type string	Either `payment_order` for outbound claims or `incoming_payment` for inbound claims.
related_payment_id string	The UUID of the related payment order or incoming payment, if found.
related_payment object	The raw content of the payment, when Numeral cannot find the related payment among payment orders or incoming payments. If filled, it could contain the following sub-properties: - `amount`: amount of the underlying payment - `currency`: currency of the payment - `direction`: always “credit” - `value_date`: value date of the payment - `reference`: reference of the payment - `originating_account`: originating account object - `receiving_account`: receiving account object - `bank_data`: technical bank identifiers of the payment
metadata object	Additional data in JSON `key:value` format. See Metadata.
bank_data object	Bank data, such as message and transaction IDs, in JSON key:value format.
created_at datetime	The UTC timestamp of the creation of the claim.

Below is an example of a claim:

{
    "id": "d8780109-3e1b-5132-b0fe-7e2adeca90b8",
    "object": "claim",
    "type": "sepa_non_receipt",
    "status": "received",
    "status_details": "We have been advised that the beneficiary did not receive payment",
    "reason": null,
    "value_date": "2024-12-18",
    "connected_account_id": "f32ca0d3-0d86-4398-820f-ce2183dd414c",
    "related_payment_type": "incoming_payment",
    "related_payment_id": "9b375315-8181-5714-9906-3817add93853",
    "related_payment": null,
    "metadata": {},
    "bank_data": {
        "assignment_id": "5743264673463473467324",
        "case_id": "SE362734732463",
        "file_id": "a4989a6d-01bf-5baf-a0b2-532953c35ed7"
    },
    "created_at": "2024-12-18T15:04:37.604046Z"
}