v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB

Claims

Retrieve claim

Retrieve the details of a claim.

get/claims/{id}

Path parameters

idstring uuid required

The ID of the claim.

Response

Successfully retrieved claim.

idstring 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

The status of the claim.

status_detailsstring required

The details of the status of the claim.

value_datestring date required

The value date of the claim.

connected_account_idstring 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_idstring required

The ID of the payment on which the claim applies.

descriptionstring required

Claim instructions for the receiving financial institution.

metadataobject required

Additional client data in JSON format. See Metadata.

created_atstring date-time required

The UTC timestamp of the creation of the claim.

Example response

{
  "object": "claim",
  "status": "received",
  "value_date": "2024-01-03",
  "related_payment": {
    "structured_reference": [
      {
        "creditor_reference_information": {
          "type": {
            "code": "dispatch_advice",
            "issuer": "Issuer"
          },
          "reference": "RF18539007547034"
        },
        "referred_document_information": [
          {
            "type": {
              "code": "commercial_invoice",
              "issuer": "Issuer"
            },
            "number": "ABC-13679",
            "related_date": "2024-03-15"
          }
        ],
        "invoicer": {
          "name": "Invoicer name"
        },
        "invoicee": {
          "name": "Invoicee name"
        },
        "additional_remittance_info": [
          "Payment for invoice INV-2024-001"
        ]
      }
    ],
    "originating_account": {
      "holder_address": {
        "line_1": "1, place de la Concorde",
        "building_number": "1",
        "street_name": "place de la Concorde",
        "postal_code": "75008",
        "city": "Paris",
        "country": "FR",
        "department": "Marketing",
        "sub_department": "Content team",
        "building_name": "Bat. 4",
        "floor": "3",
        "postal_box": "67b",
        "room": "47",
        "city_location_name": "Confluences",
        "district_name": "District 9"
      }
    },
    "receiving_account": {
      "holder_address": {
        "line_1": "1, place de la Concorde",
        "building_number": "1",
        "street_name": "place de la Concorde",
        "postal_code": "75008",
        "city": "Paris",
        "country": "FR",
        "department": "Marketing",
        "sub_department": "Content team",
        "building_name": "Bat. 4",
        "floor": "3",
        "postal_box": "67b",
        "room": "47",
        "city_location_name": "Confluences",
        "district_name": "District 9"
      }
    }
  },
  "metadata": {
    "property_a": true,
    "property_b": "false"
  },
  "investigation_fee": {
    "amount": 150000,
    "currency": "EUR"
  },
  "compensation_fee": {
    "amount": 250000,
    "currency": "EUR"
  },
  "bank_data": {
    "reference": "WfVCPfBzPjfEyO4CLpPDrjjYGSGXt0",
    "assignment_id": "oRiB7XRvqlfB6yGEikSFeBeCVkyo7h",
    "case_id": "AFpCILqubWQ5YLWePG5bYpw",
    "file_id": "a815e756-5576-4d40-9fbd-38ec304b856c",
    "file_reference": "FILE_REF_12345"
  },
  "created_at": "2024-01-03T11:53:19.734182Z"
}