v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB

Reconciliations

Create reconciliation

Create a reconciliation by matching a transaction with a payment.

post/reconciliations

Headers

Idempotency-Keystring

Request body

transaction_idstring

The ID of the transaction to be reconciled. If empty and the payment is unreconciled (reconciliation_status = unreconciled), will exclude the payment from reconciliation (reconciliation_status = excluded).

payment_idstring

The ID of the payment_order, incoming_payment, return, expected_payment or payment_capture to be reconciled. If empty and the transaction is unreconciled (reconciliation_status = unreconciled), will exclude the transaction from reconciliation (reconciliation_status = excluded).

amountinteger

The amount of the reconciliation, in the related payment and transaction currency’s smallest unit. For euro, the smallest unit is cents. €20 is represented as 2000. If unspecified, the system will try to create a reconciliation with the maximum amount possible. It must be left empty if payment_id is empty.

metadataobject

Additional client data in JSON format. See Metadata.

Example request

{
  "transaction_id": "288ea7c0-4944-76ab-c658-0756ab150043",
  "payment_id": "15b88a94-4944-11ed-b878-0242ac120002",
  "amount": 3000,
  "metadata": {
    "property_a": true,
    "property_b": "some label"
  }
}

Response

200

idstring

amountinteger

match_typestring

objectstring

metadataobject

Additional client data in JSON format. See Metadata.

transaction_idstring

payment_idstring

payment_typestring

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

created_atstring

Example response

{
  "id": "7d399984-b435-4a63-ab11-4a4185c13cba",
  "amount": 500,
  "match_type": "manual",
  "object": "reconciliation",
  "metadata": {
    "property_a": true,
    "property_b": "some label"
  },
  "transaction_id": "8a0e3912-59c7-4b86-980f-d1ab4b8786e2",
  "payment_id": "fb9ec63e-7b32-47ef-9326-fe214ebeadb7",
  "payment_type": "expected_payment",
  "created_at": "2022-05-09T12:17:07.48448Z"
}