Go quick start

Create a Go project and install the SDK. v1.2.0 and later require Go 1.22 or later.

go mod init blnk-quickstart
go get github.com/blnkfinance/blnk-go

Parse your Blnk base URL and create a client. Pass a pointer to your API key when your instance requires authentication. The SDK sends it as the X-Blnk-Key header.

Use nil when running locally without auth.

baseURL, _ := url.Parse("http://localhost:5001/")
apiKey := "your_api_key"
client := blnkgo.NewClient(
	baseURL,
	&apiKey,
	blnkgo.WithTimeout(10*time.Second),
	blnkgo.WithRetry(2),
)

Create a main.go file as shown below to create your first transaction with the SDK.

package main

	"math/big"
	"net/url"
	"time"

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

func main() {
	baseURL, _ := url.Parse("http://localhost:5001/")
	client := blnkgo.NewClient(
		baseURL,
		nil,
		blnkgo.WithTimeout(10*time.Second),
		blnkgo.WithRetry(2),
	)

	transaction, _, _ := client.Transaction.Create(blnkgo.CreateTransactionRequest{
		ParentTransaction: blnkgo.ParentTransaction{
			PreciseAmount: big.NewInt(100000),
			Reference:     "first_txn_001",
			Currency:      "USD",
			Precision:     100,
			Source:        "@FundingPool",
			Destination:   "@MyBalance",
			Description:   "My first Blnk transaction",
		},
		AllowOverdraft: true,
	})
}

Run the file.

go run main.go

You should get a response similar to this:

{
  "amount": 1000,
  "precision": 100,
  "precise_amount": 100000,
  "transaction_id": "txn_8d2ce2f0-0d75-4a91-9d43-2ad2c2e6b9ad",
  "parent_transaction": "",
  "source": "bln_f344b673-e855-4bda-b769-3e94a02c1941",
  "destination": "bln_d5cbde84-d20a-485b-8ce8-6677d782c3a1",
  "reference": "first_txn_001",
  "currency": "USD",
  "description": "My first Blnk transaction",
  "status": "QUEUED",
  "allow_overdraft": true,
  "inflight": false,
  "created_at": "2024-11-26T09:33:35.265582042Z"
}

Confirm the transaction landed in your ledger.

blnk transactions list --id txn_8d2ce2f0-0d75-4a91-9d43-2ad2c2e6b9ad