Reconciliation
Instant Reconciliation
Learn how to run reconciliation instantly.
POST
/
reconciliation
/
start-instant
{
"external_transactions": [
{
"id": "txn1a2b3c4d5e6f7g8h9i0",
"amount": 549,
"reference": "INV-2023-002",
"currency": "GBP",
"description": "Card payment",
"date": "2024-11-15T14:25:30Z",
"source": "bank-api"
}
],
"strategy": "one_to_one",
"dry_run": false,
"matching_rule_ids": [
"rule_890bdbc4-467f-4670-8424-5667e41daf29"
]
}
{
"error": "external_transactions is required",
"error_detail": {
"code": "RECON_EXTERNAL_TXNS_REQUIRED",
"message": "external_transactions is required"
}
}
{
"error": "too many external_transactions; max is 10000",
"error_detail": {
"code": "GEN_VALIDATION_ERROR",
"message": "too many external_transactions; max is 10000"
}
}
If you’re using the auto-provisioned
Enterprise Core instance included with your Production License deployment, set the base URL to: https://ENTERPRISE_PUBLIC_URL/core.If you’re connecting to a different Core instance, use the publicly accessible base URL for that instance instead.Authorization
If set, the API uses an API key for authentication. Include the following header in your requests:X-blnk-key: <api-key>.
Replace <api-key> with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code.
See also: Scoped API keys and Secure your Blnk server.
Body
array
Array of external transactions to be reconciled. Max number of external transactions allowed is 10,000.
Show child attributes
Show child attributes
string
required
Unique external transaction id.
integer
required
The transaction amount.
string
required
Unique transaction reference.
string
required
ISO 4217 currency code.
string
required
Description/narration of the transaction.
string
required
Transaction date and time.
string
required
Origin of the transaction data.
string
required
Specifies the reconciliation strategy to be applied. Learn more: Reconciliation strategy. Supported values are:
one_to_one: Used for a direct match between an internal transaction record in your Blnk Ledger and an external transaction record.one_to_many: Used when one external transaction represents multiple internal transactions (e.g., batch or split payments).many_to_one: Used when multiple external transaction records make up one internal transaction record (e.g., installment payments, ACH transfers, etc.).
boolean
default:"false"
required
Indicates whether the reconciliation process should be executed as a test or not.
true: Results are not stored in the ledger, treating it as a test.false: Results are stored in the ledger.
string
required
Specifies the field used to group records during reconciliation.
array
required
Specifies the IDs of the matching rules to apply during the reconciliation process.
{
"external_transactions": [
{
"id": "txn1a2b3c4d5e6f7g8h9i0",
"amount": 549,
"reference": "INV-2023-002",
"currency": "GBP",
"description": "Card payment",
"date": "2024-11-15T14:25:30Z",
"source": "bank-api"
}
],
"strategy": "one_to_one",
"dry_run": false,
"matching_rule_ids": [
"rule_890bdbc4-467f-4670-8424-5667e41daf29"
]
}
{
"error": "external_transactions is required",
"error_detail": {
"code": "RECON_EXTERNAL_TXNS_REQUIRED",
"message": "external_transactions is required"
}
}
{
"error": "too many external_transactions; max is 10000",
"error_detail": {
"code": "GEN_VALIDATION_ERROR",
"message": "too many external_transactions; max is 10000"
}
}
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.Was this page helpful?
⌘I
{
"external_transactions": [
{
"id": "txn1a2b3c4d5e6f7g8h9i0",
"amount": 549,
"reference": "INV-2023-002",
"currency": "GBP",
"description": "Card payment",
"date": "2024-11-15T14:25:30Z",
"source": "bank-api"
}
],
"strategy": "one_to_one",
"dry_run": false,
"matching_rule_ids": [
"rule_890bdbc4-467f-4670-8424-5667e41daf29"
]
}
{
"error": "external_transactions is required",
"error_detail": {
"code": "RECON_EXTERNAL_TXNS_REQUIRED",
"message": "external_transactions is required"
}
}
{
"error": "too many external_transactions; max is 10000",
"error_detail": {
"code": "GEN_VALIDATION_ERROR",
"message": "too many external_transactions; max is 10000"
}
}