# Stark Bank Python SDK
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](https://www.starkbank.com/)
and discover a world where receiving or making payments
is as easy as sending a text message to your client!
# Introduction
## Index
- [Introduction](#introduction)
- [Supported Python versions](#supported-python-versions)
- [API documentation](#stark-bank-api-documentation)
- [Versioning](#versioning)
- [Setup](#setup)
- [Install our SDK](#1-install-our-sdk)
- [Create your Private and Public Keys](#2-create-your-private-and-public-keys)
- [Register your user credentials](#3-register-your-user-credentials)
- [Setting up the user](#4-setting-up-the-user)
- [Setting up the error language](#5-setting-up-the-error-language)
- [Resource listing and manual pagination](#resource-listing-and-manual-pagination)
- [Testing in Sandbox](#testing-in-sandbox)
- [Usage](#usage)
- [Transactions](#create-transactions): Account statement entries
- [Balance](#get-balance): Account balance
- [Transfers](#create-transfers): Wire transfers (TED and manual Pix)
- [DictKeys](#get-dict-key): Pix Key queries to use with Transfers
- [Institutions](#query-bacen-institutions): Institutions recognized by the Central Bank
- [Invoices](#create-invoices): Reconciled receivables (dynamic Pix QR Codes)
- [DynamicBrcode](#create-dynamicbrcodes): Simplified reconciled receivables (dynamic Pix QR Codes)
- [Deposits](#query-deposits): Other cash-ins (static Pix QR Codes, DynamicBrcodes, manual Pix, etc)
- [Boletos](#create-boletos): Boleto receivables
- [BoletoHolmes](#investigate-a-boleto): Boleto receivables investigator
- [BrcodePayments](#pay-a-br-code): Pay Pix QR Codes
- [BoletoPayments](#pay-a-boleto): Pay Boletos
- [UtilityPayments](#create-utility-payments): Pay Utility bills (water, light, etc.)
- [TaxPayments](#create-tax-payment): Pay taxes
- [DarfPayments](#create-darf-payment): Pay DARFs
- [PaymentPreviews](#preview-payment-information-before-executing-the-payment): Preview all sorts of payments
- [PaymentRequest](#create-payment-requests-to-be-approved-by-authorized-people-in-a-cost-center): Request a payment approval to a cost center
- [CorporateHolders](#create-corporateholders): Manage cardholders
- [CorporateCards](#create-corporatecards): Create virtual and/or physical cards
- [CorporateInvoices](#create-corporateinvoices): Add money to your corporate balance
- [CorporateWithdrawals](#create-corporatewithdrawals): Send money back to your Workspace from your corporate balance
- [CorporateBalance](#get-your-corporatebalance): View your corporate balance
- [CorporateTransactions](#query-corporatetransactions): View the transactions that have affected your corporate balance
- [CorporateEnums](#corporate-enums): Query enums related to the corporate purchases, such as merchant categories, countries and card purchase methods
- [Split](#query-splits): Split received Invoice payments between different receivers
- [SplitReceiver](#create-splitreceivers): Receiver of an Invoice split
- [Webhooks](#create-a-webhook-subscription): Configure your webhook endpoints and subscriptions
- [WebhookEvents](#process-webhook-events): Manage webhook events
- [WebhookEventAttempts](#query-failed-webhook-event-delivery-attempts-information): Query failed webhook event deliveries
- [Workspaces](#create-a-new-workspace): Manage your accounts
- [Handling errors](#handling-errors)
- [Help and Feedback](#help-and-feedback)
## Supported Python Versions
This library supports the following Python versions:
* Python 2.7
* Python 3.4+
## Stark Bank API documentation
Feel free to take a look at our [API docs](https://www.starkbank.com/docs/api).
## Versioning
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.
# Setup
## 1. Install our SDK
1.1 To install the package with pip, run:
```sh
pip install starkbank
```
1.2 To install from source, clone the repo and run:
```sh
python setup.py install
```
## 2. Create your Private and Public Keys
We 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](https://starkbank.com/faq/how-to-create-ecdsa-keys).
2.2. Use our SDK:
```python
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.
## 3. Register your user credentials
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](https://web.sandbox.starkbank.com)
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:
```python
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](https://web.sandbox.starkbank.com)
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:
```python
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.
## 4. Setting up the user
There are three kinds of users that can access our API: **Organization**, **Project** and **Member**.
- `Project` and `Organization` are designed for integrations and are the ones meant for our SDKs.
- `Member` is 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:
```python
import starkbank
balance = starkbank.balance.get(user=project) # or organization
```
4.2 Set it as a default user in the SDK:
```python
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.
## 5. Setting up the error language
The error language can also be set in the same way as the default user:
```python
import starkbank
starkbank.language = "en-US"
```
Language options are "en-US" for english and "pt-BR" for brazilian portuguese. English is default.
# Resource listing and manual pagination
Almost all SDK resources provide a `query` and a `page` function.
- The `query` function 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.
```python
import starkbank
for transaction in starkbank.transaction.query(limit=200):
print(transaction)
```
- The `page` function 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 be `None`.
```python
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:
break
```
To simplify the following SDK examples, we will only use the `query` function, but feel free to use `page` instead.
# Testing in Sandbox
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.
# Usage
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)`)
## Create transactions
To send money between Stark Bank accounts, you can create transactions:
```python
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
## Query transactions
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.
```python
import starkbank
transactions = starkbank.transaction.query(
after="2020-01-01",
before="2020-03-01"
)
for transaction in transactions:
print(transaction)
```
## Get a transaction
You can get a specific transaction by its id:
```python
import starkbank
transaction = starkbank.transaction.get("5155165527080960")
print(transaction)
```
## Get balance
To know how much money you have in your workspace, run:
```python
import starkbank
balance = starkbank.balance.get()
print(balance)
```
## Create transfers
You can also create transfers in the SDK (TED/Pix) and configure transfer behavior according to its rules.
```python
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
## Query transfers
You can query multiple transfers according to filters.
```python
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)
```
## Cancel a scheduled transfer
To cancel a single scheduled transfer by its id, run:
```python
import starkbank
transfer = starkbank.transfer.delete("5155165527080960")
print(transfer)
```
## Get a transfer
To get a single transfer by its id, run:
```python
import starkbank
transfer = starkbank.transfer.get("5155165527080960")
print(transfer)
```
## Get a transfer PDF
A transfer PDF may also be retrieved by its id.
This operation is only valid if the transfer status is "processing" or "success".
```python
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.
## Query transfer logs
You can query transfer logs to better understand transfer life cycles.
```python
import starkbank
logs = starkbank.transfer.log.query(limit=50)
for log in logs:
print(log.id)
```
## Get a transfer log
You can also get a specific log by its id.
```python
import starkbank
log = starkbank.transfer.log.get("5155165527080960")
print(log)
```
## Get DICT key
You can get the Pix key's parameters by its id.
```python
import starkbank
dict_key = starkbank.dictkey.get("tony@starkbank.com")
print(dict_key)
```
## Query your DICT keys
To take a look at the Pix keys linked to your workspace, just run the following:
```python
import starkbank
dict_keys = starkbank.dictkey.query(status="registered")
for dict_key in dict_keys:
print(dict_key)
```
## Query Bacen institutions
You can query institutions registered by the Brazilian Central Bank for Pix and TED transactions.
```python
import starkbank
institutions = starkbank.institution.query(search="stark")
for institution in institutions:
print(institution)
```
## Create invoices
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**.
```python
# 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
## Get an invoice
After its creation, information on an invoice may be retrieved by its id.
Its status indicates whether it's been paid.
```python
import starkbank
invoice = starkbank.invoice.get("5155165527080960")
print(invoice)
```
## Get an invoice PDF
After its creation, an invoice PDF may be retrieved by its id.
```python
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.
## Get an invoice QR Code
After its creation, an Invoice QR Code may be retrieved by its id.
```python
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.
## Cancel an invoice
You can also cancel an invoice by its id.
Note that this is not possible if it has been paid already.
```python
import starkbank
invoice = starkbank.invoice.update("5155165527080960", status="canceled")
print(invoice)
```
## Update an 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.
```python
import starkbank
from datetime import datetime, timedelta
invoice = starkbank.invoice.update(
"5155165527080960",
amount=100,
expiration=0,
due=datetime.utcnow() + timedelta(hours=1),
)
print(invoice)
```
## Query invoices
You can get a list of created invoices given some filters.
```python
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)
```
## Query invoice logs
Logs are pretty important to understand the life cycle of an invoice.
```python
import starkbank
logs = starkbank.invoice.log.query(limit=150)
for log in logs:
print(log)
```
## Get an invoice log
You can get a single log by its id.
```python
import starkbank
log = starkbank.invoice.log.get("5155165527080960")
print(log)
```
## Get a reversed invoice log PDF
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:
```python
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.
## Get an invoice payment information
Once an invoice has been paid, you can get the payment information using the Invoice.Payment sub-resource:
```python
import starkbank
paymentInformation = starkbank.invoice.payment("5155165527080960")
print(paymentInformation)
```
## Create DynamicBrcodes
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.
```python
# 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
## Get a DynamicBrcode
After its creation, information on a DynamicBrcode may be retrieved by its uuid.
```python
import starkbank
brcode = starkbank.dynamicbrcode.get("bb9cd43ea6f4403391bf7ef6aa876600")
print(brcode)
```
## Query DynamicBrcodes
You can get a list of created DynamicBrcodes given some filters.
```python
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)
```
## Query deposits
You can get a list of created deposits given some filters.
```python
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)
```
## Get a deposit
After its creation, information on a deposit may be retrieved by its id.
```python
import starkbank
deposit = starkbank.deposit.get("5155165527080960")
print(deposit)
```
## Update a 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.
```python
import starkbank
deposit = starkbank.deposit.update(
"5155165527080960",
amount=0,
)
print(deposit)
```
## Query deposit logs
Logs are pretty important to understand the life cycle of a deposit.
```python
import starkbank
logs = starkbank.deposit.log.query(limit=150)
for log in logs:
print(log)
```
## Get a deposit log
You can get a single log by its id.
```python
import starkbank
log = starkbank.deposit.log.get("5155165527080960")
print(log)
```
## Get a reversed deposit log PDF
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:
```python
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.
## Create boletos
You can create boletos to charge customers or to receive money from accounts
you have in other banks.
```python
# 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
## Get a boleto
After its creation, information on a boleto may be retrieved by its id.
Its status indicates whether it's been paid.
```python
import starkbank
boleto = starkbank.boleto.get("5155165527080960")
print(boleto)
```
## Get a boleto PDF
After its creation, a boleto PDF may be retrieved by its id.
```python
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.
## Delete a boleto
You can also cancel a boleto by its id.
Note that this is not possible if it has been processed already.
```python
import starkbank
boleto = starkbank.boleto.delete("5155165527080960")
print(boleto)
```
## Query boletos
You can get a list of created boletos given some filters.
```python
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)
```
## Query boleto logs
Logs are pretty important to understand the life cycle of a boleto.
```python
import starkbank
logs = starkbank.boleto.log.query(limit=150)
for log in logs:
print(log)
```
## Get a boleto log
You can get a single log by its id.
```python
import starkbank
log = starkbank.boleto.log.get("5155165527080960")
print(log)
```
## Investigate a boleto
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.
```python
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
## Get a boleto holmes
To get a single Holmes by its id, run:
```python
import starkbank
sherlock = starkbank.boletoholmes.get("19278361897236187236")
print(sherlock)
```
## Query boleto holmes
You can search for boleto Holmes using filters.
```python
import starkbank
holmes = starkbank.boletoholmes.query(
tags=["customer_1", "customer_2"]
)
for sherlock in holmes:
print(sherlock)
```
## Query boleto holmes logs
Searches are also possible with boleto holmes logs:
```python
import starkbank
logs = starkbank.boletoholmes.log.query(
holmes_ids=["5155165527080960", "76551659167801921"],
)
for log in logs:
print(log)
```
## Get a boleto holmes log
You can also get a boleto holmes log by specifying its id.
```python
import starkbank
log = starkbank.boletoholmes.log.get("5155165527080960")
print(log)
```
## Pay a BR Code
Paying a BR Code is also simple. After extracting the BR Code encoded in the Pix QR Code, you can do the following:
```python
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
## Get a BR Code payment
To get a single BR Code payment by its id, run:
```python
import starkbank
payment = starkbank.brcodepayment.get("19278361897236187236")
print(payment)
```
## Get a BR Code payment PDF
After its creation, a BR Code payment PDF may be retrieved by its id.
```python
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.
## Cancel a BR Code payment
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.
```python
import starkbank
from datetime import datetime, timedelta
payment = starkbank.brcodepayment.update(
"5155165527080960",
status="canceled"
)
print(payment)
```
## Query BR Code payments
You can search for brcode payments using filters.
```python
import starkbank
payments = starkbank.brcodepayment.query(
tags=["company_1", "company_2"]
)
for payment in payments:
print(payment)
```
## Query BR Code payment logs
Searches are also possible with BR Code payment logs:
```python
import starkbank
logs = starkbank.brcodepayment.log.query(
payment_ids=["5155165527080960", "76551659167801921"],
)
for log in logs:
print(log)
```
## Get a BR Code payment log
You can also get a BR Code payment log by specifying its id.
```python
import starkbank
log = starkbank.brcodepayment.log.get("5155165527080960")
print(log)
```
## Pay a boleto
Paying a boleto is also simple.
```python
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
## Get a boleto payment
To get a single boleto payment by its id, run:
```python
import starkbank
payment = starkbank.boletopayment.get("19278361897236187236")
print(payment)
```
## Get a boleto payment PDF
After its creation, a boleto payment PDF may be retrieved by its id.
```python
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.
## Delete a boleto payment
You can also cancel a boleto payment by its id.
Note that this is not possible if it has been processed already.
```python
import starkbank
payment = starkbank.boletopayment.delete("5155165527080960")
print(payment)
```
## Query boleto payments
You can search for boleto payments using filters.
```python
import starkbank
payments = starkbank.boletopayment.query(
tags=["company_1", "company_2"]
)
for payment in payments:
print(payment)
```
## Query boleto payment logs
Searches are also possible with boleto payment logs:
```python
import starkbank
logs = starkbank.boletopayment.log.query(
payment_ids=["5155165527080960", "76551659167801921"],
)
for log in logs:
print(log)
```
## Get a boleto payment log
You can also get a boleto payment log by specifying its id.
```python
import starkbank
log = starkbank.boletopayment.log.get("5155165527080960")
print(log)
```
## Create utility payments
Its also simple to pay utility bills (such as electricity and water bills) in the SDK.
```python
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
## Query utility payments
To search for utility payments using filters, run:
```python
import starkbank
payments = starkbank.utilitypayment.query(
tags=["electricity", "gas"]
)
for payment in payments:
print(payment)
```
## Get a utility payment
You can get a specific bill by its id:
```python
import starkbank
payment = starkbank.utilitypayment.get("5155165527080960")
print(payment)
```
## Get a utility payment PDF
After its creation, a utility payment PDF may also be retrieved by its id.
```python
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.
## Delete a utility payment
You can also cancel a utility payment by its id.
Note that this is not possible if it has been processed already.
```python
import starkbank
payment = starkbank.utilitypayment.delete("5155165527080960")
print(payment)
```
## Query utility payment logs
You can search for payments by specifying filters. Use this to understand the
bills life cycles.
```python
import starkbank
logs = starkbank.utilitypayment.log.query(
payment_ids=["102893710982379182", "92837912873981273"],
)
for log in logs:
print(log)
```
## Get a utility payment log
If you want to get a specific payment log by its id, just run:
```python
import starkbank
log = starkbank.utilitypayment.log.get("1902837198237992")
print(log)
```
## Create tax payment
It is also simple to pay taxes (such as ISS and DAS) using this SDK.
```python
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
## Query tax payments
To search for tax payments using filters, run:
```python
import starkbank
payments = starkbank.taxpayment.query(
tags=["das", "july"]
)
for payment in payments:
print(payment)
```
## Get tax payment
You can get a specific tax payment by its id:
```python
import starkbank
payment = starkbank.taxpayment.get("5155165527080960")
print(payment)
```
## Get tax payment PDF
After its creation, a tax payment PDF may also be retrieved by its id.
```python
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.
## Delete tax payment
You can also cancel a tax payment by its id.
Note that this is not possible if it has been processed already.
```python
import starkbank
payment = starkbank.taxpayment.delete("5155165527080960")
print(payment)
```
## Query tax payment logs
You can search for payment logs by specifying filters. Use this to understand each payment life cycle.
```python
import starkbank
logs = starkbank.taxpayment.log.query(limit=10)
for log in logs:
print(log)
```
## Get tax payment log
If you want to get a specific payment log by its id, just run:
```python
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
## Create DARF payment
If you want to manually pay DARFs without barcodes, you may create DarfPayments:
```python
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
## Query DARF payments
To search for DARF payments using filters, run:
```python
import starkbank
payments = starkbank.darfpayment.query(
tags=["darf", "july"]
)
for payment in payments:
print(payment)
```
## Get DARF payment
You can get a specific DARF payment by its id:
```python
import starkbank
payment = starkbank.darfpayment.get("5155165527080960")
print(payment)
```
## Get DARF payment PDF
After its creation, a DARF payment PDF may also be retrieved by its id.
```python
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.
## Delete DARF payment
You can also cancel a DARF payment by its id.
Note that this is not possible if it has been processed already.
```python
import starkbank
payment = starkbank.darfpayment.delete("5155165527080960")
print(payment)
```
## Query DARF payment logs
You can search for payment logs by specifying filters. Use this to understand each payment life cycle.
```python
import starkbank
logs = starkbank.darfpayment.log.query(limit=10)
for log in logs:
print(log)
```
## Get DARF payment log
If you want to get a specific payment log by its id, just run:
```python
import starkbank
log = starkbank.darfpayment.log.get("1902837198237992")
print(log)
```
## Preview payment information before executing the payment
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"
```python
# 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
## Create payment requests to be approved by authorized people in a cost center
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.
```python
# 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
## Query payment requests
To search for payment requests, run:
```python
import starkbank
requests = starkbank.paymentrequest.query(center_id="123456789", limit=10)
for request in requests:
print(request)
```
## Corporate
## Create CorporateHolders
You can create card holders to which your cards will be bound.
They support spending rules that will apply to all underlying cards.
```python
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
## Query CorporateHolders
You can query multiple holders according to filters.
```python
import starkbank
holders = starkbank.corporateholder.query()
for holder in holders:
print(holder)
```
## Cancel a CorporateHolder
To cancel a single Corporate Holder by its id, run:
```python
import starkbank
holder = starkbank.corporateholder.cancel("5155165527080960")
print(holder)
```
## Get a CorporateHolder
To get a single Corporate Holder by its id, run:
```python
import starkbank
holder = starkbank.corporateholder.get("5155165527080960")
print(holder)
```
## Query CorporateHolder logs
You can query holder logs to better understand holder life cycles.
```python
import starkbank
logs = starkbank.corporateholder.log.query(limit=50)
for log in logs:
print(log.id)
```
## Get a CorporateHolder log
You can also get a specific log by its id.
```python
import starkbank
log = starkbank.corporateholder.log.get("5155165527080960")
print(log)
```
## Create CorporateCard
You can issue cards with specific spending rules.
```python
import starkbank
card = starkbank.corporatecard.create(
starkbank.CorporateCard(
holder_id="5155165527080960"
)
)
print(card)
```
## Query CorporateCards
You can get a list of created cards given some filters.
```python
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)
```
## Get a CorporateCard
After its creation, information on a card may be retrieved by its id.
```python
import starkbank
card = starkbank.corporatecard.get("5155165527080960")
print(card)
```
## Update a CorporateCard
You can update a specific card by its id.
```python
import starkbank
card = starkbank.corporatecard.update("5155165527080960", status="blocked")
print(card)
```
## Cancel a CorporateCard
You can also cancel a card by its id.
```python
import starkbank
card = starkbank.corporatecard.cancel("5155165527080960")
print(card)
```
## Query CorporateCard logs
Logs are pretty important to understand the life cycle of a card.
```python
import starkbank
logs = starkbank.corporatecard.log.query(limit=150)
for log in logs:
print(log)
```
## Get a CorporateCard log
You can get a single log by its id.
```python
import starkbank
log = starkbank.corporatecard.log.get("5155165527080960")
print(log)
```
## Query CorporatePurchases
You can get a list of created purchases given some filters.
```python
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)
```
## Get a CorporatePurchase
After its creation, information on a purchase may be retrieved by its id.
```python
import starkbank
purchase = starkbank.corporatepurchase.get("5155165527080960")
print(purchase)
```
## Query CorporatePurchase logs
Logs are pretty important to understand the life cycle of a purchase.
```python
import starkbank
logs = starkbank.corporatepurchase.log.query(limit=150)
for log in logs:
print(log)
```
## Get a CorporatePurchase log
You can get a single log by its id.
```python
import starkbank
log = starkbank.corporatepurchase.log.get("5155165527080960")
print(log)
```
## Create CorporateInvoices
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.
```python
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
## Query CorporateInvoices
You can get a list of created invoices given some filters.
```python
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)
```
## Create CorporateWithdrawals
You can create withdrawals to send cash back from your Corporate balance to your Banking balance
by using the Withdrawal resource.
```python
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
## Get a CorporateWithdrawal
After its creation, information on a withdrawal may be retrieved by its id.
```python
import starkbank
withdrawal = starkbank.corporatewithdrawal.get("5155165527080960")
print(withdrawal)
```
## Query CorporateWithdrawals
You can get a list of created withdrawals given some filters.
```python
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)
```
## Get your CorporateBalance
To know how much money you have available to run authorizations, run:
```python
import starkbank
balance = starkbank.corporatebalance.get()
print(balance)
```
## Query CorporateTransactions
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.
```python
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)
```
## Get a CorporateTransaction
You can get a specific transaction by its id:
```python
import starkbank
transaction = starkbank.corporatetransaction.get("5155165527080960")
print(transaction)
```
## Corporate Enums
### Query MerchantCategories
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.
```python
import starkbank
categories = starkbank.merchantcategory.query(
search="food",
)
for category in categories:
print(category)
```
### Query MerchantCountries
You can query any merchant countries using this resource.
You may also use MerchantCountries to define specific country filters in CorporateRules.
```python
import starkbank
countries = starkbank.merchantcountry.query(
search="brazil",
)
for country in countries:
print(country)
```
### Query CardMethods
You can query available card methods using this resource.
You may also use CardMethods to define specific purchase method filters in CorporateRules.
```python
import starkbank
methods = starkbank.cardmethod.query(
search="token",
)
for method in methods:
print(method)
```
## Split
Split an Invoice between different receivers.
## Query Splits
You can get a list of created Splits given some filters.
```python
import starkbank
splits = starkbank.split.query(limit=10)
for split in splits:
print(split)
```
## Get a Split
To get a single Split by its id, run:
```python
import starkbank
split = starkbank.split.get("5155165527080960")
print(split)
```
## Query Split Logs
You can query Split logs to check additional information.
```python
import starkbank
logs = starkbank.split.log.query(
split_ids=["5155165527080960", "76551659167801921"],
)
for log in logs:
print(log)
```
## Get a Split Log
You can also get a Split log by specifying its id.
```python
import starkbank
log = starkbank.split.log.get("5155165527080960")
print(log)
```
## Create SplitReceivers
You can create receivers to an Invoice Split by using the SplitReceiver resource.
```python
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)
```
## Query SplitReceivers
To take a look at the SplitReceivers created to your workspace, just run the following:
```python
import starkbank
receivers = starkbank.splitreceiver.query(limit=10)
for receiver in receivers:
print(receiver)
```
## Get a Split Receiver
To get a single SplitReceiver by its id, run:
```python
import starkbank
receiver = starkbank.splitreceiver.get("5155165527080960")
print(receiver)
```
## Query SplitReceiver Logs
You can query SplitReceiver logs to check additional information
```python
import starkbank
logs = starkbank.splitreceiver.log.query(
receiver_ids =["5155165527080960", "76551659167801921"],
)
for log in logs:
print(log)
```
## Get a SplitReceiver Log
You can also get a SplitReceiver Log by specifying its id.
```python
import starkbank
log = starkbank.splitreceiver.log.get("5155165527080960")
print(log)
```
## Create a webhook subscription
To create a webhook subscription and be notified whenever an event occurs, run:
```python
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)
```
## Query webhook subscriptions
To search for registered webhook subscriptions, run:
```python
import starkbank
webhooks = starkbank.webhook.query()
for webhook in webhooks:
print(webhook)
```
## Get a webhook subscription
You can get a specific webhook subscription by its id.
```python
import starkbank
webhook = starkbank.webhook.get("10827361982368179")
print(webhook)
```
## Delete a webhook subscription
You can also delete a specific webhook subscription by its id.
```python
import starkbank
webhook = starkbank.webhook.delete("10827361982368179")
print(webhook)
```
## Process webhook events
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.
```python
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)
```
## Query webhook events
To search for webhooks events, run:
```python
import starkbank
events = starkbank.event.query(after="2020-03-20", is_delivered=False)
for event in events:
print(event)
```
## Get a webhook event
You can get a specific webhook event by its id.
```python
import starkbank
event = starkbank.event.get("10827361982368179")
print(event)
```
## Delete a webhook event
You can also delete a specific webhook event by its id.
```python
import starkbank
event = starkbank.event.delete("10827361982368179")
print(event)
```
## Set webhook events as delivered
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`.
```python
import starkbank
event = starkbank.event.update("129837198237192", is_delivered=True)
print(event)
```
## Query failed webhook event delivery attempts information
You can also get information on failed webhook event delivery attempts.
```python
import starkbank
attempts = starkbank.event.attempt.query(after="2020-03-20")
for attempt in attempts:
print(attempt.code)
print(attempt.message)
```
## Get a failed webhook event delivery attempt information
To retrieve information on a single attempt, use the following function:
```python
import starkbank
attempt = starkbank.event.attempt.get("1616161616161616")
print(attempt)
```
## Create a new Workspace
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`.
```python
import starkbank
workspace = starkbank.workspace.create(
username="iron-bank-workspace-1",
name="Iron Bank Workspace 1",
user=organization,
)
print(workspace)
```
## List your Workspaces
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.
```python
import starkbank
workspaces = starkbank.workspace.query(limit=30)
for workspace in workspaces:
print(workspace)
```
## Get a Workspace
You can get a specific Workspace by its id.
```python
import starkbank
workspace = starkbank.workspace.get("1082736198236817")
print(workspace)
```
## Update a Workspace
You can update a specific Workspace by its id.
```python
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.
```python
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.
# Handling errors
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:
```python
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.
# Help and Feedback
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
Raw data
{
"_id": null,
"home_page": "https://github.com/starkbank/sdk-python",
"name": "starkbank",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "stark bank, starkbank, sdk, open banking, openbanking, banking, open, stark",
"author": "Stark Bank",
"author_email": "developers@starkbank.com",
"download_url": "https://files.pythonhosted.org/packages/42/7a/764beda97aa26d12f6d049eb3c40fdf825c2b06b5550c63c8be3a2a94645/starkbank-2.25.1.tar.gz",
"platform": null,
"description": "# Stark Bank Python SDK\n\nWelcome to the Stark Bank Python SDK! This tool is made for Python \ndevelopers who want to easily integrate with our API.\nThis SDK version is compatible with the Stark Bank API v2.\n\nIf you have no idea what Stark Bank is, check out our [website](https://www.starkbank.com/) \nand discover a world where receiving or making payments \nis as easy as sending a text message to your client!\n\n# Introduction\n\n## Index\n\n- [Introduction](#introduction)\n - [Supported Python versions](#supported-python-versions)\n - [API documentation](#stark-bank-api-documentation)\n - [Versioning](#versioning)\n- [Setup](#setup)\n - [Install our SDK](#1-install-our-sdk)\n - [Create your Private and Public Keys](#2-create-your-private-and-public-keys)\n - [Register your user credentials](#3-register-your-user-credentials)\n - [Setting up the user](#4-setting-up-the-user)\n - [Setting up the error language](#5-setting-up-the-error-language)\n- [Resource listing and manual pagination](#resource-listing-and-manual-pagination)\n- [Testing in Sandbox](#testing-in-sandbox) \n- [Usage](#usage)\n - [Transactions](#create-transactions): Account statement entries\n - [Balance](#get-balance): Account balance\n - [Transfers](#create-transfers): Wire transfers (TED and manual Pix)\n - [DictKeys](#get-dict-key): Pix Key queries to use with Transfers\n - [Institutions](#query-bacen-institutions): Institutions recognized by the Central Bank\n - [Invoices](#create-invoices): Reconciled receivables (dynamic Pix QR Codes)\n - [DynamicBrcode](#create-dynamicbrcodes): Simplified reconciled receivables (dynamic Pix QR Codes)\n - [Deposits](#query-deposits): Other cash-ins (static Pix QR Codes, DynamicBrcodes, manual Pix, etc)\n - [Boletos](#create-boletos): Boleto receivables\n - [BoletoHolmes](#investigate-a-boleto): Boleto receivables investigator\n - [BrcodePayments](#pay-a-br-code): Pay Pix QR Codes\n - [BoletoPayments](#pay-a-boleto): Pay Boletos\n - [UtilityPayments](#create-utility-payments): Pay Utility bills (water, light, etc.)\n - [TaxPayments](#create-tax-payment): Pay taxes\n - [DarfPayments](#create-darf-payment): Pay DARFs\n - [PaymentPreviews](#preview-payment-information-before-executing-the-payment): Preview all sorts of payments\n - [PaymentRequest](#create-payment-requests-to-be-approved-by-authorized-people-in-a-cost-center): Request a payment approval to a cost center\n - [CorporateHolders](#create-corporateholders): Manage cardholders\n - [CorporateCards](#create-corporatecards): Create virtual and/or physical cards\n - [CorporateInvoices](#create-corporateinvoices): Add money to your corporate balance\n - [CorporateWithdrawals](#create-corporatewithdrawals): Send money back to your Workspace from your corporate balance\n - [CorporateBalance](#get-your-corporatebalance): View your corporate balance\n - [CorporateTransactions](#query-corporatetransactions): View the transactions that have affected your corporate balance\n - [CorporateEnums](#corporate-enums): Query enums related to the corporate purchases, such as merchant categories, countries and card purchase methods\n - [Split](#query-splits): Split received Invoice payments between different receivers\n - [SplitReceiver](#create-splitreceivers): Receiver of an Invoice split\n - [Webhooks](#create-a-webhook-subscription): Configure your webhook endpoints and subscriptions\n - [WebhookEvents](#process-webhook-events): Manage webhook events\n - [WebhookEventAttempts](#query-failed-webhook-event-delivery-attempts-information): Query failed webhook event deliveries\n - [Workspaces](#create-a-new-workspace): Manage your accounts\n- [Handling errors](#handling-errors)\n- [Help and Feedback](#help-and-feedback)\n\n## Supported Python Versions\n\nThis library supports the following Python versions:\n\n* Python 2.7\n* Python 3.4+\n\n## Stark Bank API documentation\n\nFeel free to take a look at our [API docs](https://www.starkbank.com/docs/api).\n\n## Versioning\n\nThis project adheres to the following versioning pattern:\n\nGiven a version number MAJOR.MINOR.PATCH, increment:\n\n- MAJOR version when the **API** version is incremented. This may include backwards incompatible changes;\n- MINOR version when **breaking changes** are introduced OR **new functionalities** are added in a backwards compatible manner;\n- PATCH version when backwards compatible bug **fixes** are implemented.\n\n# Setup\n\n## 1. Install our SDK\n\n1.1 To install the package with pip, run:\n\n```sh\npip install starkbank\n```\n\n1.2 To install from source, clone the repo and run:\n\n```sh\npython setup.py install\n```\n\n## 2. Create your Private and Public Keys\n\nWe use ECDSA. That means you need to generate a secp256k1 private\nkey to sign your requests to our API, and register your public key\nwith us so we can validate those requests.\n\nYou can use one of following methods:\n\n2.1. Check out the options in our [tutorial](https://starkbank.com/faq/how-to-create-ecdsa-keys).\n\n2.2. Use our SDK:\n\n```python\nimport starkbank\n\nprivateKey, publicKey = starkbank.key.create()\n\n# or, to also save .pem files in a specific path\nprivateKey, publicKey = starkbank.key.create(\"file/keys/\")\n```\n\n**NOTE**: When you are creating new credentials, it is recommended that you create the\nkeys inside the infrastructure that will use it, in order to avoid risky internet\ntransmissions of your **private-key**. Then you can export the **public-key** alone to the\ncomputer where it will be used in the new Project creation.\n\n## 3. Register your user credentials\n\nYou can interact directly with our API using two types of users: Projects and Organizations.\n\n- **Projects** are workspace-specific users, that is, they are bound to the workspaces they are created in.\nOne workspace can have multiple Projects.\n- **Organizations** are general users that control your entire organization.\nThey can control all your Workspaces and even create new ones. The Organization is bound to your company's tax ID only.\nSince this user is unique in your entire organization, only one credential can be linked to it.\n\n3.1. To create a Project in Sandbox:\n\n3.1.1. Log into [Starkbank Sandbox](https://web.sandbox.starkbank.com)\n\n3.1.2. Go to Menu > Integrations\n\n3.1.3. Click on the \"New Project\" button\n\n3.1.4. Create a Project: Give it a name and upload the public key you created in section 2\n\n3.1.5. After creating the Project, get its Project ID\n\n3.1.6. Use the Project ID and private key to create the object below:\n\n```python\nimport starkbank\n\n# Get your private key from an environment variable or an encrypted database.\n# This is only an example of a private key content. You should use your own key.\nprivate_key_content = \"\"\"\n-----BEGIN EC PARAMETERS-----\nBgUrgQQACg==\n-----END EC PARAMETERS-----\n-----BEGIN EC PRIVATE KEY-----\nMHQCAQEEIMCwW74H6egQkTiz87WDvLNm7fK/cA+ctA2vg/bbHx3woAcGBSuBBAAK\noUQDQgAE0iaeEHEgr3oTbCfh8U2L+r7zoaeOX964xaAnND5jATGpD/tHec6Oe9U1\nIF16ZoTVt1FzZ8WkYQ3XomRD4HS13A==\n-----END EC PRIVATE KEY-----\n\"\"\"\n\nproject = starkbank.Project(\n environment=\"sandbox\",\n id=\"5656565656565656\",\n private_key=private_key_content\n)\n```\n\n3.2. To create Organization credentials in Sandbox:\n\n3.2.1. Log into [Starkbank Sandbox](https://web.sandbox.starkbank.com)\n\n3.2.2. Go to Menu > Integrations\n\n3.2.3. Click on the \"Organization public key\" button\n\n3.2.4. Upload the public key you created in section 2 (only a legal representative of the organization can upload the public key)\n\n3.2.5. Click on your profile picture and then on the \"Organization\" menu to get the Organization ID\n\n3.2.6. Use the Organization ID and private key to create the object below:\n\n```python\nimport starkbank\n\n# Get your private key from an environment variable or an encrypted database.\n# This is only an example of a private key content. You should use your own key.\nprivate_key_content = \"\"\"\n-----BEGIN EC PARAMETERS-----\nBgUrgQQACg==\n-----END EC PARAMETERS-----\n-----BEGIN EC PRIVATE KEY-----\nMHQCAQEEIMCwW74H6egQkTiz87WDvLNm7fK/cA+ctA2vg/bbHx3woAcGBSuBBAAK\noUQDQgAE0iaeEHEgr3oTbCfh8U2L+r7zoaeOX964xaAnND5jATGpD/tHec6Oe9U1\nIF16ZoTVt1FzZ8WkYQ3XomRD4HS13A==\n-----END EC PRIVATE KEY-----\n\"\"\"\n\norganization = starkbank.Organization(\n environment=\"sandbox\",\n id=\"5656565656565656\",\n private_key=private_key_content,\n workspace_id=None, # You only need to set the workspace_id when you are operating a specific workspace_id\n)\n\n# To dynamically use your organization credentials in a specific workspace_id,\n# you can use the Organization.replace() function:\nstarkbank.balance.get(user=starkbank.Organization.replace(organization, \"4848484848484848\"))\n```\n\nNOTE 1: Never hard-code your private key. Get it from an environment variable or an encrypted database.\n\nNOTE 2: We support `'sandbox'` and `'production'` as environments.\n\nNOTE 3: The credentials you registered in `sandbox` do not exist in `production` and vice versa.\n\n\n## 4. Setting up the user\n\nThere are three kinds of users that can access our API: **Organization**, **Project** and **Member**.\n\n- `Project` and `Organization` are designed for integrations and are the ones meant for our SDKs.\n- `Member` is the one you use when you log into our webpage with your e-mail.\n\nThere are two ways to inform the user to the SDK:\n\n4.1 Passing the user as argument in all functions:\n\n```python\nimport starkbank\n\nbalance = starkbank.balance.get(user=project) # or organization\n```\n\n4.2 Set it as a default user in the SDK:\n\n```python\nimport starkbank\n\nstarkbank.user = project # or organization\n\nbalance = starkbank.balance.get()\n```\n\nJust select the way of passing the user that is more convenient to you.\nOn all following examples we will assume a default user has been set.\n\n## 5. Setting up the error language\n\nThe error language can also be set in the same way as the default user:\n\n```python\nimport starkbank\n\nstarkbank.language = \"en-US\"\n```\n\nLanguage options are \"en-US\" for english and \"pt-BR\" for brazilian portuguese. English is default.\n\n# Resource listing and manual pagination\n\nAlmost all SDK resources provide a `query` and a `page` function.\n\n- The `query` function provides a straight forward way to efficiently iterate through all results that match the filters you inform,\nseamlessly retrieving the next batch of elements from the API only when you reach the end of the current batch.\nIf you are not worried about data volume or processing time, this is the way to go.\n\n```python\nimport starkbank\n\nfor transaction in starkbank.transaction.query(limit=200):\n print(transaction)\n```\n\n- The `page` function gives you full control over the API pagination. With each function call, you receive up to\n100 results and the cursor to retrieve the next batch of elements. This allows you to stop your queries and\npick up from where you left off whenever it is convenient. When there are no more elements to be retrieved, the returned cursor will be `None`.\n\n```python\nimport starkbank\n\ncursor = None\nwhile True:\n transactions, cursor = starkbank.transaction.page(limit=50, cursor=cursor)\n for transaction in transactions:\n print(transaction)\n if cursor is None:\n break\n```\n\nTo simplify the following SDK examples, we will only use the `query` function, but feel free to use `page` instead.\n\n# Testing in Sandbox\n\nYour initial balance is zero. For many operations in Stark Bank, you'll need funds\nin your account, which can be added to your balance by creating an Invoice or a Boleto. \n\nIn the Sandbox environment, most of the created Invoices and Boletos will be automatically paid,\nso there's nothing else you need to do to add funds to your account. Just create\na few Invoices and wait around a bit.\n\nIn Production, you (or one of your clients) will need to actually pay this Invoice or Boleto\nfor the value to be credited to your account.\n\n\n# Usage\n\nHere are a few examples on how to use the SDK. If you have any doubts, use the built-in\n`help()` function to get more info on the desired functionality\n(for example: `help(starkbank.boleto.create)`)\n\n## Create transactions\n\nTo send money between Stark Bank accounts, you can create transactions:\n\n```python\nimport starkbank\n\ntransactions = starkbank.transaction.create([\n starkbank.Transaction(\n amount=100, # (R$ 1.00)\n receiver_id=\"1029378109327810\",\n description=\"Transaction to dear provider\",\n external_id=\"12345\", # so we can block anything you send twice by mistake\n tags=[\"provider\"]\n ),\n starkbank.Transaction(\n amount=234, # (R$ 2.34)\n receiver_id=\"2093029347820947\",\n description=\"Transaction to the other provider\",\n external_id=\"12346\", # so we can block anything you send twice by mistake\n tags=[\"provider\"]\n ),\n])\n\nfor transaction in transactions:\n print(transaction)\n```\n\n**Note**: Instead of using Transaction objects, you can also pass each transaction element in dictionary format\n\n## Query transactions\n\nTo understand your balance changes (bank statement), you can query\ntransactions. Note that our system creates transactions for you when\nyou receive boleto payments, pay a bill or make transfers, for example.\n\n```python\nimport starkbank\n\ntransactions = starkbank.transaction.query(\n after=\"2020-01-01\",\n before=\"2020-03-01\"\n)\n\nfor transaction in transactions:\n print(transaction)\n```\n\n## Get a transaction\n\nYou can get a specific transaction by its id:\n\n```python\nimport starkbank\n\ntransaction = starkbank.transaction.get(\"5155165527080960\")\n\nprint(transaction)\n```\n\n## Get balance\n\nTo know how much money you have in your workspace, run:\n\n```python\nimport starkbank\n\nbalance = starkbank.balance.get()\n\nprint(balance)\n```\n\n## Create transfers\n\nYou can also create transfers in the SDK (TED/Pix) and configure transfer behavior according to its rules.\n\n```python\nimport starkbank\nfrom datetime import datetime, timedelta\n\ntransfers = starkbank.transfer.create([\n starkbank.Transfer(\n amount=100,\n bank_code=\"033\", # TED\n branch_code=\"0001\",\n account_number=\"10000-0\",\n account_type=\"salary\",\n tax_id=\"012.345.678-90\",\n name=\"Tony Stark\",\n tags=[\"iron\", \"suit\"]\n ),\n starkbank.Transfer(\n amount=200,\n bank_code=\"20018183\", # Pix\n branch_code=\"1234\",\n account_number=\"123456-7\",\n account_type=\"salary\",\n external_id=\"my-internal-id-12345\",\n tax_id=\"012.345.678-90\",\n name=\"Jon Snow\",\n scheduled=datetime.utcnow() + timedelta(days=3),\n rules=[\n starkbank.transfer.Rule(\n key=\"resendingLimit\", # Set maximum number of retries if Transfer fails due to systemic issues at the receiver bank\n value=5 # Our resending limit is 10 by default\n ) \n ] \n )\n])\n\nfor transfer in transfers:\n print(transfer)\n```\n\n**Note**: Instead of using Transfer objects, you can also pass each transfer element in dictionary format\n\n## Query transfers\n\nYou can query multiple transfers according to filters.\n\n```python\nimport starkbank\nfrom datetime import datetime\n\ntransfers = starkbank.transfer.query(\n after=datetime(2020, 1, 1),\n before=datetime(2020, 4, 1)\n)\n\nfor transfer in transfers:\n print(transfer.name)\n```\n\n## Cancel a scheduled transfer\n\nTo cancel a single scheduled transfer by its id, run:\n\n```python\nimport starkbank\n\ntransfer = starkbank.transfer.delete(\"5155165527080960\")\n\nprint(transfer)\n```\n\n## Get a transfer\n\nTo get a single transfer by its id, run:\n\n```python\nimport starkbank\n\ntransfer = starkbank.transfer.get(\"5155165527080960\")\n\nprint(transfer)\n```\n\n## Get a transfer PDF\n\nA transfer PDF may also be retrieved by its id.\nThis operation is only valid if the transfer status is \"processing\" or \"success\". \n\n```python\nimport starkbank\n\npdf = starkbank.transfer.pdf(\"5155165527080960\")\n\nwith open(\"transfer.pdf\", \"wb\") as file:\n file.write(pdf)\n```\n\nBe careful not to accidentally enforce any encoding on the raw pdf content,\nas it may yield abnormal results in the final file, such as missing images\nand strange characters.\n\n## Query transfer logs\n\nYou can query transfer logs to better understand transfer life cycles.\n\n```python\nimport starkbank\n\nlogs = starkbank.transfer.log.query(limit=50)\n\nfor log in logs:\n print(log.id)\n```\n\n## Get a transfer log\n\nYou can also get a specific log by its id.\n\n```python\nimport starkbank\n\nlog = starkbank.transfer.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n## Get DICT key\n\nYou can get the Pix key's parameters by its id.\n\n```python\nimport starkbank\n\ndict_key = starkbank.dictkey.get(\"tony@starkbank.com\")\n\nprint(dict_key)\n```\n\n## Query your DICT keys\n\nTo take a look at the Pix keys linked to your workspace, just run the following:\n\n```python\nimport starkbank\n\ndict_keys = starkbank.dictkey.query(status=\"registered\")\n\nfor dict_key in dict_keys:\n print(dict_key)\n```\n\n## Query Bacen institutions\n\nYou can query institutions registered by the Brazilian Central Bank for Pix and TED transactions.\n\n```python\nimport starkbank\n\ninstitutions = starkbank.institution.query(search=\"stark\")\n\nfor institution in institutions:\n print(institution)\n```\n\n## Create invoices\n\nYou can create dynamic QR Code invoices to charge customers or to receive money from accounts you have in other banks. \n\nSince 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. \n\nIf 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.\n\nAlso, other banks will most likely only allow payment scheduling on invoices defined with **dates** instead of **datetimes**.\n\n```python\n# coding: utf-8\nimport starkbank\nfrom datetime import date, datetime, timedelta\n\n\ninvoices = starkbank.invoice.create([\n starkbank.Invoice(\n amount=23571, # R$ 235,71 \n name=\"Buzz Aldrin\",\n tax_id=\"012.345.678-90\", \n due=datetime.utcnow() + timedelta(hours=1),\n expiration=timedelta(hours=3).total_seconds(),\n fine=5, # 5%\n interest=2.5, # 2.5% per month\n tags=[\"immediate\"],\n rules=[\n starkbank.transfer.Rule(\n key=\"allowedTaxIds\", # Set TaxIds allowed to receive this Invoice\n value=[ \"012.345.678-90\" ]\n ) \n ] \n ),\n starkbank.Invoice(\n amount=23571, # R$ 235,71 \n name=\"Buzz Aldrin\",\n tax_id=\"012.345.678-90\", \n due=date(2022, 3, 20),\n expiration=timedelta(hours=3).total_seconds(),\n fine=5, # 5%\n interest=2.5, # 2.5% per month\n tags=[\"scheduled\"]\n )\n])\n\nfor invoice in invoices:\n print(invoice)\n```\n\n**Note**: Instead of using Invoice objects, you can also pass each invoice element in dictionary format\n\n## Get an invoice\n\nAfter its creation, information on an invoice may be retrieved by its id. \nIts status indicates whether it's been paid.\n\n```python\nimport starkbank\n\ninvoice = starkbank.invoice.get(\"5155165527080960\")\n\nprint(invoice)\n```\n\n## Get an invoice PDF\n\nAfter its creation, an invoice PDF may be retrieved by its id. \n\n```python\nimport starkbank\n\npdf = starkbank.invoice.pdf(\"5155165527080960\", layout=\"default\")\n\nwith open(\"invoice.pdf\", \"wb\") as file:\n file.write(pdf)\n```\n\nBe careful not to accidentally enforce any encoding on the raw pdf content,\nas it may yield abnormal results in the final file, such as missing images\nand strange characters.\n\n## Get an invoice QR Code \n\nAfter its creation, an Invoice QR Code may be retrieved by its id. \n\n```python\nimport starkbank\n\nqrcode = starkbank.invoice.qrcode(\"5881614903017472\", size= 15)\n\nwith open(\"qrcode.png\", \"wb\") as file:\n file.write(qrcode)\n```\n\nBe careful not to accidentally enforce any encoding on the raw png content,\nas it may corrupt the file.\n\n## Cancel an invoice\n\nYou can also cancel an invoice by its id.\nNote that this is not possible if it has been paid already.\n\n```python\nimport starkbank\n\ninvoice = starkbank.invoice.update(\"5155165527080960\", status=\"canceled\")\n\nprint(invoice)\n```\n\n## Update an invoice\n\nYou can update an invoice's amount, due date and expiration by its id.\nIf the invoice has already been paid, only the amount can be\ndecreased, which will result in a payment reversal. To fully reverse \nthe invoice, pass amount = 0.\n\n```python\nimport starkbank\nfrom datetime import datetime, timedelta\n\ninvoice = starkbank.invoice.update(\n \"5155165527080960\",\n amount=100,\n expiration=0,\n due=datetime.utcnow() + timedelta(hours=1),\n)\n\nprint(invoice)\n```\n\n## Query invoices\n\nYou can get a list of created invoices given some filters.\n\n```python\nimport starkbank\nfrom datetime import datetime\n\ninvoices = starkbank.invoice.query(\n after=datetime(2020, 1, 1),\n before=datetime(2020, 3, 1)\n)\n\nfor invoice in invoices:\n print(invoice)\n```\n\n## Query invoice logs\n\nLogs are pretty important to understand the life cycle of an invoice.\n\n```python\nimport starkbank\n\nlogs = starkbank.invoice.log.query(limit=150)\n\nfor log in logs:\n print(log)\n```\n\n## Get an invoice log\n\nYou can get a single log by its id.\n\n```python\nimport starkbank\n\nlog = starkbank.invoice.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n## Get a reversed invoice log PDF\n\nWhenever an Invoice is successfully reversed, a reversed log will be created. \nTo retrieve a specific reversal receipt, you can request the corresponding log PDF:\n\n```python\nimport starkbank\n\npdf = starkbank.invoice.log.pdf(\"5155165527080960\")\n\nwith open(\"invoice-reversal.pdf\", \"wb\") as file:\n file.write(pdf)\n```\n\nBe careful not to accidentally enforce any encoding on the raw pdf content,\nas it may yield abnormal results in the final file, such as missing images\nand strange characters.\n\n## Get an invoice payment information\n\nOnce an invoice has been paid, you can get the payment information using the Invoice.Payment sub-resource:\n\n```python\nimport starkbank\n\npaymentInformation = starkbank.invoice.payment(\"5155165527080960\")\n\nprint(paymentInformation)\n```\n\n## Create DynamicBrcodes\n\nYou can create simplified dynamic QR Codes to receive money using Pix transactions. \nWhen a DynamicBrcode is paid, a Deposit is created with the tags parameter containing the character \u201cdynamic-brcode/\u201d followed by the DynamicBrcode\u2019s uuid \"dynamic-brcode/{uuid}\" for conciliation.\n\nThe differences between an Invoice and the DynamicBrcode are the following:\n\n| | Invoice | DynamicBrcode |\n|-----------------------|:-------:|:-------------:|\n| Expiration | \u2713 | \u2713 | \n| Can only be paid once | \u2713 | \u2713 |\n| Due, fine and fee | \u2713 | X | \n| Discount | \u2713 | X | \n| Description | \u2713 | X |\n| Can be updated | \u2713 | X |\n\n**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). \n**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.\n\n```python\n# coding: utf-8\nimport starkbank\nfrom datetime import timedelta\n\n\nbrcodes = starkbank.dynamicbrcode.create([\n starkbank.DynamicBrcode(\n amount=23571, # R$ 235,71 \n expiration=timedelta(hours=3).total_seconds()\n ),\n starkbank.DynamicBrcode(\n amount=23571, # R$ 235,71 \n expiration=timedelta(hours=3).total_seconds()\n )\n])\n\nfor brcode in brcodes:\n print(brcode)\n```\n\n**Note**: Instead of using DynamicBrcode objects, you can also pass each brcode element in dictionary format\n\n## Get a DynamicBrcode\n\nAfter its creation, information on a DynamicBrcode may be retrieved by its uuid.\n\n```python\nimport starkbank\n\nbrcode = starkbank.dynamicbrcode.get(\"bb9cd43ea6f4403391bf7ef6aa876600\")\n\nprint(brcode)\n```\n\n## Query DynamicBrcodes\n\nYou can get a list of created DynamicBrcodes given some filters.\n\n```python\nimport starkbank\nfrom datetime import datetime\n\nbrcodes = starkbank.dynamicbrcode.query(\n after=datetime(2023, 1, 1),\n before=datetime(2023, 3, 1)\n)\n\nfor brcode in brcodes:\n print(brcode)\n```\n\n## Query deposits\n\nYou can get a list of created deposits given some filters.\n\n```python\nimport starkbank\nfrom datetime import datetime\n\ndeposits = starkbank.deposit.query(\n after=datetime(2020, 1, 1),\n before=datetime(2020, 3, 1)\n)\n\nfor deposit in deposits:\n print(deposit)\n```\n\n## Get a deposit\n\nAfter its creation, information on a deposit may be retrieved by its id. \n\n```python\nimport starkbank\n\ndeposit = starkbank.deposit.get(\"5155165527080960\")\n\nprint(deposit)\n```\n\n## Update a deposit\n\nYou 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.\n\n```python\nimport starkbank\n\ndeposit = starkbank.deposit.update(\n \"5155165527080960\",\n amount=0,\n)\n\nprint(deposit)\n```\n\n## Query deposit logs\n\nLogs are pretty important to understand the life cycle of a deposit.\n\n```python\nimport starkbank\n\nlogs = starkbank.deposit.log.query(limit=150)\n\nfor log in logs:\n print(log)\n```\n\n## Get a deposit log\n\nYou can get a single log by its id.\n\n```python\nimport starkbank\n\nlog = starkbank.deposit.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n## Get a reversed deposit log PDF\n\nWhenever an Deposit is successfully reversed, a reversed log will be created. \nTo retrieve a specific reversal receipt, you can request the corresponding log PDF:\n\n```python\nimport starkbank\n\npdf = starkbank.deposit.log.pdf(\"5155165527080960\")\n\nwith open(\"deposit-reversal.pdf\", \"wb\") as file:\n file.write(pdf)\n```\n\nBe careful not to accidentally enforce any encoding on the raw pdf content,\nas it may yield abnormal results in the final file, such as missing images\nand strange characters.\n\n\n## Create boletos\n\nYou can create boletos to charge customers or to receive money from accounts\nyou have in other banks.\n\n```python\n# coding: utf-8\nimport starkbank\nfrom datetime import datetime\n\n\nboletos = starkbank.boleto.create([\n starkbank.Boleto(\n amount=23571, # R$ 235,71 \n name=\"Buzz Aldrin\",\n tax_id=\"012.345.678-90\", \n street_line_1=\"Av. Paulista, 200\", \n street_line_2=\"10 andar\",\n district=\"Bela Vista\", \n city=\"S\u00e3o Paulo\",\n state_code=\"SP\",\n zip_code=\"01310-000\",\n due=datetime(2020, 3, 20),\n fine=5, # 5%\n interest=2.5, # 2.5% per month\n ),\n])\n\nfor boleto in boletos:\n print(boleto)\n```\n\n**Note**: Instead of using Boleto objects, you can also pass each boleto element in dictionary format\n\n## Get a boleto\n\nAfter its creation, information on a boleto may be retrieved by its id. \nIts status indicates whether it's been paid.\n\n```python\nimport starkbank\n\nboleto = starkbank.boleto.get(\"5155165527080960\")\n\nprint(boleto)\n```\n\n## Get a boleto PDF\n\nAfter its creation, a boleto PDF may be retrieved by its id. \n\n```python\nimport starkbank\n\npdf = starkbank.boleto.pdf(\"5155165527080960\", layout=\"default\")\n\nwith open(\"boleto.pdf\", \"wb\") as file:\n file.write(pdf)\n```\n\nBe careful not to accidentally enforce any encoding on the raw pdf content,\nas it may yield abnormal results in the final file, such as missing images\nand strange characters.\n\n## Delete a boleto\n\nYou can also cancel a boleto by its id.\nNote that this is not possible if it has been processed already.\n\n```python\nimport starkbank\n\nboleto = starkbank.boleto.delete(\"5155165527080960\")\n\nprint(boleto)\n```\n\n## Query boletos\n\nYou can get a list of created boletos given some filters.\n\n```python\nimport starkbank\nfrom datetime import datetime\n\nboletos = starkbank.boleto.query(\n after=datetime(2020, 1, 1),\n before=datetime(2020, 3, 1)\n)\n\nfor boleto in boletos:\n print(boleto)\n```\n\n## Query boleto logs\n\nLogs are pretty important to understand the life cycle of a boleto.\n\n```python\nimport starkbank\n\nlogs = starkbank.boleto.log.query(limit=150)\n\nfor log in logs:\n print(log)\n```\n\n## Get a boleto log\n\nYou can get a single log by its id.\n\n```python\nimport starkbank\n\nlog = starkbank.boleto.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n## Investigate a boleto\n\nYou can discover if a StarkBank boleto has been recently paid before we receive the response on the next day.\nThis can be done by creating a BoletoHolmes object, which fetches the updated status of the corresponding\nBoleto object according to CIP to check, for example, whether it is still payable or not. The investigation\nhappens asynchronously and the most common way to retrieve the results is to register a \"boleto-holmes\" webhook\nsubscription, although polling is also possible. \n\n```python\nimport starkbank\n\nholmes = starkbank.boletoholmes.create([\n starkbank.BoletoHolmes(\n boleto_id=\"5656565656565656\",\n ),\n starkbank.BoletoHolmes(\n boleto_id=\"4848484848484848\",\n ),\n])\n\nfor sherlock in holmes:\n print(sherlock)\n```\n\n**Note**: Instead of using BoletoHolmes objects, you can also pass each payment element in dictionary format\n\n## Get a boleto holmes\n\nTo get a single Holmes by its id, run:\n\n```python\nimport starkbank\n\nsherlock = starkbank.boletoholmes.get(\"19278361897236187236\")\n\nprint(sherlock)\n```\n\n## Query boleto holmes\n\nYou can search for boleto Holmes using filters. \n\n```python\nimport starkbank\n\nholmes = starkbank.boletoholmes.query(\n tags=[\"customer_1\", \"customer_2\"]\n)\n\nfor sherlock in holmes:\n print(sherlock)\n```\n\n## Query boleto holmes logs\n\nSearches are also possible with boleto holmes logs:\n\n```python\nimport starkbank\n\nlogs = starkbank.boletoholmes.log.query(\n holmes_ids=[\"5155165527080960\", \"76551659167801921\"],\n)\n\nfor log in logs:\n print(log)\n```\n\n\n## Get a boleto holmes log\n\nYou can also get a boleto holmes log by specifying its id.\n\n```python\nimport starkbank\n\nlog = starkbank.boletoholmes.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n## Pay a BR Code\n\nPaying a BR Code is also simple. After extracting the BR Code encoded in the Pix QR Code, you can do the following:\n\n```python\nimport starkbank\n\npayments = starkbank.brcodepayment.create([\n starkbank.BrcodePayment(\n brcode=\"00020126580014br.gov.bcb.pix0136a629532e-7693-4846-852d-1bbff817b5a8520400005303986540510.005802BR5908T'Challa6009Sao Paulo62090505123456304B14A\",\n tax_id=\"012.345.678-90\",\n scheduled=\"2020-03-13\",\n description=\"this will be fast\",\n tags=[\"pix\", \"qrcode\"],\n rules=[\n starkbank.brcodepayment.Rule(\n key=\"resendingLimit\", # Set maximum number of retries if Payment fails due to systemic issues at the receiver bank\n value=5 # Our resending limit is 10 by default\n ) \n ]\n )\n])\n\nfor payment in payments:\n print(payment)\n```\n**Note**: You can also configure payment behavior according to its rules\n**Note**: Instead of using BrcodePayment objects, you can also pass each payment element in dictionary format\n\n## Get a BR Code payment\n\nTo get a single BR Code payment by its id, run:\n\n```python\nimport starkbank\n\npayment = starkbank.brcodepayment.get(\"19278361897236187236\")\n\nprint(payment)\n```\n\n## Get a BR Code payment PDF\n\nAfter its creation, a BR Code payment PDF may be retrieved by its id. \n\n```python\nimport starkbank\n\npdf = starkbank.brcodepayment.pdf(\"5155165527080960\")\n\nwith open(\"brcode-payment.pdf\", \"wb\") as file:\n file.write(pdf)\n```\n\nBe careful not to accidentally enforce any encoding on the raw pdf content,\nas it may yield abnormal results in the final file, such as missing images\nand strange characters.\n\n## Cancel a BR Code payment\n\nYou can cancel a BR Code payment by changing its status to \"canceled\".\nNote that this is not possible if it has been processed already.\n\n```python\nimport starkbank\nfrom datetime import datetime, timedelta\n\npayment = starkbank.brcodepayment.update(\n \"5155165527080960\",\n status=\"canceled\"\n)\n\nprint(payment)\n```\n\n## Query BR Code payments\n\nYou can search for brcode payments using filters. \n\n```python\nimport starkbank\n\npayments = starkbank.brcodepayment.query(\n tags=[\"company_1\", \"company_2\"]\n)\n\nfor payment in payments:\n print(payment)\n```\n\n## Query BR Code payment logs\n\nSearches are also possible with BR Code payment logs:\n\n```python\nimport starkbank\n\nlogs = starkbank.brcodepayment.log.query(\n payment_ids=[\"5155165527080960\", \"76551659167801921\"],\n)\n\nfor log in logs:\n print(log)\n```\n\n\n## Get a BR Code payment log\n\nYou can also get a BR Code payment log by specifying its id.\n\n```python\nimport starkbank\n\nlog = starkbank.brcodepayment.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n\n## Pay a boleto\n\nPaying a boleto is also simple.\n\n```python\nimport starkbank\n\npayments = starkbank.boletopayment.create([\n starkbank.BoletoPayment(\n line=\"34191.09008 61207.727308 71444.640008 5 81310001234321\",\n tax_id=\"012.345.678-90\",\n scheduled=\"2020-03-13\",\n description=\"take my money\",\n tags=[\"take\", \"my\", \"money\"],\n ),\n starkbank.BoletoPayment(\n bar_code=\"34197819200000000011090063609567307144464000\",\n tax_id=\"012.345.678-90\",\n scheduled=\"2020-03-14\",\n description=\"take my money one more time\",\n tags=[\"again\"],\n ),\n])\n\nfor payment in payments:\n print(payment)\n```\n\n**Note**: Instead of using BoletoPayment objects, you can also pass each payment element in dictionary format\n\n## Get a boleto payment\n\nTo get a single boleto payment by its id, run:\n\n```python\nimport starkbank\n\npayment = starkbank.boletopayment.get(\"19278361897236187236\")\n\nprint(payment)\n```\n\n## Get a boleto payment PDF\n\nAfter its creation, a boleto payment PDF may be retrieved by its id. \n\n```python\nimport starkbank\n\npdf = starkbank.boletopayment.pdf(\"5155165527080960\")\n\nwith open(\"boleto-payment.pdf\", \"wb\") as file:\n file.write(pdf)\n```\n\nBe careful not to accidentally enforce any encoding on the raw pdf content,\nas it may yield abnormal results in the final file, such as missing images\nand strange characters.\n\n## Delete a boleto payment\n\nYou can also cancel a boleto payment by its id.\nNote that this is not possible if it has been processed already.\n\n```python\nimport starkbank\n\npayment = starkbank.boletopayment.delete(\"5155165527080960\")\n\nprint(payment)\n```\n\n## Query boleto payments\n\nYou can search for boleto payments using filters. \n\n```python\nimport starkbank\n\npayments = starkbank.boletopayment.query(\n tags=[\"company_1\", \"company_2\"]\n)\n\nfor payment in payments:\n print(payment)\n```\n\n## Query boleto payment logs\n\nSearches are also possible with boleto payment logs:\n\n```python\nimport starkbank\n\nlogs = starkbank.boletopayment.log.query(\n payment_ids=[\"5155165527080960\", \"76551659167801921\"],\n)\n\nfor log in logs:\n print(log)\n```\n\n## Get a boleto payment log\n\nYou can also get a boleto payment log by specifying its id.\n\n```python\nimport starkbank\n\nlog = starkbank.boletopayment.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n## Create utility payments\n\nIts also simple to pay utility bills (such as electricity and water bills) in the SDK.\n\n```python\nimport starkbank\n\npayments = starkbank.utilitypayment.create([\n starkbank.UtilityPayment(\n line=\"34197819200000000011090063609567307144464000\",\n scheduled=\"2020-03-13\",\n description=\"take my money\",\n tags=[\"take\", \"my\", \"money\"],\n ),\n starkbank.UtilityPayment(\n bar_code=\"34191.09008 61207.727308 71444.640008 5 81310001234321\",\n scheduled=\"2020-03-14\",\n description=\"take my money one more time\",\n tags=[\"again\"],\n ),\n])\n\nfor payment in payments:\n print(payment)\n```\n\n**Note**: Instead of using UtilityPayment objects, you can also pass each payment element in dictionary format\n\n## Query utility payments\n\nTo search for utility payments using filters, run:\n\n```python\nimport starkbank\n\npayments = starkbank.utilitypayment.query(\n tags=[\"electricity\", \"gas\"]\n)\n\nfor payment in payments:\n print(payment)\n```\n\n## Get a utility payment\n\nYou can get a specific bill by its id:\n\n```python\nimport starkbank\n\npayment = starkbank.utilitypayment.get(\"5155165527080960\")\n\nprint(payment)\n```\n\n## Get a utility payment PDF\n\nAfter its creation, a utility payment PDF may also be retrieved by its id. \n\n```python\nimport starkbank\n\npdf = starkbank.utilitypayment.pdf(\"5155165527080960\")\n\nwith open(\"electricity-payment.pdf\", \"wb\") as file:\n file.write(pdf)\n```\n\nBe careful not to accidentally enforce any encoding on the raw pdf content,\nas it may yield abnormal results in the final file, such as missing images\nand strange characters.\n\n## Delete a utility payment\n\nYou can also cancel a utility payment by its id.\nNote that this is not possible if it has been processed already.\n\n```python\nimport starkbank\n\npayment = starkbank.utilitypayment.delete(\"5155165527080960\")\n\nprint(payment)\n```\n\n## Query utility payment logs\n\nYou can search for payments by specifying filters. Use this to understand the\nbills life cycles.\n\n```python\nimport starkbank\n\nlogs = starkbank.utilitypayment.log.query(\n payment_ids=[\"102893710982379182\", \"92837912873981273\"],\n)\n\nfor log in logs:\n print(log)\n```\n\n## Get a utility payment log\n\nIf you want to get a specific payment log by its id, just run:\n\n```python\nimport starkbank\n\nlog = starkbank.utilitypayment.log.get(\"1902837198237992\")\n\nprint(log)\n```\n\n## Create tax payment\n\nIt is also simple to pay taxes (such as ISS and DAS) using this SDK.\n\n```python\nimport starkbank\n\npayments = starkbank.taxpayment.create([\n starkbank.TaxPayment(\n bar_code=\"83660000001084301380074119002551100010601813\",\n scheduled=\"2020-08-13\",\n description=\"fix the road\",\n tags=[\"take\", \"my\", \"money\"],\n ),\n starkbank.TaxPayment(\n line=\"85800000003 0 28960328203 1 56072020190 5 22109674804 0\",\n scheduled=\"2020-08-14\",\n description=\"build the hospital, hopefully\",\n tags=[\"expensive\"],\n ),\n])\n\nfor payment in payments:\n print(payment)\n```\n\n**Note**: Instead of using TaxPayment objects, you can also pass each payment element in dictionary format\n\n## Query tax payments\n\nTo search for tax payments using filters, run:\n\n```python\nimport starkbank\n\npayments = starkbank.taxpayment.query(\n tags=[\"das\", \"july\"]\n)\n\nfor payment in payments:\n print(payment)\n```\n\n## Get tax payment\n\nYou can get a specific tax payment by its id:\n\n```python\nimport starkbank\n\npayment = starkbank.taxpayment.get(\"5155165527080960\")\n\nprint(payment)\n```\n\n## Get tax payment PDF\n\nAfter its creation, a tax payment PDF may also be retrieved by its id. \n\n```python\nimport starkbank\n\npdf = starkbank.taxpayment.pdf(\"5155165527080960\")\n\nwith open(\"iss-payment.pdf\", \"wb\") as file:\n file.write(pdf)\n```\n\nBe careful not to accidentally enforce any encoding on the raw pdf content,\nas it may yield abnormal results in the final file, such as missing images\nand strange characters.\n\n## Delete tax payment\n\nYou can also cancel a tax payment by its id.\nNote that this is not possible if it has been processed already.\n\n```python\nimport starkbank\n\npayment = starkbank.taxpayment.delete(\"5155165527080960\")\n\nprint(payment)\n```\n\n## Query tax payment logs\n\nYou can search for payment logs by specifying filters. Use this to understand each payment life cycle.\n\n```python\nimport starkbank\n\nlogs = starkbank.taxpayment.log.query(limit=10)\n\nfor log in logs:\n print(log)\n```\n\n## Get tax payment log\n\nIf you want to get a specific payment log by its id, just run:\n\n```python\nimport starkbank\n\nlog = starkbank.taxpayment.log.get(\"1902837198237992\")\n\nprint(log)\n```\n\n**Note**: Some taxes can't be payed with bar codes. Since they have specific parameters, each one of them has its own\nresource and routes, which are all analogous to the TaxPayment resource. The ones we currently support are:\n- DarfPayment, for DARFs\n\n## Create DARF payment\n\nIf you want to manually pay DARFs without barcodes, you may create DarfPayments:\n\n```python\nimport starkbank\nfrom datetime import datetime, timedelta\n\n\npayments = starkbank.darfpayment.create([\n starkbank.DarfPayment(\n revenue_code=\"1240\",\n tax_id=\"012.345.678-90\",\n competence=\"2020-09-01\",\n reference_number=\"2340978970\",\n nominal_amount=1234,\n fine_amount=12,\n interest_amount=34,\n due=datetime.now() + timedelta(days=30),\n scheduled=datetime.now() + timedelta(days=30),\n tags=[\"DARF\", \"making money\"],\n description=\"take my money\",\n )\n])\n\nfor payment in payments:\n print(payment)\n```\n\n**Note**: Instead of using DarfPayment objects, you can also pass each payment element in dictionary format\n\n## Query DARF payments\n\nTo search for DARF payments using filters, run:\n\n```python\nimport starkbank\n\npayments = starkbank.darfpayment.query(\n tags=[\"darf\", \"july\"]\n)\n\nfor payment in payments:\n print(payment)\n```\n\n## Get DARF payment\n\nYou can get a specific DARF payment by its id:\n\n```python\nimport starkbank\n\npayment = starkbank.darfpayment.get(\"5155165527080960\")\n\nprint(payment)\n```\n\n## Get DARF payment PDF\n\nAfter its creation, a DARF payment PDF may also be retrieved by its id. \n\n```python\nimport starkbank\n\npdf = starkbank.darfpayment.pdf(\"5155165527080960\")\n\nwith open(\"darf-payment.pdf\", \"wb\") as file:\n file.write(pdf)\n```\n\nBe careful not to accidentally enforce any encoding on the raw pdf content,\nas it may yield abnormal results in the final file, such as missing images\nand strange characters.\n\n## Delete DARF payment\n\nYou can also cancel a DARF payment by its id.\nNote that this is not possible if it has been processed already.\n\n```python\nimport starkbank\n\npayment = starkbank.darfpayment.delete(\"5155165527080960\")\n\nprint(payment)\n```\n\n## Query DARF payment logs\n\nYou can search for payment logs by specifying filters. Use this to understand each payment life cycle.\n\n```python\nimport starkbank\n\nlogs = starkbank.darfpayment.log.query(limit=10)\n\nfor log in logs:\n print(log)\n```\n\n## Get DARF payment log\n\nIf you want to get a specific payment log by its id, just run:\n\n```python\nimport starkbank\n\nlog = starkbank.darfpayment.log.get(\"1902837198237992\")\n\nprint(log)\n```\n\n## Preview payment information before executing the payment\n\nYou can preview multiple types of payment to confirm any information before actually paying.\nIf the \"scheduled\" parameter is not informed, today will be assumed as the intended payment date.\nRight now, the \"scheduled\" parameter only has effect on BrcodePreviews.\nThis resource is able to preview the following types of payment:\n\"brcode-payment\", \"boleto-payment\", \"utility-payment\" and \"tax-payment\"\n\n```python\n# coding: utf-8\nimport starkbank\nfrom datetime import date, timedelta\n\n\npreviews = starkbank.paymentpreview.create([\n starkbank.PaymentPreview(\n id=\"00020126580014br.gov.bcb.pix0136a629532e-7693-4846-852d-1bbff817b5a8520400005303986540510.005802BR5908T'Challa6009Sao Paulo62090505123456304B14A\",\n scheduled=date.today() + timedelta(days=3)\n ),\n starkbank.PaymentPreview(\n id=\"34191.09008 61207.727308 71444.640008 5 81310001234321\"\n ),\n])\n\nfor preview in previews:\n print(preview)\n payment = preview.payment\n if preview.type == \"brcode-payment\":\n print(payment.status)\n```\n\n**Note**: Instead of using PaymentPreview objects, you can also pass each request element in dictionary format\n\n\n## Create payment requests to be approved by authorized people in a cost center \n\nYou can also request payments that must pass through a specific cost center approval flow to be executed.\nIn certain structures, this allows double checks for cash-outs and also gives time to load your account\nwith the required amount before the payments take place.\nThe approvals can be granted at our website and must be performed according to the rules\nspecified in the cost center.\n\n**Note**: The value of the center_id parameter can be consulted by logging into our website and going\nto the desired cost center page.\n\n```python\n# coding: utf-8\nimport starkbank\nfrom datetime import date, timedelta\n\n\nrequests = starkbank.paymentrequest.create([\n starkbank.PaymentRequest(\n center_id=\"5967314465849344\",\n payment=starkbank.Transfer(\n amount=200,\n bank_code=\"341\",\n branch_code=\"1234\",\n account_number=\"123456-7\",\n tax_id=\"012.345.678-90\",\n name=\"Bucket Head\",\n tags=[]\n ),\n due=\"2020-11-01\"\n ),\n])\n\nfor request in requests:\n print(request)\n```\n\n**Note**: Instead of using PaymentRequest objects, you can also pass each request element in dictionary format\n\n\n## Query payment requests\n\nTo search for payment requests, run:\n\n```python\nimport starkbank\n\nrequests = starkbank.paymentrequest.query(center_id=\"123456789\", limit=10)\n\nfor request in requests:\n print(request)\n```\n\n## Corporate\n\n## Create CorporateHolders\n\nYou can create card holders to which your cards will be bound.\nThey support spending rules that will apply to all underlying cards.\n\n```python\nimport starkbank\n\nholders = starkbank.corporateholder.create([\n starkbank.CorporateHolder(\n name=\"Iron Bank S.A.\",\n tags=[\n \"Traveler Employee\"\n ],\n rules=[\n {\n \"name\": \"General USD\",\n \"interval\": \"day\",\n \"amount\": 100000,\n \"currencyCode\": \"USD\",\n \"categories\": [\n starkbank.MerchantCategory(type=\"services\"),\n starkbank.MerchantCategory(code=\"fastFoodRestaurants\")\n ],\n \"countries\": [\n starkbank.MerchantCountry(code=\"USA\")\n ],\n \"methods\": [\n starkbank.CardMethod(code=\"token\")\n ]\n }\n ]\n )\n])\n\nfor holder in holders:\n print(holder)\n```\n\n**Note**: Instead of using CorporateHolder objects, you can also pass each element in dictionary format\n\n## Query CorporateHolders\n\nYou can query multiple holders according to filters.\n\n```python\nimport starkbank\n\nholders = starkbank.corporateholder.query()\n\nfor holder in holders:\n print(holder)\n```\n\n## Cancel a CorporateHolder\n\nTo cancel a single Corporate Holder by its id, run:\n\n```python\nimport starkbank\n\nholder = starkbank.corporateholder.cancel(\"5155165527080960\")\n\nprint(holder)\n```\n\n## Get a CorporateHolder\n\nTo get a single Corporate Holder by its id, run:\n\n```python\nimport starkbank\n\nholder = starkbank.corporateholder.get(\"5155165527080960\")\n\nprint(holder)\n```\n\n## Query CorporateHolder logs\n\nYou can query holder logs to better understand holder life cycles.\n\n```python\nimport starkbank\n\nlogs = starkbank.corporateholder.log.query(limit=50)\n\nfor log in logs:\n print(log.id)\n```\n\n## Get a CorporateHolder log\n\nYou can also get a specific log by its id.\n\n```python\nimport starkbank\n\nlog = starkbank.corporateholder.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n## Create CorporateCard\n\nYou can issue cards with specific spending rules.\n\n```python\nimport starkbank\n\ncard = starkbank.corporatecard.create(\n starkbank.CorporateCard(\n holder_id=\"5155165527080960\"\n )\n)\n\nprint(card)\n```\n\n## Query CorporateCards\n\nYou can get a list of created cards given some filters.\n\n```python\nimport starkbank\nfrom datetime import date\n\ncards = starkbank.corporatecard.query(\n after=date(2020, 1, 1),\n before=date(2020, 3, 1)\n)\n\nfor card in cards:\n print(card)\n```\n\n## Get a CorporateCard\n\nAfter its creation, information on a card may be retrieved by its id.\n\n```python\nimport starkbank\n\ncard = starkbank.corporatecard.get(\"5155165527080960\")\n\nprint(card)\n```\n\n## Update a CorporateCard\n\nYou can update a specific card by its id.\n\n```python\nimport starkbank\n\ncard = starkbank.corporatecard.update(\"5155165527080960\", status=\"blocked\")\n\nprint(card)\n```\n\n## Cancel a CorporateCard\n\nYou can also cancel a card by its id.\n\n```python\nimport starkbank\n\ncard = starkbank.corporatecard.cancel(\"5155165527080960\")\n\nprint(card)\n```\n\n## Query CorporateCard logs\n\nLogs are pretty important to understand the life cycle of a card.\n\n```python\nimport starkbank\n\nlogs = starkbank.corporatecard.log.query(limit=150)\n\nfor log in logs:\n print(log)\n```\n\n## Get a CorporateCard log\n\nYou can get a single log by its id.\n\n```python\nimport starkbank\n\nlog = starkbank.corporatecard.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n## Query CorporatePurchases\n\nYou can get a list of created purchases given some filters.\n\n```python\nimport starkbank\nfrom datetime import date\n\npurchases = starkbank.corporatepurchase.query(\n after=date(2020, 1, 1),\n before=date(2020, 3, 1)\n)\n\nfor purchase in purchases:\n print(purchase)\n```\n\n## Get a CorporatePurchase\n\nAfter its creation, information on a purchase may be retrieved by its id. \n\n```python\nimport starkbank\n\npurchase = starkbank.corporatepurchase.get(\"5155165527080960\")\n\nprint(purchase)\n```\n\n## Query CorporatePurchase logs\n\nLogs are pretty important to understand the life cycle of a purchase.\n\n```python\nimport starkbank\n\nlogs = starkbank.corporatepurchase.log.query(limit=150)\n\nfor log in logs:\n print(log)\n```\n\n## Get a CorporatePurchase log\n\nYou can get a single log by its id.\n\n```python\nimport starkbank\n\nlog = starkbank.corporatepurchase.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n## Create CorporateInvoices\n\nYou can create Pix invoices to transfer money from accounts you have in any bank to your Corporate balance,\nallowing you to run your corporate operation.\n\n```python\nimport starkbank\n\ninvoice = starkbank.corporateinvoice.create(\n invoice=starkbank.CorporateInvoice(\n amount=1000\n )\n)\n\nprint(invoice)\n```\n\n**Note**: Instead of using CorporateInvoice objects, you can also pass each element in dictionary format\n\n## Query CorporateInvoices\n\nYou can get a list of created invoices given some filters.\n\n```python\nimport starkbank\nfrom datetime import date\n\ninvoices = starkbank.corporateinvoice.query(\n after=date(2020, 1, 1),\n before=date(2020, 3, 1)\n)\n\nfor invoice in invoices:\n print(invoice)\n```\n\n## Create CorporateWithdrawals\n\nYou can create withdrawals to send cash back from your Corporate balance to your Banking balance\nby using the Withdrawal resource.\n\n```python\nimport starkbank\n\nwithdrawal = starkbank.corporatewithdrawal.create(\n withdrawal=starkbank.CorporateWithdrawal(\n amount=10000,\n external_id=\"123\",\n description=\"Sending back\"\n )\n)\n\nprint(withdrawal)\n```\n\n**Note**: Instead of using CorporateWithdrawal objects, you can also pass each element in dictionary format\n\n## Get a CorporateWithdrawal\n\nAfter its creation, information on a withdrawal may be retrieved by its id.\n\n```python\nimport starkbank\n\nwithdrawal = starkbank.corporatewithdrawal.get(\"5155165527080960\")\n\nprint(withdrawal)\n```\n\n## Query CorporateWithdrawals\n\nYou can get a list of created withdrawals given some filters.\n\n```python\nimport starkbank\nfrom datetime import date\n\nwithdrawals = starkbank.corporatewithdrawal.query(\n after=date(2020, 1, 1),\n before=date(2020, 3, 1)\n)\n\nfor withdrawal in withdrawals:\n print(withdrawal)\n```\n\n## Get your CorporateBalance\n\nTo know how much money you have available to run authorizations, run:\n\n```python\nimport starkbank\n\nbalance = starkbank.corporatebalance.get()\n\nprint(balance)\n```\n\n## Query CorporateTransactions\n\nTo understand your balance changes (corporate statement), you can query\ntransactions. Note that our system creates transactions for you when\nyou make purchases, withdrawals, receive corporate invoice payments, for example.\n\n```python\nimport starkbank\nfrom datetime import date\n\ntransactions = starkbank.corporatetransaction.query(\n after=date(2020, 1, 1),\n before=date(2020, 3, 1)\n)\nfor transaction in transactions:\n print(transaction)\n```\n\n## Get a CorporateTransaction\n\nYou can get a specific transaction by its id:\n\n```python\nimport starkbank\n\ntransaction = starkbank.corporatetransaction.get(\"5155165527080960\")\n\nprint(transaction)\n```\n\n## Corporate Enums\n\n### Query MerchantCategories\n\nYou can query any merchant categories using this resource.\nYou may also use MerchantCategories to define specific category filters in CorporateRules.\nEither codes (which represents specific MCCs) or types (code groups) will be accepted as filters.\n\n```python\nimport starkbank\n\ncategories = starkbank.merchantcategory.query(\n search=\"food\",\n)\n\nfor category in categories:\n print(category)\n```\n\n### Query MerchantCountries\n\nYou can query any merchant countries using this resource.\nYou may also use MerchantCountries to define specific country filters in CorporateRules.\n\n```python\nimport starkbank\n\ncountries = starkbank.merchantcountry.query(\n search=\"brazil\",\n)\n\nfor country in countries:\n print(country)\n```\n\n### Query CardMethods\n\nYou can query available card methods using this resource.\nYou may also use CardMethods to define specific purchase method filters in CorporateRules.\n\n```python\nimport starkbank\n\nmethods = starkbank.cardmethod.query(\n search=\"token\",\n)\n\nfor method in methods:\n print(method)\n```\n\n## Split\n\nSplit an Invoice between different receivers.\n\n## Query Splits\n\nYou can get a list of created Splits given some filters.\n\n```python\nimport starkbank\n\nsplits = starkbank.split.query(limit=10)\n\nfor split in splits:\n print(split)\n```\n\n## Get a Split\n\nTo get a single Split by its id, run:\n\n```python\nimport starkbank\n\nsplit = starkbank.split.get(\"5155165527080960\")\n\nprint(split)\n```\n\n## Query Split Logs\n\nYou can query Split logs to check additional information.\n\n```python\nimport starkbank\n\nlogs = starkbank.split.log.query(\n split_ids=[\"5155165527080960\", \"76551659167801921\"],\n)\n\nfor log in logs:\n print(log)\n```\n\n## Get a Split Log\n\nYou can also get a Split log by specifying its id.\n\n```python\nimport starkbank\n\nlog = starkbank.split.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n## Create SplitReceivers\n\nYou can create receivers to an Invoice Split by using the SplitReceiver resource.\n\n```python\nimport starkbank\n\nreceiver = starkbank.splitreceiver.create(\n receiver=starkbank.SplitReceiver(\n name=\"Daenerys Targaryen Stormborn\",\n tax_id=\"594.739.480-42\",\n bank_code=\"341\",\n branch_code=\"2201\",\n account_number=\"76543-8\",\n account_type=\"salary\"\n )\n)\n\nprint(receiver)\n```\n\n## Query SplitReceivers\n\nTo take a look at the SplitReceivers created to your workspace, just run the following:\n\n```python\nimport starkbank\n\nreceivers = starkbank.splitreceiver.query(limit=10)\n\nfor receiver in receivers:\n print(receiver)\n```\n\n## Get a Split Receiver\n\nTo get a single SplitReceiver by its id, run:\n\n```python\nimport starkbank\n\nreceiver = starkbank.splitreceiver.get(\"5155165527080960\")\n\nprint(receiver)\n```\n\n## Query SplitReceiver Logs\n\nYou can query SplitReceiver logs to check additional information\n\n```python\nimport starkbank\n\nlogs = starkbank.splitreceiver.log.query(\n receiver_ids =[\"5155165527080960\", \"76551659167801921\"],\n)\n\nfor log in logs:\n print(log)\n```\n\n## Get a SplitReceiver Log\n\nYou can also get a SplitReceiver Log by specifying its id.\n\n```python\nimport starkbank\n\nlog = starkbank.splitreceiver.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n## Create a webhook subscription\n\nTo create a webhook subscription and be notified whenever an event occurs, run:\n\n```python\nimport starkbank\n\nwebhook = starkbank.webhook.create(\n url=\"https://webhook.site/dd784f26-1d6a-4ca6-81cb-fda0267761ec\",\n subscriptions=[\"transfer\", \"boleto\", \"boleto-payment\", \"boleto-holmes\", \"brcode-payment\", \"utility-payment\", \"deposit\", \"invoice\"],\n)\n\nprint(webhook)\n```\n\n## Query webhook subscriptions \n\nTo search for registered webhook subscriptions, run:\n\n```python\nimport starkbank\n\nwebhooks = starkbank.webhook.query()\n\nfor webhook in webhooks:\n print(webhook)\n```\n\n## Get a webhook subscription\n\nYou can get a specific webhook subscription by its id.\n\n```python\nimport starkbank\n\nwebhook = starkbank.webhook.get(\"10827361982368179\")\n\nprint(webhook)\n```\n\n## Delete a webhook subscription\n\nYou can also delete a specific webhook subscription by its id.\n\n```python\nimport starkbank\n\nwebhook = starkbank.webhook.delete(\"10827361982368179\")\n\nprint(webhook)\n```\n\n## Process webhook events\n\nIt's easy to process events that arrived in your webhook. Remember to pass the\nsignature header so the SDK can make sure it's really StarkBank that sent you\nthe event.\n\n```python\nimport starkbank\n\nresponse = listen() # this is the method you made to get the events posted to your webhook endpoint\n\nevent = starkbank.event.parse(\n content=response.data.decode(\"utf-8\"),\n signature=response.headers[\"Digital-Signature\"],\n)\n\nif event.subscription == \"transfer\":\n print(event.log.transfer)\n \nelif event.subscription == \"boleto\":\n print(event.log.boleto)\n \nelif event.subscription == \"boleto-payment\":\n print(event.log.payment)\n\nelif event.subscription == \"boleto-holmes\":\n print(event.log.holmes)\n\nelif event.subscription == \"brcode-payment\":\n print(event.log.payment)\n\nelif event.subscription == \"utility-payment\":\n print(event.log.payment)\n\nelif event.subscription == \"deposit\":\n print(event.log.deposit)\n\nelif event.subscription == \"invoice\":\n print(event.log.invoice)\n```\n\n## Query webhook events\n\nTo search for webhooks events, run:\n\n```python\nimport starkbank\n\nevents = starkbank.event.query(after=\"2020-03-20\", is_delivered=False)\n\nfor event in events:\n print(event)\n```\n\n## Get a webhook event\n\nYou can get a specific webhook event by its id.\n\n```python\nimport starkbank\n\nevent = starkbank.event.get(\"10827361982368179\")\n\nprint(event)\n```\n\n## Delete a webhook event\n\nYou can also delete a specific webhook event by its id.\n\n```python\nimport starkbank\n\nevent = starkbank.event.delete(\"10827361982368179\")\n\nprint(event)\n```\n\n## Set webhook events as delivered\n\nThis can be used in case you've lost events.\nWith this function, you can manually set events retrieved from the API as\n\"delivered\" to help future event queries with `is_delivered=False`.\n\n```python\nimport starkbank\n\nevent = starkbank.event.update(\"129837198237192\", is_delivered=True)\n\nprint(event)\n```\n\n## Query failed webhook event delivery attempts information\n\nYou can also get information on failed webhook event delivery attempts.\n\n```python\nimport starkbank\n\nattempts = starkbank.event.attempt.query(after=\"2020-03-20\")\n\nfor attempt in attempts:\n print(attempt.code)\n print(attempt.message)\n```\n\n## Get a failed webhook event delivery attempt information\n\nTo retrieve information on a single attempt, use the following function:\n\n```python\nimport starkbank\n\nattempt = starkbank.event.attempt.get(\"1616161616161616\")\n\nprint(attempt)\n```\n\n## Create a new Workspace\n\nThe Organization user allows you to create new Workspaces (bank accounts) under your organization.\nWorkspaces have independent balances, statements, operations and users.\nThe only link between your Workspaces is the Organization that controls them.\n\n**Note**: This route will only work if the Organization user is used with `workspace_id=None`.\n\n```python\nimport starkbank\n\nworkspace = starkbank.workspace.create(\n username=\"iron-bank-workspace-1\",\n name=\"Iron Bank Workspace 1\",\n user=organization,\n)\n\nprint(workspace)\n```\n\n## List your Workspaces\n\nThis route lists Workspaces. If no parameter is passed, all the workspaces the user has access to will be listed, but\nyou can also find other Workspaces by searching for their usernames or IDs directly.\n\n```python\nimport starkbank\n\nworkspaces = starkbank.workspace.query(limit=30)\n\nfor workspace in workspaces:\n print(workspace)\n```\n\n## Get a Workspace\n\nYou can get a specific Workspace by its id.\n\n```python\nimport starkbank\n\nworkspace = starkbank.workspace.get(\"1082736198236817\")\n\nprint(workspace)\n```\n\n## Update a Workspace\n\nYou can update a specific Workspace by its id.\n\n```python\nimport starkbank\n\npicture = open(\"path/to/picture.png\", \"rb\").read()\n\nworkspace = starkbank.workspace.update(\n \"1082736198236817\",\n username=\"new-username\",\n name=\"New Name\",\n allowed_tax_ids=[\"012.345.678-90\"],\n picture=picture,\n picture_type=\"image/png\",\n user=starkbank.Organization.replace(organization, \"1082736198236817\")\n)\n\nprint(workspace)\n```\n\nYou can also block a specific Workspace by its id.\n\n```python\nimport starkbank\n\nworkspace = starkbank.workspace.update(\n \"1082736198236817\",\n username=\"new-username\",\n name=\"New Name\",\n status=\"blocked\",\n user=starkbank.Organization.replace(organization, \"1082736198236817\")\n)\n\nprint(workspace)\n```\n\n**Note**: the Organization user can only update a workspace with the Workspace ID set.\n\n# Handling errors\n\nThe SDK may raise one of four types of errors: __InputErrors__, __InternalServerError__, __UnknownError__, __InvalidSignatureError__\n\n__InputErrors__ will be raised whenever the API detects an error in your request (status code 400).\nIf you catch such an error, you can get its elements to verify each of the\nindividual errors that were detected in your request by the API.\nFor example:\n\n```python\nimport starkbank\n\ntry:\n transactions = starkbank.transaction.create([\n starkbank.Transaction(\n amount=99999999999999, # (R$ 999,999,999,999.99)\n receiver_id=\"1029378109327810\",\n description=\".\",\n external_id=\"12345\", # so we can block anything you send twice by mistake\n tags=[\"provider\"]\n ),\n ])\nexcept starkbank.error.InputErrors as exception:\n for error in exception.errors:\n print(error.code)\n print(error.message)\n```\n\n__InternalServerError__ will be raised if the API runs into an internal error.\nIf you ever stumble upon this one, rest assured that the development team\nis already rushing in to fix the mistake and get you back up to speed.\n\n__UnknownError__ will be raised if a request encounters an error that is\nneither __InputErrors__ nor an __InternalServerError__, such as connectivity problems.\n\n__InvalidSignatureError__ will be raised specifically by starkbank.event.parse()\nwhen the provided content and signature do not check out with the Stark Bank public\nkey.\n\n# Help and Feedback\n\nIf you have any questions about our SDK, just send us an email.\nWe will respond you quickly, pinky promise. We are here to help you integrate with us ASAP.\nWe also love feedback, so don't be shy about sharing your thoughts with us.\n\nEmail: help@starkbank.com\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "SDK to facilitate Python integrations with Stark Bank",
"version": "2.25.1",
"project_urls": {
"Homepage": "https://github.com/starkbank/sdk-python"
},
"split_keywords": [
"stark bank",
" starkbank",
" sdk",
" open banking",
" openbanking",
" banking",
" open",
" stark"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "427a764beda97aa26d12f6d049eb3c40fdf825c2b06b5550c63c8be3a2a94645",
"md5": "d41231d058cfe908a49702d0ef0c7357",
"sha256": "9cb177f6c3125562d31b03f3d1c4e1eb8452b08a0968face004195006efc4b50"
},
"downloads": -1,
"filename": "starkbank-2.25.1.tar.gz",
"has_sig": false,
"md5_digest": "d41231d058cfe908a49702d0ef0c7357",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 94151,
"upload_time": "2024-04-02T00:49:03",
"upload_time_iso_8601": "2024-04-02T00:49:03.945739Z",
"url": "https://files.pythonhosted.org/packages/42/7a/764beda97aa26d12f6d049eb3c40fdf825c2b06b5550c63c8be3a2a94645/starkbank-2.25.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-02 00:49:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "starkbank",
"github_project": "sdk-python",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "starkbank"
}
JSON
