--- title: "Accept claim" method: POST path: "/claims/{id}/accept" tags: ["Claims"] --- # Accept claim `POST /claims/{id}/accept` Accept a claim that has been received. This will update the claim status to `accepted`. ## Path parameters - `id` string, uuid, required ## Request body - ClaimAcceptDetails — Request body for accepting a claim. - `option` 'ACVA' | 'MODI' — The option for accepting the claim. Only used for `sepa_value_date_correction` claims. - `ACVA`: Accept value date correction - `MODI`: Modify value date correction - `value_date` string, date — Applicable value date of the payment. Automatically set to the payment's initial value_date if not filled. Only used for `sepa_non_receipt` claims. ## Response `200` Successfully accepted claim. - ClaimDetails - `id` string, uuid, required — The UUID of the claim. - `object` 'claim', required — Label used to identify this kind of object - `type` 'sepa_non_receipt' | 'sepa_value_date_correction', required — The type of the claim - `status` 'created' | 'processing' | 'sent' | 'received' | 'accepted' | 'rejected', required — The status of the claim. - `status_details` string, required — The details of the status of the claim. - `value_date` string, date, required — The value date of the claim. - `connected_account_id` string, uuid, required — The ID of the connected account. - `related_payment_type` 'payment_order' | 'incoming_payment', required — The type of the payment related to the return, either `incoming_payment` or `payment_order`. - `related_payment_id` string, required — The ID of the payment on which the claim applies. - `related_payment` ClaimRelatedPayment, required — The related payment details. - `amount` integer, required — The amount of the related payment. - `currency` 'EUR', required — The three-letter ISO 4217 currency code, in lowercase. Only `EUR` is supported for now. - `direction` string, required — The direction of the related payment. - `value_date` string, date, required — The value date of the related payment. - `reference` string, required — The reference of the related payment. - `structured_reference` object[] — Structured reference data - `creditor_reference_information` ClaimCreditorReferenceInformation — Reference information provided by the creditor to allow the identification of the underlying documents. - `type` ClaimCreditorReferenceType — Specifies the type of creditor reference. - `code` 'dispatch_advice' | 'foreign_exchange_deal_reference' | 'purchase_order' | 'related_payment_instruction' | 'remittance_advice_message' | 'structured_communication_reference' | 'other' — Type of creditor reference. - `issuer` string — Entity that assigns the credit reference type. - `reference` string — Unique and unambiguous identification of the referred document. - `referred_document_information` ClaimReferredDocumentInformation[] - `type` ClaimReferredDocumentType — Specifies the type of referred document. - `code` 'commercial_invoice' | 'credit_note_related_to_financial_adjustment' | 'contract' | 'credit_note' | 'debit_note' | 'dispatch_advice' | 'debit_note_related_to_financial_adjustment' | 'hire_invoice' | 'invoice_signed' | 'metered_service_invoice' | 'proforma_invoice' | 'purchase_order' | 'quotation' | 'self_billed_invoice' | 'seller_presentment' | 'time_sheet' | 'usage_report' | 'account_receivable_open_item' | 'bill_of_lading' | 'commercial_contract' | 'statement_of_account' | 'trade_services_utility_transaction' | 'voucher' | 'other' — Type of referred document. - `issuer` string — Identification of the issuer of the reference document type. - `number` string — Unique and unambiguous identification of the referred document. - `related_date` string, date — Date associated with the referred document. - `invoicer` object — Identification of the organisation issuing the invoice. - `name` string — Name by which a party is known and which is usually used to identify that party. - `invoicee` object — Identification of the party to whom an invoice is issued. - `name` string — Name by which a party is known and which is usually used to identify that party. - `additional_remittance_info` string[] — Additional information, in free text form, to complement the structured remittance information. - `originating_account` ClaimRelatedAccountInfo, required - `account_number` string, required — The account number. - `bank_code` string, required — The bank code. - `holder_name` string, required — The name of the account holder. - `holder_address` CommonAddress, required — The address of the account holder, as an address object. - `line_1` string — Line 1. - `line_2` string — Line 2. - `building_number` string — Building number. - `street_name` string — Street name. - `postal_code` string — Postal / zip code. - `region_state` string — Region or state. - `city` string — City. - `country` string — ISO 3166 alpha-2 country code. - `department` string, nullable — Department name or code. - `sub_department` string, nullable — Sub-department name. - `building_name` string, nullable — Name of the building. - `floor` string, nullable — Floor number or identifier. - `postal_box` string, nullable — Postal box. - `room` string, nullable — Room number. - `city_location_name` string, nullable — Specific city location or landmark. - `district_name` string, nullable — District name or administrative region. - `receiving_account` ClaimRelatedAccountInfo, required - `account_number` string, required — The account number. - `bank_code` string, required — The bank code. - `holder_name` string, required — The name of the account holder. - `holder_address` CommonAddress, required — The address of the account holder, as an address object. - `line_1` string — Line 1. - `line_2` string — Line 2. - `building_number` string — Building number. - `street_name` string — Street name. - `postal_code` string — Postal / zip code. - `region_state` string — Region or state. - `city` string — City. - `country` string — ISO 3166 alpha-2 country code. - `department` string, nullable — Department name or code. - `sub_department` string, nullable — Sub-department name. - `building_name` string, nullable — Name of the building. - `floor` string, nullable — Floor number or identifier. - `postal_box` string, nullable — Postal box. - `room` string, nullable — Room number. - `city_location_name` string, nullable — Specific city location or landmark. - `district_name` string, nullable — District name or administrative region. - `bank_data` ClaimRelatedPaymentBankData - `message_id` string, required — The message ID of the related payment. - `end_to_end_id` string, required — The end-to-end ID of the related payment. - `transaction_id` string, required — The transaction ID of the related payment. - `description` string, required — Claim instructions for the receiving financial institution. - `metadata` object, required — Additional client data in JSON format. See [Metadata](https://docs.numeral.io/reference/metadata). - `investigation_fee` object — Investigation fee details, if provided by the scheme/bank. - `amount` integer — Fee amount in minor units. - `currency` string — ISO 4217 currency. - `account_number` string — Account number to which the fee should be paid. - `bank_code` string — Bank identifier code associated with the fee account. - `compensation_fee` object — Compensation fee details, if provided by the scheme/bank. - `amount` integer — Fee amount in minor units. - `currency` string — ISO 4217 currency. - `account_number` string — Account number to which the fee should be paid. - `bank_code` string — Bank identifier code associated with the fee account. - `bank_data` object, required — Bank data, such as assignment id and file IDs, in JSON format. - `reference` string, required - `assignment_id` string, required - `case_id` string, required - `file_id` string, required - `file_reference` string — The reference of the file containing the claim. - `created_at` string, date-time, required — The UTC timestamp of the creation of the claim. ## Other responses - `400` — Validation error. - `404` — The specified resource was not found. - `409` — Conflict. - `415` — Unsupported Media Type. - `500` — Internal server error. --- [API](https://skmtc.net/numeral/apis/payments.md) · [All operations](https://skmtc.net/numeral/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/numeral/payments/revisions/220f101cc2ef/schema)