Reconciliation

Instant reconciliation

Run instant reconciliation with the TypeScript SDK.

POST/reconciliation/start-instant

Use blnk.Reconciliation.runInstant to reconcile external records inline.

Call the method

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_890bdbc4-467f-4670-8424-5667e41daf29',
  ],
});

Field	Type	Description
`external_transactions`	`object[]`	Array of external transaction rows to reconcile.
`external_transactions[].id`	`string`	Unique external transaction ID.
`external_transactions[].amount`	`number`	Transaction amount.
`external_transactions[].reference`	`string`	Unique transaction reference.
`external_transactions[].currency`	`string`	ISO 4217 currency code.
`external_transactions[].description`	`string`	Description of the transaction.
`external_transactions[].date`	`string`	Transaction date and time.
`external_transactions[].source`	`string`	Origin of the transaction data.
`strategy`	`string`	Match strategy: `one_to_one`, `one_to_many`, or `many_to_one`.
`matching_rule_ids`	`string[]`	IDs of the matching rules to apply.

Optional parameters

Field	Type	Description
`dry_run`	`boolean`	Set `true` to test without writing results to the ledger.
`grouping_criteria`	`string`	Field used to group records during matching.

Save the reconciliation ID

Use response.data.reconciliation_id with blnk.Reconciliation.get to poll status and match counts.

Response

{
  "reconciliation_id": "rec_a8f2c91d-1234-4abc-9def-0123456789ab"
}

Field	Type	Description
`reconciliation_id`	`string`	ID of the reconciliation run. Use it with `blnk.Reconciliation.get` to check status.