Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
Claims

List claims

List and filter claims.

get/claims

Query parameters

limitinteger
starting_afterstring

The ID of the object from which your list request will start. It is not included in the result.

sort_order'asc' | 'desc'

Order is based on attribute created_at. If asc, results are fetched in chronological order. If desc, results are fetched in reversed chronological order. Default order is desc.

start_datestring date

The creation date of the claim.

end_datestring date

The creation date of the claim.

start_value_datestring date

The value date of the claim.

end_value_datestring date

The value date of the claim.

type'sepa_value_date_correction' | 'sepa_non_receipt'

The type of the claim.

connected_account_idstring

The ID of the connected account used to send or receive the claim.

related_payment_type'payment_order' | 'incoming_payment'

The payment type on which the claim applies, either incoming_payment or payment_order.

related_payment_idstring

The ID of the payment (payment order or incoming payment) on which the claim applies.

originating_account_numberstring

The account number of the entity having sent the claim.

receiving_account_numberstring

The account number of the entity having received the claim.

status'created' | 'processing' | 'sent' | 'received' | 'accepted' | 'rejected'

The status of the claim.

file_idstring

The ID of the file including the claim.

Response

List of filtered claims.

Example response

{
  "records": [
    {
      "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"
    }
  ]
}