The reconciliation object

A reconciliation is the action of reconciling a transaction of one of your connected accounts with a payment order or expected payment.

AttributeDescription
id
string
The UUID of the reconciliation.
object
string
The object, here reconciliation.
transaction_id
object
The reconciled transaction.

The object includes the following attributes:
  • id: the UUID of the transaction
  • object: the object, here transaction
  • amount: the amount of the transaction
  • reconciled_amount: the sum of the reconciled_amount of all the reconciliations that involve the transaction
  • reconciliation_status: transaction can be unreconciled, partially_reconciled or reconciled
payment_id
object
The reconciled payment.

The object includes the following attributes:
  • id: the UUID of the payment
  • object: the object, here payment_order or expected_payment
  • amount: the amount of the payment
  • reconciled_amount: the sum of the reconciled_amount of all the reconciliations that involve the payment
  • reconciliation_status: payment can be unreconciled, partially_reconciled or reconciled
reconciled_amount
integer
The reconciled amount.

If not specified by the customer, it is the smallest value between the transaction_amount and the payment_amount.

Example: if the payment_amount is 1000, the transaction_amount is 1500, and the reconciled_amount parameter is not specified, then reconciled_amount = 1000.
match_type
string
The type of the reconciliation.

match_type is manual if the reconciliation is performed manually.

match_type is auto if the reconciliation is performed by Numeral automatic reconciliation engine.
metadata
object
Additional data in JSON key:value format. See Metadata.
canceled_at
datetime
The UTC timestamp of the cancellation of this reconciliation. canceled_at is null if reconciliation was not canceled.
created_at
datetime
The UTC timestamp of the creation of this reconciliation

Below is an example of a reconciliation:

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