Skip to main content
POST
/
reconciliation
/
start-instant
Instant reconciliation
curl --request POST \
  --url http://localhost:5001/reconciliation/start-instant \
  --header 'X-blnk-key: <api-key>'
Use blnk.Reconciliation.runInstant to reconcile external records inline.
blnk.Reconciliation.runInstant
const response = await blnk.Reconciliation.runInstant({
  external_transactions: [
    {
      id: 'txn_1',
      amount: 5.49,
      reference: 'INV-2023-002',
      currency: 'GBP',
      description: 'Card payment',
      date: '2024-11-15T14:25:30Z',
      source: 'bank-api',
    },
  ],
  strategy: 'one_to_one',
  dry_run: true,
  matching_rule_ids: ['rule_abc123'],
});
FieldDescription
external_transactionsArray of external transaction rows to reconcile.
external_transactions[].idUnique external transaction ID.
external_transactions[].amountTransaction amount.
external_transactions[].referenceUnique transaction reference.
external_transactions[].currencyISO 4217 currency code.
external_transactions[].descriptionDescription of the transaction.
external_transactions[].dateTransaction date and time.
external_transactions[].sourceOrigin of the transaction data.
strategyMatch strategy: one_to_one, one_to_many, or many_to_one.
matching_rule_idsIDs of the matching rules to apply.
dry_runOptional. Set true to test without writing results to the ledger.
grouping_criteriaOptional field used to group records during matching.

​
Response shape

200 OK
{
  "reconciliation_id": "rec_a8f2c91d-1234-4abc-9def-0123456789ab"
}
FieldDescription
reconciliation_idID of the reconciliation run. Use it with blnk.Reconciliation.get to check status.

How reconciliation works

Batch and instant reconciliation workflows.

Instant reconciliation

HTTP request and response schema.

​
Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.