Skip to main content
POST
/
proxy
/
transactions
curl -X POST "https://api.cloud.blnkfinance.com/proxy/transactions?instance_id=YOUR_INSTANCE_ID" \
  -H "Authorization: Bearer blnk_at_YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 100.50,
    "currency": "USD",
    "precision": 100,
    "reference": "ref_myApp-integration-test-001",
    "source": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
    "destination": "bln_ANOTHER_BALANCE_ID",
    "description": "Integration test: transfer from Balance A to Balance B",
    "allow_overdraft": true
  }'

{
  "amount": 100.50,
  "rate": 0,
  "precision": 100,
  "precise_amount": 10050,
  "transaction_id": "txn_c4e70eb8-e4d6-4e04-a2e2-92a43b969e0c",
  "parent_transaction": "",
  "source": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
  "destination": "bln_ANOTHER_BALANCE_ID",
  "reference": "ref_myApp-integration-test-001",
  "currency": "USD",
  "description": "Integration test: transfer from Balance A to Balance B",
  "status": "QUEUED",
  "hash": "hash_...",
  "allow_overdraft": true,
  "inflight": false,
  "created_at": "2024-11-26T08:40:00.000000000Z",
  "scheduled_for": "0001-01-01T00:00:00Z",
  "inflight_expiry_date": "0001-01-01T00:00:00Z"
}

Documentation Index

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

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

Create a transaction to transfer funds from a source balance to a destination balance. Transactions are applied asynchronously and update both balances.
For in-depth information about Blnk’s ledger, balance, transaction, and identity APIs, see the Blnk Core docs.

​
Request structure

curl -X POST "https://api.cloud.blnkfinance.com/proxy/transactions?instance_id=YOUR_INSTANCE_ID" \
  -H "Authorization: Bearer blnk_at_YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 100.50,
    "currency": "USD",
    "precision": 100,
    "reference": "ref_myApp-integration-test-001",
    "source": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
    "destination": "bln_ANOTHER_BALANCE_ID",
    "description": "Integration test: transfer from Balance A to Balance B",
    "allow_overdraft": true
  }'
​
Authorization
string
required
Bearer token for authentication. Format: Bearer <access_token>. Your OAuth key must include proxy:write scope (or *).
​
amount
number
required
Transaction amount.
​
currency
string
required
Currency code for the transaction (e.g., USD, EUR, GBP).
​
source
string
required
Balance ID to debit from.
​
destination
string
required
Balance ID to credit to.
​
precision
integer
required
Precision multiplier for the amount. Defaults to 100 (e.g., 100.50 becomes 10050).
​
reference
string
required
Optional reference identifier for the transaction.
​
description
string
required
Optional description of the transaction.
​
meta_data
object
Optional metadata object for custom key-value data. Use a top-level key (e.g., your app name) to avoid conflicts.

​
Query parameters

​
instance_id
string
required
The Blnk Core instance ID to target. Find this in Blnk Cloud under Instances.

​
Response structure

{
  "amount": 100.50,
  "rate": 0,
  "precision": 100,
  "precise_amount": 10050,
  "transaction_id": "txn_c4e70eb8-e4d6-4e04-a2e2-92a43b969e0c",
  "parent_transaction": "",
  "source": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
  "destination": "bln_ANOTHER_BALANCE_ID",
  "reference": "ref_myApp-integration-test-001",
  "currency": "USD",
  "description": "Integration test: transfer from Balance A to Balance B",
  "status": "QUEUED",
  "hash": "hash_...",
  "allow_overdraft": true,
  "inflight": false,
  "created_at": "2024-11-26T08:40:00.000000000Z",
  "scheduled_for": "0001-01-01T00:00:00Z",
  "inflight_expiry_date": "0001-01-01T00:00:00Z"
}
​
transaction_id
string
Unique identifier for the created transaction.
​
amount
number
Transaction amount.
​
precise_amount
integer
Amount multiplied by precision (e.g., 100.50 * 100 = 10050).
​
currency
string
Currency code for the transaction.
​
source
string
Balance ID debited from.
​
destination
string
Balance ID credited to.
​
status
string
Current status of the transaction (e.g., QUEUED, APPLIED, FAILED).
​
reference
string
Reference identifier for the transaction, if provided.
​
description
string
Description of the transaction, if provided.
​
precision
integer
Precision multiplier used for the amount.
​
created_at
timestamp
ISO 8601 formatted timestamp of when the transaction was created.

​
Need help?

If you’re having trouble with Blnk Cloud, don’t hesitate to send us a message via email at support@blnkfinance.com or send us a message here.