Skip to main content
POST
/
transactions
curl --request POST \
  --url http://localhost:5001/balances \
  --header 'X-blnk-key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": 19050.34,
    "currency": "USD",
    "precision": 100,
    "reference": "ref_2ye281ewiu-1e17-dh17-eh18728hd245",
    "source": "bln_f344b673-e855-4bda-b769-3e94a02c1941",
    "destinations": [
      {
        "identifier": "bln_f2073f6b-905a-4e3e-b5a2-8d1b3dc2fb7f",
        "distribution": "10%"
      },
      {
        "identifier": "bln_64c50fb5-32d5-4f78-9f4a-e8b01aaf025d",
        "distribution": "5000"
      },
      {
        "identifier": "bln_7d98dfe9-5c3e-4c9b-b96a-65f6d9f7b89b",
        "distribution": "left"
      }
    ],
    "meta_data": {}
  }'

{
    "amount": 19050.34,
    "rate": 0,
    "precision": 100,
    "precise_amount": 1905034,
    "transaction_id": "txn_c4e70eb8-e4d6-4e04-a2e2-92a43b969e0c",
    "parent_transaction": "",
    "source": "bln_f344b673-e855-4bda-b769-3e94a02c1941",
    "destinations": [
      {
        "identifier": "bln_f2073f6b-905a-4e3e-b5a2-8d1b3dc2fb7f",
        "distribution": "10%"
      },
      {
        "identifier": "bln_64c50fb5-32d5-4f78-9f4a-e8b01aaf025d",
        "distribution": "5000"
      },
      {
        "identifier": "bln_7d98dfe9-5c3e-4c9b-b96a-65f6d9f7b89b",
        "distribution": "left"
      }
    ],
    "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"
}

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

Important tip: To apply multiple destinations, Blnk uses the destinations array instead of the conventional destination parameter in Record transaction.
​
amount
integer | float
required
The transaction amount.
​
precise_amount
integer
The transaction amount in its smallest unit. Use this instead of amount when working with values that have more than 15 digits to avoid rounding errors. You must provide the corresponding precision value. See Transaction precision for more details.
Either amount or precise_amount should be provided, not both.
​
currency
string
required
The currency of the transaction amount is in.
​
precision
integer
default:"1"
required
Precision for the transaction’s currency. Also see: Precision.
​
reference
string
required
The unique transaction reference number for the transaction. If empty, Blnk auto-creates one.
​
source
string
required
The balance sending the amount. @ prefix indicates that the balance is an internal balance.
​
destinations
array
required
Lists the destinations for the transaction. Each destination includes:
​
scheduled_for
string
Indicates the date and time of a scheduled transaction, e.g., "2024-02-20 05:28:03".
​
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: Inflight transactions.
​
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.
​
inflight_commit_date
string
When inflight is true, the date and time when Blnk should automatically commit the inflight transaction. See Schedule inflight commits.
​
rate
integer
Defines the conversion rate to be applied when the transaction involves balances in different currencies. See also: Applying rates.
​
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
This is computed by amount x precision. Learn why this is important: Why use 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
SHA-256 hash of the transaction details. 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 --request POST \
  --url http://localhost:5001/balances \
  --header 'X-blnk-key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": 19050.34,
    "currency": "USD",
    "precision": 100,
    "reference": "ref_2ye281ewiu-1e17-dh17-eh18728hd245",
    "source": "bln_f344b673-e855-4bda-b769-3e94a02c1941",
    "destinations": [
      {
        "identifier": "bln_f2073f6b-905a-4e3e-b5a2-8d1b3dc2fb7f",
        "distribution": "10%"
      },
      {
        "identifier": "bln_64c50fb5-32d5-4f78-9f4a-e8b01aaf025d",
        "distribution": "5000"
      },
      {
        "identifier": "bln_7d98dfe9-5c3e-4c9b-b96a-65f6d9f7b89b",
        "distribution": "left"
      }
    ],
    "meta_data": {}
  }'

{
    "amount": 19050.34,
    "rate": 0,
    "precision": 100,
    "precise_amount": 1905034,
    "transaction_id": "txn_c4e70eb8-e4d6-4e04-a2e2-92a43b969e0c",
    "parent_transaction": "",
    "source": "bln_f344b673-e855-4bda-b769-3e94a02c1941",
    "destinations": [
      {
        "identifier": "bln_f2073f6b-905a-4e3e-b5a2-8d1b3dc2fb7f",
        "distribution": "10%"
      },
      {
        "identifier": "bln_64c50fb5-32d5-4f78-9f4a-e8b01aaf025d",
        "distribution": "5000"
      },
      {
        "identifier": "bln_7d98dfe9-5c3e-4c9b-b96a-65f6d9f7b89b",
        "distribution": "left"
      }
    ],
    "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.