Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
Expected Payments

List expected payments

List and filter expected payments.

get/expected_payments

Query parameters

limitinteger
starting_afterstring uuid

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 expected payment.

end_datestring date

The creation date of the expected payment.

start_expected_datestring date

The expected date of the expected payment.

end_expected_datestring date

The expected date of the expected payment.

direction'credit' | 'debit'

The direction of the expected payment.

amount_frominteger

The amount of the expected payment.

amount_tointeger

The amount of the expected payment.

currencystring

The currency of the payment.

canceledboolean

If true, only canceled expected payments will be fetched.

connected_account_idstring uuid

The ID of the connected account related to the expected payment.

counterparty_account_numberstring

The account number of the counterparty, which can be the IBAN or any other identification provided by the bank.

external_account_numberstring

The external account number, which can be the IBAN or any other identification provided by the bank.

counterparty_holder_namestring

The name of the counterparty.

external_account_holder_namestring

The name of the external account holder.

descriptionstring

The description of the expected_payment.

virtual_account_numberstring

The number of the virtual account linked to the expected payment.

internal_account_numberstring

The number of the internal account of type virtual linked to the expected payment.

reconciliation_status'unreconciled' | 'partially_reconciled' | 'reconciled' | 'excluded'

The reconciliation status of the expected payment.

counterparty_idstring uuid

The ID of the counterparty of the expected payment.

external_account_holder_idstring uuid

The ID of the external account holder.

counterparty_account_idstring uuid

The ID of the counterparty account of the expected payment.

external_account_idstring uuid

The ID of the external account.

idempotency_keystring

Response

200

Example response

{
  "records": [
    {
      "id": "2086dfa8-2640-43ff-9144-e73bab721832",
      "idempotency_key": "8A2gcC",
      "object": "expected_payment",
      "direction": "credit",
      "amount_from": 2000,
      "amount_to": 3000,
      "currency": "EUR",
      "start_date": "2022-01-05",
      "end_date": "2022-01-05",
      "connected_account_id": "254e3100-afd6-44f2-8084-87e8ae67b554",
      "counterparty_account": {
        "account_number": "FR7601234567890627967100010",
        "holder_name": "PartnerCo"
      },
      "external_account": {
        "account_number": "FR7601234567890627967100010",
        "holder_name": "PartnerCo"
      },
      "internal_account": {
        "account_number": "FR8414508000704858926265I89",
        "name": "Expenses account",
        "type": "virtual"
      },
      "reconciliation_status": "reconciled",
      "reconciled_amount": 2000,
      "metadata": {
        "property_a": true,
        "property_b": "some label"
      },
      "virtual_account_number": "FR4217569000705838477329D20",
      "created_at": "2022-01-03T11:53:19.734182Z",
      "canceled_at": "2022-01-03T15:12:20.644356Z"
    }
  ]
}