Welcome to the Stark Bank Golang SDK! This tool is made for Golang developers who want to easily integrate with our API. This SDK version is compatible with the Stark Bank API v2.
If you have no idea what Stark Bank is, check out our website and discover a world where receiving or making payments is as easy as sending a text message to your client!
- Introduction
- Setup
- Resource listing and manual pagination
- Testing in Sandbox
- Usage
- Transactions: Account statement entries
- Balance: Account balance
- Transfers: Wire transfers (TED and manual Pix)
- DictKeys: Pix Key queries to use with Transfers
- Institutions: Institutions recognized by the Central Bank
- Invoices: Reconciled receivables (dynamic Pix QR Codes)
- DynamicBrcode: Simplified reconciled receivables (dynamic Pix QR Codes)
- Deposits: Other cash-ins (static Pix QR Codes, manual Pix, etc)
- Boletos: Boleto receivables
- BoletoHolmes: Boleto receivables investigator
- BrcodePayments: Pay Pix QR Codes
- BoletoPayments: Pay Boletos
- UtilityPayments: Pay Utility bills (water, light, etc.)
- TaxPayments: Pay taxes
- DarfPayments: Pay DARFs
- PaymentPreviews: Preview all sorts of payments
- PaymentRequest: Request a payment approval to a cost center
- CorporateHolders: Manage cardholders
- CorporateCards: Create virtual and/or physical cards
- CorporateInvoices: Add money to your corporate balance
- CorporateWithdrawals: Send money back to your Workspace from your corporate balance
- CorporateBalance: View your corporate balance
- CorporateTransactions: View the transactions that have affected your corporate balance
- CorporateEnums: Query enums related to the corporate purchases, such as merchant categories, countries and card purchase methods
- Webhooks: Configure your webhook endpoints and subscriptions
- WebhookEvents: Manage webhook events
- WebhookEventAttempts: Query failed webhook event deliveries
- Workspaces: Manage your accounts
- Handling errors
- Help and Feedback
This library supports the following Golang versions:
- Golang 1.17 or later
Feel free to take a look at our API docs.
This project adheres to the following versioning pattern:
Given a version number MAJOR.MINOR.PATCH, increment:
- MAJOR version when the API version is incremented. This may include backwards incompatible changes;
- MINOR version when breaking changes are introduced OR new functionalities are added in a backwards compatible manner;
- PATCH version when backwards compatible bug fixes are implemented.
1.1 In go.mod file, add the path in the required packages
github.com/starkbank/sdk-go v0.4.21.2 You can also explicitly go get the package into a project:
go get -u github.com/starkbank/sdk-goWe use ECDSA. That means you need to generate a secp256k1 private key to sign your requests to our API, and register your public key with us, so we can validate those requests.
You can use one of following methods:
2.1. Check out the options in our tutorial.
2.2. Use our SDK:
package main
import (
"github.com/starkinfra/core-go/starkcore/key"
)
func main() {
privateKey, publicKey := key.Create("")
// or, to also save .pem files in a specific path
privateKey, publicKey := key.Create("files/keys/")
}NOTE: When you are creating new credentials, it is recommended that you create the keys inside the infrastructure that will use it, in order to avoid risky internet transmissions of your private-key. Then you can export the public-key alone to the computer where it will be used in the new Project creation.
You can interact directly with our API using two types of users: Projects and Organizations.
- Projects are workspace-specific users, that is, they are bound to the workspaces they are created in. One workspace can have multiple Projects.
- Organizations are general users that control your entire organization. They can control all your Workspaces and even create new ones. The Organization is bound to your company's tax ID only. Since this user is unique in your entire organization, only one credential can be linked to it.
3.1. To create a Project in Sandbox:
3.1.1. Log into Starkbank Sandbox
3.1.2. Go to Menu > Integrations
3.1.3. Click on the "New Project" button
3.1.4. Create a Project: Give it a name and upload the public key you created in section 2
3.1.5. After creating the Project, get its Project ID
3.1.6. Use the Project ID and private key to create the struct below:
package main
import (
"github.com/starkinfra/core-go/starkcore/user/project"
"github.com/starkinfra/core-go/starkcore/utils/checks"
)
// Get your private key from an environment variable or an encrypted database.
// This is only an example of a private key content. You should use your own key.
var privateKeyContent = "-----BEGIN EC PRIVATE KEY-----\nMHQCAQEEILChZrjrrtFnyCLhcxm/hp+9ljWSmG7Wv9HRugf+FnhkoAcGBSuBBAAK\noUQDQgAEpIAM/tMqXEfLeR93rRHiFcpDB9I18MrnCJyTVk0MdD1J9wgEbRfvAZEL\nYcEGhTFYp2X3B7K7c4gDDCr0Pu1L3A==\n-----END EC PRIVATE KEY-----\n"
var project = project.Project{
Id: "5656565656565656",
PrivateKey: checks.CheckPrivateKey(privateKeyContent),
Environment: checks.CheckEnvironment("sandbox"),
}3.2. To create Organization credentials in Sandbox:
3.2.1. Log into Starkbank Sandbox
3.2.2. Go to Menu > Integrations
3.2.3. Click on the "Organization public key" button
3.2.4. Upload the public key you created in section 2 (only a legal representative of the organization can upload the public key)
3.2.5. Click on your profile picture and then on the "Organization" menu to get the Organization ID
3.2.6. Use the Organization ID and private key to create the struct below:
package main
import (
"fmt"
Balance "github.com/starkbank/sdk-go/starkbank/balance"
"github.com/starkinfra/core-go/starkcore/user/organization"
"github.com/starkinfra/core-go/starkcore/utils/checks"
)
// Get your private key from an environment variable or an encrypted database.
// This is only an example of a private key content. You should use your own key.
var privateKeyContent = "-----BEGIN EC PRIVATE KEY-----\nMHQCAQEEILChZrjrrtFnyCLhcxm/hp+9ljWSmG7Wv9HRugf+FnhkoAcGBSuBBAAK\noUQDQgAEpIAM/tMqXEfLeR93rRHiFcpDB9I18MrnCJyTVk0MdD1J9wgEbRfvAZEL\nYcEGhTFYp2X3B7K7c4gDDCr0Pu1L3A==\n-----END EC PRIVATE KEY-----\n"
var organization = organization.Organization{
Id: "5656565656565656",
PrivateKey: checks.CheckPrivateKey(privateKeyContent),
Environment: checks.CheckEnvironment("sandbox"),
}
// To dynamically use your organization credentials in a specific workspaceId,
// you can use the organization.Replace() function:
func main() {
balance := Balance.Get(organization.Replace("4848484848484848"))
fmt.Println(balance)
}NOTE 1: Never hard-code your private key. Get it from an environment variable or an encrypted database.
NOTE 2: We support 'sandbox' and 'production' as environments.
NOTE 3: The credentials you registered in sandbox do not exist in production and vice versa.
There are three kinds of users that can access our API: Organization, Project and Member.
ProjectandOrganizationare designed for integrations and are the ones meant for our SDKs.Memberis the one you use when you log into our webpage with your e-mail.
There are two ways to inform the user to the SDK:
4.1 Passing the user as argument in all functions:
package main
import (
"fmt"
Balance "github.com/starkbank/sdk-go/starkbank/balance"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
balance := Balance.Get(utils.ExampleProject) // or organization
fmt.Println(balance)
}4.2 Set it as a default user in the SDK:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Balance "github.com/starkbank/sdk-go/starkbank/balance"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
balance := Balance.Get(nil) // or organization
fmt.Println(balance)
}The error language can also be set in the same way as the default user:
package main
import (
"github.com/starkbank/sdk-go/starkbank"
)
func main() {
starkbank.Language = "pt-BR"
}Language options are "en-US" for english and "pt-BR" for brazilian portuguese. English is default.
Almost all SDK resources provide a query and a page function.
-
The
queryfunction provides a straight forward way, through achannel, to efficiently iterate through all results that match the filters you inform, seamlessly retrieving the next batch of elements from the API only when you reach the end of the current batch. If you are not worried about data volume or processing time, this is the way to go. -
In this function, in particular, when an error is encountered a
panic()is raised with the code and error's message
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Transaction "github.com/starkbank/sdk-go/starkbank/transaction"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["limit"] = 200
transactions := Transaction.Query(params, nil)
for transaction := range transactions {
fmt.Println(transaction)
}
}- The
pagefunction gives you full control over the API pagination. With each function call, you receive up to 100 results and the cursor to retrieve the next batch of elements. This allows you to stop your queries and pick up from where you left off whenever it is convenient. When there are no more elements to be retrieved, the returned cursor will benil.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Transaction "github.com/starkbank/sdk-go/starkbank/transaction"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["limit"] = 50
for true {
transactions, cursor, err := Transaction.Page(params, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
for _, transaction := range transactions {
fmt.Println(transaction)
}
if cursor == "" {
break
}
}
}To simplify the following SDK examples, we will only use the query function, but feel free to use page instead.
Your initial balance is zero. For many operations in Stark Bank, you'll need funds in your account, which can be added to your balance by creating an Invoice or a Boleto.
In the Sandbox environment, most of the created Invoices and Boletos will be automatically paid, so there's nothing else you need to do to add funds to your account. Just create a few Invoices and wait around a bit.
In Production, you (or one of your clients) will need to actually pay this Invoice or Boleto for the value to be credited to your account.
Here are a few examples on how to use the SDK. If you have any doubts, check out the function or class docstring to get more info or go straight to our [API docs].
To send money between Stark Bank accounts, you can create transactions:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Transaction "github.com/starkbank/sdk-go/starkbank/transaction"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
transactions, err := Transaction.Create(
[]Transaction.Transaction{
{
Amount: 10000,
ReceiverId: "5768064935133184",
Description: "Paying my debts",
ExternalId: "my_external_id",
},
}, utils.Project)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
for _, transaction := range transactions {
fmt.Println(transaction)
}
}Note: Instead of using Transaction structs, you can also pass each transaction element in map format
To understand your balance changes (bank statement), you can query transactions. Note that our system creates transactions for you when you receive boleto payments, pay a bill or make transfers, for example.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Transaction "github.com/starkbank/sdk-go/starkbank/transaction"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["limit"] = 200
transactions := Transaction.Query(params, nil)
for transaction := range transactions {
fmt.Println(transaction)
}
}You can get a specific transaction by its id:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Transaction "github.com/starkbank/sdk-go/starkbank/transaction"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
transaction, err := Transaction.Get("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(transaction)
}To know how much money you have in your workspace, run:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Balance "github.com/starkbank/sdk-go/starkbank/balance"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
balance := Balance.Get(nil)
fmt.Println(balance)
}You can also create transfers in the SDK (TED/Pix).
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Transfer "github.com/starkbank/sdk-go/starkbank/transfer"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
transfers, err := Transfer.Create(
[]Transfer.Transfer{
{
Amount: 100,
Name: "Tony Stark",
TaxId: "012.345.678-90",
BankCode: "033", // TED
BranchCode: "0001",
AccountNumber: "10000-0",
},
{
Amount: 200,
Name: "Jon Snow",
TaxId: "012.345.678-90",
BankCode: "20018183", //Pix
BranchCode: "1234",
AccountNumber: "123456-7",
AccountType: "salary",
ExternalId: "my-internal-id-12345",
},
}, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
for _, transfer := range transfers {
fmt.Println(transfer)
}
}Note: Instead of using Transfer structs, you can also pass each transfer element in map format
You can query multiple transfers according to filters.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Transfer "github.com/starkbank/sdk-go/starkbank/transfer"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["after"] = "2020-01-01"
params["before"] = "2020-04-01"
transfers := Transfer.Query(params, nil)
for transfer := range transfers {
fmt.Println(transfer.Name)
}
}To cancel a single scheduled transfer by its id, run:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Transfer "github.com/starkbank/sdk-go/starkbank/transfer"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
transfer, err := Transfer.Delete("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(transfer)
}To get a single transfer by its id, run:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Transfer "github.com/starkbank/sdk-go/starkbank/transfer"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
transfer, err := Transfer.Get("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(transfer)
}A transfer PDF may also be retrieved by its id. This operation is only valid if the transfer status is "processing" or "success".
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Transfer "github.com/starkbank/sdk-go/starkbank/transfer"
"github.com/starkbank/sdk-go/tests/utils"
"io/ioutil"
)
func main() {
starkbank.User = utils.ExampleProject
pdf, err := Transfer.Pdf("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
filename := fmt.Sprintf("%v%v.pdf", "transfer", "5155165527080960")
errFile := ioutil.WriteFile(filename, pdf, 0666)
if errFile != nil {
fmt.Print(errFile)
}
}Be careful not to accidentally enforce any encoding on the raw pdf content, as it may yield abnormal results in the final file, such as missing images and strange characters.
You can query transfer logs to better understand transfer life cycles.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/transfer/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["limit"] = 50
logs := Log.Query(params, nil)
for log := range logs {
fmt.Println(log)
}
}You can also get a specific log by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/transfer/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
log, err := Log.Get("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(log)
}You can get the Pix key's parameters by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
DictKey "github.com/starkbank/sdk-go/starkbank/dictkey"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
key, err := DictKey.Get("[email protected]", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(key)
}To take a look at the Pix keys linked to your workspace, just run the following:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
DictKey "github.com/starkbank/sdk-go/starkbank/dictkey"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["status"] = "registered"
keys := DictKey.Query(params, nil)
for key := range keys {
fmt.Println(key)
}
}You can query institutions registered by the Brazilian Central Bank for Pix and TED transactions.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Institution "github.com/starkbank/sdk-go/starkbank/institution"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["search"] = "stark"
institutions := Institution.Query(params, nil)
for institution := range institutions {
fmt.Println(institution)
}
}You can create dynamic QR Code invoices to charge customers or to receive money from accounts you have in other banks.
Since the banking system only understands value modifiers (discounts, fines and interest) when dealing with dates ( instead of datetimes), these values will only show up in the end user banking interface if you use dates in the "due" and "discounts" fields.
If you use datetimes instead, our system will apply the value modifiers in the same manner, but the end user will only see the final value to be paid on his interface.
Also, other banks will most likely only allow payment scheduling on invoices defined with dates instead of * datetimes*.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Invoice "github.com/starkbank/sdk-go/starkbank/invoice"
"github.com/starkbank/sdk-go/tests/utils"
"time"
)
func main() {
starkbank.User = utils.ExampleProject
due := time.Now().Add(time.Hour * 1)
due2 := time.Date(2022, 03, 20, 0, 0, 0, 0, time.UTC)
invoices, err := Invoice.Create(
[]Invoice.Invoice{
{
Amount: 23571, // R$ 235,71
Name: "Buzz Aldrin",
TaxId: "012.345.678-90",
Due: &due,
Fine: 5, // 5%
Interest: 2.5, // 2.5% per month
Tags: []string{"imediate"},
},
{
Amount: 923571, // R$ 235,71
Name: "Buzz Aldrin",
TaxId: "012.345.678-90",
Due: &due2,
Fine: 5, // 5%
Interest: 2.5, // 2.5% per month
Tags: []string{"scheduled"},
},
}, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
for _, invoice := range invoices {
fmt.Println(invoice)
}
}Note: Instead of using Invoice structs, you can also pass each invoice element in map format
After its creation, information on an invoice may be retrieved by its id. Its status indicates whether it's been paid.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Invoice "github.com/starkbank/sdk-go/starkbank/invoice"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
invoice, err := Invoice.Get("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(invoice)
}After its creation, an invoice PDF may be retrieved by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Invoice "github.com/starkbank/sdk-go/starkbank/invoice"
"github.com/starkbank/sdk-go/tests/utils"
"io/ioutil"
)
func main() {
starkbank.User = utils.ExampleProject
pdf, err := Invoice.Pdf("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
filename := fmt.Sprintf("%v%v.pdf", "invoice", "5155165527080960")
errFile := ioutil.WriteFile(filename, pdf, 0666)
if errFile != nil {
fmt.Print(errFile)
}
}Be careful not to accidentally enforce any encoding on the raw pdf content, as it may yield abnormal results in the final file, such as missing images and strange characters.
After its creation, an Invoice QR Code may be retrieved by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Invoice "github.com/starkbank/sdk-go/starkbank/invoice"
"github.com/starkbank/sdk-go/tests/utils"
"io/ioutil"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["size"] = 10
qrcode, err := Invoice.Qrcode("5155165527080960", params, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
filename := fmt.Sprintf("%v%v.png", "invoice", "5155165527080960")
errFile := ioutil.WriteFile(filename, qrcode, 0666)
if errFile != nil {
fmt.Print(errFile)
}
}Be careful not to accidentally enforce any encoding on the raw png content, as it may corrupt the file.
You can also cancel an invoice by its id. Note that this is not possible if it has been paid already.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Invoice "github.com/starkbank/sdk-go/starkbank/invoice"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var patchData = map[string]interface{}{}
patchData["status"] = "canceled"
invoice, err := Invoice.Update("5155165527080960", patchData, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(invoice)
}You can update an invoice's amount, due date and expiration by its id. If the invoice has already been paid, only the amount can be decreased, which will result in a payment reversal. To fully reverse the invoice, pass amount = 0.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Invoice "github.com/starkbank/sdk-go/starkbank/invoice"
"github.com/starkbank/sdk-go/tests/utils"
"time"
)
func main() {
starkbank.User = utils.ExampleProject
var patchData = map[string]interface{}{}
patchData["amount"] = 100
patchData["expiration"] = 0
patchData["due"] = time.Now().Add(time.Hour * 1)
invoice, err := Invoice.Update("5155165527080960", patchData, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(invoice)
}You can get a list of created invoices given some filters.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Invoice "github.com/starkbank/sdk-go/starkbank/invoice"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["after"] = "2020-01-01"
params["before"] = "2020-03-01"
invoices := Invoice.Query(params, nil)
for invoice := range invoices {
fmt.Println(invoice)
}
}Logs are pretty important to understand the life cycle of an invoice.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/invoice/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["limit"] = 150
logs := Log.Query(params, nil)
for log := range logs {
fmt.Println(log)
}
}You can get a single log by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/invoice/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
log, err := Log.Get("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(log)
}Whenever an Invoice is successfully reversed, a reversed log will be created. To retrieve a specific reversal receipt, you can request the corresponding log PDF:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/invoice/log"
"github.com/starkbank/sdk-go/tests/utils"
"io/ioutil"
)
func main() {
starkbank.User = utils.ExampleProject
pdf, err := Log.Pdf("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
filename := fmt.Sprintf("%v%v.pdf", "invoice-log", "5155165527080960")
errFile := ioutil.WriteFile(filename, pdf, 0666)
if errFile != nil {
fmt.Print(errFile)
}
}Be careful not to accidentally enforce any encoding on the raw pdf content, as it may yield abnormal results in the final file, such as missing images and strange characters.
Once an invoice has been paid, you can get the payment information using the Invoice.Payment sub-resource:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Invoice "github.com/starkbank/sdk-go/starkbank/invoice"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
payment, err := Invoice.GetPayment("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(payment)
}You can create simplified dynamic QR Codes to receive money using Pix transactions. When a DynamicBrcode is paid, a Deposit is created with the tags parameter containing the character “dynamic-brcode/” followed by the DynamicBrcode’s uuid "dynamic-brcode/{uuid}" for conciliation.
The differences between an Invoice and the DynamicBrcode are the following:
| Invoice | DynamicBrcode | |
|---|---|---|
| Expiration | âś“ | âś“ |
| Due, fine and fee | âś“ | X |
| Discount | âś“ | X |
| Description | âś“ | X |
| Can be updated | âś“ | X |
| Can only be paid once | âś“ | âś“ |
Note: In order to check if a BR code has expired, you must first calculate its expiration date (add the expiration to the creation date). Note: To know if the BR code has been paid, you need to query your Deposits by the tag "dynamic-brcode/{uuid}" to check if it has been paid.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/dynamicbrcode"
"github.com/starkbank/sdk-go/tests/utils"
"math/rand"
)
func main() {
starkbank.User = utils.ExampleProject
brcodes, err := dynamicbrcode.Create(
[]dynamicbrcode.DynamicBrcode{
{
Amount: 23571,
Expiration: rand.Intn(3600),
}, {
Amount: 23571, // R$ 235,71
Expiration: rand.Intn(3600),
},
}, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
for brcode := range brcodes {
fmt.Println(brcode)
}
}Note: Instead of using DynamicBrcode objects, you can also pass each brcode element in dictionary format
After its creation, information on a DynamicBrcode may be retrieved by its uuid.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/dynamicbrcode"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
brcode, err := dynamicbrcode.Get("bb9cd43ea6f4403391bf7ef6aa876600", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(brcode)
}You can get a list of created DynamicBrcodes given some filters.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/dynamicbrcode"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["limit"] = 4
brcodes := dynamicbrcode.Query(params, nil)
for brcode := range brcodes {
fmt.Println(brcode)
}
}You can get a list of created deposits given some filters.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Deposit "github.com/starkbank/sdk-go/starkbank/deposit"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["after"] = "2020-01-01"
params["before"] = "2020-03-01"
deposits := Deposit.Query(params, nil)
for deposit := range deposits {
fmt.Println(deposit)
}
}After its creation, information on a deposit may be retrieved by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Deposit "github.com/starkbank/sdk-go/starkbank/deposit"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
deposit, err := Deposit.Get("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(deposit)
}Logs are pretty important to understand the life cycle of a deposit.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/deposit/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["limit"] = 150
logs := Log.Query(params, nil)
for log := range logs {
fmt.Println(log)
}
}You can get a single log by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/deposit/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
log, err := Log.Get("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(log)
}You can create boletos to charge customers or to receive money from accounts you have in other banks.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Boleto "github.com/starkbank/sdk-go/starkbank/boleto"
"github.com/starkbank/sdk-go/tests/utils"
"time"
)
func main() {
starkbank.User = utils.ExampleProject
due := time.Date(time.Now().Year(), time.Now().Month(), time.Now().Day(), 0, 0, 0, 0, time.UTC)
boletos, err := Boleto.Create(
[]Boleto.Boleto{
{
Amount: 23571, //R$235,71
Name: "Buzz Aldrin",
TaxId: "012.345.678-90",
StreetLine1: "Av. Paulista, 200",
StreetLine2: "10 Andar",
District: "Bela Vista",
City: "SĂŁo Paulo",
StateCode: "SP",
ZipCode: "01420-020",
Due: &due,
Fine: 5, //5%
Interest: 2.5, //2.5% per month
},
}, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
for _, boleto := range boletos {
fmt.Println(boleto)
}
}Note: Instead of using Boleto structs, you can also pass each boleto element in map format
After its creation, information on a boleto may be retrieved by its id. Its status indicates whether it's been paid.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Boleto "github.com/starkbank/sdk-go/starkbank/boleto"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
boleto, err := Boleto.Get("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(boleto)
}After its creation, a boleto PDF may be retrieved by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Boleto "github.com/starkbank/sdk-go/starkbank/boleto"
"github.com/starkbank/sdk-go/tests/utils"
"io/ioutil"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["layout"] = "booklet"
pdf, err := Boleto.Pdf("5155165527080960", params, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
filename := fmt.Sprintf("%v%v.pdf", "boleto", "5155165527080960")
errFile := ioutil.WriteFile(filename, pdf, 0666)
if errFile != nil {
fmt.Print(errFile)
}
}Be careful not to accidentally enforce any encoding on the raw pdf content, as it may yield abnormal results in the final file, such as missing images and strange characters.
You can also cancel a boleto by its id. Note that this is not possible if it has been processed already.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Boleto "github.com/starkbank/sdk-go/starkbank/boleto"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
boleto, err := Boleto.Delete("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(boleto)
}You can get a list of created boletos given some filters.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Boleto "github.com/starkbank/sdk-go/starkbank/boleto"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["after"] = "2020-01-01"
params["before"] = "2020-03-01"
boletos := Boleto.Query(params, nil)
for boleto := range boletos {
fmt.Println(boleto)
}
}Logs are pretty important to understand the life cycle of a boleto.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/boleto/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["limit"] = 150
logs := Log.Query(params, nil)
for log := range logs {
fmt.Println(log)
}
}You can get a single log by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/boleto/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
log, err := Log.Get("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(log)
}You can discover if a StarkBank boleto has been recently paid before we receive the response on the next day. This can be done by creating a BoletoHolmes struct, which fetches the updated status of the corresponding Boleto struct according to CIP to check, for example, whether it is still payable or not. The investigation happens asynchronously and the most common way to retrieve the results is to register a "boleto-holmes" webhook subscription, although polling is also possible.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Holmes "github.com/starkbank/sdk-go/starkbank/boletoholmes"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
holmes, err := Holmes.Create(
[]Holmes.BoletoHolmes{
{
BoletoId: "5656565656565656",
},
{
BoletoId: "4848484848484848",
},
}, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
for _, holmes := range holmes {
fmt.Println(holmes)
}
}Note: Instead of using BoletoHolmes structs, you can also pass each payment element in map format
To get a single Holmes by its id, run:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Holmes "github.com/starkbank/sdk-go/starkbank/boletoholmes"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
holmes, err := Holmes.Get("19278361897236187236", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(holmes)
}You can search for boleto Holmes using filters.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Holmes "github.com/starkbank/sdk-go/starkbank/boletoholmes"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["holmesIds"] = []string{"customer_1", "customer_2"}
holmes := Holmes.Query(params, nil)
for holmes := range holmes {
fmt.Println(holmes)
}
}Searches are also possible with boleto holmes logs:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/boletoholmes/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["holmesIds"] = []string{"5155165527080960", "76551659167801921"}
logs := Log.Query(params, nil)
for log := range logs {
fmt.Println(log)
}
}You can also get a boleto holmes log by specifying its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/boletoholmes/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
log, err := Log.Get("19278361897236187236", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(log)
}Paying a BR Code is also simple. After extracting the BRCode encoded in the Pix QR Code, you can do the following:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
BrcodePayment "github.com/starkbank/sdk-go/starkbank/brcodepayment"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
payments, err := BrcodePayment.Create(
[]BrcodePayment.BrcodePayment{
{
Brcode: "00020101021226930014br.gov.bcb.pix2571brcode-h.sandbox.starkinfra.com/v2/09a7970542fe4399ab2af079982bb1005204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044AC2",
TaxId: "38.446.231/0001-04",
Description: "this will be fast",
Tags: []string{"pix", "qrcode"},
},
}, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
for _, payment := range payments {
fmt.Println(payment)
}
}Note: Instead of using BrcodePayment structs, you can also pass each payment element in map format
To get a single BR Code payment by its id, run:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
BrcodePayment "github.com/starkbank/sdk-go/starkbank/brcodepayment"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
payment, err := BrcodePayment.Get("19278361897236187236", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(payment)
}After its creation, a BR Code payment PDF may be retrieved by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
BrcodePayment "github.com/starkbank/sdk-go/starkbank/brcodepayment"
"github.com/starkbank/sdk-go/tests/utils"
"io/ioutil"
)
func main() {
starkbank.User = utils.ExampleProject
pdf, err := BrcodePayment.Pdf("19278361897236187236", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
filename := fmt.Sprintf("%v%v.pdf", "brcode-payment", "19278361897236187236")
errFile := ioutil.WriteFile(filename, pdf, 0666)
if errFile != nil {
fmt.Print(errFile)
}
}Be careful not to accidentally enforce any encoding on the raw pdf content, as it may yield abnormal results in the final file, such as missing images and strange characters.
You can cancel a BR Code payment by changing its status to "canceled". Note that this is not possible if it has been processed already.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
BrcodePayment "github.com/starkbank/sdk-go/starkbank/brcodepayment"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var patchData = map[string]interface{}{}
patchData["status"] = "canceled"
payment, err := BrcodePayment.Update("19278361897236187236", patchData, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(payment)
}You can search for brcode payments using filters.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
BrcodePayment "github.com/starkbank/sdk-go/starkbank/brcodepayment"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["tags"] = []string{"company_1", "company_2"}
payments := BrcodePayment.Query(params, nil)
for payment := range payments {
fmt.Println(payment)
}
}Searches are also possible with BR Code payment logs:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/brcodepayment/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["paymentIds"] = []string{"5155165527080960", "76551659167801921"}
logs := Log.Query(params, nil)
for log := range logs {
fmt.Println(log)
}
}You can also get a BR Code payment log by specifying its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/brcodepayment/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
payment, err := Log.Get("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(payment)
}Paying a boleto is also simple.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
BoletoPayment "github.com/starkbank/sdk-go/starkbank/boletopayment"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
payments, err := BoletoPayment.Create(
[]BoletoPayment.BoletoPayment{
{
TaxId: "20.018.183/0001-80",
Description: "take my money",
Line: "34191.09008 76038.597308 71444.640008 4 92150000028000",
},
{
TaxId: "20.018.183/0001-80",
Description: "take my money one more time",
BarCode: "34197819200000000011090063609567307144464000",
},
}, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
for _, payment := range payments {
fmt.Println(payment)
}
}Note: Instead of using BoletoPayment structs, you can also pass each payment element in map format
To get a single boleto payment by its id, run:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
BoletoPayment "github.com/starkbank/sdk-go/starkbank/boletopayment"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
payment, err := BoletoPayment.Get("19278361897236187236", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(payment)
}After its creation, a boleto payment PDF may be retrieved by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
BoletoPayment "github.com/starkbank/sdk-go/starkbank/boletopayment"
"github.com/starkbank/sdk-go/tests/utils"
"io/ioutil"
)
func main() {
starkbank.User = utils.ExampleProject
pdf, err := BoletoPayment.Pdf("19278361897236187236", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
filename := fmt.Sprintf("%v%v.pdf", "boleto-payment", "19278361897236187236")
errFile := ioutil.WriteFile(filename, pdf, 0666)
if errFile != nil {
fmt.Print(errFile)
}
}Be careful not to accidentally enforce any encoding on the raw pdf content, as it may yield abnormal results in the final file, such as missing images and strange characters.
You can also cancel a boleto payment by its id. Note that this is not possible if it has been processed already.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
BoletoPayment "github.com/starkbank/sdk-go/starkbank/boletopayment"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
payment, err := BoletoPayment.Delete("19278361897236187236", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(payment)
}You can search for boleto payments using filters.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
BoletoPayment "github.com/starkbank/sdk-go/starkbank/boletopayment"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["tags"] = []string{"company_1", "company_2"}
payments := BoletoPayment.Query(params, nil)
for payment := range payments {
fmt.Println(payment)
}
}Searches are also possible with boleto payment logs:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/boletopayment/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["paymentIds"] = []string{"5155165527080960", "76551659167801921"}
logs := Log.Query(params, nil)
for log := range logs {
fmt.Println(log)
}
}You can also get a boleto payment log by specifying its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/boletopayment/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
log, err := Log.Get("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(log)
}It's also simple to pay utility bills (such as electricity and water bills) in the SDK.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
UtilityPayment "github.com/starkbank/sdk-go/starkbank/utilitypayment"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
payments, err := UtilityPayment.Create(
[]UtilityPayment.UtilityPayment{
{
Line: "3419109107 41224987309 71444640008 9 91800999999999",
Description: "take my money",
Tags: []string{"take", "my", "money"},
},
{
BarCode: "34194918109999999991091041242887307144464000",
Description: "take my money one more time",
Tags: []string{"again"},
},
}, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
for _, payment := range payments {
fmt.Println(payment)
}
}Note: Instead of using UtilityPayment structs, you can also pass each payment element in map format
To search for utility payments using filters, run:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
UtilityPayment "github.com/starkbank/sdk-go/starkbank/utilitypayment"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["tags"] = []string{"eletricity", "gas"}
payments := UtilityPayment.Query(params, nil)
for payment := range payments {
fmt.Println(payment)
}
}You can get a specific bill by its id:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
UtilityPayment "github.com/starkbank/sdk-go/starkbank/utilitypayment"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
payment, err := UtilityPayment.Get("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(payment)
}After its creation, a utility payment PDF may also be retrieved by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
UtilityPayment "github.com/starkbank/sdk-go/starkbank/utilitypayment"
"github.com/starkbank/sdk-go/tests/utils"
"io/ioutil"
)
func main() {
starkbank.User = utils.ExampleProject
pdf, err := UtilityPayment.Pdf("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
filename := fmt.Sprintf("%v%v.pdf", "utility-payment", "5155165527080960")
errFile := ioutil.WriteFile(filename, pdf, 0666)
if errFile != nil {
fmt.Print(errFile)
}
}Be careful not to accidentally enforce any encoding on the raw pdf content, as it may yield abnormal results in the final file, such as missing images and strange characters.
You can also cancel a utility payment by its id. Note that this is not possible if it has been processed already.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
UtilityPayment "github.com/starkbank/sdk-go/starkbank/utilitypayment"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
payment, err := UtilityPayment.Delete("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(payment)
}You can search for payments by specifying filters. Use this to understand the bills life cycles.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/utilitypayment/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["paymentIds"] = []string{"102893710982379182", "92837912873981273"}
logs := Log.Query(params, nil)
for log := range logs {
fmt.Println(log)
}
}If you want to get a specific payment log by its id, just run:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/utilitypayment/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
log, err := Log.Get("1902837198237992", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(log)
}It is also simple to pay taxes (such as ISS and DAS) using this SDK.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
TaxPayment "github.com/starkbank/sdk-go/starkbank/taxpayment"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
payments, err := TaxPayment.Create(
[]TaxPayment.TaxPayment{
{
BarCode: "83660000001084301380074119002551100010601813",
Description: "fix the road",
Tags: []string{"take", "my", "money"},
},
{
Line: "85800000003 0 28960328203 1 56072020190 5 22109674804 0",
Description: "build the hospital, hopefully",
Tags: []string{"expensive"},
},
}, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
for _, payment := range payments {
fmt.Println(payment)
}
}Note: Instead of using TaxPayment structs, you can also pass each payment element in map format
To search for tax payments using filters, run:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
TaxPayment "github.com/starkbank/sdk-go/starkbank/taxpayment"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["tags"] = []string{"das", "july"}
payments := TaxPayment.Query(params, nil)
for payment := range payments {
fmt.Println(payment)
}
}You can get a specific tax payment by its id:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
TaxPayment "github.com/starkbank/sdk-go/starkbank/taxpayment"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
payment, err := TaxPayment.Get("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(payment)
}After its creation, a tax payment PDF may also be retrieved by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
TaxPayment "github.com/starkbank/sdk-go/starkbank/taxpayment"
"github.com/starkbank/sdk-go/tests/utils"
"io/ioutil"
)
func main() {
starkbank.User = utils.ExampleProject
pdf, err := TaxPayment.Pdf("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
filename := fmt.Sprintf("%v%v.pdf", "tax-payment", "5155165527080960")
errFile := ioutil.WriteFile(filename, pdf, 0666)
if errFile != nil {
fmt.Print(errFile)
}
}Be careful not to accidentally enforce any encoding on the raw pdf content, as it may yield abnormal results in the final file, such as missing images and strange characters.
You can also cancel a tax payment by its id. Note that this is not possible if it has been processed already.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
TaxPayment "github.com/starkbank/sdk-go/starkbank/taxpayment"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
payment, err := TaxPayment.Delete("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(payment)
}You can search for payment logs by specifying filters. Use this to understand each payment life cycle.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/taxpayment/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["limit"] = 10
logs := Log.Query(params, nil)
for log := range logs {
fmt.Println(log)
}
}If you want to get a specific payment log by its id, just run:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/taxpayment/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
log, err := Log.Get("1902837198237992", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(log)
}Note: Some taxes can't be paid with bar codes. Since they have specific parameters, each one of them has its own resource and routes, which are all analogous to the TaxPayment resource. The ones we currently support are:
- DarfPayment, for DARFs
If you want to manually pay DARFs without barcodes, you may create DarfPayments:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
DarfPayment "github.com/starkbank/sdk-go/starkbank/darfpayment"
"github.com/starkbank/sdk-go/tests/utils"
"time"
)
func main() {
starkbank.User = utils.ExampleProject
competence := time.Date(2022, 10, 28, 0, 0, 0, 0, time.UTC)
due := time.Now().Add(time.Hour * 24 * 30)
scheduled := time.Now().Add(time.Hour * 24 * 30)
payments, err := DarfPayment.Create(
[]DarfPayment.DarfPayment{
{
Description: "take my money",
RevenueCode: "1240",
TaxId: "012.345.678-90",
ReferenceNumber: "2340978970",
Competence: &competence,
NominalAmount: 1234,
FineAmount: 12,
InterestAmount: 34,
Due: &due,
Scheduled: &scheduled,
Tags: []string{"DARF", "making money"},
},
}, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
for _, payment := range payments {
fmt.Println(payment)
}
}Note: Instead of using DarfPayment structs, you can also pass each payment element in map format
To search for DARF payments using filters, run:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
DarfPayment "github.com/starkbank/sdk-go/starkbank/darfpayment"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["tags"] = []string{"darf", "july"}
payments := DarfPayment.Query(params, nil)
for payment := range payments {
fmt.Println(payment)
}
}You can get a specific DARF payment by its id:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
DarfPayment "github.com/starkbank/sdk-go/starkbank/darfpayment"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
payment, err := DarfPayment.Get("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(payment)
}After its creation, a DARF payment PDF may also be retrieved by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
DarfPayment "github.com/starkbank/sdk-go/starkbank/darfpayment"
"github.com/starkbank/sdk-go/tests/utils"
"io/ioutil"
)
func main() {
starkbank.User = utils.ExampleProject
pdf, err := DarfPayment.Pdf("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
filename := fmt.Sprintf("%v%v.pdf", "darf-paymet", "5155165527080960")
errFile := ioutil.WriteFile(filename, pdf, 0666)
if errFile != nil {
fmt.Print(errFile)
}
}Be careful not to accidentally enforce any encoding on the raw pdf content, as it may yield abnormal results in the final file, such as missing images and strange characters.
You can also cancel a DARF payment by its id. Note that this is not possible if it has been processed already.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
DarfPayment "github.com/starkbank/sdk-go/starkbank/darfpayment"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
payment, err := DarfPayment.Delete("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(payment)
}You can search for payment logs by specifying filters. Use this to understand each payment life cycle.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/darfpayment/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["limit"] = 10
logs := Log.Query(params, nil)
for log := range logs {
fmt.Println(log)
}
}If you want to get a specific payment log by its id, just run:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/darfpayment/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
log, err := Log.Get("5155165527080960", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(log)
}You can preview multiple types of payment to confirm any information before actually paying. If the "scheduled" parameter is not informed, today will be assumed as the intended payment date. Right now, the "scheduled" parameter only has effect on BrcodePreviews. This resource is able to preview the following types of payment: "brcode-payment", "boleto-payment", "utility-payment" and "tax-payment"
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
PaymentPreview "github.com/starkbank/sdk-go/starkbank/paymentpreview"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
previews, err := PaymentPreview.Create(
[]PaymentPreview.PaymentPreview{
{
Id: "00020101021226930014br.gov.bcb.pix2571brcode-h.sandbox.starkinfra.com/v2/09a7970542fe4399ab2af079982bb1005204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044AC2",
},
}, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
for _, preview := range previews {
fmt.Println(preview)
}
}Note: Instead of using PaymentPreview structs, you can also pass each request element in map format
You can also request payments that must pass through a specific cost center approval flow to be executed. In certain structures, this allows double checks for cash-outs and also gives time to load your account with the required amount before the payments take place. The approvals can be granted at our website and must be performed according to the rules specified in the cost center.
Note: The value of the centerId parameter can be consulted by logging into our website and going to the desired cost center page.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
PaymentRequest "github.com/starkbank/sdk-go/starkbank/paymentrequest"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
requests, err := PaymentRequest.Create(
[]PaymentRequest.PaymentRequest{
{
Amount: 12345,
},
{
Amount: 67890,
},
}, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
for _, request := range requests {
fmt.Println(request)
}
}Note: Instead of using PaymentRequest structs, you can also pass each request element in map format
To search for payment requests, run:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
PaymentRequest "github.com/starkbank/sdk-go/starkbank/paymentrequest"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["status"] = "approved"
requests := PaymentRequest.Query("123456778890", params, nil)
for request := range requests {
fmt.Println(request)
}
}You can create card holders to which your cards will be bound. They support spending rules that will apply to all underlying cards.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/corporateholder"
"github.com/starkbank/sdk-go/starkbank/corporaterule"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
holders, err := corporateholder.Create(
[]corporateholder.CorporateHolder{
{
Name: "Iron Bank S.A.",
Tags: []string{"Traveler Employee"},
Rules: []corporaterule.CorporateRule{
{
Name: "General USD",
Interval: "day",
Amount: 100000,
CurrencyCode: "USD",
},
},
},
{
Name: "Iron Bank S.A.",
},
}, nil, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
for _, holder := range holders {
fmt.Println(holder)
}
}Note: Instead of using CorporateHolder objects, you can also pass each element in dictionary format
You can query multiple holders according to filters.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/corporateholder"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["limit"] = 10
holders := corporateholder.Query(params, nil)
for holder := range holders {
fmt.Println(holder)
}
}To cancel a single Corporate Holder by its id, run:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/corporateholder"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
holder, err := corporateholder.Cancel("5353197895942144", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(holder)
}To get a single Corporate Holder by its id, run:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/corporateholder"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
holder, err := corporateholder.Get("5353197895942144", nil, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(holder)
}You can query holder logs to better understand holder life cycles.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/corporateholder/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["limit"] = 10
logs := Log.Query(params, nil)
for log := range logs {
fmt.Println(log)
}
}You can also get a specific log by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/corporateholder/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
log, err := Log.Get("5353197895942144", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(log)
}You can issue cards with specific spending rules.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/corporatecard"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
card, err := corporatecard.Create(
corporatecard.CorporateCard{
HolderId: "5155165527080960",
}, nil, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(card)
}You can get a list of created cards given some filters.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/corporatecard"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["limit"] = 10
cards := corporatecard.Query(params, nil)
for card := range cards {
fmt.Println(card)
}
}After its creation, information on a card may be retrieved by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/corporatecard"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
card, err := corporatecard.Get("5353197895942144", nil, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(card)
}You can update a specific card by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/corporatecard"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var patchData = map[string]interface{}{}
patchData["status"] = "blocked"
card, err := corporatecard.Update("5353197895942144", patchData, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(card)
}You can also cancel a card by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/corporatecard"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
card, err := corporatecard.Cancel("5353197895942144", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(card)
}Logs are pretty important to understand the life cycle of a card.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/corporatecard/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["limit"] = 10
logs := Log.Query(params, nil)
for log := range logs {
fmt.Println(log)
}
}You can get a single log by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/corporatecard/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
log, err := Log.Get("5353197895942144", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(log)
}You can get a list of created purchases given some filters.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/corporatepurchase"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["limit"] = 10
purchases := corporatepurchase.Query(params, nil)
for purchase := range purchases {
fmt.Println(purchase)
}
}After its creation, information on a purchase may be retrieved by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/corporatepurchase"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
purchase, err := corporatepurchase.Get("5353197895942144", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(purchase)
}Logs are pretty important to understand the life cycle of a purchase.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/corporatepurchase/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["limit"] = 10
logs := Log.Query(params, nil)
for log := range logs {
fmt.Println(log)
}
}You can get a single log by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Log "github.com/starkbank/sdk-go/starkbank/corporatepurchase/log"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
log, err := Log.Get("5353197895942144", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(log)
}You can create Pix invoices to transfer money from accounts you have in any bank to your Corporate balance, allowing you to run your corporate operation.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/corporateinvoice"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
invoice, err := corporateinvoice.Create(
corporateinvoice.CorporateInvoice{
Amount: 10000,
}, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(invoice)
}Note: Instead of using CorporateInvoice objects, you can also pass each element in dictionary format
You can get a list of created invoices given some filters.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/corporateinvoice"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["limit"] = 10
invoices := corporateinvoice.Query(params, nil)
for invoice := range invoices {
fmt.Println(invoice)
}
}You can create withdrawals to send cash back from your Corporate balance to your Banking balance by using the Withdrawal resource.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/corporatewithdrawal"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
withdrawal, err := corporatewithdrawal.Create(
corporatewithdrawal.CorporateWithdrawal{
Amount: 10000,
ExternalId: "my-external-id",
}, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(withdrawal)
}Note: Instead of using CorporateWithdrawal objects, you can also pass each element in dictionary format
After its creation, information on a withdrawal may be retrieved by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/corporatewithdrawal"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
withdrawal, err := corporatewithdrawal.Get("5353197895942144", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(withdrawal)
}You can get a list of created withdrawals given some filters.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/corporatewithdrawal"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["limit"] = 10
withdrawals := corporatewithdrawal.Query(params, nil)
for withdrawal := range withdrawals {
fmt.Println(withdrawal)
}
}To know how much money you have available to run authorizations, run:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/corporatebalance"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
balance := corporatebalance.Get(nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(balance)
}To understand your balance changes (corporate statement), you can query transactions. Note that our system creates transactions for you when you make purchases, withdrawals, receive corporate invoice payments, for example.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/corporatetransaction"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["limit"] = 10
transactions := corporatetransaction.Query(params, nil)
for transaction := range transactions {
fmt.Println(transaction)
}
}You can get a specific transaction by its id:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/corporatetransaction"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
transaction, err := corporatetransaction.Get("5353197895942144", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(transaction)
}You can query any merchant categories using this resource. You may also use MerchantCategories to define specific category filters in CorporateRules. Either codes (which represents specific MCCs) or types (code groups) will be accepted as filters.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/merchantcategory"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
categories := merchantcategory.Query(nil, nil)
for category := range categories {
fmt.Println(category.Code)
}
}You can query any merchant countries using this resource. You may also use MerchantCountries to define specific country filters in CorporateRules.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/merchantcountry"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
countries := merchantcountry.Query(nil, nil)
for country := range countries {
fmt.Println(country.Code)
}
}You can query available card methods using this resource. You may also use CardMethods to define specific purchase method filters in CorporateRules.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
"github.com/starkbank/sdk-go/starkbank/cardmethod"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
methods := cardmethod.Query(nil, nil)
for method := range methods {
fmt.Println(method.Code)
}
}To create a webhook subscription and be notified whenever an event occurs, run:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Webhook "github.com/starkbank/sdk-go/starkbank/webhook"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
webhook, err := Webhook.Create(
Webhook.Webhook{
Url: "https://webhook.site/dd784f26-1d6a-4ca6-81cb-fda0267761ec",
Subscriptions: []string{"transfer", "boleto", "boleto-payment", "boleto-holmes", "brcode-payment", "utility-payment", "deposit", "invoice"},
}, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(webhook)
}To search for registered webhooks, run:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Webhook "github.com/starkbank/sdk-go/starkbank/webhook"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
webhooks := Webhook.Query(nil, nil)
for webhook := range webhooks {
fmt.Println(webhook)
}
}You can get a specific webhook by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Webhook "github.com/starkbank/sdk-go/starkbank/webhook"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
webhook, err := Webhook.Get("10827361982368179", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(webhook)
}You can also delete a specific webhook by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Webhook "github.com/starkbank/sdk-go/starkbank/webhook"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
webhook, err := Webhook.Delete("10827361982368179", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(webhook)
}It's easy to process events that arrived in your webhook. Remember to pass the signature header so the SDK can make sure it's really StarkBank that sent you the event.
package main
import (
"fmt"
Event "github.com/starkbank/sdk-go/starkbank/event"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
request := listen() // this is the method you made to get the events posted to your webhook endpoint
event := Event.Parse(
request.Data,
request.Headers["Digital-Signature"],
"",
utils.ExampleProject,
)
if event.Subscription == "transfer" {
fmt.Println(event.Log)
} else if event.Subscription == "boleto" {
fmt.Println(event.Log)
} else if event.Subscription == "boleto-payment" {
fmt.Println(event.Log)
} else if event.Subscription == "boleto-holmes" {
fmt.Println(event.Log)
} else if event.Subscription == "brcode-payment" {
fmt.Println(event.Log)
} else if event.Subscription == "utility-payment" {
fmt.Println(event.Log)
} else if event.Subscription == "deposit" {
fmt.Println(event.Log)
} else if event.Subscription == "invoice" {
fmt.Println(event.Log)
}
}To search for webhooks events, run:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Event "github.com/starkbank/sdk-go/starkbank/event"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["isDelivered"] = "false"
params["after"] = "2020-03-20"
events := Event.Query(params, nil)
for event := range events {
fmt.Println(event)
}
}You can get a specific webhook event by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Event "github.com/starkbank/sdk-go/starkbank/event"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
event, err := Event.Get("10827361982368179", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(event)
}You can also delete a specific webhook event by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Event "github.com/starkbank/sdk-go/starkbank/event"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
event, err := Event.Delete("10827361982368179", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(event)
}This can be used in case you've lost events.
With this function, you can manually set events retrieved from the API as
"delivered" to help future event queries with isDelivered=False.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Event "github.com/starkbank/sdk-go/starkbank/event"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var patchData = map[string]interface{}{}
patchData["isDelivered"] = true
event, err := Event.Update("10827361982368179", patchData, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(event)
}You can also get information on failed webhook event delivery attempts.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Attempt "github.com/starkbank/sdk-go/starkbank/event/attempt"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["after"] = "2020-03-20"
attempts := Attempt.Query(params, nil)
for attempt := range attempts {
fmt.Println(attempt)
}
}To retrieve information on a single attempt, use the following function:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Attempt "github.com/starkbank/sdk-go/starkbank/event/attempt"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
attempt, err := Attempt.Get("1616161616161616", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(attempt)
}The Organization user allows you to create new Workspaces (bank accounts) under your organization. Workspaces have independent balances, statements, operations and users. The only link between your Workspaces is the Organization that controls them.
Note: This route will only work if the Organization user is used with workspaceId=nil.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Workspace "github.com/starkbank/sdk-go/starkbank/workspace"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
workspace, err := Workspace.Create(
Workspace.Workspace{
Username: "iron-bank-workspace-1",
Name: "Iron Bank Workspace 1",
AllowedTaxIds: []string{""},
}, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(workspace)
}This route lists Workspaces. If no parameter is passed, all the workspaces the user has access to will be listed, but you can also find other Workspaces by searching for their usernames or IDs directly.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Workspace "github.com/starkbank/sdk-go/starkbank/workspace"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var params = map[string]interface{}{}
params["limit"] = 30
workspaces := Workspace.Query(params, nil)
for workspace := range workspaces {
fmt.Println(workspace)
}
}You can get a specific Workspace by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Workspace "github.com/starkbank/sdk-go/starkbank/workspace"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
workspace, err := Workspace.Get("10827361982368179", nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(workspace)
}You can update a specific Workspace by its id.
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Workspace "github.com/starkbank/sdk-go/starkbank/workspace"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
var patchData = map[string]interface{}{}
patchData["username"] = "new-username"
patchData["name"] = "New Name"
patchData["allowedTaxIds"] = []string{"012.345.678-90"}
workspace, err := Workspace.Update("10827361982368179", patchData, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
fmt.Println(workspace)
}Note: the Organization user can only update a workspace with the Workspace ID set.
This resource allows you to send HTTP requests to StarkBank routes.
You can perform a GET request to any StarkBank route.
It's possible to get a single resource using its id in the path.
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Request "github.com/starkbank/sdk-go/starkbank/request"
)
func main() {
data := map[string]interface{}{}
var path string
path = "/invoice/5155165527080960"
response, err := Request.Get(
path,
nil,
nil,
)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
unmarshalError := json.Unmarshal(response.Content, &data)
if unmarshalError != nil {
panic(unmarshalError)
}
fmt.Println(data)
}You can also get the specific resource log,
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Request "github.com/starkbank/sdk-go/starkbank/request"
)
func main() {
data := map[string]interface{}{}
var path string
path = "/invoice/log/5155165527080960"
response, err := Request.Get(
path,
nil,
nil,
)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
unmarshalError := json.Unmarshal(response.Content, &data)
if unmarshalError != nil {
panic(unmarshalError)
}
fmt.Println(data)
}This same method will be used to list all created items for the requested resource.
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Request "github.com/starkbank/sdk-go/starkbank/request"
)
func main() {
data := map[string]interface{}{}
var path string
var query = map[string]interface{}{}
path = "/invoice/"
query["limit"] = 2
query["status"] = "paid"
response, err := Request.Get(
path,
query,
nil,
)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
unmarshalError := json.Unmarshal(response.Content, &data)
if unmarshalError != nil {
panic(unmarshalError)
}
fmt.Println(data)
}To list logs, you will use the same logic as for getting a single log.
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Request "github.com/starkbank/sdk-go/starkbank/request"
)
func main() {
data := map[string]interface{}{}
var path string
var query = map[string]interface{}{}
path = "/invoice/log"
query["limit"] = 2
query["status"] = "paid"
response, err := Request.Get(
path,
query,
nil,
)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
unmarshalError := json.Unmarshal(response.Content, &data)
if unmarshalError != nil {
panic(unmarshalError)
}
fmt.Println(data)
}You can get a resource file using this method.
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Request "github.com/starkbank/sdk-go/starkbank/request"
)
func main() {
var path string
path = "/invoice/log/5155165527080960/pdf"
response, err := Request.Get(
path,
nil,
nil,
)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
filename := fmt.Sprintf("%v%v.pdf", "transfer", "5155165527080960")
errFile := ioutil.WriteFile(filename, pdf, 0666)
if errFile != nil {
fmt.Print(errFile)
}
}You can perform a POST request to any StarkBank route.
This will create an object for each item sent in your request
Note: It's not possible to create multiple resources simultaneously. You need to send separate requests if you want to create multiple resources, such as invoices and boletos.
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Request "github.com/starkbank/sdk-go/starkbank/request"
)
func main() {
starkbank.User = Utils.ExampleProject
data := map[string]interface{}{}
var path string
body := map[string][]map[string]interface{}{
"invoices": {
{
"amount": 996699999,
"name": "Tony Stark",
"taxId": "38.446.231/0001-04",
},
},
}
path = "/invoice/"
response, err := Request.Post(
path,
body,
nil,
Utils.ExampleProject,
)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
unmarshalError := json.Unmarshal(response.Content, &data)
if unmarshalError != nil {
panic(unmarshalError)
}
fmt.Println(data)
}You can perform a PATCH request to any StarkBank route.
It's possible to update a single item of a StarkBank resource.
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Request "github.com/starkbank/sdk-go/starkbank/request"
)
func main() {
starkbank.User = Utils.ExampleProject
body := map[string]interface{}{
"amount" : 0,
}
path = "/invoice/log/5155165527080960"
response, err := Request.Patch(
path,
body,
nil,
Utils.ExampleProject,
)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
unmarshalError := json.Unmarshal(response.Content, &data)
if unmarshalError != nil {
panic(unmarshalError)
}
fmt.Println(data)
}You can perform a PUT request to any StarkBank route.
It's possible to put a single item of a StarkBank resource.
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Request "github.com/starkbank/sdk-go/starkbank/request"
)
func main() {
starkbank.User = Utils.ExampleProject
data := map[string]interface{}{}
body := map[string][]map[string]interface{}{
"profiles": {
{
"interval": "day",
"delay": 0,
},
},
}
path := "split-profile/"
response, err := Request.Put(
path,
body,
nil,
Utils.ExampleProject,
)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
unmarshalError := json.Unmarshal(response.Content, &data)
if unmarshalError != nil {
panic(unmarshalError)
}
fmt.Println(data)
}You can perform a DELETE request to any StarkBank route.
It's possible to delete a single item of a StarkBank resource.
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Request "github.com/starkbank/sdk-go/starkbank/request"
)
func main() {
starkbank.User = Utils.ExampleProject
path = "transfer/5155165527080960"
response, err := Request.Delete(
path,
Utils.ExampleProject,
)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
unmarshalError := json.Unmarshal(response.Content, &data)
if unmarshalError != nil {
panic(unmarshalError)
}
fmt.Println(data)
}The SDK may return errors as the StarkErrors struct, which contains the "code" and "message" attributes.
It's highly recommended that you handle the errors returned from the functions used to get a feedback of the operation, as the example below:
InputErrors will be raised whenever the API detects an error in your request (status code 400). If you catch such an error, you can get its elements to verify each of the individual errors that were detected in your request by the API.
For example:
package main
import (
"fmt"
"github.com/starkbank/sdk-go/starkbank"
Transaction "github.com/starkbank/sdk-go/starkbank/transaction"
"github.com/starkbank/sdk-go/tests/utils"
)
func main() {
starkbank.User = utils.ExampleProject
transactions, err := Transaction.Create(
[]Transaction.Transaction{
{
Amount: 10000,
ReceiverId: "5768064935133184",
Description: "Paying my debts",
ExternalId: "my_unique_external_id",
},
}, nil)
if err.Errors != nil {
for _, e := range err.Errors {
panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
}
}
for _, transaction := range transactions {
fmt.Println(transaction)
}
}InternalServerError will be raised if the API runs into an internal error. If you ever stumble upon this one, rest assured that the development team is already rushing in to fix the mistake and get you back up to speed.
UnknownError will be raised if a request encounters an error that is neither InputErrors nor an InternalServerError, such as connectivity problems.
InvalidSignatureError will be raised specifically by event.Parse() when the provided content and signature do not check out with the Stark Bank public key.
If you have any questions about our SDK, just email us. We will respond you quickly, pinky promise. We are here to help you integrate with us ASAP. We also love feedback, so don't be shy about sharing your thoughts with us.
Email: [email protected]