The expected payment object

An expected payment is a payment that you expect to be credited or debited on your connected account.

While a payment order is initiated through Numeral, an expected payment is a payment that is not initiated through Numeral, but that you nonetheless want to track and reconcile with a transaction.

An expected payment is typically a payment expected from a customer or a payment service provider.

AttributeDescription
id
string
The UUID of the expected payment.
object
string
The object, here expected_payment.
connected_account
string
The ID of the connected account related to the payment.
direction
string
Either credit or debit.

Direction is credit when you expect to receive money, while it is debit when you expect to send money.
amount_from
integer
The absolute value of the payment in the specified currency's smallest unit.

If the amount of the payment is uncertain, you can specified the lowest amount you could expect in amount_from.

If the exact amount of the payment is known with certainty, the same amount can be specified in amount_from and amount_to.
amount_to
integer
The absolute value of the payment in the specified currency's smallest unit.

If the amount of the payment is uncertain, you can specified the highest amount you could expect in amount_to.

If the exact amount of the payment is known with certainty, the same amount can be specified in amount_from and amount_to.
currency
string
The currency of the payment.
start_date
date
The expected date of the payment.

If the date of the payment is uncertain, you can specified the earliest date in start_date.

If the exact date of the payment is known with certainty, the same date can be specified in start_date and end_date.
end_date
date
The expected date of the payment.

If the date of the payment is uncertain, you can specified the earliest date in start_date.

If the exact date of the payment is known with certainty, the same date can be specified in start_date and end_date.
counterparty_account_details
object
The account of the counterparty, which is either the debitor or the creditor depending on the payment's direction.\n\nThe object includes the following attributes:
  • account_number: the account number of the counterparty, which can be the IBAN or any other identification provided by the bank
  • holder_name: the name of the counterparty
description
string
The description of the expected_payment.
metadata
object
Additional data in JSON key:value format. See Metadata.
reconciliation_status
string
The reconciliation status of the transaction, which is either unreconciled, reconciled, or partially_reconciled.
reconciled_amount
integer
The amount of the expected payment that is already reconciled.

It is the sum of the amount of the reconciliations related to this expected payment.
canceled_at
datetime
The UTC timestamp of the cancellation of this expected payment. canceled_at is null if the expected payment was not canceled.
created_at
datetime
The UTC timestamp of the creation of the expected payment.
updated_at
datetime
The UTC timestamp of the last update of the expected payment.

Below is an example of an expected_payment :

{
  "id":"fdff5955-fb30-4827-993d-3841016e8246",
  "object": "expected_payment",
  "direction": "credit",
  "amount": 12000,
  "currency": "EUR",
  "start_date": "2022-01-05",
  "end_date": "2022-01-10",
  "connected_account_id": "a55e3ac4-6956-422f-be98-aa7374482f7c",
  "counterparty_account_details": {
    "account_number": "",
    "holder_name": ""
  },
  "description": "Invoice 1234",
  "metadata": {},
  "reconciled_amount": 12000,
  "reconciliation_status": "reconciled",
  "created_at": "2022-01-03T08:51:13.958195Z",
  "updated_at": "2022-01-06T14:32:49.180422Z",
  "canceled_at": null
}