Start Here

Using the Go SDK

Configure authentication, timeouts, retries, logging, and request shapes for the Go SDK.

Initialize the client

Your Blnk client is the single entry point to everything: ledgers, balances, transactions, reconciliation, and more. Configure it once when your app starts, then use it everywhere.

Create a helper that reads your base URL and API key from the environment, then passes functional options for timeout and retries:

package blnk

	"net/url"
	"os"
	"time"

	blnkgo "github.com/blnkfinance/blnk-go"
)

func NewBlnkClient() *blnkgo.Client {
	baseURL, _ := url.Parse(os.Getenv("BLNK_BASE_URL"))
	if baseURL == nil || baseURL.String() == "" {
		baseURL, _ = url.Parse("http://localhost:5001/")
	}

	apiKey := os.Getenv("BLNK_API_KEY")
	return blnkgo.NewClient(
		baseURL,
		&apiKey,
		blnkgo.WithTimeout(10*time.Second),
		blnkgo.WithRetry(2),
	)
}

That’s it. One import, one call, one client. From here you can create ledgers, move money, reconcile transactions, and manage your entire financial infrastructure.

Pass a request struct to the service method you need. For example, create a ledger with metadata:

client := NewBlnkClient()

ledger, _, _ := client.Ledger.Create(blnkgo.CreateLedgerRequest{
	Name: "Customer Savings Account",
	MetaData: blnkgo.MetaData{
		"project_owner": "YOUR_APP_NAME",
	},
})

Per-method SDK pages in the sidebar list each call on client.Ledger, client.LedgerBalance, and other services.

Authentication

NewClient takes a base URL and an optional API key pointer. The SDK sends the key on every request in the X-Blnk-Key header when you pass a non-nil pointer.

How you set the API key depends on whether Core runs in secure mode:

apiKey := os.Getenv("BLNK_API_KEY")
client := blnkgo.NewClient(baseURL, &apiKey)

client := blnkgo.NewClient(baseURL, nil)

Timeouts and retries

When connections fail, Core restarts, or requests hang, the SDK handles it without blocking your app. Pass functional options to NewClient to tune behavior:

client := blnkgo.NewClient(
	baseURL,
	&apiKey,
	blnkgo.WithTimeout(30*time.Second),
	blnkgo.WithRetry(3),
	blnkgo.WithRetryDelay(2*time.Second),
)

When to tune these:

• Keep defaults if you’re making fast, local calls and want to fail fast.
• Increase WithTimeout if you’re running large batch requests that may take a while to complete synchronously.
• Increase WithRetry if you’re reading data across an unreliable network.

Custom logger

By default, the SDK logs retry and transport events through a built-in logger that writes to stdout with INFO: and ERROR: prefixes.

Pass a type that implements blnkgo.Logger to route these messages to your own logging system instead of stdout.

type appLogger struct{}

func (l appLogger) Info(msg string)  { log.Println("info:", msg) }
func (l appLogger) Error(msg string) { log.Println("error:", msg) }

client := blnkgo.NewClient(
	baseURL,
	&apiKey,
	blnkgo.WithLogger(appLogger{}),
)

Building transaction requests

Call client.Transaction.Create and pass a blnkgo.CreateTransactionRequest struct. It has two parts:

1. ParentTransaction holds the core transaction fields: amount, currency, source, destination, reference, and metadata.
2. Top-level fields control how the request is processed, such as AllowOverdraft, Inflight, and ScheduledFor.

blnkgo.CreateTransactionRequest{
	ParentTransaction: blnkgo.ParentTransaction{
		PreciseAmount: big.NewInt(100000),
		Precision: 100,
		Currency: "USD",
		Source: "bln_28f25ef6-2e0d-4fa6-891c-37fc409d654e",
		Destination: "bln_86ba7976-499d-4282-955e-a7c2abf5db12",
		Reference: "payment_001",
	},
	AllowOverdraft: true,
}

Transactions are the exception. Every other resource uses a single request struct with no nesting. Pass CreateLedgerRequest to client.Ledger.Create, CreateLedgerBalanceRequest to client.LedgerBalance.Create, and so on.

JSON field names

Go struct fields use PascalCase, like MetaData and LedgerID. These map to the API’s snake_case JSON fields (meta_data, ledger_id).

You should always use the Go field names in your code. Per-method Go SDK pages list the Go request and response field names for each call.

Precise amounts

Transaction PreciseAmount fields use *big.Int in the Go SDK. Pass minor units with big.NewInt(...), for example big.NewInt(75000) with Precision: 100 for 750.00. Add import "math/big" at the top of your file when you use big.NewInt.

You can still use Amount as a float64 when you prefer float-style values; the SDK and Core apply Precision to derive precise_amount.

Date and time fields

Fields such as DOB, EffectiveDate, ScheduledFor, InflightCommitDate, and historical balance timestamps use time.Time (or *time.Time). Parse ISO 8601 strings with time.Parse(time.RFC3339, "..."), for example "2024-04-22T15:28:03Z" or "2024-12-21T01:36:46+01:00", then pass the resulting value. Use a pointer when the field is optional so zero values omit from JSON.