---
title: "Create expected payment"
method: POST
path: "/expected_payments"
tags: ["Expected Payments"]
---

# Create expected payment

`POST /expected_payments`

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

## Headers

- `Idempotency-Key` string

## Request body

- ExpectedPaymentCreationDetails
  - `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_from` integer, 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_to` integer, 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`.
  - `currency` string, required — The ISO 4217 currency code of the expected payment.
  - `start_date` string, date, required — The earliest date the payment is expected.
  - `end_date` string, date, required — The latest date the payment is expected.
  - `counterparty_account_id` string, uuid — The ID of the `counterparty_account`. It must be left empty if `counterparty_account` parameter is filled.
  - `external_account_id` string, uuid — The ID of the `external_account`. It must be left empty if `external_account` parameter is filled.
  - `counterparty_account` ExpectedPaymentCounterpartyAccount — The account of the counterparty, which is either the debtor or the creditor depending on the payment's direction. It must be left empty if `counterparty_account_id` parameter is filled.
    - `account_number` string — The account number of the counterparty.
    - `holder_name` string — The name of the counterparty.
  - `external_account` ExpectedPaymentExternalAccount — The external account, which is either the debtor or the creditor depending on the payment's direction. It must be left empty if `external_account_id` parameter is filled.
    - `account_number` string — The number of the external account.
    - `holder_name` string — The name of the external account holder.
  - `virtual_account_id` string, uuid — The ID of the `virtual_account`. It must be left empty if `virtual_account` parameter is filled.
  - `internal_account_id` string, 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.
  - `virtual_account` ExpectedPaymentCreationDetailsVirtualAccount — The virtual account that the payment is expected to credit or debit. It must be left empty if `virtual_account_id` parameter is filled.
    - `virtual_account_number` string, required — The virtual account number.
    - `name` string — The name of the virtual account.
  - `internal_account` ExpectedPaymentCreationDetailsInternalAccount — The internal account of type `virtual` that the payment is expected to credit or debit. It must be left empty if `internal_account_id` parameter is filled.
    - `account_number` string, required — The account number of the internal account.
  - `connected_account_id` string, uuid, required — The ID of the connected account.
  - `metadata` object — Additional client data in JSON format. See [Metadata](https://docs.numeral.io/reference/metadata).
  - `custom_fields` CommonCustomFields — Custom fields in JSON `key:value` format. See [Custom fields](https://docs.numeral.io/reference/custom-fields).
  - `descriptions` string[] — Descriptions of the expected payment

## Response `200`

200

- ExpectedPaymentDetails
  - `id` string, uuid, required
  - `idempotency_key` string — 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_from` integer, required
  - `amount_to` integer, required
  - `currency` string, required
  - `start_date` string, date
  - `end_date` string, date
  - `connected_account_id` string, uuid
  - `counterparty_account_id` string, uuid — The UUID of the counterparty account.
  - `counterparty_account` ExpectedPaymentCounterpartyAccount, required — The account of the counterparty, which is either the debtor or the creditor depending on the payment's direction. It must be left empty if `counterparty_account_id` parameter is filled.
    - `account_number` string — The account number of the counterparty.
    - `holder_name` string — The name of the counterparty.
  - `virtual_account_id` string, uuid — The UUID of the virtual account.
  - `virtual_account` CommonVirtualAccount, required
    - `virtual_account_number` string, required — The virtual account number.
    - `name` string — The name of the virtual account.
  - `external_account_id` string, uuid — The UUID of the external account.
  - `external_account` ExpectedPaymentExternalAccount — The external account, which is either the debtor or the creditor depending on the payment's direction. It must be left empty if `external_account_id` parameter is filled.
    - `account_number` string — The number of the external account.
    - `holder_name` string — The name of the external account holder.
  - `internal_account_id` string, uuid — The UUID of the internal virtual account that the payment is expected to credit or debit.
  - `internal_account` ExpectedPaymentInternalAccount — The internal account, type 'virtual', that the payment is expected to credit or debit. It must be left empty if `internal_account_id` parameter is filled.
    - `account_number` string — The number of the internal account.
    - `name` string — The name of the internal account.
    - `type` string — The type of the internal account.
  - `reconciliation_status` 'unreconciled' | 'partially_reconciled' | 'reconciled' | 'excluded', required
  - `reconciled_amount` integer, required
  - `metadata` object, required — Additional client data in JSON format. See [Metadata](https://docs.numeral.io/reference/metadata).
  - `custom_fields` CommonCustomFields, required — Custom fields in JSON `key:value` format. See [Custom fields](https://docs.numeral.io/reference/custom-fields).
  - `descriptions` string[], required — Descriptions of the expected payment
  - `virtual_account_number` string
  - `created_at` string, date-time, required
  - `canceled_at` string, date-time, nullable, required

## Other responses

- `400` — 400
- `415` — Unsupported Media Type.

---

[API](https://skmtc.net/numeral/apis/payments.md) · [All operations](https://skmtc.net/numeral/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/numeral/payments/versions/220f101cc2ef/schema)