Skip to main content
POST
/
transactions
curl -X POST "http://localhost:5001/transactions" \
  -H "X-blnk-key: <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "precise_amount": 125034,
    "currency": "USD",
    "precision": 100,
    "reference": "ref_2ye281ewiu-1e17-dh17-eh18728hd245",
    "source": "@WorldUSD",
    "destination": "@MyBalance",
    "description": "Fund with starting balance amount",
    "meta_data": {}
  }'

{
    "amount": 1250.34,
    "precision": 100,
    "precise_amount": 125034,
    "transaction_id": "txn_c4e70eb8-e4d6-4e04-a2e2-92a43b969e0c",
    "parent_transaction": "",
    "source": "bln_f344b673-e855-4bda-b769-3e94a02c1941",
    "destination": "bln_d5cbde84-d20a-485b-8ce8-6677d782c3a1",
    "reference": "ref_2ye281ewiu-1e17-dh17-eh18728hd245",
    "currency": "USD",
    "description": "Card payment on Stripe",
    "status": "QUEUED",
    "hash": "0b9c25fb5b00d6c71cb4ca87026bf6dc316e63353d3330deb588bd0b3d74dcc0",
    "allow_overdraft": false,
    "inflight": false,
    "created_at": "2024-11-26T09:33:35.265582042Z",
    "scheduled_for": "0001-01-01T00:00:00Z",
    "inflight_expiry_date": "0001-01-01T00:00:00Z",
    "inflight_commit_date": "0001-01-01T00:00:00Z"
}
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

​
precise_amount
integer
The transaction amount in its smallest unit (recommended). Include the corresponding precision value. See Precision.
Either precise_amount or amount should be provided, not both.
​
amount
float
The transaction amount as a float. Blnk multiplies amount by precision to store precise_amount. The amount field supports up to 15 digits; use precise_amount for larger values. See also: Precision.
​
currency
string
required
The currency of the transaction amount is in.
​
precision
integer
default:"1"
required
Precision for the transaction’s currency. See also: Precision.
​
reference
string
required
The unique transaction reference number for the transaction.
​
source
string
required
The unique id of the balance sending the amount. @ prefix indicates that the balance is an internal balance.
​
destination
string
required
The unique id of the balance receiving the amount. @ prefix indicates that the balance is an internal balance.
​
description
string
required
Narration of the transaction.
​
scheduled_for
string
Indicates the date and time of a scheduled transaction.Always format the date input as ‘YYYY-MM-DDTHH:MM:SS+00:00’ (e.g., 2024-04-22T15:28:03+00:00), where +00:00 specifies the timezone. It is UTC by default.
​
allow_overdraft
boolean
default:"false"
Specifies whether the transaction should proceed even if the source’s balance is insufficient. If enabled and the source has less than the required amount, the balance will become negative. See also: Overdrafts
​
inflight
boolean
default:"false"
Specifies that the transaction should be held until certain conditions are met. See also: Create inflight.
​
inflight_expiry_date
string
Specifies the date and time when an inflight transaction should expire. Once expired, the transaction is voided and the amount is rolled back.Always format the date input as ‘YYYY-MM-DDTHH:MM:SS+00:00’ (e.g., 2024-04-22T15:28:03+00:00), where +00:00 specifies the timezone. It is UTC by default.
​
inflight_commit_date
string
When inflight is true, the date and time when Blnk should automatically commit the inflight transaction (same ledger outcome as Update Inflight with commit). See Schedule inflight commits.Always format the date input as ‘YYYY-MM-DDTHH:MM:SS+00:00’ (e.g., 2024-04-22T15:28:03+00:00), where +00:00 specifies the timezone. It is UTC by default.
​
effective_date
string
Specifies the actual date the transaction occurred. Learn more: Backdated transactions.
​
skip_queue
boolean
When true, it bypasses the default transaction queuing system and processes transactions directly. See also: Skip transaction queue.
​
atomic
boolean
default:"false"
Controls how Blnk processes split transactions when you use sources or destinations. When false (default), Blnk applies each leg that can succeed and rejects legs that fail. When true, every leg succeeds together or the entire split fails with no partial application. See Multiple sources and Multiple destinations.
​
meta_data
object
Additional metadata of the transaction.

​
Response

All parameters from the request body also mean the same in the corresponding response JSON.
​
precise_amount
integer
The amount stored in the ledger in its smallest unit. When you pass amount, Blnk computes this as amount x precision. See Precision.
​
transaction_id
string
Unique id of the transaction.
​
parent_transaction
string
The transaction ID of the parent transaction. A parent transaction is one that impacts the creation of a new transaction, such as an inflight transaction, a scheduled transaction, or similar.For instance, refunding a sample transaction A creates a new transaction B; therefore A is the parent transaction of B.
​
status
string
The status of the transaction. See the following: Transaction statuses.
​
hash
string
Per-row SHA-256 fingerprint of the transaction’s core details. The optional global hash chain is separate and not returned in API responses. Learn more: Transaction hashing
​
created_at
string
Indicates the date & time the transaction was created.
​
meta_data
User Object
Additional metadata of the transaction.
curl -X POST "http://localhost:5001/transactions" \
  -H "X-blnk-key: <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "precise_amount": 125034,
    "currency": "USD",
    "precision": 100,
    "reference": "ref_2ye281ewiu-1e17-dh17-eh18728hd245",
    "source": "@WorldUSD",
    "destination": "@MyBalance",
    "description": "Fund with starting balance amount",
    "meta_data": {}
  }'

{
    "amount": 1250.34,
    "precision": 100,
    "precise_amount": 125034,
    "transaction_id": "txn_c4e70eb8-e4d6-4e04-a2e2-92a43b969e0c",
    "parent_transaction": "",
    "source": "bln_f344b673-e855-4bda-b769-3e94a02c1941",
    "destination": "bln_d5cbde84-d20a-485b-8ce8-6677d782c3a1",
    "reference": "ref_2ye281ewiu-1e17-dh17-eh18728hd245",
    "currency": "USD",
    "description": "Card payment on Stripe",
    "status": "QUEUED",
    "hash": "0b9c25fb5b00d6c71cb4ca87026bf6dc316e63353d3330deb588bd0b3d74dcc0",
    "allow_overdraft": false,
    "inflight": false,
    "created_at": "2024-11-26T09:33:35.265582042Z",
    "scheduled_for": "0001-01-01T00:00:00Z",
    "inflight_expiry_date": "0001-01-01T00:00:00Z",
    "inflight_commit_date": "0001-01-01T00:00:00Z"
}

​
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.