Skip to main content
POST
/
transactions
/
bulk
Bulk Transactions
curl --request POST \
  --url http://localhost:5001/transactions/bulk \
  --header 'Content-Type: application/json' \
  --header 'X-blnk-key: <api-key>' \
  --data '
{
  "atomic": true,
  "inflight": true,
  "run_async": true,
  "skip_queue": true,
  "transactions": [
    {}
  ]
}
'
{
  "batch_id": "bulk_c62f200b-905f-4983-a349-cadd279234aa",
  "status": "applied",
  "transaction_count": 4
}

Documentation Index

Fetch the complete documentation index at: https://docs.blnkfinance.com/llms.txt

Use this file to discover all available pages before exploring further.

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: Secure your Blnk server

Body

atomic
boolean
required
When true, either all transactions succeed or all fail. When false, transactions are processed independently.
inflight
boolean
required
When true, transactions are created in INFLIGHT status and require a separate commit. When false, transactions are applied immediately.
run_async
boolean
default:"false"
When true, processing happens in the background and results are delivered via webhook. When false or not provided, processing happens synchronously and results are returned in the response.
skip_queue
boolean
default:"false"
When true, transactions bypass the queue system. Learn more: Why we use queueing.
transactions
object[]
required
An array of transaction objects.
Sample transaction object
{
  "amount": 358.90,
  "precision": 100,
  "reference": "unique_reference_1",
  "description": "Transaction description",
  "currency": "USD",
  "source": "@source_account",
  "destination": "@destination_account",
  "allow_overdraft": true
}

Response

batch_id
string
required
Identifier for the bulk batch. Use this value as parent_transaction when searching for child transactions, or when committing or voiding an inflight batch.
status
string
required
When run_async is false, value is applied if transactions posted immediately, or inflight if the batch was created in inflight status. When run_async is true, value is queued while the batch runs in the background.
transaction_count
integer
Number of transactions in the batch. Present when processing finished synchronously and the batch succeeded (or when reported in webhooks for async success).
message
string
Human-readable status message. Included on the immediate response when run_async is true (for example, confirming that background processing started).
{
  "batch_id": "bulk_c62f200b-905f-4983-a349-cadd279234aa",
  "status": "applied",
  "transaction_count": 4
}

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.
Tip: Connect to Blnk Cloud to see your Core data.You can view your transactions, manage identities, create custom reports, invite other team members to collaborate, and perform operations on your Core — all in one dashboard.Check out Blnk Cloud →