A reconciliation is the action of reconciling a transaction of one of your connected accounts with a payment order or expected payment.
Attribute | Description |
---|---|
id string | The UUID of the reconciliation. |
object string | The object, here reconciliation . |
transaction_id string | The ID of the reconciled transaction. |
payment_id string | The ID of the reconciled payment, either a payment order, incoming payment, return, expected payment, or payment capture. |
payment_type string | The type of reconciled payment. Either payment_order , incoming_payment , return , expected_payment , or payment_capture . |
amount integer | The amount of the reconciliation. |
match_tye 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 automated 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",
"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"
}