Skip to main content

Claim (refund request)

A Claim is a request to Meetch to reimburse a customer for covered loss or policy event in accordance with the contract.

idstring

Issue identifier

Example: iss_1234abc
subscription_referencestring

Unique reference of the subscription

Example: 11223344
order_referencestring

Subscription's order reference - made on the vendor side

Example: ORD_123ABC
reason_keystring

Claim's reason

Possible values: <= 30 characters

Example: professional, tickets-theft, insured-corporal-accident
reason_categorystring

Claim's reason category

Possible values: <= 30 characters

Example: cancellation
commentstring

Claim's comment by the customer

Possible values: <= 255 characters

statusstring

Possible values: [draft, open, refund, refund_repeal, uncomplete, refused, closed]

status_formattedstring

Localized status label.

Example: Refunded
created_atdatetime

Creation date of the claim.

issue_datedatetime

Date of the declared issue.

processed_atdatetime

Processing date by an operator. The claim can be marked as accepted or refused.

requested_amountfloat

Amount requested by the customer

refund_amountfloat

Amount refunded

currencycurrency

Subscription currency

Possible values: <= 3 characters

target_currencycurrency

Payment mode currency. If different from the subscription currency.

Possible values: <= 3 characters

refusal_reasonstring

Refusal reason, in case the claim is refused by an operator

payment_mode_idstring

Identifier of the payment mode in order to refund

payment_mode_methodstring

Associated payment method name

refund_mode_selectedstring

Depending of the insurance contract, it can a full refund, 70% refund or a repeal.

Possible values: [70, 100, repeal]

additional_dataobject

You can use this parameter to attach any key-value data.

Claim (refund request)
{
"id": "iss_1234abc",
"subscription_reference": 11223344,
"order_reference": "ORD_123ABC",
"reason_key": "professional, tickets-theft, insured-corporal-accident",
"reason_category": "cancellation",
"comment": "string",
"status": "draft",
"status_formatted": "Refunded",
"created_at": "string",
"issue_date": "string",
"processed_at": "string",
"requested_amount": 0,
"refund_amount": 0,
"currency": "string",
"target_currency": "string",
"refusal_reason": "string",
"payment_mode_id": "string",
"payment_mode_method": "string",
"refund_mode_selected": 70,
"additional_data": {}
}