Reconciliation object

Reconciliation link one or multiple payments (payment orders, incoming payments, returns, and expected payments) with one or multiple transactions booked on your bank accounts. They can be created automatically by the Numeral reconciliation engine or manually by the customer through the API or dashboard.

AttributeDescription
id
string
The reconciliation ID.
object
string
Always reconciliation.
transaction_id
string
The ID of the transaction reconciled.
payment_id
string
The ID of the payment reconciled.
payment_type
string
The type of the payment payment. Either payment_order, incoming_payment, return, expected_payment, or payment_capture.
amount
integer
The amount reconciliation.
match_tye
string
The reconciliation type, either manual if the reconciliation has been created manually by the customer through the API or dashboard or auto if the reconciliation has been created automatically by the Numeral reconciliation engine.
metadata
object
Additional data in JSON key:value format. See Metadata.
canceled_at
datetime
The reconciliation cancelation UTC timestamp.
created_at
datetime
The reconciliation creation UTC timestamp.

Below is an example of a reconciliation:

{
   "id": "d0c8a4f5-8c0e-4aa2-bbf2-f70f825a205a",
   "object": "reconciliation",
   "transaction_id": "a6ba4011-7f8f-4402-88b3-3bc268c0281f",
   "payment_id": "34755536-fff8-4c2f-929f-a82447936db3",
   "payment_type": "expected_payment",
   "amount": 300,
   "match_type": "manual",
   "metadata": {},
   "canceled_at": null,
   "created_at": "2023-08-12T15:23:36.273498Z"
}