v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB

Reconciliations

Update reconciliation

Update a reconciliation.

post/reconciliations/{id}

Path parameters

idstring required

The UUID of the reconciliation.

Request body

metadataobject required

Additional client data in JSON format. See Metadata.

Example request

{
  "metadata": {
    "property_a": true,
    "property_b": "some label"
  }
}

Response

200

idstring

amountinteger

match_typestring

objectstring

{"stackTrail":"paths:/reconciliations/{id}:post:responses:200:content:application/json:schema:properties:metadata","oasType":"schema","type":"unknown","example":{"foo":"bar"}}

transaction_idstring

payment_idstring

payment_typestring

{"stackTrail":"paths:/reconciliations/{id}:post:responses:200:content:application/json:schema:properties:canceled_at","oasType":"schema","type":"unknown"}

created_atstring

Example response

{
  "id": "c0f8a4f5-8c1e-4aa2-bbf2-d704835a705f",
  "amount": 300,
  "match_type": "manual",
  "object": "reconciliation",
  "metadata": {
    "foo": "bar"
  },
  "transaction_id": "c6bb4031-7f2f-4a02-88b3-3bc268d0281f",
  "payment_id": "34ac5536-af38-4c99-921f-a81447966db1",
  "payment_type": "expected_payment",
  "created_at": "2022-05-04T15:23:36.273498Z"
}