v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB

Reconciliations

List reconciliations

List and filter reconciliations.

get/reconciliations

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.

transaction_idstring

The ID of the transaction. All the reconciliations related to this transaction will be fetched.

payment_idstring

The ID of the payment. All the reconciliations related to this payment will be fetched.

payment_type'payment_order' | 'incoming_payment' | 'return' | 'expected_payment' | 'payment_capture'

The type of the payment.

match_type'manual' | 'auto'

The type of the reconciliation.

start_datestring date

The creation date of the reconciliation.

end_datestring date

The creation date of the reconciliation.

canceledboolean

If true, only canceled reconciliations will be fetched.

Response

200

idstring

objectstring

amountinteger

match_typestring

created_atstring

{"stackTrail":"paths:/reconciliations:get:responses:200:content:application/json:schema:properties:canceled_at","oasType":"schema","type":"unknown"}

Example response

{
  "id": "cbe093aa-339f-498f-b08a-9fc11593b755",
  "object": "reconciliation",
  "amount": 2000,
  "match_type": "auto",
  "created_at": "2022-01-03",
  "transaction": {
    "id": "ac2925f7e06944b",
    "object": "reconciliation",
    "amount": 2000,
    "match_type": "manual",
    "created_at": "2022-19-01",
    "transaction": {
      "id": "f902cace-8a56-11ec-a8a3-0242ac120002",
      "object": "transaction",
      "connected_account_id": "ff1714ae-3ec8-450d-984c-c6ee44c82a88",
      "booking_date": "2021-01-01",
      "value_date": "2021-01-02",
      "direction": "credit",
      "category": "credit_transfer",
      "amount": 2000,
      "currency": "EUR",
      "description": "MyCompany Invoice 5678",
      "counterparty_account_details": {
        "account_number": "FR5412739000504811631858C47",
        "holder_name": "Jane Doe"
      },
      "virtual_account_number": "FR4714508000301359366727T71",
      "metadata": {
        "property_a": true,
        "property_b": "some label"
      },
      "reconciled_amount": 2000,
      "reconciliation_status": "reconciled",
      "created_at": "2021-01-01T00:11:07Z",
      "updated_at": "2021-19-01T00:11:07Z"
    }
  },
  "payment": {
    "id": "b69837bf-e784-4bd1-b0d0-2ad0e61a89b6",
    "object": "payment_order",
    "connected_account_id": "254e3100-afd6-44f2-8084-87e8ae67b554",
    "type": "sepa",
    "direction": "credit",
    "amount": 2000,
    "currency": "EUR",
    "purpose": "Invoice 1234",
    "originating_account": {
      "account_number": "FR7601234567890627967100010",
      "bank_code": "SOGEFRPP",
      "holder_name": "SoftwareCo",
      "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"
      }
    },
    "receiving_account": {
      "account_number": "FR7601234567891127967100082",
      "bank_code": "BNPAFRPPXXX",
      "holder_name": "PartnerCo",
      "holder_address": {
        "line_1": "1, rue de la Bourse",
        "building_number": "1",
        "street_name": "rue de la Bourse",
        "postal_code": "59000",
        "city": "Lille",
        "country": "FR"
      }
    },
    "value_date": "2022-01-03",
    "status": "executed",
    "reconciled_amount": 2000,
    "reconciliation_status": "reconciled",
    "metadata": {
      "property_a": true,
      "property_b": "some label"
    },
    "bank_data": {
      "file_id": "a815e756-5576-4d40-9fbd-38ec304b856c",
      "message_id": "1gXrtKMxLJ",
      "transaction_id": "1zDrzOMxCJ",
      "end_to_end_id": "c3b2d737bc"
    },
    "created_at": "2022-01-03T11:53:19.734182Z",
    "updated_at": "2022-01-03T15:12:20.644356Z"
  }
}