v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB

Expected Payments

Cancel expected payment

Cancel an expected payment. Only unreconciled expected payments can be canceled. To cancel an expected payment which is already part of a reconciliation, cancel the related reconciliations beforehand.

post/expected_payments/{id}/cancel

Path parameters

idstring uuid required

Example:2086dfa8-2640-43ff-9144-e73bab721832

The ID of the expected payment.

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