Welcome to the Stark Bank Python SDK! This tool is made for Python 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, DynamicBrcodes, 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
- Split: Split received Invoice payments between different receivers
- SplitReceiver: Receiver of an Invoice split
- Webhooks: Configure your webhook endpoints and subscriptions
- WebhookEvents: Manage webhook events
- WebhookEventAttempts: Query failed webhook event deliveries
- Workspaces: Manage your accounts
- Request: Send a custom request to Stark Bank. This can be used to access features that haven't been mapped yet.
- Handling errors
- Help and Feedback
This library supports the following Python versions:
- Python 2.7
- Python 3.4+
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 To install the package with pip, run:
pip install starkbank1.2 To install from source, clone the repo and run:
python setup.py installWe 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:
import starkbank
privateKey, publicKey = starkbank.key.create()
# or, to also save .pem files in a specific path
privateKey, publicKey = starkbank.key.create("file/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 object below:
import starkbank
# 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.
private_key_content = """
-----BEGIN EC PARAMETERS-----
BgUrgQQACg==
-----END EC PARAMETERS-----
-----BEGIN EC PRIVATE KEY-----
MHQCAQEEIMCwW74H6egQkTiz87WDvLNm7fK/cA+ctA2vg/bbHx3woAcGBSuBBAAK
oUQDQgAE0iaeEHEgr3oTbCfh8U2L+r7zoaeOX964xaAnND5jATGpD/tHec6Oe9U1
IF16ZoTVt1FzZ8WkYQ3XomRD4HS13A==
-----END EC PRIVATE KEY-----
"""
project = starkbank.Project(
environment="sandbox",
id="5656565656565656",
private_key=private_key_content
)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 object below:
import starkbank
# 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.
private_key_content = """
-----BEGIN EC PARAMETERS-----
BgUrgQQACg==
-----END EC PARAMETERS-----
-----BEGIN EC PRIVATE KEY-----
MHQCAQEEIMCwW74H6egQkTiz87WDvLNm7fK/cA+ctA2vg/bbHx3woAcGBSuBBAAK
oUQDQgAE0iaeEHEgr3oTbCfh8U2L+r7zoaeOX964xaAnND5jATGpD/tHec6Oe9U1
IF16ZoTVt1FzZ8WkYQ3XomRD4HS13A==
-----END EC PRIVATE KEY-----
"""
organization = starkbank.Organization(
environment="sandbox",
id="5656565656565656",
private_key=private_key_content,
workspace_id=None, # You only need to set the workspace_id when you are operating a specific workspace_id
)
# To dynamically use your organization credentials in a specific workspace_id,
# you can use the Organization.replace() function:
starkbank.balance.get(user=starkbank.Organization.replace(organization, "4848484848484848"))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:
import starkbank
balance = starkbank.balance.get(user=project) # or organization4.2 Set it as a default user in the SDK:
import starkbank
starkbank.user = project # or organization
balance = starkbank.balance.get()Just select the way of passing the user that is more convenient to you. On all following examples we will assume a default user has been set.
The error language can also be set in the same way as the default user:
import starkbank
starkbank.language = "en-US"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 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.
import starkbank
for transaction in starkbank.transaction.query(limit=200):
print(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 beNone.
import starkbank
cursor = None
while True:
transactions, cursor = starkbank.transaction.page(limit=50, cursor=cursor)
for transaction in transactions:
print(transaction)
if cursor is None:
breakTo 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, use the built-in
help() function to get more info on the desired functionality
(for example: help(starkbank.boleto.create))
To send money between Stark Bank accounts, you can create transactions:
import starkbank
transactions = starkbank.transaction.create([
starkbank.Transaction(
amount=100, # (R$ 1.00)
receiver_id="1029378109327810",
description="Transaction to dear provider",
external_id="12345", # so we can block anything you send twice by mistake
tags=["provider"]
),
starkbank.Transaction(
amount=234, # (R$ 2.34)
receiver_id="2093029347820947",
description="Transaction to the other provider",
external_id="12346", # so we can block anything you send twice by mistake
tags=["provider"]
),
])
for transaction in transactions:
print(transaction)Note: Instead of using Transaction objects, you can also pass each transaction element in dictionary 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.
import starkbank
transactions = starkbank.transaction.query(
after="2020-01-01",
before="2020-03-01"
)
for transaction in transactions:
print(transaction)You can get a specific transaction by its id:
import starkbank
transaction = starkbank.transaction.get("5155165527080960")
print(transaction)To know how much money you have in your workspace, run:
import starkbank
balance = starkbank.balance.get()
print(balance)You can also create transfers in the SDK (TED/Pix) and configure transfer behavior according to its rules.
import starkbank
from datetime import datetime, timedelta
transfers = starkbank.transfer.create([
starkbank.Transfer(
amount=100,
bank_code="033", # TED
branch_code="0001",
account_number="10000-0",
account_type="salary",
tax_id="012.345.678-90",
name="Tony Stark",
tags=["iron", "suit"]
),
starkbank.Transfer(
amount=200,
bank_code="20018183", # Pix
branch_code="1234",
account_number="123456-7",
account_type="salary",
external_id="my-internal-id-12345",
tax_id="012.345.678-90",
name="Jon Snow",
scheduled=datetime.utcnow() + timedelta(days=3),
rules=[
starkbank.transfer.Rule(
key="resendingLimit", # Set maximum number of retries if Transfer fails due to systemic issues at the receiver bank
value=5 # Our resending limit is 10 by default
)
]
)
])
for transfer in transfers:
print(transfer)Note: Instead of using Transfer objects, you can also pass each transfer element in dictionary format
You can query multiple transfers according to filters.
import starkbank
from datetime import datetime
transfers = starkbank.transfer.query(
after=datetime(2020, 1, 1),
before=datetime(2020, 4, 1)
)
for transfer in transfers:
print(transfer.name)To cancel a single scheduled transfer by its id, run:
import starkbank
transfer = starkbank.transfer.delete("5155165527080960")
print(transfer)To get a single transfer by its id, run:
import starkbank
transfer = starkbank.transfer.get("5155165527080960")
print(transfer)A transfer PDF may also be retrieved by its id. This operation is only valid if the transfer status is "processing" or "success".
import starkbank
pdf = starkbank.transfer.pdf("5155165527080960")
with open("transfer.pdf", "wb") as file:
file.write(pdf)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.
import starkbank
logs = starkbank.transfer.log.query(limit=50)
for log in logs:
print(log.id)You can also get a specific log by its id.
import starkbank
log = starkbank.transfer.log.get("5155165527080960")
print(log)You can get the Pix key's parameters by its id.
import starkbank
dict_key = starkbank.dictkey.get("tony@starkbank.com")
print(dict_key)To take a look at the Pix keys linked to your workspace, just run the following:
import starkbank
dict_keys = starkbank.dictkey.query(status="registered")
for dict_key in dict_keys:
print(dict_key)You can query institutions registered by the Brazilian Central Bank for Pix and TED transactions.
import starkbank
institutions = starkbank.institution.query(search="stark")
for institution in institutions:
print(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.
# coding: utf-8
import starkbank
from datetime import date, datetime, timedelta
invoices = starkbank.invoice.create([
starkbank.Invoice(
amount=23571, # R$ 235,71
name="Buzz Aldrin",
tax_id="012.345.678-90",
due=datetime.utcnow() + timedelta(hours=1),
expiration=timedelta(hours=3).total_seconds(),
fine=5, # 5%
interest=2.5, # 2.5% per month
tags=["immediate"],
rules=[
starkbank.transfer.Rule(
key="allowedTaxIds", # Set TaxIds allowed to receive this Invoice
value=[ "012.345.678-90" ]
)
]
),
starkbank.Invoice(
amount=23571, # R$ 235,71
name="Buzz Aldrin",
tax_id="012.345.678-90",
due=date(2022, 3, 20),
expiration=timedelta(hours=3).total_seconds(),
fine=5, # 5%
interest=2.5, # 2.5% per month
tags=["scheduled"]
)
])
for invoice in invoices:
print(invoice)Note: Instead of using Invoice objects, you can also pass each invoice element in dictionary format
After its creation, information on an invoice may be retrieved by its id. Its status indicates whether it's been paid.
import starkbank
invoice = starkbank.invoice.get("5155165527080960")
print(invoice)After its creation, an invoice PDF may be retrieved by its id.
import starkbank
pdf = starkbank.invoice.pdf("5155165527080960", layout="default")
with open("invoice.pdf", "wb") as file:
file.write(pdf)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.
import starkbank
qrcode = starkbank.invoice.qrcode("5881614903017472", size= 15)
with open("qrcode.png", "wb") as file:
file.write(qrcode)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.
import starkbank
invoice = starkbank.invoice.update("5155165527080960", status="canceled")
print(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.
import starkbank
from datetime import datetime, timedelta
invoice = starkbank.invoice.update(
"5155165527080960",
amount=100,
expiration=0,
due=datetime.utcnow() + timedelta(hours=1),
)
print(invoice)You can get a list of created invoices given some filters.
import starkbank
from datetime import datetime
invoices = starkbank.invoice.query(
after=datetime(2020, 1, 1),
before=datetime(2020, 3, 1)
)
for invoice in invoices:
print(invoice)Logs are pretty important to understand the life cycle of an invoice.
import starkbank
logs = starkbank.invoice.log.query(limit=150)
for log in logs:
print(log)You can get a single log by its id.
import starkbank
log = starkbank.invoice.log.get("5155165527080960")
print(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:
import starkbank
pdf = starkbank.invoice.log.pdf("5155165527080960")
with open("invoice-reversal.pdf", "wb") as file:
file.write(pdf)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:
import starkbank
paymentInformation = starkbank.invoice.payment("5155165527080960")
print(paymentInformation)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 | âś“ | âś“ |
| Can only be paid once | âś“ | âś“ |
| Due, fine and fee | âś“ | X |
| Discount | âś“ | X |
| Description | âś“ | X |
| Can be updated | âś“ | X |
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.
# coding: utf-8
import starkbank
from datetime import timedelta
brcodes = starkbank.dynamicbrcode.create([
starkbank.DynamicBrcode(
amount=23571, # R$ 235,71
expiration=timedelta(hours=3).total_seconds()
),
starkbank.DynamicBrcode(
amount=23571, # R$ 235,71
expiration=timedelta(hours=3).total_seconds()
)
])
for brcode in brcodes:
print(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.
import starkbank
brcode = starkbank.dynamicbrcode.get("bb9cd43ea6f4403391bf7ef6aa876600")
print(brcode)You can get a list of created DynamicBrcodes given some filters.
import starkbank
from datetime import datetime
brcodes = starkbank.dynamicbrcode.query(
after=datetime(2023, 1, 1),
before=datetime(2023, 3, 1)
)
for brcode in brcodes:
print(brcode)You can get a list of created deposits given some filters.
import starkbank
from datetime import datetime
deposits = starkbank.deposit.query(
after=datetime(2020, 1, 1),
before=datetime(2020, 3, 1)
)
for deposit in deposits:
print(deposit)After its creation, information on a deposit may be retrieved by its id.
import starkbank
deposit = starkbank.deposit.get("5155165527080960")
print(deposit)You can update an deposit's amount by its id. Only the amount can be decreased, which will result in a payment reversal. To fully reverse the deposit, pass amount = 0.
import starkbank
deposit = starkbank.deposit.update(
"5155165527080960",
amount=0,
)
print(deposit)Logs are pretty important to understand the life cycle of a deposit.
import starkbank
logs = starkbank.deposit.log.query(limit=150)
for log in logs:
print(log)You can get a single log by its id.
import starkbank
log = starkbank.deposit.log.get("5155165527080960")
print(log)Whenever an Deposit is successfully reversed, a reversed log will be created. To retrieve a specific reversal receipt, you can request the corresponding log PDF:
import starkbank
pdf = starkbank.deposit.log.pdf("5155165527080960")
with open("deposit-reversal.pdf", "wb") as file:
file.write(pdf)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 create boletos to charge customers or to receive money from accounts you have in other banks.
# coding: utf-8
import starkbank
from datetime import datetime
boletos = starkbank.boleto.create([
starkbank.Boleto(
amount=23571, # R$ 235,71
name="Buzz Aldrin",
tax_id="012.345.678-90",
street_line_1="Av. Paulista, 200",
street_line_2="10 andar",
district="Bela Vista",
city="SĂŁo Paulo",
state_code="SP",
zip_code="01310-000",
due=datetime(2020, 3, 20),
fine=5, # 5%
interest=2.5, # 2.5% per month
),
])
for boleto in boletos:
print(boleto)Note: Instead of using Boleto objects, you can also pass each boleto element in dictionary format
After its creation, information on a boleto may be retrieved by its id. Its status indicates whether it's been paid.
import starkbank
boleto = starkbank.boleto.get("5155165527080960")
print(boleto)After its creation, a boleto PDF may be retrieved by its id.
import starkbank
pdf = starkbank.boleto.pdf("5155165527080960", layout="default")
with open("boleto.pdf", "wb") as file:
file.write(pdf)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.
import starkbank
boleto = starkbank.boleto.delete("5155165527080960")
print(boleto)You can get a list of created boletos given some filters.
import starkbank
from datetime import datetime
boletos = starkbank.boleto.query(
after=datetime(2020, 1, 1),
before=datetime(2020, 3, 1)
)
for boleto in boletos:
print(boleto)Logs are pretty important to understand the life cycle of a boleto.
import starkbank
logs = starkbank.boleto.log.query(limit=150)
for log in logs:
print(log)You can get a single log by its id.
import starkbank
log = starkbank.boleto.log.get("5155165527080960")
print(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 object, which fetches the updated status of the corresponding Boleto object 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.
import starkbank
holmes = starkbank.boletoholmes.create([
starkbank.BoletoHolmes(
boleto_id="5656565656565656",
),
starkbank.BoletoHolmes(
boleto_id="4848484848484848",
),
])
for sherlock in holmes:
print(sherlock)Note: Instead of using BoletoHolmes objects, you can also pass each payment element in dictionary format
To get a single Holmes by its id, run:
import starkbank
sherlock = starkbank.boletoholmes.get("19278361897236187236")
print(sherlock)You can search for boleto Holmes using filters.
import starkbank
holmes = starkbank.boletoholmes.query(
tags=["customer_1", "customer_2"]
)
for sherlock in holmes:
print(sherlock)Searches are also possible with boleto holmes logs:
import starkbank
logs = starkbank.boletoholmes.log.query(
holmes_ids=["5155165527080960", "76551659167801921"],
)
for log in logs:
print(log)You can also get a boleto holmes log by specifying its id.
import starkbank
log = starkbank.boletoholmes.log.get("5155165527080960")
print(log)Paying a BR Code is also simple. After extracting the BR Code encoded in the Pix QR Code, you can do the following:
import starkbank
payments = starkbank.brcodepayment.create([
starkbank.BrcodePayment(
brcode="00020126580014br.gov.bcb.pix0136a629532e-7693-4846-852d-1bbff817b5a8520400005303986540510.005802BR5908T'Challa6009Sao Paulo62090505123456304B14A",
tax_id="012.345.678-90",
scheduled="2020-03-13",
description="this will be fast",
tags=["pix", "qrcode"],
rules=[
starkbank.brcodepayment.Rule(
key="resendingLimit", # Set maximum number of retries if Payment fails due to systemic issues at the receiver bank
value=5 # Our resending limit is 10 by default
)
]
)
])
for payment in payments:
print(payment)Note: You can also configure payment behavior according to its rules Note: Instead of using BrcodePayment objects, you can also pass each payment element in dictionary format
To get a single BR Code payment by its id, run:
import starkbank
payment = starkbank.brcodepayment.get("19278361897236187236")
print(payment)After its creation, a BR Code payment PDF may be retrieved by its id.
import starkbank
pdf = starkbank.brcodepayment.pdf("5155165527080960")
with open("brcode-payment.pdf", "wb") as file:
file.write(pdf)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.
import starkbank
from datetime import datetime, timedelta
payment = starkbank.brcodepayment.update(
"5155165527080960",
status="canceled"
)
print(payment)You can search for brcode payments using filters.
import starkbank
payments = starkbank.brcodepayment.query(
tags=["company_1", "company_2"]
)
for payment in payments:
print(payment)Searches are also possible with BR Code payment logs:
import starkbank
logs = starkbank.brcodepayment.log.query(
payment_ids=["5155165527080960", "76551659167801921"],
)
for log in logs:
print(log)You can also get a BR Code payment log by specifying its id.
import starkbank
log = starkbank.brcodepayment.log.get("5155165527080960")
print(log)Paying a boleto is also simple.
import starkbank
payments = starkbank.boletopayment.create([
starkbank.BoletoPayment(
line="34191.09008 61207.727308 71444.640008 5 81310001234321",
tax_id="012.345.678-90",
scheduled="2020-03-13",
description="take my money",
tags=["take", "my", "money"],
),
starkbank.BoletoPayment(
bar_code="34197819200000000011090063609567307144464000",
tax_id="012.345.678-90",
scheduled="2020-03-14",
description="take my money one more time",
tags=["again"],
),
])
for payment in payments:
print(payment)Note: Instead of using BoletoPayment objects, you can also pass each payment element in dictionary format
To get a single boleto payment by its id, run:
import starkbank
payment = starkbank.boletopayment.get("19278361897236187236")
print(payment)After its creation, a boleto payment PDF may be retrieved by its id.
import starkbank
pdf = starkbank.boletopayment.pdf("5155165527080960")
with open("boleto-payment.pdf", "wb") as file:
file.write(pdf)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.
import starkbank
payment = starkbank.boletopayment.delete("5155165527080960")
print(payment)You can search for boleto payments using filters.
import starkbank
payments = starkbank.boletopayment.query(
tags=["company_1", "company_2"]
)
for payment in payments:
print(payment)Searches are also possible with boleto payment logs:
import starkbank
logs = starkbank.boletopayment.log.query(
payment_ids=["5155165527080960", "76551659167801921"],
)
for log in logs:
print(log)You can also get a boleto payment log by specifying its id.
import starkbank
log = starkbank.boletopayment.log.get("5155165527080960")
print(log)Its also simple to pay utility bills (such as electricity and water bills) in the SDK.
import starkbank
payments = starkbank.utilitypayment.create([
starkbank.UtilityPayment(
line="34197819200000000011090063609567307144464000",
scheduled="2020-03-13",
description="take my money",
tags=["take", "my", "money"],
),
starkbank.UtilityPayment(
bar_code="34191.09008 61207.727308 71444.640008 5 81310001234321",
scheduled="2020-03-14",
description="take my money one more time",
tags=["again"],
),
])
for payment in payments:
print(payment)Note: Instead of using UtilityPayment objects, you can also pass each payment element in dictionary format
To search for utility payments using filters, run:
import starkbank
payments = starkbank.utilitypayment.query(
tags=["electricity", "gas"]
)
for payment in payments:
print(payment)You can get a specific bill by its id:
import starkbank
payment = starkbank.utilitypayment.get("5155165527080960")
print(payment)After its creation, a utility payment PDF may also be retrieved by its id.
import starkbank
pdf = starkbank.utilitypayment.pdf("5155165527080960")
with open("electricity-payment.pdf", "wb") as file:
file.write(pdf)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.
import starkbank
payment = starkbank.utilitypayment.delete("5155165527080960")
print(payment)You can search for payments by specifying filters. Use this to understand the bills life cycles.
import starkbank
logs = starkbank.utilitypayment.log.query(
payment_ids=["102893710982379182", "92837912873981273"],
)
for log in logs:
print(log)If you want to get a specific payment log by its id, just run:
import starkbank
log = starkbank.utilitypayment.log.get("1902837198237992")
print(log)It is also simple to pay taxes (such as ISS and DAS) using this SDK.
import starkbank
payments = starkbank.taxpayment.create([
starkbank.TaxPayment(
bar_code="83660000001084301380074119002551100010601813",
scheduled="2020-08-13",
description="fix the road",
tags=["take", "my", "money"],
),
starkbank.TaxPayment(
line="85800000003 0 28960328203 1 56072020190 5 22109674804 0",
scheduled="2020-08-14",
description="build the hospital, hopefully",
tags=["expensive"],
),
])
for payment in payments:
print(payment)Note: Instead of using TaxPayment objects, you can also pass each payment element in dictionary format
To search for tax payments using filters, run:
import starkbank
payments = starkbank.taxpayment.query(
tags=["das", "july"]
)
for payment in payments:
print(payment)You can get a specific tax payment by its id:
import starkbank
payment = starkbank.taxpayment.get("5155165527080960")
print(payment)After its creation, a tax payment PDF may also be retrieved by its id.
import starkbank
pdf = starkbank.taxpayment.pdf("5155165527080960")
with open("iss-payment.pdf", "wb") as file:
file.write(pdf)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.
import starkbank
payment = starkbank.taxpayment.delete("5155165527080960")
print(payment)You can search for payment logs by specifying filters. Use this to understand each payment life cycle.
import starkbank
logs = starkbank.taxpayment.log.query(limit=10)
for log in logs:
print(log)If you want to get a specific payment log by its id, just run:
import starkbank
log = starkbank.taxpayment.log.get("1902837198237992")
print(log)Note: Some taxes can't be payed 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:
import starkbank
from datetime import datetime, timedelta
payments = starkbank.darfpayment.create([
starkbank.DarfPayment(
revenue_code="1240",
tax_id="012.345.678-90",
competence="2020-09-01",
reference_number="2340978970",
nominal_amount=1234,
fine_amount=12,
interest_amount=34,
due=datetime.now() + timedelta(days=30),
scheduled=datetime.now() + timedelta(days=30),
tags=["DARF", "making money"],
description="take my money",
)
])
for payment in payments:
print(payment)Note: Instead of using DarfPayment objects, you can also pass each payment element in dictionary format
To search for DARF payments using filters, run:
import starkbank
payments = starkbank.darfpayment.query(
tags=["darf", "july"]
)
for payment in payments:
print(payment)You can get a specific DARF payment by its id:
import starkbank
payment = starkbank.darfpayment.get("5155165527080960")
print(payment)After its creation, a DARF payment PDF may also be retrieved by its id.
import starkbank
pdf = starkbank.darfpayment.pdf("5155165527080960")
with open("darf-payment.pdf", "wb") as file:
file.write(pdf)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.
import starkbank
payment = starkbank.darfpayment.delete("5155165527080960")
print(payment)You can search for payment logs by specifying filters. Use this to understand each payment life cycle.
import starkbank
logs = starkbank.darfpayment.log.query(limit=10)
for log in logs:
print(log)If you want to get a specific payment log by its id, just run:
import starkbank
log = starkbank.darfpayment.log.get("1902837198237992")
print(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"
# coding: utf-8
import starkbank
from datetime import date, timedelta
previews = starkbank.paymentpreview.create([
starkbank.PaymentPreview(
id="00020126580014br.gov.bcb.pix0136a629532e-7693-4846-852d-1bbff817b5a8520400005303986540510.005802BR5908T'Challa6009Sao Paulo62090505123456304B14A",
scheduled=date.today() + timedelta(days=3)
),
starkbank.PaymentPreview(
id="34191.09008 61207.727308 71444.640008 5 81310001234321"
),
])
for preview in previews:
print(preview)
payment = preview.payment
if preview.type == "brcode-payment":
print(payment.status)Note: Instead of using PaymentPreview objects, you can also pass each request element in dictionary 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 center_id parameter can be consulted by logging into our website and going to the desired cost center page.
# coding: utf-8
import starkbank
from datetime import date, timedelta
requests = starkbank.paymentrequest.create([
starkbank.PaymentRequest(
center_id="5967314465849344",
payment=starkbank.Transfer(
amount=200,
bank_code="341",
branch_code="1234",
account_number="123456-7",
tax_id="012.345.678-90",
name="Bucket Head",
tags=[]
),
due="2020-11-01"
),
])
for request in requests:
print(request)Note: Instead of using PaymentRequest objects, you can also pass each request element in dictionary format
To search for payment requests, run:
import starkbank
requests = starkbank.paymentrequest.query(center_id="123456789", limit=10)
for request in requests:
print(request)You can create card holders to which your cards will be bound. They support spending rules that will apply to all underlying cards.
import starkbank
holders = starkbank.corporateholder.create([
starkbank.CorporateHolder(
name="Iron Bank S.A.",
tags=[
"Traveler Employee"
],
rules=[
{
"name": "General USD",
"interval": "day",
"amount": 100000,
"currencyCode": "USD",
"categories": [
starkbank.MerchantCategory(type="services"),
starkbank.MerchantCategory(code="fastFoodRestaurants")
],
"countries": [
starkbank.MerchantCountry(code="USA")
],
"methods": [
starkbank.CardMethod(code="token")
]
}
]
)
])
for holder in holders:
print(holder)Note: Instead of using CorporateHolder objects, you can also pass each element in dictionary format
You can query multiple holders according to filters.
import starkbank
holders = starkbank.corporateholder.query()
for holder in holders:
print(holder)To cancel a single Corporate Holder by its id, run:
import starkbank
holder = starkbank.corporateholder.cancel("5155165527080960")
print(holder)To get a single Corporate Holder by its id, run:
import starkbank
holder = starkbank.corporateholder.get("5155165527080960")
print(holder)You can query holder logs to better understand holder life cycles.
import starkbank
logs = starkbank.corporateholder.log.query(limit=50)
for log in logs:
print(log.id)You can also get a specific log by its id.
import starkbank
log = starkbank.corporateholder.log.get("5155165527080960")
print(log)You can issue cards with specific spending rules.
import starkbank
card = starkbank.corporatecard.create(
starkbank.CorporateCard(
holder_id="5155165527080960"
)
)
print(card)You can get a list of created cards given some filters.
import starkbank
from datetime import date
cards = starkbank.corporatecard.query(
after=date(2020, 1, 1),
before=date(2020, 3, 1)
)
for card in cards:
print(card)After its creation, information on a card may be retrieved by its id.
import starkbank
card = starkbank.corporatecard.get("5155165527080960")
print(card)You can update a specific card by its id.
import starkbank
card = starkbank.corporatecard.update("5155165527080960", status="blocked")
print(card)You can also cancel a card by its id.
import starkbank
card = starkbank.corporatecard.cancel("5155165527080960")
print(card)Logs are pretty important to understand the life cycle of a card.
import starkbank
logs = starkbank.corporatecard.log.query(limit=150)
for log in logs:
print(log)You can get a single log by its id.
import starkbank
log = starkbank.corporatecard.log.get("5155165527080960")
print(log)You can get a list of created purchases given some filters.
import starkbank
from datetime import date
purchases = starkbank.corporatepurchase.query(
after=date(2020, 1, 1),
before=date(2020, 3, 1)
)
for purchase in purchases:
print(purchase)After its creation, information on a purchase may be retrieved by its id.
import starkbank
purchase = starkbank.corporatepurchase.get("5155165527080960")
print(purchase)Logs are pretty important to understand the life cycle of a purchase.
import starkbank
logs = starkbank.corporatepurchase.log.query(limit=150)
for log in logs:
print(log)You can get a single log by its id.
import starkbank
log = starkbank.corporatepurchase.log.get("5155165527080960")
print(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.
import starkbank
invoice = starkbank.corporateinvoice.create(
invoice=starkbank.CorporateInvoice(
amount=1000
)
)
print(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.
import starkbank
from datetime import date
invoices = starkbank.corporateinvoice.query(
after=date(2020, 1, 1),
before=date(2020, 3, 1)
)
for invoice in invoices:
print(invoice)You can create withdrawals to send cash back from your Corporate balance to your Banking balance by using the Withdrawal resource.
import starkbank
withdrawal = starkbank.corporatewithdrawal.create(
withdrawal=starkbank.CorporateWithdrawal(
amount=10000,
external_id="123",
description="Sending back"
)
)
print(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.
import starkbank
withdrawal = starkbank.corporatewithdrawal.get("5155165527080960")
print(withdrawal)You can get a list of created withdrawals given some filters.
import starkbank
from datetime import date
withdrawals = starkbank.corporatewithdrawal.query(
after=date(2020, 1, 1),
before=date(2020, 3, 1)
)
for withdrawal in withdrawals:
print(withdrawal)To know how much money you have available to run authorizations, run:
import starkbank
balance = starkbank.corporatebalance.get()
print(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.
import starkbank
from datetime import date
transactions = starkbank.corporatetransaction.query(
after=date(2020, 1, 1),
before=date(2020, 3, 1)
)
for transaction in transactions:
print(transaction)You can get a specific transaction by its id:
import starkbank
transaction = starkbank.corporatetransaction.get("5155165527080960")
print(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.
import starkbank
categories = starkbank.merchantcategory.query(
search="food",
)
for category in categories:
print(category)You can query any merchant countries using this resource. You may also use MerchantCountries to define specific country filters in CorporateRules.
import starkbank
countries = starkbank.merchantcountry.query(
search="brazil",
)
for country in countries:
print(country)You can query available card methods using this resource. You may also use CardMethods to define specific purchase method filters in CorporateRules.
import starkbank
methods = starkbank.cardmethod.query(
search="token",
)
for method in methods:
print(method)Split an Invoice between different receivers.
You can get a list of created Splits given some filters.
import starkbank
splits = starkbank.split.query(limit=10)
for split in splits:
print(split)To get a single Split by its id, run:
import starkbank
split = starkbank.split.get("5155165527080960")
print(split)You can query Split logs to check additional information.
import starkbank
logs = starkbank.split.log.query(
split_ids=["5155165527080960", "76551659167801921"],
)
for log in logs:
print(log)You can also get a Split log by specifying its id.
import starkbank
log = starkbank.split.log.get("5155165527080960")
print(log)You can create receivers to an Invoice Split by using the SplitReceiver resource.
import starkbank
receiver = starkbank.splitreceiver.create(
receiver=starkbank.SplitReceiver(
name="Daenerys Targaryen Stormborn",
tax_id="594.739.480-42",
bank_code="341",
branch_code="2201",
account_number="76543-8",
account_type="salary"
)
)
print(receiver)To take a look at the SplitReceivers created to your workspace, just run the following:
import starkbank
receivers = starkbank.splitreceiver.query(limit=10)
for receiver in receivers:
print(receiver)To get a single SplitReceiver by its id, run:
import starkbank
receiver = starkbank.splitreceiver.get("5155165527080960")
print(receiver)You can query SplitReceiver logs to check additional information
import starkbank
logs = starkbank.splitreceiver.log.query(
receiver_ids =["5155165527080960", "76551659167801921"],
)
for log in logs:
print(log)You can also get a SplitReceiver Log by specifying its id.
import starkbank
log = starkbank.splitreceiver.log.get("5155165527080960")
print(log)To create a webhook subscription and be notified whenever an event occurs, run:
import starkbank
webhook = starkbank.webhook.create(
url="https://webhook.site/dd784f26-1d6a-4ca6-81cb-fda0267761ec",
subscriptions=["transfer", "boleto", "boleto-payment", "boleto-holmes", "brcode-payment", "utility-payment", "deposit", "invoice"],
)
print(webhook)To search for registered webhook subscriptions, run:
import starkbank
webhooks = starkbank.webhook.query()
for webhook in webhooks:
print(webhook)You can get a specific webhook subscription by its id.
import starkbank
webhook = starkbank.webhook.get("10827361982368179")
print(webhook)You can also delete a specific webhook subscription by its id.
import starkbank
webhook = starkbank.webhook.delete("10827361982368179")
print(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.
import starkbank
response = listen() # this is the method you made to get the events posted to your webhook endpoint
event = starkbank.event.parse(
content=response.data.decode("utf-8"),
signature=response.headers["Digital-Signature"],
)
if event.subscription == "transfer":
print(event.log.transfer)
elif event.subscription == "boleto":
print(event.log.boleto)
elif event.subscription == "boleto-payment":
print(event.log.payment)
elif event.subscription == "boleto-holmes":
print(event.log.holmes)
elif event.subscription == "brcode-payment":
print(event.log.payment)
elif event.subscription == "utility-payment":
print(event.log.payment)
elif event.subscription == "deposit":
print(event.log.deposit)
elif event.subscription == "invoice":
print(event.log.invoice)To search for webhooks events, run:
import starkbank
events = starkbank.event.query(after="2020-03-20", is_delivered=False)
for event in events:
print(event)You can get a specific webhook event by its id.
import starkbank
event = starkbank.event.get("10827361982368179")
print(event)You can also delete a specific webhook event by its id.
import starkbank
event = starkbank.event.delete("10827361982368179")
print(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 is_delivered=False.
import starkbank
event = starkbank.event.update("129837198237192", is_delivered=True)
print(event)You can also get information on failed webhook event delivery attempts.
import starkbank
attempts = starkbank.event.attempt.query(after="2020-03-20")
for attempt in attempts:
print(attempt.code)
print(attempt.message)To retrieve information on a single attempt, use the following function:
import starkbank
attempt = starkbank.event.attempt.get("1616161616161616")
print(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 workspace_id=None.
import starkbank
workspace = starkbank.workspace.create(
username="iron-bank-workspace-1",
name="Iron Bank Workspace 1",
user=organization,
)
print(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.
import starkbank
workspaces = starkbank.workspace.query(limit=30)
for workspace in workspaces:
print(workspace)You can get a specific Workspace by its id.
import starkbank
workspace = starkbank.workspace.get("1082736198236817")
print(workspace)You can update a specific Workspace by its id.
import starkbank
picture = open("path/to/picture.png", "rb").read()
workspace = starkbank.workspace.update(
"1082736198236817",
username="new-username",
name="New Name",
allowed_tax_ids=["012.345.678-90"],
picture=picture,
picture_type="image/png",
user=starkbank.Organization.replace(organization, "1082736198236817")
)
print(workspace)You can also block a specific Workspace by its id.
import starkbank
workspace = starkbank.workspace.update(
"1082736198236817",
username="new-username",
name="New Name",
status="blocked",
user=starkbank.Organization.replace(organization, "1082736198236817")
)
print(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 starkbank
example_id = "5155165527080960"
request = starkbank.request.get(
path=f"/invoice/{example_id}"
).json()
print(request)You can also get the specific resource log,
import starkbank
example_id = "5699165527090460"
request = starkbank.request.get(
path=f"/invoice/log/{example_id}",
).json()
print(request)This same method will be used to list all created items for the requested resource.
import starkbank
request = starkbank.request.get(
path="/invoice",
query={"limit": 10, "status": "paid"},
).json()
for item in request["invoices"]:
print(item)To list logs, you will use the same logic as for getting a single log.
import starkbank
request = starkbank.request.get(
path="/invoice/log",
query={"limit": 10, "status": "paid"},
).json()
for item in request["invoices"]:
print(item)You can get a resource file using this method.
import starkbank
example_id = "5155165527080960"
pdf = starkbank.request.get(
path=f"/invoice/{example_id}/pdf",
).content
with open("request.pdf", "wb") as file:
file.write(pdf)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 starkbank
data={
"invoices": [
{
"amount": 100,
"name": "Iron Bank S.A.",
"taxId": "20.018.183/0001-80"
},
{
"amount": 450000,
"name": "Arya Stark.",
"taxId": "012.345.678-90"
}
]
}
request = starkbank.request.post(
path="/invoice",
body=data,
).json()
print(request)You can perform a PATCH request to any StarkBank route.
It's possible to update a single item of a StarkBank resource.
import starkbank
example_id = "5155165527080960"
request = starkbank.request.patch(
path=f"/invoice/{example_id}",
body={"amount": 0},
).json()
print(request)You can perform a PUT request to any StarkBank route.
It's possible to put a single item of a StarkBank resource.
import starkbank
data = {
"profiles": [
{
"interval": "day",
"delay": 0
}
]
}
request = starkbank.request.put(
path="/split-profile",
body=data,
).json()
print(request)You can perform a DELETE request to any StarkBank route.
It's possible to delete a single item of a StarkBank resource.
import starkbank
example_id = "5155165527080960"
request = starkbank.request.delete(
path=f"/transfer/{example_id}",
).json()
print(request) The SDK may raise one of four types of errors: InputErrors, InternalServerError, UnknownError, InvalidSignatureError
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:
import starkbank
try:
transactions = starkbank.transaction.create([
starkbank.Transaction(
amount=99999999999999, # (R$ 999,999,999,999.99)
receiver_id="1029378109327810",
description=".",
external_id="12345", # so we can block anything you send twice by mistake
tags=["provider"]
),
])
except starkbank.error.InputErrors as exception:
for error in exception.errors:
print(error.code)
print(error.message)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 starkbank.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 send us an email. 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: help@starkbank.com