Reconciliation

Upload data

Upload external data for reconciliation with the TypeScript SDK.

POST/reconciliation/upload

Use blnk.Reconciliation.upload to upload external statement data.

Call the method

const response = await blnk.Reconciliation.upload('statement.csv', 'stripe');
FieldTypeDescription
fileInputstringPath to a CSV or JSON file, or a readable stream containing the external records.
sourcestringLabel describing where the data came from, for example stripe.

Save the upload ID

Use response.data.upload_id as the upload_id when you start reconciliation.

Response

{
  "upload_id": "upload_8c700d1b-09c0-4ef4-9ab1-a0decf3d0aa3",
  "record_count": 1000,
  "source": "Stripe"
}
FieldTypeDescription
upload_idstringUnique ID for the upload. Store it to start a batch reconciliation run.
record_countnumberNumber of records found in the file.
sourcestringLabel you passed for the data origin.