Skip to main content
POST
/
proxy
/
{path}
curl -X POST 'https://api.cloud.blnkfinance.com/proxy/ledgers?instance_id=YOUR_INSTANCE_ID' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "My Integration Ledger",
    "meta_data": {
      "description": "Ledger for integration test"
    }
  }'

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.

The Proxy API forwards HTTP requests to your Blnk Core instance through Blnk Cloud. Use it to create ledgers, balances, transactions, identities, and other Core resources without connecting to Core directly.
Blnk Cloud authenticates your request, routes it to the target instance using instance_id, and returns the Core response unchanged. For a step-by-step walkthrough, see Making requests via the Cloud Proxy.

​
Request structure

curl -X POST 'https://api.cloud.blnkfinance.com/proxy/ledgers?instance_id=YOUR_INSTANCE_ID' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "My Integration Ledger",
    "meta_data": {
      "description": "Ledger for integration test"
    }
  }'
​
Authorization
string
required
Bearer token for an API key or OAuth access token. Format: Bearer YOUR_API_KEY or Bearer YOUR_ACCESS_TOKEN. Credentials must include the appropriate proxy scope:
ScopeAccess
proxy:writeCreate and update resources (POST, PUT, DELETE)
proxy:readRead resources (GET routes)
Create credentials with proxy scopes in API keys or OAuth clients.
​
instance_id
string
required
Unique identifier of the Blnk Core instance to target. Required on every Proxy API request.
​
Content-Type
string
Required for requests with a body. Set to application/json. Use multipart/form-data for reconciliation file uploads.

​
Available endpoints

All paths are relative to https://api.cloud.blnkfinance.com/proxy. Append ?instance_id=YOUR_INSTANCE_ID to every request.
MethodPathDescription
POST/ledgersCreate a ledger
POST/balancesCreate a balance
POST/transactionsCreate a transaction
POST/transactions/bulkCreate multiple transactions
PUT/transactions/inflight/:idUpdate an inflight transaction
POST/refund-transaction/:idRefund a transaction
POST/identitiesCreate an identity
PUT/identities/:identity_idUpdate an identity
PUT/balances/:id/identityLink an identity to a balance
POST/:id/metadataUpdate metadata on a ledger, balance, transaction, or identity
When creating a transaction, Blnk Cloud automatically adds precision: 100 and a reference value if they are omitted from the request body.

​
Response structure

Proxy responses pass through the Core instance response unchanged. Status codes and body shapes match the corresponding Core endpoint.

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