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.
Attribute | Description |
---|---|
id | The UUID of the expected payment. |
object | The object, here |
connected_account | The ID of the connected account related to the payment. |
direction | Either Direction is |
amount_from | 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 If the exact amount of the payment is known with certainty, the same amount can be specified in `amount_from |
amount_to | 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 If the exact amount of the payment is known with certainty, the same amount can be specified in `amount_from |
currency | The currency of the payment. |
start_date | The expected date of the payment. If the date of the payment is uncertain, you can specified the earliest date in If the exact date of the payment is known with certainty, the same date can be specified in |
end_date | The expected date of the payment. If the date of the payment is uncertain, you can specified the earliest date in If the exact date of the payment is known with certainty, the same date can be specified in |
counterparty_account_details | The account of the counterparty, which is either the debitor or the creditor depending on the payment's direction. The object includes the following attributes: |
description | The description of the |
metadata | Additional data in JSON |
reconciliation_status | The reconciliation status of the transaction, which is either |
reconciled_amount | 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 | The UTC timestamp of the cancellation of this expected payment. |
created_at | The UTC timestamp of the creation of the expected payment. |
updated_at | 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-03",
"canceled_at": null
}