Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
Expected Payments

Create expected payment

Create an expected payment, that can be used for reconciliation purposes.

post/expected_payments

Headers

Idempotency-Keystring
Example:8A2gcC

An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request.

Request body

direction'debit' | 'credit' required

The direction of the expected payment. Direction is credit when one expects to receive money and debit when one expects to send money.

amount_frominteger required

The lowest amount to be expected for the payment, in the specified currency's smallest unit. For euro payments, the smallest unit is cents. €20 is represented as 2000.

amount_tointeger required

The highest amount to be expected for the payment, in the specified currency's smallest unit. For euro payments, the smallest unit is cents. €20 is represented as 2000.

currencystring required

The ISO 4217 currency code of the expected payment.

start_datestring date required

The earliest date the payment is expected.

end_datestring date required

The latest date the payment is expected.

counterparty_account_idstring uuid

The ID of the counterparty_account. It must be left empty if counterparty_account parameter is filled.

external_account_idstring uuid

The ID of the external_account. It must be left empty if external_account parameter is filled.

virtual_account_idstring uuid

The ID of the virtual_account. It must be left empty if virtual_account parameter is filled.

internal_account_idstring uuid

The ID of the internal virtual account that the payment is expected to credit or debit. It must be left empty if internal_account parameter is filled.

connected_account_idstring uuid required

The ID of the connected account.

metadataobject

Additional client data in JSON format. See Metadata.

custom_fieldsCommonCustomFields

Custom fields in JSON key:value format. See Custom fields.

descriptionsstring[]

Descriptions of the expected payment

Example request

{
  "direction": "credit",
  "amount_from": 2500,
  "amount_to": 2700,
  "currency": "EUR",
  "start_date": "2022-09-29",
  "end_date": "2022-10-02",
  "counterparty_account_id": "b38f5318-a389-4278-9cbe-d16116750982",
  "external_account_id": "24e3157c-4942-11ed-b878-0242ac120002",
  "counterparty_account": {
    "account_number": "FR7601234567890627967100010",
    "holder_name": "PartnerCo"
  },
  "external_account": {
    "account_number": "FR7601234567890627967100010",
    "holder_name": "PartnerCo"
  },
  "connected_account_id": "24e3157c-4942-11ed-b878-0242ac120002",
  "metadata": {
    "property_a": true,
    "property_b": "some label"
  }
}

Response

200

idstring uuid required
idempotency_keystring

An idempotency key is a unique value sent by the client, which the server uses to recognize subsequent retries of the same request.

object'expected_payment' required
direction'credit' | 'debit' required
amount_frominteger required
amount_tointeger required
currencystring required
start_datestring date
end_datestring date
connected_account_idstring uuid
counterparty_account_idstring uuid

The UUID of the counterparty account.

virtual_account_idstring uuid

The UUID of the virtual account.

external_account_idstring uuid

The UUID of the external account.

internal_account_idstring uuid

The UUID of the internal virtual account that the payment is expected to credit or debit.

reconciliation_status'unreconciled' | 'partially_reconciled' | 'reconciled' | 'excluded' required
reconciled_amountinteger required
metadataobject required

Additional client data in JSON format. See Metadata.

custom_fieldsCommonCustomFields required

Custom fields in JSON key:value format. See Custom fields.

descriptionsstring[] required

Descriptions of the expected payment

virtual_account_numberstring
created_atstring date-time required
canceled_atstring date-time nullable required

Example response

{
  "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"
}