# Stark Infra Python SDK - Beta
Welcome to the Stark Infra 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 Infra API v2.
# Introduction
## Index
- [Introduction](#introduction)
- [Supported Python versions](#supported-python-versions)
- [API documentation](#stark-infra-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)
- [Issuing](#issuing)
- [Products](#query-issuingproducts): View available sub-issuer card products (a.k.a. card number ranges or BINs)
- [Holders](#create-issuingholders): Manage card holders
- [Cards](#create-issuingcards): Create virtual and/or physical cards
- [Design](#query-issuingdesigns): View your current card or package designs
- [EmbossingKit](#query-issuingembossingkits): View your current embossing kits
- [Stock](#query-issuingstocks): View your current stock of a certain IssuingDesign linked to an Embosser on the workspace
- [Restock](#create-issuingrestocks): Create restock orders of a specific IssuingStock object
- [EmbossingRequest](#create-issuingembossingrequests): Create embossing requests
- [TokenRequest](#create-an-issuingtokenrequest): Generate the payload to create the token
- [Token](#process-token-authorizations): Authorize and manage your tokens
- [TokenActivation](#process-token-activations): Get notified on how to inform the activation code to the holder
- [TokenDesign](#get-an-issuingtokendesign): View your current token card arts
- [Purchases](#process-purchase-authorizations): Authorize and view your past purchases
- [Invoices](#create-issuinginvoices): Add money to your issuing balance
- [Withdrawals](#create-issuingwithdrawals): Send money back to your Workspace from your issuing balance
- [Balance](#get-your-issuingbalance): View your issuing balance
- [Transactions](#query-issuingtransactions): View the transactions that have affected your issuing balance
- [Enums](#issuing-enums): Query enums related to the issuing purchases, such as merchant categories, countries and card purchase methods
- [Pix](#pix)
- [PixRequests](#create-pixrequests): Create Pix transactions
- [PixReversals](#create-pixreversals): Reverse Pix transactions
- [PixBalance](#get-your-pixbalance): View your account balance
- [PixStatement](#create-a-pixstatement): Request your account statement
- [PixKey](#create-a-pixkey): Create a Pix Key
- [PixClaim](#create-a-pixclaim): Claim a Pix Key
- [PixDirector](#create-a-pixdirector): Create a Pix Director
- [PixInfraction](#create-pixinfractions): Create Pix Infraction reports
- [PixFraud](#create-a-pixfraud): Create a Pix Fraud
- [PixUser](#get-a-pixuser): Get fraud statistics of a user
- [PixChargeback](#create-pixchargebacks): Create Pix Chargeback requests
- [PixDomain](#query-pixdomains): View registered SPI participants certificates
- [StaticBrcode](#create-staticbrcodes): Create static Pix BR codes
- [DynamicBrcode](#create-dynamicbrcodes): Create dynamic Pix BR codes
- [BrcodePreview](#create-brcodepreviews): Read data from BR Codes before paying them
- [Lending](#lending)
- [CreditNote](#create-creditnotes): Create credit notes
- [CreditPreview](#create-creditpreviews): Create credit previews
- [CreditHolmes](#create-creditholmes): Create credit holmes debt verification
- [Identity](#identity)
- [IndividualIdentity](#create-individualidentities): Create individual identities
- [IndividualDocument](#create-individualdocuments): Create individual documents
- [Webhook](#webhook):
- [Webhook](#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
- [Request](#request): Send a custom request to Stark Bank. This can be used to access features that haven't been mapped yet.
- [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 Infra API documentation
Feel free to take a look at our [API docs](https://www.starkinfra.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 starkinfra
```
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 the 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 starkinfra
privateKey, publicKey = starkinfra.key.create()
# or, to also save .pem files in a specific path
privateKey, publicKey = starkinfra.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 [StarkInfra Sandbox](https://web.sandbox.starkinfra.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 starkinfra
# 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 = starkinfra.Project(
environment="sandbox",
id="5656565656565656",
private_key=private_key_content
)
```
3.2. To create Organization credentials in Sandbox:
3.2.1. Log into [Starkinfra Sandbox](https://web.sandbox.starkinfra.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 starkinfra
# 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 = starkinfra.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
)
```
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 an argument in all functions:
```python
import starkinfra
balance = starkinfra.pixbalance.get(user=project) # or organization
```
4.2 Set it as a default user in the SDK:
```python
import starkinfra
starkinfra.user = project # or organization
balance = starkinfra.pixbalance.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 starkinfra
starkinfra.language = "en-US"
```
Language options are "en-US" for English and "pt-BR" for Brazilian Portuguese. English is the default.
# Resource listing and manual pagination
Almost all SDK resources provide a `query` and a `page` function.
- The `query` function provides a straightforward 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 starkinfra
for request in starkinfra.pixrequest.query(limit=200):
print(request)
```
- 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 starkinfra
cursor = None
while True:
requests, cursor = starkinfra.pixrequest.page(limit=50, cursor=cursor)
for request in requests:
print(request)
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 Infra, you'll need funds
in your account, which can be added to your balance by creating a starkbank.Invoice.
In the Sandbox environment, most of the created starkbank.Invoices will be automatically paid,
so there's nothing else you need to do to add funds to your account. Just create
a few starkbank.Invoice and wait around a bit.
In Production, you (or one of your clients) will need to actually pay this Pix Request
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(starkinfra.issuinginvoice.create)`)
## Issuing
### Query IssuingProducts
To take a look at the sub-issuer card products available to you, just run the following:
```python
import starkinfra
products = starkinfra.issuingproduct.query()
for product in products:
print(product)
```
This will tell which card products and card number prefixes you have at your disposal.
### Create IssuingHolders
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 starkinfra
holders = starkinfra.issuingholder.create([
starkinfra.IssuingHolder(
name="Iron Bank S.A.",
external_id="1234",
tax_id="012.345.678-90",
tags=[
"Traveler Employee"
],
rules=[
{
"name": "General USD",
"interval": "day",
"amount": 100000,
"currencyCode": "USD",
"categories": [
{
"type": "services"
},
{
"code": "fastFoodRestaurants"
}
],
"countries": [
{
"code": "USA"
}
],
"methods": [
{
"code": "token"
}
]
}
]
)
])
for holder in holders:
print(holder)
```
**Note**: Instead of using IssuingHolder objects, you can also pass each element in dictionary format
### Query IssuingHolders
You can query multiple holders according to filters.
```python
import starkinfra
holders = starkinfra.issuingholder.query()
for holder in holders:
print(holder)
```
### Cancel an IssuingHolder
To cancel a single Issuing Holder by its id, run:
```python
import starkinfra
holder = starkinfra.issuingholder.cancel("5155165527080960")
print(holder)
```
### Get an IssuingHolder
To get a specific Issuing Holder by its id, run:
```python
import starkinfra
holder = starkinfra.issuingholder.get("5155165527080960")
print(holder)
```
### Query IssuingHolder logs
You can query IssuingHolder logs to better understand IssuingHolder life cycles.
```python
import starkinfra
logs = starkinfra.issuingholder.log.query(limit=50)
for log in logs:
print(log.id)
```
### Get an IssuingHolder log
You can also get a specific log by its id.
```python
import starkinfra
log = starkinfra.issuingholder.log.get("5155165527080960")
print(log)
```
### Create IssuingCards
You can issue cards with specific spending rules.
```python
import starkinfra
cards = starkinfra.issuingcard.create([
starkinfra.IssuingCard(
holder_name="Developers",
holder_tax_id="012.345.678-90",
holder_external_id="1234",
rules=[starkinfra.IssuingRule(
name="general",
interval="week",
amount=50000,
currency_code="USD",
categories=[
starkinfra.MerchantCategory(type="services"), # Covers all service-related MCCs
starkinfra.MerchantCategory(code="fastFoodRestaurants") # Covers a specific MCC
],
countries=[
starkinfra.MerchantCountry(code="BRA")
],
methods=[
starkinfra.CardMethod(code="token")
]
)]
)
])
for card in cards:
print(card)
```
### Query IssuingCards
You can get a list of created cards given some filters.
```python
import starkinfra
from datetime import date
cards = starkinfra.issuingcard.query(
after=date(2020, 1, 1),
before=date(2020, 3, 1)
)
for card in cards:
print(card)
```
### Get an IssuingCard
After its creation, information on a card may be retrieved by its id.
```python
import starkinfra
card = starkinfra.issuingcard.get("5155165527080960")
print(card)
```
### Update an IssuingCard
You can update a specific card by its id.
```python
import starkinfra
card = starkinfra.issuingcard.update("5155165527080960", status="blocked")
print(card)
```
### Cancel an IssuingCard
You can also cancel a card by its id.
```python
import starkinfra
card = starkinfra.issuingcard.cancel("5155165527080960")
print(card)
```
### Query IssuingCard logs
Logs are pretty important to understand the life cycle of a card.
```python
import starkinfra
logs = starkinfra.issuingcard.log.query(limit=150)
for log in logs:
print(log)
```
### Get an IssuingCard log
You can get a single log by its id.
```python
import starkinfra
log = starkinfra.issuingcard.log.get("5155165527080960")
print(log)
```
### Query IssuingDesigns
You can get a list of available designs given some filters.
```python
import starkinfra
designs = starkinfra.issuingdesign.query(
limit=1
)
for design in designs:
print(design)
```
### Get an IssuingDesign
Information on a design may be retrieved by its id.
```python
import starkinfra
design = starkinfra.issuingdesign.get("5747368922185728")
print(design)
```
### Query IssuingEmbossingKits
You can get a list of existing embossing kits given some filters.
```python
import starkinfra
from datetime import date
kits = starkinfra.issuingembossingkit.query(
after=date(2022, 11, 1),
before=date(2022, 12, 1)
)
for kit in kits:
print(kit)
```
### Get an IssuingEmbossingKit
After its creation, information on an embossing kit may be retrieved by its id.
```python
import starkinfra
kit = starkinfra.issuingembossingkit.get("5664445921492992")
print(kit)
```
### Query IssuingStocks
You can get a list of available stocks given some filters.
```python
import starkinfra
from datetime import date
stocks = starkinfra.issuingstock.query(
after=date(2020, 1, 1),
before=date(2020, 3, 1)
)
for stock in stocks:
print(stock)
```
### Get an IssuingStock
Information on a stock may be retrieved by its id.
```python
import starkinfra
stock = starkinfra.issuingstock.get("5792731695677440")
print(stock)
```
### Query IssuingStock logs
Logs are pretty important to understand the life cycle of a stock.
```python
import starkinfra
logs = starkinfra.issuingstock.log.query(limit=150)
for log in logs:
print(log)
```
### Get an IssuingStock log
You can get a single log by its id.
```python
import starkinfra
log = starkinfra.issuingstock.log.get("5809977331548160")
print(log)
```
### Create IssuingRestocks
You can order restocks for a specific IssuingStock.
```python
import starkinfra
restocks = starkinfra.issuingrestock.create([
starkinfra.IssuingRestock(
count=100,
stock_id="5136459887542272"
)
])
for restock in restocks:
print(restock)
```
### Query IssuingRestocks
You can get a list of created restocks given some filters.
```python
import starkinfra
from datetime import date
restocks = starkinfra.issuingrestock.query(
after=date(2022, 11, 1),
before=date(2022, 12, 1)
)
for restock in restocks:
print(restock)
```
### Get an IssuingRestock
After its creation, information on a restock may be retrieved by its id.
```python
import starkinfra
restock = starkinfra.issuingrestock.get("5664445921492992")
print(restock)
```
### Query IssuingRestock logs
Logs are pretty important to understand the life cycle of a restock.
```python
import starkinfra
logs = starkinfra.issuingrestock.log.query(limit=150)
for log in logs:
print(log)
```
### Get an IssuingRestock log
You can get a single log by its id.
```python
import starkinfra
log = starkinfra.issuingrestock.log.get("6310318875607040")
print(log)
```
### Create IssuingEmbossingRequests
You can create a request to emboss a physical card.
```python
import starkinfra
embossing_requests = starkinfra.issuingembossingrequest.create([
starkinfra.IssuingEmbossingRequest(
kit_id="5648359658356736",
card_id="5714424132272128",
display_name_1="Antonio Stark",
shipping_city="Sao Paulo",
shipping_country_code="BRA",
shipping_district="Bela Vista",
shipping_service="loggi",
shipping_state_code="SP",
shipping_street_line_1="Av. Paulista, 200",
shipping_street_line_2="10 andar",
shipping_tracking_number="My_custom_tracking_number",
shipping_zip_code="12345-678",
embosser_id="5746980898734080"
)
])
for embossing_request in embossing_requests:
print(embossing_request)
```
### Query IssuingEmbossingRequests
You can get a list of created embossing requests given some filters.
```python
import starkinfra
from datetime import date
embossing_requests = starkinfra.issuingembossingrequest.query(
after=date(2022, 11, 1),
before=date(2022, 12, 1)
)
for embossing_request in embossing_requests:
print(embossing_request)
```
### Get an IssuingEmbossingRequest
After its creation, information on an embossing request may be retrieved by its id.
```python
import starkinfra
embossing_request = starkinfra.issuingembossingrequest.get("5191752558313472")
print(embossing_request)
```
### Query IssuingEmbossingRequest logs
Logs are pretty important to understand the life cycle of an embossing request.
```python
import starkinfra
logs = starkinfra.issuingembossingrequest.log.query(limit=150)
for log in logs:
print(log)
```
### Get an IssuingEmbossingRequest log
You can get a single log by its id.
```python
import starkinfra
log = starkinfra.issuingembossingrequest.log.get("6724771005857792")
print(log)
```
### Create an IssuingTokenRequest
You can create a request that provides the required data you must send to the wallet app.
```python
import starkinfra
request = starkinfra.issuingtokenrequest.create(
starkinfra.IssuingTokenRequest(
card_id="5189831499972623",
wallet_id="google",
method_code="app"
)
)
print(request)
```
### Process Token authorizations
It's easy to process token authorizations delivered to your endpoint.
Remember to pass the signature header so the SDK can make sure it's StarkInfra that sent you the event.
If you do not approve or decline the authorization within 2 seconds, the authorization will be denied.
```python
import starkinfra
request = listen() # this is the method you made to get the events posted to your tokenAuthorizationUrl endpoint
authorization = starkinfra.issuingtoken.parse(
content=request.data.decode("utf-8"),
signature=request.headers["Digital-Signature"],
)
sendResponse(
starkinfra.issuingtoken.response_authorization( # this optional method just helps you build the response JSON
status="approved",
activation_methods=[
{
"type": "app",
"value": "com.subissuer.android"
},
{
"type": "text",
"value": "** *****-5678"
}
],
design_id="4584031664472031",
tags=["token", "user/1234"],
)
)
# or
sendResponse(
starkinfra.issuingtoken.response_authorization( # this optional method just helps you build the response JSON
status="denied",
reason="other",
)
)
```
### Process Token activations
It's easy to process token activation notifications delivered to your endpoint.
Remember to pass the signature header so the SDK can make sure it's Stark Infra that sent you the event.
```python
import starkinfra
request = listen() # this is the method you made to get the events posted to your tokenActivationUrl endpoint
authorization = starkinfra.issuingtokenactivation.parse(
content=request.data.decode("utf-8"),
signature=request.headers["Digital-Signature"],
)
```
After that, you may generate the activation code and send it to the cardholder.
The cardholder enters the received code in the wallet app. We'll receive and send it to
tokenAuthorizationUrl for your validation. Completing the provisioning process.
```python
import starkinfra
request = listen() # this is the method you made to get the events posted to your tokenAuthorizationUrl endpoint
activation = starkinfra.issuingtoken.parse(
content=request.data.decode("utf-8"),
signature=request.headers["Digital-Signature"],
)
sendResponse(
starkinfra.issuingtoken.response_activation( # this optional method just helps you build the response JSON
status="approved",
tags=["token", "user/1234"]
)
)
# or
sendResponse(
starkinfra.issuingtoken.response_activation( # this optional method just helps you build the response JSON
status="denied",
reason="other",
tags=["token", "user/1234"]
)
)
```
### Get an IssuingToken
You can get a single token by its id.
```python
import starkinfra
token = starkinfra.issuingtoken.get(id="5749080709922816")
print(token)
```
### Query IssuingTokens
You can get a list of created tokens given some filters.
```python
import starkinfra
tokens = starkinfra.issuingtoken.query(
limit=5,
after=date.today() - timedelta(days=100),
before=date.today(),
status="active",
card_ids=["5656565656565656", "4545454545454545"],
external_ids=["DSHRMC00002626944b0e3b539d4d459281bdba90c2588791", "DSHRMC00002626941c531164a0b14c66ad9602ee716f1e85"]
)
for token in tokens:
print(token)
```
### Update an IssuingToken
You can update a specific token by its id.
```python
import starkinfra
token = starkinfra.issuingtoken.update(id="5155165527080960", status="blocked")
print(token)
```
### Cancel an IssuingToken
You can also cancel a token by its id.
```python
import starkinfra
token = starkinfra.issuingtoken.cancel(id="5155165527080960")
print(token)
```
### Get an IssuingTokenDesign
You can get a single design by its id.
```python
import starkinfra
design = starkinfra.issuingtokendesign.get(id="5749080709922816")
print(design)
```
### Query IssuingTokenDesigns
You can get a list of available designs given some filters.
```python
import starkinfra
designs = starkinfra.issuingtokendesign.query(limit=5)
for design in designs:
print(design)
```
## Get an IssuingTokenDesign PDF
A design PDF can be retrieved by its id.
```python
import starkinfra
pdf = starkinfra.issuingtokendesign.pdf(id="5155165527080960")
with open("design.pdf", "wb") as file:
file.write(pdf)
```
### Process Purchase authorizations
It's easy to process purchase authorizations delivered to your endpoint.
Remember to pass the signature header so the SDK can make sure it's StarkInfra that sent you the event.
If you do not approve or decline the authorization within 2 seconds, the authorization will be denied.
```python
import starkinfra
request = listen() # this is the method you made to get the events posted to your tokenActivationUrl endpoint
authorization = starkinfra.issuingpurchase.parse(
content=request.data.decode("utf-8"),
signature=request.headers["Digital-Signature"],
)
sendResponse( # you should also implement this method
starkinfra.issuingpurchase.response( # this optional method just helps you build the response JSON
status="approved",
amount=authorization.amount,
tags=["my-purchase-id/123"],
)
)
# or
sendResponse(
starkinfra.issuingpurchase.response(
status="denied",
reason="other",
tags=["other-id/456"],
)
)
```
### Query IssuingPurchases
You can get a list of created purchases given some filters.
```python
import starkinfra
from datetime import date
purchases = starkinfra.issuingpurchase.query(
after=date(2020, 1, 1),
before=date(2020, 3, 1)
)
for purchase in purchases:
print(purchase)
```
### Get an IssuingPurchase
After its creation, information on a purchase may be retrieved by its id.
```python
import starkinfra
purchase = starkinfra.issuingpurchase.get("5155165527080960")
print(purchase)
```
### Update an IssuingPurchase
You can update a specific IssuingPurchase by its id.
```python
import starkinfra
purchase = starkinfra.issuingpurchase.update("5155165527080960", description="Dinner", tags=["customer-x", "reimbursement"])
print(purchase)
```
### Query IssuingPurchase logs
Logs are pretty important to understand the life cycle of a purchase.
```python
import starkinfra
logs = starkinfra.issuingpurchase.log.query(limit=150)
for log in logs:
print(log)
```
### Get an IssuingPurchase log
You can get a single log by its id.
```python
import starkinfra
log = starkinfra.issuingpurchase.log.get("5155165527080960")
print(log)
```
### Create IssuingInvoices
You can create Pix invoices to transfer money from accounts you have in any bank to your Issuing balance,
allowing you to run your issuing operation.
```python
import starkinfra
invoice = starkinfra.issuinginvoice.create(
invoice=starkinfra.IssuingInvoice(
amount=1000
)
)
print(invoice)
```
**Note**: Instead of using IssuingInvoice objects, you can also pass each element in dictionary format
### Get an IssuingInvoice
After its creation, information on an invoice may be retrieved by its id.
Its status indicates whether it's been paid.
```python
import starkinfra
invoice = starkinfra.issuinginvoice.get("5155165527080960")
print(invoice)
```
### Query IssuingInvoices
You can get a list of created invoices given some filters.
```python
import starkinfra
from datetime import date
invoices = starkinfra.issuinginvoice.query(
after=date(2020, 1, 1),
before=date(2020, 3, 1)
)
for invoice in invoices:
print(invoice)
```
### Query IssuingInvoice logs
Logs are pretty important to understand the life cycle of an invoice.
```python
import starkinfra
logs = starkinfra.issuinginvoice.log.query(limit=150)
for log in logs:
print(log)
```
### Get an IssuingInvoice log
You can also get a specific log by its id.
```python
import starkinfra
log = starkinfra.issuinginvoice.log.get("5155165527080960")
print(log)
```
### Create IssuingWithdrawals
You can create withdrawals to send cash back from your Issuing balance to your Banking balance
by using the IssuingWithdrawal resource.
```python
import starkinfra
withdrawal = starkinfra.issuingwithdrawal.create(
withdrawal=starkinfra.IssuingWithdrawal(
amount=10000,
external_id="123",
description="Sending back"
)
)
print(withdrawal)
```
**Note**: Instead of using IssuingWithdrawal objects, you can also pass each element in dictionary format
### Get an IssuingWithdrawal
After its creation, information on a withdrawal may be retrieved by its id.
```python
import starkinfra
invoice = starkinfra.issuingwithdrawal.get("5155165527080960")
print(invoice)
```
### Query IssuingWithdrawals
You can get a list of created withdrawals given some filters.
```python
import starkinfra
from datetime import date
withdrawals = starkinfra.issuingwithdrawal.query(
after=date(2020, 1, 1),
before=date(2020, 3, 1)
)
for withdrawal in withdrawals:
print(withdrawal)
```
### Get your IssuingBalance
To know how much money you have available to run authorizations, run:
```python
import starkinfra
balance = starkinfra.issuingbalance.get()
print(balance)
```
### Query IssuingTransactions
To understand your balance changes (issuing statement), you can query
transactions. Note that our system creates transactions for you when
you make purchases, withdrawals, receive issuing invoice payments, for example.
```python
import starkinfra
from datetime import date
transactions = starkinfra.issuingtransaction.query(
after=date(2020, 1, 1),
before=date(2020, 3, 1)
)
for transaction in transactions:
print(transaction)
```
### Get an IssuingTransaction
You can get a specific transaction by its id:
```python
import starkinfra
transaction = starkinfra.issuingtransaction.get("5155165527080960")
print(transaction)
```
### Issuing Enums
#### Query MerchantCategories
You can query any merchant categories using this resource.
You may also use MerchantCategories to define specific category filters in IssuingRules.
Either codes (which represents specific MCCs) or types (code groups) will be accepted as filters.
```python
import starkinfra
categories = starkinfra.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 IssuingRules.
```python
import starkinfra
countries = starkinfra.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 IssuingRules.
```python
import starkinfra
methods = starkinfra.cardmethod.query(
search="token",
)
for method in methods:
print(method)
```
## Pix
### Create PixRequests
You can create a Pix request to transfer money from one of your users to anyone else:
```python
import starkinfra
requests = starkinfra.pixrequest.create([
starkinfra.PixRequest(
amount=100, # (R$ 1.00)
external_id="141234121", # so we can block anything you send twice by mistake
sender_branch_code="0000",
sender_account_number="00000-0",
sender_account_type="checking",
sender_name="Tyrion Lannister",
sender_tax_id="012.345.678-90",
receiver_bank_code="00000001",
receiver_branch_code="0001",
receiver_account_number="00000-1",
receiver_account_type="checking",
receiver_name="Jamie Lannister",
receiver_tax_id="45.987.245/0001-92",
end_to_end_id=starkinfra.endtoendid.create("20018183"), # Pass your bank code to create an end to end ID
description="For saving my life",
),
starkinfra.PixRequest(
amount=200, # (R$ 2.00)
external_id="2135613462", # so we can block anything you send twice by mistake
sender_account_number="00000-0",
sender_branch_code="0000",
sender_account_type="checking",
sender_name="Arya Stark",
sender_tax_id="012.345.678-90",
receiver_bank_code="00000001",
receiver_account_number="00000-1",
receiver_branch_code="0001",
receiver_account_type="checking",
receiver_name="John Snow",
receiver_tax_id="012.345.678-90",
end_to_end_id=starkinfra.endtoendid.create("20018183"), # Pass your bank code to create an end to end ID
tags=["Needle", "sword"],
)
])
for request in requests:
print(request)
```
**Note**: Instead of using PixRequest objects, you can also pass each element in dictionary format
### Query PixRequests
You can query multiple Pix requests according to filters.
```python
import starkinfra
from datetime import date
requests = starkinfra.pixrequest.query(
limit=10,
after=date(2020, 1, 1),
before=date(2020, 4, 1),
status="success",
tags=["iron", "suit"],
end_to_end_ids=["E79457883202101262140HHX553UPqeq"],
)
for request in requests:
print(request)
```
### Get a PixRequest
After its creation, information on a Pix request may be retrieved by its id. Its status indicates whether it has been paid.
```python
import starkinfra
request = starkinfra.pixrequest.get("5155165527080960")
print(request)
```
### Process inbound PixRequest authorizations
It's easy to process authorization requests that arrived at your endpoint.
Remember to pass the signature header so the SDK can make sure it's StarkInfra that sent you the event.
If you do not approve or decline the authorization within 1 second, the authorization will be denied.
```python
import starkinfra
request = listen() # this is your handler to listen for authorization requests
pix_request = starkinfra.pixrequest.parse(
content=request.data.decode("utf-8"),
signature=request.headers["Digital-Signature"],
)
print(pix_request)
sendResponse( # you should also implement this method
starkinfra.pixrequest.response( # this optional method just helps you build the response JSON
status="approved",
)
)
# or
sendResponse(
starkinfra.pixrequest.response(
status="denied",
reason="orderRejected",
)
)
```
### Query PixRequest logs
You can query Pix request logs to better understand Pix request life cycles.
```python
import starkinfra
from datetime import date
logs = starkinfra.pixrequest.log.query(
limit=50,
after=date(2022, 1, 1),
before=date(2022, 1, 20),
)
for log in logs:
print(log)
```
### Get a PixRequest log
You can also get a specific log by its id.
```python
import starkinfra
log = starkinfra.pixrequest.log.get("5155165527080960")
print(log)
```
### Create PixReversals
You can reverse a PixRequest either partially or totally using a PixReversal.
```python
import starkinfra
reversal = starkinfra.pixreversal.create([
starkinfra.PixReversal(
amount=100,
end_to_end_id="E00000000202201060100rzsJzG9PzMg",
external_id="17238435823958934",
reason="bankError",
)
])
print(reversal)
```
### Query PixReversals
You can query multiple Pix reversals according to filters.
```python
import starkinfra
from datetime import date
reversals = starkinfra.pixreversal.query(
limit=10,
after=date(2020, 1, 1),
before=date(2020, 4, 1),
status="success",
tags=["iron", "suit"],
return_ids=["D20018183202202030109X3OoBHG74wo"],
)
for reversal in reversals:
print(reversal)
```
### Get a PixReversal
After its creation, information on a Pix reversal may be retrieved by its id.
Its status indicates whether it has been successfully processed.
```python
import starkinfra
reversal = starkinfra.pixreversal.get("5155165527080960")
print(reversal)
```
### Process inbound PixReversal authorizations
It's easy to process authorization requests that arrived at your endpoint.
Remember to pass the signature header so the SDK can make sure it's StarkInfra that sent you the event.
If you do not approve or decline the authorization within 1 second, the authorization will be denied.
```python
import starkinfra
request = listen() # this is your handler to listen for authorization requests
reversal = starkinfra.pixreversal.parse(
content=request.data.decode("utf-8"),
signature=request.headers["Digital-Signature"],
)
print(reversal)
sendResponse( # you should also implement this method
starkinfra.pixreversal.response( # this optional method just helps you build the response JSON
status="approved",
)
)
# or
sendResponse(
starkinfra.pixreversal.response(
status="denied",
reason="orderRejected",
)
)
```
### Query PixReversal logs
You can query Pix reversal logs to better understand their life cycles.
```python
import starkinfra
from datetime import date
logs = starkinfra.pixreversal.log.query(
limit=50,
after=date(2020, 1, 1),
before=date(2020, 1, 20),
)
for log in logs:
print(log)
```
### Get a PixReversal log
You can also get a specific log by its id.
```python
import starkinfra
log = starkinfra.pixreversal.log.get("5155165527080960")
print(log)
```
### Get your PixBalance
To see how much money you have in your account, run:
```python
import starkinfra
balance = starkinfra.pixbalance.get()
print(balance)
```
### Create a PixStatement
Statements are generated directly by the Central Bank and are only available for direct participants.
To create a statement of all the transactions that happened on your account during a specific day, run:
```python
import starkinfra
from datetime import date
statement = starkinfra.pixstatement.create(
starkinfra.PixStatement(
after=date(2022, 1, 1), # This is the date that you want to create a statement.
before=date(2022, 1, 1), # After and before must be the same date.
type="transaction" # Options are "interchange", "interchangeTotal", "transaction".
)
)
print(statement)
```
### Query PixStatements
You can query multiple Pix statements according to filters.
```python
import starkinfra
statements = starkinfra.pixstatement.query(
limit=50,
)
for statement in statements:
print(statement)
```
### Get a PixStatement
Statements are only available for direct participants. To get a Pix statement by its id:
```python
import starkinfra
statement = starkinfra.pixstatement.get("5155165527080960")
print(statement)
```
### Get a PixStatement .csv file
To get the .csv file corresponding to a Pix statement using its id, run:
```python
import starkinfra
csv = starkinfra.pixstatement.csv("5155165527080960")
with open("test.zip", "wb") as file:
file.write(csv)
```
### Create a PixKey
You can create a Pix Key to link a bank account information to a key id:
```python
import starkinfra
from datetime import datetime
key = starkinfra.pixkey.create(
starkinfra.PixKey(
account_created=datetime(2022, 2, 1, 0, 0, 0),
account_number="00000",
account_type="savings",
branch_code="0000",
name="Jamie Lannister",
tax_id="012.345.678-90",
id="+5511989898989",
)
)
print(key)
```
### Query PixKeys
You can query multiple Pix keys you own according to filters.
```python
import starkinfra
from datetime import date
keys = starkinfra.pixkey.query(
limit=1,
after=date(2022, 1, 1),
before=date(2020, 1, 12),
status="registered",
tags=["iron", "bank"],
ids=["+5511989898989"],
type="phone"
)
for key in keys:
print(key)
```
### Get a PixKey
Information on a Pix key may be retrieved by its id and the tax ID of the consulting agent.
An endToEndId must be informed so you can link any resulting purchases to this query,
avoiding sweep blocks by the Central Bank.
```python
import starkinfra
key = starkinfra.pixkey.get(
"5155165527080960",
payer_id="012.345.678-90",
end_to_end_id=starkinfra.endtoendid.create("20018183"),
)
print(key)
```
### Update a PixKey
Update the account information linked to a Pix Key.
```python
import starkinfra
key = starkinfra.pixkey.update(
id="+5511989898989",
reason="branchTransfer",
name="Jamie Lannister"
)
print(key)
```
### Cancel a PixKey
Cancel a specific Pix Key using its id.
```python
import starkinfra
key = starkinfra.pixkey.cancel("5155165527080960")
print(key)
```
### Query PixKey logs
You can query Pix key logs to better understand a Pix key life cycle.
```python
import starkinfra
from datetime import date
logs = starkinfra.pixkey.log.query(
limit=50,
ids=["5729405850615808"],
after=date(2022, 1, 1),
before=date(2022, 1, 20),
types=["created"],
key_ids=["+5511989898989"]
)
for log in logs:
print(log)
```
### Get a PixKey log
You can also get a specific log by its id.
```python
import starkinfra
log = starkinfra.pixkey.log.get("5155165527080960")
print(log)
```
### Create a PixClaim
You can create a Pix claim to request the transfer of a Pix key from another bank to one of your accounts:
```python
import starkinfra
from datetime import datetime
claim = starkinfra.pixclaim.create(
starkinfra.PixClaim(
account_created=datetime(2022, 2, 1, 0, 0, 0),
account_number="5692908409716736",
account_type="checking",
branch_code="0000",
name="testKey",
tax_id="012.345.678-90",
key_id="+5511989898989"
)
)
print(claim)
```
### Query PixClaims
You can query multiple Pix claims according to filters.
```python
import starkinfra
from datetime import date
claims = starkinfra.pixclaim.query(
limit=1,
after=date(2022, 1, 1),
before=date(2022, 1, 12),
status="registered",
ids=["5729405850615808"],
bacen_id="ccf9bd9c-e99d-999e-bab9-b999ca999f99",
type="ownership",
flow="out",
key_type="phone",
key_id="+5511989898989"
)
for claim in claims:
print(claim)
```
### Get a PixClaim
After its creation, information on a Pix claim may be retrieved by its id.
```python
import starkinfra
claim = starkinfra.pixclaim.get("5155165527080960")
print(claim)
```
### Update a PixClaim
A Pix Claim can be confirmed or canceled by patching its status.
A received Pix Claim must be confirmed by the donor to be completed.
Ownership Pix Claims can only be canceled by the donor if the reason is "fraud".
A sent Pix Claim can also be canceled.
```python
import starkinfra
claim = starkinfra.pixclaim.update(
id="5155165527080960",
status="confirmed"
)
print(claim)
```
### Query PixClaim logs
You can query Pix claim logs to better understand Pix claim life cycles.
```python
import starkinfra
from datetime import date
logs = starkinfra.pixclaim.log.query(
limit=50,
ids=["5729405850615808"],
after=date(2022, 1, 1),
before=date(2022, 1, 20),
types=["registered"],
claim_ids=["5719405850615809"]
)
for log in logs:
print(log)
```
### Get a PixClaim log
You can also get a specific log by its id.
```python
import starkinfra
log = starkinfra.pixclaim.log.get("5155165527080960")
print(log)
```
### Create a PixDirector
To register the Pix director contact information at the Central Bank, run the following:
```python
import starkinfra
director = starkinfra.pixdirector.create(
starkinfra.PixDirector(
name="Edward Stark",
tax_id="03.300.300/0001-00",
phone="+5511999999999",
email="ned.stark@company.com",
password="12345678",
team_email="pix.team@company.com",
team_phones=["+5511988889999", "+5511988889998"],
)
)
print(director)
```
### Create PixInfractions
Pix Infraction reports are used to report transactions that raise fraud suspicion, to request a refund or to
reverse a refund. Infraction reports can be created by either participant of a transaction.
```python
import starkinfra
infractions = starkinfra.pixinfraction.create(
infractions=[
starkinfra.PixInfraction(
reference_id="E20018183202201201450u34sDGd19lz",
type="reversal",
method="scam"
)
]
)
for infraction in infractions:
print(infraction)
```
### Query PixInfractions
You can query multiple infraction reports according to filters.
```python
import starkinfra
from datetime import date
infractions = starkinfra.pixinfraction.query(
limit=1,
after=date(2022, 1, 1),
before=date(2022, 1, 12),
status="delivered",
ids=["5155165527080960"],
bacen_id="ccf9bd9c-e99d-999e-bab9-b999ca999f99"
)
for infraction in infractions:
print(infraction)
```
### Get a PixInfraction
After its creation, information on a Pix Infraction may be retrieved by its id.
```python
import starkinfra
infraction = starkinfra.pixinfraction.get("5155165527080960")
print(infraction)
```
### Update a PixInfraction
A received Pix Infraction can be confirmed or declined by patching its status.
After a Pix Infraction is patched, its status changes to closed.
```python
import starkinfra
infraction = starkinfra.pixinfraction.update(
id="5155165527080960",
result="agreed",
)
print(infraction)
```
### Cancel a PixInfraction
Cancel a specific Pix Infraction using its id.
```python
import starkinfra
infraction = starkinfra.pixinfraction.cancel("5155165527080960")
print(infraction)
```
### Query PixInfraction logs
You can query infraction report logs to better understand their life cycles.
```python
import starkinfra
from datetime import date
logs = starkinfra.pixinfraction.log.query(
limit=50,
ids=["5729405850615808"],
after=date(2022, 1, 1),
before=date(2022, 1, 20),
types=["created"],
infraction_ids=["5155165527080960"]
)
for log in logs:
print(log)
```
### Get a PixInfraction log
You can also get a specific log by its id.
```python
import starkinfra
log = starkinfra.pixinfraction.log.get("5155165527080960")
print(log)
```
### Create a PixFraud
Pix Frauds can be created by either participant or automatically when a Pix Infraction is accepted.
```python
import starkinfra
frauds = starkinfra.pixfraud.create(
frauds=[
starkinfra.PixFraud(
external_id="my_external_id_1234",
type="mule",
tax_id="01234567890",
)
]
)
for fraud in frauds:
print(fraud)
```
### Query Pix Frauds
You can query multiple Pix frauds according to filters.
```python
import starkinfra
from datetime import date
frauds = starkinfra.pixfraud.query(
limit=1,
after=date(2022, 1, 1),
before=date(2022, 1, 12),
status="created",
ids=["5155165527080960"]
)
for fraud in frauds:
print(fraud)
```
### Get a PixFraud
After its creation, information on a Pix Fraud may be retrieved by its ID.
```python
import starkinfra
fraud = starkinfra.pixfraud.get("5155165527080960")
print(fraud)
```
### Cancel a PixFraud
Cancel a specific Pix Fraud using its id.
```python
import starkinfra
fraud = starkinfra.pixfraud.cancel("5155165527080960")
print(fraud)
```
### Get a PixUser
You can get a specific fraud statistics of a user with his taxId.
```python
import starkinfra
user = starkinfra.pixuser.get("01234567890")
print(user)
```
### Create PixChargebacks
A Pix chargeback can be created when fraud is detected on a transaction or a system malfunction
results in an erroneous transaction.
```python
import starkinfra
chargebacks = starkinfra.pixchargeback.create(
chargebacks=[
starkinfra.PixChargeback(
amount=100,
reference_id="E20018183202201201450u34sDGd19lz",
reason="fraud",
)
]
)
for chargeback in chargebacks:
print(chargeback)
```
### Query PixChargebacks
You can query multiple Pix chargebacks according to filters.
```python
import starkinfra
from datetime import date
chargebacks = starkinfra.pixchargeback.query(
limit=1,
after=date(2022, 1, 1),
before=date(2022, 1, 12),
status="registered",
ids=["5155165527080960"],
bacen_id="ccf9bd9c-e99d-999e-bab9-b999ca999f99"
)
for chargeback in chargebacks:
print(chargeback)
```
### Get a PixChargeback
After its creation, information on a Pix Chargeback may be retrieved by its.
```python
import starkinfra
chargeback = starkinfra.pixchargeback.get("5155165527080960")
print(chargeback)
```
### Update a PixChargeback
A received Pix Chargeback can be accepted or rejected by patching its status.
After a Pix Chargeback is patched, its status changes to closed.
```python
import starkinfra
chargeback = starkinfra.pixchargeback.update(
id="5155165527080960",
result="accepted",
reversal_reference_id=starkinfra.returnid.create("20018183"),
)
print(chargeback)
```
### Cancel a PixChargeback
Cancel a specific Pix Chargeback using its id.
```python
import starkinfra
chargeback = starkinfra.pixchargeback.cancel("5155165527080960")
print(chargeback)
```
### Query PixChargeback logs
You can query Pix chargeback logs to better understand Pix chargeback life cycles.
```python
import starkinfra
from datetime import date
logs = starkinfra.pixchargeback.log.query(
limit=50,
ids=["5729405850615808"],
after=date(2022, 1, 1),
before=date(2022, 1, 20),
types=["created"],
chargeback_ids=["5155165527080960"]
)
for log in logs:
print(log)
```
### Get a PixChargeback log
You can also get a specific log by its id.
```python
import starkinfra
log = starkinfra.pixchargeback.log.get("5155165527080960")
print(log)
```
### Query PixDomains
Here you can list all Pix Domains registered at the Brazilian Central Bank. The Pix Domain object displays the domain
name and the QR Code domain certificates of registered Pix participants able to issue dynamic QR Codes.
```python
import starkinfra
domains = starkinfra.pixdomain.query()
for domain in domains:
print(domain)
```
### Create StaticBrcodes
StaticBrcodes store account information via a BR code or an image (QR code)
that represents a PixKey and a few extra fixed parameters, such as an amount
and a reconciliation ID. They can easily be used to receive Pix transactions.
```python
import starkinfra
brcodes = starkinfra.staticbrcode.create([
starkinfra.StaticBrcode(
name="Jamie Lannister",
key_id="+5511988887777",
amount=100,
reconciliation_id="123",
city="Rio de Janeiro"
)
])
for brcode in brcodes:
print(brcode)
```
### Query StaticBrcodes
You can query multiple StaticBrcodes according to filters.
```python
import starkinfra
from datetime import date
brcodes = starkinfra.staticbrcode.query(
limit=1,
after=date(2022, 6, 1),
before=date(2022, 6, 30),
uuids=["5ddde28043a245c2848b08cf315effa2"]
)
for brcode in brcodes:
print(brcode)
```
### Get a StaticBrcode
After its creation, information on a StaticBrcode may be retrieved by its UUID.
```python
import starkinfra
brcode = starkinfra.staticbrcode.get("5ddde28043a245c2848b08cf315effa2")
print(brcode)
```
### Create DynamicBrcodes
BR codes store information represented by Pix QR Codes, which are used to send
or receive Pix transactions in a convenient way.
DynamicBrcodes represent charges with information that can change at any time,
since all data needed for the payment is requested dynamically to an URL stored
in the BR Code. Stark Infra will receive the GET request and forward it to your
registered endpoint with a GET request containing the UUID of the BR code for
identification.
```python
import starkinfra
brcodes = starkinfra.dynamicbrcode.create([
starkinfra.DynamicBrcode(
name="Jamie Lannister",
city="Rio de Janeiro",
external_id="my_unique_id_01",
type="instant"
)
])
for brcode in brcodes:
print(brcode)
```
### Query DynamicBrcodes
You can query multiple DynamicBrcodes according to filters.
```python
import starkinfra
from datetime import date
brcodes = starkinfra.dynamicbrcode.query(
limit=1,
after=date(2022, 6, 1),
before=date(2022, 6, 30),
uuids=["ac7caa14e601461dbd6b12bf7e4cc48e"]
)
for brcode in brcodes:
print(brcode)
```
### Get a DynamicBrcode
After its creation, information on a DynamicBrcode may be retrieved by its UUID.
```python
import starkinfra
brcode = starkinfra.dynamicbrcode.get("ac7caa14e601461dbd6b12bf7e4cc48e")
print(brcode)
```
### Verify a DynamicBrcode read
When a DynamicBrcode is read by your user, a GET request will be made to your registered URL to
retrieve additional information needed to complete the transaction.
Use this method to verify the authenticity of a GET request received at your registered endpoint.
If the provided digital signature does not check out with the StarkInfra public key, a stark.exception.InvalidSignatureException will be raised.
```python
import starkinfra
request = listen() # this is the method you made to get the read requests posted to your registered endpoint
uuid = starkinfra.dynamicbrcode.verify(
uuid=request.url.get_parameter("uuid"),
signature=request.headers["Digital-Signature"],
)
```
### Answer to a Due DynamicBrcode read
When a Due DynamicBrcode is read by your user, a GET request containing
the BR code UUID will be made to your registered URL to retrieve additional
information needed to complete the transaction.
The GET request must be answered in the following format within 5 seconds
and with an HTTP status code 200.
```python
import starkinfra
request = listen() # this is the method you made to get the read requests posted to your registered endpoint
uuid = starkinfra.dynamicbrcode.verify(
uuid=request.url.get_parameter("uuid"),
signature=request.headers["Digital-Signature"],
)
invoice = get_my_invoice(uuid) # you should implement this method to get the information of the BR code from its uuid
send_response( # you should also implement this method to respond the read request
starkinfra.dynamicbrcode.response_due(
version=invoice.version,
created=invoice.created,
due=invoice.due,
key_id=invoice.key_id,
status=invoice.status,
reconciliation_id=invoice.reconciliation_id,
amount=invoice.amount,
sender_name=invoice.sender_name,
sender_tax_id=invoice.sender_tax_id,
receiver_name=invoice.receiver_name,
receiver_tax_id=invoice.receiver_tax_id,
receiver_street_line=invoice.receiver_street_line,
receiver_city=invoice.receiver_city,
receiver_state_code=invoice.receiver_state_code,
receiver_zip_code=invoice.receiver_zip_code
)
)
```
### Answer to an Instant DynamicBrcode read
When an Instant DynamicBrcode is read by your user, a GET request
containing the BR code UUID will be made to your registered URL to retrieve
additional information needed to complete the transaction.
The get request must be answered in the following format
within 5 seconds and with an HTTP status code 200.
```python
import starkinfra
request = listen() # this is the method you made to get the read requests posted to your registered endpoint
uuid = starkinfra.dynamicbrcode.verify(
uuid=request.url.get_parameter("uuid"),
signature=request.headers["Digital-Signature"],
)
invoice = get_my_invoice(uuid) # you should implement this method to get the information of the BR code from its uuid
send_response( # you should also implement this method to respond the read request
starkinfra.issuingpurchase.response_instant(
version=invoice.version,
created=invoice.created,
key_id=invoice.key_id,
status=invoice.status,
reconciliation_id=invoice.reconciliation_id,
amount=invoice.amount,
cashier_type=invoice.cashier_type,
cashier_bank_code=invoice.cashier_bank_code,
cash_amount=invoice.cash_amount
)
)
```
## Create BrcodePreviews
You can create BrcodePreviews to preview BR Codes before paying them.
```python
import starkinfra
previews = starkinfra.brcodepreview.create([
starkinfra.BrcodePreview(
id="00020126420014br.gov.bcb.pix0120nedstark@hotmail.com52040000530398654075000.005802BR5909Ned Stark6014Rio de Janeiro621605126674869738606304FF71",
payer_id="012.345.678-90"
),
starkinfra.BrcodePreview(
id="00020126430014br.gov.bcb.pix0121aryastark@hotmail.com5204000053039865406100.005802BR5910Arya Stark6014Rio de Janeiro6216051262678188104863042BA4",
payer_id="012.345.678-90"
),
])
for preview in previews:
print(preview)
```
## Lending
If you want to establish a lending operation, you can use Stark Infra to
create a CCB contract. This will enable your business to lend money without
requiring a banking license, as long as you use a Credit Fund
or Securitization company.
The required steps to initiate the operation are:
1. Have funds in your Credit Fund or Securitization account
2. Request the creation of an [Identity Check](#create-individualidentities)
for the credit receiver (make sure you have their documents and express authorization)
3. (Optional) Create a [Credit Simulation](#create-creditpreviews)
with the desired installment plan to display information for the credit receiver
4. Create a [Credit Note](#create-creditnotes)
with the desired installment plan
### Create CreditNotes
For lending operations, you can create a CreditNote to generate a CCB contract.
Note that you must have recently created an identity check for that same Tax ID before
being able to create a credit operation for them.
```python
import starkinfra
from datetime import date
notes = starkinfra.creditnote.create([
starkinfra.CreditNote(
template_id="0123456789101112",
name="Jamie Lannister",
tax_id="012.345.678-90",
nominal_amount=100000,
scheduled=date(2022, 4, 28),
invoices=[
starkinfra.creditnote.Invoice(
due=date(2023, 6, 25),
amount=120000,
fine=10,
interest=2,
tax_id="012.345.678-90",
name="Jamie Lannister"
)
],
payment=starkinfra.creditnote.Transfer(
bank_code="00000000",
branch_code="1234",
account_number="129340-1",
name="Jamie Lannister",
tax_id="012.345.678-90",
amount=100000,
),
payment_type="transfer",
signers=[
starkinfra.creditsigner.CreditSigner(
name="Jamie Lannister",
contact="jamie.lannister@gmail.com",
method="link"
)
],
external_id="1234",
street_line_1="Av. Paulista, 200",
street_line_2="10 andar",
district="Bela Vista",
city="Sao Paulo",
state_code="SP",
zip_code="01310-000",
)
])
for note in notes:
print(note)
```
**Note**: Instead of using CreditNote objects, you can also pass each element in dictionary format
### Query CreditNotes
You can query multiple credit notes according to filters.
```python
import starkinfra
from datetime import date
notes = starkinfra.creditnote.query(
limit=10,
after=date(2020, 1, 1),
before=date(2020, 4, 1),
status="success",
tags=["iron", "suit"],
)
for note in notes:
print(note)
```
### Get a CreditNote
After its creation, information on a credit note may be retrieved by its id.
```python
import starkinfra
note = starkinfra.creditnote.get("5155165527080960")
print(note)
```
### Cancel a CreditNote
You can cancel a credit note if it has not been signed yet.
```python
import starkinfra
note = starkinfra.creditnote.cancel("5155165527080960")
print(note)
```
### Query CreditNote logs
You can query credit note logs to better understand CreditNote life cycles.
```python
import starkinfra
from datetime import date
logs = starkinfra.creditnote.log.query(
limit=50,
after=date(2022, 1, 1),
before=date(2022, 1, 20),
)
for log in logs:
print(log)
```
### Get a CreditNote log
You can also get a specific log by its id.
```python
import starkinfra
log = starkinfra.creditnote.log.get("5155165527080960")
print(log)
```
### Create CreditPreviews
You can preview a credit operation before creating them (Currently we only have CreditNote / CCB previews):
```python
import starkinfra
from datetime import date
previews = starkinfra.creditpreview.create([
starkinfra.CreditPreview(
type="credit-note",
credit=starkinfra.creditpreview.CreditNotePreview(
initial_amount=2478,
initial_due=date(2022, 7, 22),
nominal_amount=90583,
nominal_interest=3.7,
rebate_amount=23,
scheduled=date(2022, 6, 28),
tax_id="477.954.506-44",
type="sac"
)
),
starkinfra.CreditPreview(
type="credit-note",
credit=starkinfra.creditpreview.CreditNotePreview(
initial_amount=4449,
initial_due=date(2022, 7, 16),
interval="year",
nominal_amount=96084,
nominal_interest=3.1,
rebate_amount=239,
scheduled=date(2022, 7, 2),
tax_id="81.882.684/0001-02",
type="price",
)
),
starkinfra.CreditPreview(
type="credit-note",
credit=starkinfra.creditpreview.CreditNotePreview(
count=8,
initial_due=date(2022, 7, 18),
nominal_amount=6161,
nominal_interest=3.2,
scheduled=date(2022, 7, 3),
tax_id="59.352.830/0001-20",
type="american"
)
),
starkinfra.CreditPreview(
type="credit-note",
credit=starkinfra.creditpreview.CreditNotePreview(
initial_due=date(2022, 7, 13),
nominal_amount=86237,
nominal_interest=2.6,
scheduled=date(2022, 7, 3),
tax_id="37.293.955/0001-94",
type="bullet"
)
),
starkinfra.CreditPreview(
type="credit-note",
credit=starkinfra.creditpreview.CreditNotePreview(
invoices=[
starkinfra.creditnote.Invoice(
amount=14500,
due=date(2022, 8, 19)
),
starkinfra.creditnote.Invoice(
amount=14500,
due=date(2022, 9, 25)
)
],
nominal_amount=29000,
rebate_amount=900,
scheduled=date(2022, 7, 31),
tax_id="36.084.400/0001-70",
type="custom"
),
),
])
for preview in previews:
print(preview)
```
**Note**: Instead of using CreditPreview objects, you can also pass each element in dictionary format
### Create CreditHolmes
Before you request a credit operation, you may want to check previous credit operations
the credit receiver has taken.
For that, open up a CreditHolmes investigation to receive information on all debts and credit
operations registered for that individual or company inside the Central Bank's SCR.
```python
import starkinfra
holmes = starkinfra.creditholmes.create([
starkinfra.CreditHolmes(
tax_id="123.456.789-00",
competence="2022-09"
),
starkinfra.CreditHolmes(
tax_id="123.456.789-00",
competence="2022-08"
),
starkinfra.CreditHolmes(
tax_id="123.456.789-00",
competence="2022-07"
)
])
for sherlock in holmes:
print(sherlock)
```
### Query CreditHolmes
You can query multiple credit holmes according to filters.
```python
import starkinfra
from datetime import date
holmes = starkinfra.creditholmes.query(
after=date(2022, 6, 1),
before=date(2022, 10, 30),
status="success"
)
for sherlock in holmes:
print(sherlock)
```
### Get a CreditHolmes
After its creation, information on a credit holmes may be retrieved by its id.
```python
import starkinfra
holmes = starkinfra.creditholmes.get("5657818854064128")
print(holmes)
```
### Query CreditHolmes logs
You can query credit holmes logs to better understand their life cycles.
```python
import starkinfra
from datetime import date
logs = starkinfra.creditholmes.log.query(
limit=50,
ids=["5729405850615808"],
after=date(2022, 1, 1),
before=date(2022, 1, 20),
types=["created"]
)
for log in logs:
print(log)
```
### Get a CreditHolmes log
You can also get a specific log by its id.
```python
import starkinfra
log = starkinfra.creditholmes.log.get("5155165527080960")
print(log)
```
## Identity
Several operations, especially credit ones, require that the identity
of a person or business is validated beforehand.
Identities are validated according to the following sequence:
1. The Identity resource is created for a specific Tax ID
2. Documents are attached to the Identity resource
3. The Identity resource is updated to indicate that all documents have been attached
4. The Identity is sent for validation and returns a webhook notification to reflect
the success or failure of the operation
### Create IndividualIdentities
You can create an IndividualIdentity to validate a document of a natural person
```python
import starkinfra
identities = starkinfra.individualidentity.create([
starkinfra.IndividualIdentity(
name="Walter White",
tax_id="012.345.678-90",
tags=["breaking", "bad"]
)
])
for identity in identities:
print(identity)
```
**Note**: Instead of using IndividualIdentity objects, you can also pass each element in dictionary format
### Query IndividualIdentity
You can query multiple individual identities according to filters.
```python
import starkinfra
from datetime import date
identities = starkinfra.individualidentity.query(
limit=10,
after=date(2020, 1, 1),
before=date(2020, 4, 1),
status="success",
tags=["breaking", "bad"],
)
for identity in identities:
print(identity)
```
### Get an IndividualIdentity
After its creation, information on an individual identity may be retrieved by its id.
```python
import starkinfra
identity = starkinfra.individualidentity.get("5155165527080960")
print(identity)
```
### Update an IndividualIdentity
You can update a specific identity status to "processing" for send it to validation.
```python
import starkinfra
identity = starkinfra.individualidentity.update("5155165527080960", status="processing")
print(identity)
```
**Note**: Before sending your individual identity to validation by patching its status, you must send all the required documents using the create method of the CreditDocument resource. Note that you must reference the individual identity in the create method of the CreditDocument resource by its id.
### Cancel an IndividualIdentity
You can cancel an individual identity before updating its status to processing.
```python
import starkinfra
identity = starkinfra.individualidentity.cancel("5155165527080960")
print(identity)
```
### Query IndividualIdentity logs
You can query individual identity logs to better understand individual identity life cycles.
```python
import starkinfra
from datetime import date
logs = starkinfra.individualidentity.log.query(
limit=50,
after=date(2022, 1, 1),
before=date(2022, 1, 20),
)
for log in logs:
print(log)
```
### Get an IndividualIdentity log
You can also get a specific log by its id.
```python
import starkinfra
log = starkinfra.individualidentity.log.get("5155165527080960")
print(log)
```
### Create IndividualDocuments
You can create an individual document to attach images of documents to a specific individual Identity.
You must reference the desired individual identity by its id.
```python
import starkinfra
documents = starkinfra.individualdocument.create([
starkinfra.IndividualDocument(
type="identity-front",
content="data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAASABIAAD...",
identity_id='5155165527080960',
tags=["breaking", "bad"]
),
starkinfra.IndividualDocument(
type="identity-back",
content="data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAASABIAAD...",
identity_id='5155165527080960',
tags=["breaking", "bad"]
),
starkinfra.IndividualDocument(
type="selfie",
content="data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAASABIAAD...",
identity_id='5155165527080960',
tags=["breaking", "bad"]
)
])
for document in documents:
print(document)
```
**Note**: Instead of using IndividualDocument objects, you can also pass each element in dictionary format
### Query IndividualDocuments
You can query multiple individual documents according to filters.
```python
import starkinfra
from datetime import date
documents = starkinfra.individualidentity.query(
limit=10,
after=date(2020, 1, 1),
before=date(2020, 4, 1),
status="success",
tags=["breaking", "bad"],
)
for document in documents:
print(document)
```
### Get an IndividualDocument
After its creation, information on an individual document may be retrieved by its id.
```python
import starkinfra
document = starkinfra.individualdocument.get("5155165527080960")
print(document)
```
### Query IndividualDocument logs
You can query individual document logs to better understand individual document life cycles.
```python
import starkinfra
from datetime import date
logs = starkinfra.individualdocument.log.query(
limit=50,
after=date(2022, 1, 1),
before=date(2022, 1, 20),
)
for log in logs:
print(log)
```
### Get an IndividualDocument log
You can also get a specific log by its id.
```python
import starkinfra
log = starkinfra.individualdocument.log.get("5155165527080960")
print(log)
```
## Webhook
### Create a webhook subscription
To create a webhook subscription and be notified whenever an event occurs, run:
```python
import starkinfra
webhook = starkinfra.webhook.create(
url="https://webhook.site/dd784f26-1d6a-4ca6-81cb-fda0267761ec",
subscriptions=[
"credit-note",
"issuing-card", "issuing-invoice", "issuing-purchase",
"pix-request.in", "pix-request.out", "pix-reversal.in", "pix-reversal.out", "pix-claim", "pix-key", "pix-chargeback", "pix-infraction",
],
)
print(webhook)
```
### Query webhook subscriptions
To search for registered webhook subscriptions, run:
```python
import starkinfra
webhooks = starkinfra.webhook.query()
for webhook in webhooks:
print(webhook)
```
### Get a webhook subscription
You can get a specific webhook subscription by its id.
```python
import starkinfra
webhook = starkinfra.webhook.get("1082736198236817")
print(webhook)
```
### Delete a webhook subscription
You can also delete a specific webhook subscription by its id.
```python
import starkinfra
webhook = starkinfra.webhook.delete("1082736198236817")
print(webhook)
```
### Process webhook events
It's easy to process events delivered to your Webhook endpoint.
Remember to pass the signature header so the SDK can make sure it was StarkInfra that sent you the event.
```python
import starkinfra
request = listen() # this is the method you made to get the events posted to your webhook endpoint
event = starkinfra.event.parse(
content=request.data.decode("utf-8"),
signature=request.headers["Digital-Signature"],
)
if "pix-request" in event.subscription:
print(event.log.request)
elif "pix-reversal" in event.subscription:
print(event.log.reversal)
elif "issuing-card" in event.subscription:
print(event.log.card)
elif "issuing-invoice" in event.subscription:
print(event.log.invoice)
elif "issuing-purchase" in event.subscription:
print(event.log.purchase)
elif "credit-note" in event.subscription:
print(event.log.note)
```
### Query webhook events
To search for webhooks events, run:
```python
import starkinfra
from datetime import date
events = starkinfra.event.query(after=date(2020, 3, 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 starkinfra
event = starkinfra.event.get("1082736198236817")
print(event)
```
### Delete a webhook event
You can also delete a specific webhook event by its id.
```python
import starkinfra
event = starkinfra.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 starkinfra
event = starkinfra.event.update(id="1298371982371921", 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 starkinfra
from datetime import date
attempts = starkinfra.event.attempt.query(after=date(2020, 3, 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 starkinfra
attempt = starkinfra.event.attempt.get("1616161616161616")
print(attempt)
```
# request
This resource allows you to send HTTP requests to StarkInfra routes.
## GET
You can perform a GET request to any StarkInfra route.
It's possible to get a single resource using its id in the path.
```python
import starkinfra
example_id = "5155165527080960"
request = starkinfra.request.get(
path=f'/pix-request/{example_id}'
).json()
print(request)
```
You can also get the specific resource log,
```python
import starkinfra
example_id = "5699165527090460"
request = starkinfra.request.get(
path=f'/pix-request/log/{example_id}',
).json()
print(request)
```
This same method will be used to list all created items for the requested resource.
```python
import starkinfra
after = "2024-01-01"
before = "2024-02-01"
cursor = None
while True:
request = starkinfra.request.get(
path=f'/pix-request/',
query={
"after": after,
"before": before,
"cursor": cursor
}
).json()
cursor = request["cursor"]
if cursor is None:
break
```
To list logs, you will use the same logic as for getting a single log.
```python
import starkinfra
after = "2024-01-01"
before = "2024-02-01"
cursor = None
while True:
request = starkinfra.request.get(
path=f'/pix-request/log',
query={
"after": after,
"before": before,
"cursor": cursor
}
).json()
cursor = request["cursor"]
if cursor is None:
break
```
## POST
You can perform a POST request to any StarkInfra route.
This will create an object for each item sent in your request
**Note**: It's not possible to create multiple resources simultaneously. You need to send separate requests if you want to create multiple resources, such as invoices and boletos.
```python
import starkinfra
data = {
"holders": [
{
"name": "Jaime Lannister",
"externalId": "my_external_id",
"taxId": "012.345.678-90"
}
]
}
request = starkinfra.request.post(
path="/issuing-holder",
body=data,
).json()
print(request)
```
## PATCH
You can perform a PATCH request to any StarkInfra route.
It's possible to update a single item of a StarkInfra resource.
```python
import starkinfra
example_id = "5155165527080960"
request = starkinfra.request.patch(
path=f'/issuing-holder/{example_id}',
body={
"tags": ["Arya", "Stark"]
}
).json()
print(request)
```
## DELETE
You can perform a DELETE request to any StarkInfra route.
It's possible to delete a single item of a StarkInfra resource.
```python
import starkinfra
example_id = "5155165527080960"
request = starkinfra.request.delete(
path=f'/issuing-holder/{example_id}'
).json()
print(request)
```
# 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 starkinfra
try:
reversal = starkinfra.pixreversal.create([
starkinfra.PixReversal(
amount=100,
end_to_end_id="E00000000202201060100rzsJzG9PzMg",
external_id="1723843582395893",
reason="bankError",
)
])
except starkinfra.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 starkinfra.event.parse()
when the provided content and signature do not check out with the Stark Infra 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/starkinfra/sdk-python",
"name": "starkinfra",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "stark infra, starkinfra, sdk, open banking, openbanking, banking, open, stark",
"author": "Stark Infra",
"author_email": "developers@starkbank.com",
"download_url": "https://files.pythonhosted.org/packages/72/c2/9f12a47c6a56613fdb1ee87bb865b11997f9a3617a5a73609d57f5e87937/starkinfra-0.13.0.tar.gz",
"platform": null,
"description": "# Stark Infra Python SDK - Beta\n\nWelcome to the Stark Infra 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 Infra API v2.\n\n# Introduction\n\n## Index\n\n- [Introduction](#introduction)\n - [Supported Python versions](#supported-python-versions)\n - [API documentation](#stark-infra-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 - [Issuing](#issuing)\n - [Products](#query-issuingproducts): View available sub-issuer card products (a.k.a. card number ranges or BINs)\n - [Holders](#create-issuingholders): Manage card holders\n - [Cards](#create-issuingcards): Create virtual and/or physical cards\n - [Design](#query-issuingdesigns): View your current card or package designs\n - [EmbossingKit](#query-issuingembossingkits): View your current embossing kits\n - [Stock](#query-issuingstocks): View your current stock of a certain IssuingDesign linked to an Embosser on the workspace\n - [Restock](#create-issuingrestocks): Create restock orders of a specific IssuingStock object\n - [EmbossingRequest](#create-issuingembossingrequests): Create embossing requests\n - [TokenRequest](#create-an-issuingtokenrequest): Generate the payload to create the token\n - [Token](#process-token-authorizations): Authorize and manage your tokens\n - [TokenActivation](#process-token-activations): Get notified on how to inform the activation code to the holder \n - [TokenDesign](#get-an-issuingtokendesign): View your current token card arts\n - [Purchases](#process-purchase-authorizations): Authorize and view your past purchases\n - [Invoices](#create-issuinginvoices): Add money to your issuing balance\n - [Withdrawals](#create-issuingwithdrawals): Send money back to your Workspace from your issuing balance\n - [Balance](#get-your-issuingbalance): View your issuing balance\n - [Transactions](#query-issuingtransactions): View the transactions that have affected your issuing balance\n - [Enums](#issuing-enums): Query enums related to the issuing purchases, such as merchant categories, countries and card purchase methods\n - [Pix](#pix)\n - [PixRequests](#create-pixrequests): Create Pix transactions\n - [PixReversals](#create-pixreversals): Reverse Pix transactions\n - [PixBalance](#get-your-pixbalance): View your account balance\n - [PixStatement](#create-a-pixstatement): Request your account statement\n - [PixKey](#create-a-pixkey): Create a Pix Key\n - [PixClaim](#create-a-pixclaim): Claim a Pix Key\n - [PixDirector](#create-a-pixdirector): Create a Pix Director\n - [PixInfraction](#create-pixinfractions): Create Pix Infraction reports\n - [PixFraud](#create-a-pixfraud): Create a Pix Fraud \n - [PixUser](#get-a-pixuser): Get fraud statistics of a user\n - [PixChargeback](#create-pixchargebacks): Create Pix Chargeback requests\n - [PixDomain](#query-pixdomains): View registered SPI participants certificates\n - [StaticBrcode](#create-staticbrcodes): Create static Pix BR codes\n - [DynamicBrcode](#create-dynamicbrcodes): Create dynamic Pix BR codes\n - [BrcodePreview](#create-brcodepreviews): Read data from BR Codes before paying them\n - [Lending](#lending)\n - [CreditNote](#create-creditnotes): Create credit notes\n - [CreditPreview](#create-creditpreviews): Create credit previews\n - [CreditHolmes](#create-creditholmes): Create credit holmes debt verification\n - [Identity](#identity)\n - [IndividualIdentity](#create-individualidentities): Create individual identities\n - [IndividualDocument](#create-individualdocuments): Create individual documents\n - [Webhook](#webhook):\n - [Webhook](#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 - [Request](#request): Send a custom request to Stark Bank. This can be used to access features that haven't been mapped yet.\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 Infra API documentation\n\nFeel free to take a look at our [API docs](https://www.starkinfra.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 starkinfra\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 the 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 starkinfra\n\nprivateKey, publicKey = starkinfra.key.create()\n\n# or, to also save .pem files in a specific path\nprivateKey, publicKey = starkinfra.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 [StarkInfra Sandbox](https://web.sandbox.starkinfra.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 starkinfra\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 = starkinfra.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 [Starkinfra Sandbox](https://web.sandbox.starkinfra.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 starkinfra\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 = starkinfra.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```\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 an argument in all functions:\n\n```python\nimport starkinfra\n\nbalance = starkinfra.pixbalance.get(user=project) # or organization\n```\n\n4.2 Set it as a default user in the SDK:\n\n```python\nimport starkinfra\n\nstarkinfra.user = project # or organization\n\nbalance = starkinfra.pixbalance.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 starkinfra\n\nstarkinfra.language = \"en-US\"\n```\n\nLanguage options are \"en-US\" for English and \"pt-BR\" for Brazilian Portuguese. English is the 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 straightforward 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 starkinfra\n\nfor request in starkinfra.pixrequest.query(limit=200):\n print(request)\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 starkinfra\n\ncursor = None\nwhile True:\n requests, cursor = starkinfra.pixrequest.page(limit=50, cursor=cursor)\n for request in requests:\n print(request)\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 Infra, you'll need funds\nin your account, which can be added to your balance by creating a starkbank.Invoice. \n\nIn the Sandbox environment, most of the created starkbank.Invoices will be automatically paid,\nso there's nothing else you need to do to add funds to your account. Just create\na few starkbank.Invoice and wait around a bit.\n\nIn Production, you (or one of your clients) will need to actually pay this Pix Request\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(starkinfra.issuinginvoice.create)`)\n\n## Issuing\n\n### Query IssuingProducts\n\nTo take a look at the sub-issuer card products available to you, just run the following:\n\n```python\nimport starkinfra\n\nproducts = starkinfra.issuingproduct.query()\n\nfor product in products:\n print(product)\n```\n\nThis will tell which card products and card number prefixes you have at your disposal.\n\n### Create IssuingHolders\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 starkinfra\n\nholders = starkinfra.issuingholder.create([\n starkinfra.IssuingHolder(\n name=\"Iron Bank S.A.\",\n external_id=\"1234\",\n tax_id=\"012.345.678-90\",\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 {\n \"type\": \"services\"\n },\n {\n \"code\": \"fastFoodRestaurants\"\n }\n ],\n \"countries\": [\n {\n \"code\": \"USA\"\n }\n ],\n \"methods\": [\n {\n \"code\": \"token\"\n }\n ]\n }\n ]\n )\n])\n\nfor holder in holders:\n print(holder)\n```\n\n**Note**: Instead of using IssuingHolder objects, you can also pass each element in dictionary format\n\n### Query IssuingHolders\n\nYou can query multiple holders according to filters.\n\n```python\nimport starkinfra\n\nholders = starkinfra.issuingholder.query()\n\nfor holder in holders:\n print(holder)\n```\n\n### Cancel an IssuingHolder\n\nTo cancel a single Issuing Holder by its id, run:\n\n```python\nimport starkinfra\n\nholder = starkinfra.issuingholder.cancel(\"5155165527080960\")\n\nprint(holder)\n```\n\n### Get an IssuingHolder\n\nTo get a specific Issuing Holder by its id, run:\n\n```python\nimport starkinfra\n\nholder = starkinfra.issuingholder.get(\"5155165527080960\")\n\nprint(holder)\n```\n\n### Query IssuingHolder logs\n\nYou can query IssuingHolder logs to better understand IssuingHolder life cycles.\n\n```python\nimport starkinfra\n\nlogs = starkinfra.issuingholder.log.query(limit=50)\n\nfor log in logs:\n print(log.id)\n```\n\n### Get an IssuingHolder log\n\nYou can also get a specific log by its id.\n\n```python\nimport starkinfra\n\nlog = starkinfra.issuingholder.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n### Create IssuingCards\n\nYou can issue cards with specific spending rules.\n\n```python\nimport starkinfra\n\ncards = starkinfra.issuingcard.create([\n starkinfra.IssuingCard(\n holder_name=\"Developers\",\n holder_tax_id=\"012.345.678-90\",\n holder_external_id=\"1234\",\n rules=[starkinfra.IssuingRule(\n name=\"general\",\n interval=\"week\",\n amount=50000,\n currency_code=\"USD\",\n categories=[\n starkinfra.MerchantCategory(type=\"services\"), # Covers all service-related MCCs\n starkinfra.MerchantCategory(code=\"fastFoodRestaurants\") # Covers a specific MCC\n ],\n countries=[\n starkinfra.MerchantCountry(code=\"BRA\")\n ],\n methods=[\n starkinfra.CardMethod(code=\"token\")\n ]\n )]\n )\n])\n\nfor card in cards:\n print(card)\n```\n\n### Query IssuingCards\n\nYou can get a list of created cards given some filters.\n\n```python\nimport starkinfra\nfrom datetime import date\n\ncards = starkinfra.issuingcard.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 an IssuingCard\n\nAfter its creation, information on a card may be retrieved by its id.\n\n```python\nimport starkinfra\n\ncard = starkinfra.issuingcard.get(\"5155165527080960\")\n\nprint(card)\n```\n\n### Update an IssuingCard\n\nYou can update a specific card by its id.\n\n```python\nimport starkinfra\n\ncard = starkinfra.issuingcard.update(\"5155165527080960\", status=\"blocked\")\n\nprint(card)\n```\n\n### Cancel an IssuingCard\n\nYou can also cancel a card by its id.\n\n```python\nimport starkinfra\n\ncard = starkinfra.issuingcard.cancel(\"5155165527080960\")\n\nprint(card)\n```\n\n### Query IssuingCard logs\n\nLogs are pretty important to understand the life cycle of a card.\n\n```python\nimport starkinfra\n\nlogs = starkinfra.issuingcard.log.query(limit=150)\n\nfor log in logs:\n print(log)\n```\n\n### Get an IssuingCard log\n\nYou can get a single log by its id.\n\n```python\nimport starkinfra\n\nlog = starkinfra.issuingcard.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n### Query IssuingDesigns\n\nYou can get a list of available designs given some filters.\n\n```python\nimport starkinfra\n\ndesigns = starkinfra.issuingdesign.query(\n limit=1\n)\n\nfor design in designs:\n print(design)\n```\n\n### Get an IssuingDesign\n\nInformation on a design may be retrieved by its id.\n\n```python\nimport starkinfra\n\ndesign = starkinfra.issuingdesign.get(\"5747368922185728\")\n\nprint(design)\n```\n\n### Query IssuingEmbossingKits\n\nYou can get a list of existing embossing kits given some filters.\n\n```python\nimport starkinfra\nfrom datetime import date\n\nkits = starkinfra.issuingembossingkit.query(\n after=date(2022, 11, 1),\n before=date(2022, 12, 1)\n)\n\nfor kit in kits:\n print(kit)\n```\n\n### Get an IssuingEmbossingKit\n\nAfter its creation, information on an embossing kit may be retrieved by its id.\n\n```python\nimport starkinfra\n\nkit = starkinfra.issuingembossingkit.get(\"5664445921492992\")\n\nprint(kit)\n```\n\n### Query IssuingStocks\n\nYou can get a list of available stocks given some filters.\n\n```python\nimport starkinfra\nfrom datetime import date\n\nstocks = starkinfra.issuingstock.query(\n after=date(2020, 1, 1),\n before=date(2020, 3, 1)\n)\n\nfor stock in stocks:\n print(stock)\n```\n\n### Get an IssuingStock\n\nInformation on a stock may be retrieved by its id.\n\n```python\nimport starkinfra\n\nstock = starkinfra.issuingstock.get(\"5792731695677440\")\n\nprint(stock)\n```\n\n### Query IssuingStock logs\n\nLogs are pretty important to understand the life cycle of a stock.\n\n```python\nimport starkinfra\n\nlogs = starkinfra.issuingstock.log.query(limit=150)\n\nfor log in logs:\n print(log)\n```\n\n### Get an IssuingStock log\n\nYou can get a single log by its id.\n\n```python\nimport starkinfra\n\nlog = starkinfra.issuingstock.log.get(\"5809977331548160\")\n\nprint(log)\n```\n\n### Create IssuingRestocks\n\nYou can order restocks for a specific IssuingStock.\n\n```python\nimport starkinfra\n\nrestocks = starkinfra.issuingrestock.create([\n starkinfra.IssuingRestock(\n count=100,\n stock_id=\"5136459887542272\"\n )\n])\n\nfor restock in restocks:\n print(restock)\n```\n\n### Query IssuingRestocks\n\nYou can get a list of created restocks given some filters.\n\n```python\nimport starkinfra\nfrom datetime import date\n\nrestocks = starkinfra.issuingrestock.query(\n after=date(2022, 11, 1),\n before=date(2022, 12, 1)\n)\n\nfor restock in restocks:\n print(restock)\n```\n\n### Get an IssuingRestock\n\nAfter its creation, information on a restock may be retrieved by its id.\n\n```python\nimport starkinfra\n\nrestock = starkinfra.issuingrestock.get(\"5664445921492992\")\n\nprint(restock)\n```\n\n### Query IssuingRestock logs\n\nLogs are pretty important to understand the life cycle of a restock.\n\n```python\nimport starkinfra\n\nlogs = starkinfra.issuingrestock.log.query(limit=150)\n\nfor log in logs:\n print(log)\n```\n\n### Get an IssuingRestock log\n\nYou can get a single log by its id.\n\n```python\nimport starkinfra\n\nlog = starkinfra.issuingrestock.log.get(\"6310318875607040\")\n\nprint(log)\n```\n\n### Create IssuingEmbossingRequests\n\nYou can create a request to emboss a physical card.\n\n```python\nimport starkinfra\n\nembossing_requests = starkinfra.issuingembossingrequest.create([\n starkinfra.IssuingEmbossingRequest(\n kit_id=\"5648359658356736\", \n card_id=\"5714424132272128\", \n display_name_1=\"Antonio Stark\", \n shipping_city=\"Sao Paulo\",\n shipping_country_code=\"BRA\",\n shipping_district=\"Bela Vista\",\n shipping_service=\"loggi\",\n shipping_state_code=\"SP\",\n shipping_street_line_1=\"Av. Paulista, 200\",\n shipping_street_line_2=\"10 andar\",\n shipping_tracking_number=\"My_custom_tracking_number\",\n shipping_zip_code=\"12345-678\",\n embosser_id=\"5746980898734080\"\n )\n])\n\nfor embossing_request in embossing_requests:\n print(embossing_request)\n```\n\n### Query IssuingEmbossingRequests\n\nYou can get a list of created embossing requests given some filters.\n\n```python\nimport starkinfra\nfrom datetime import date\n\nembossing_requests = starkinfra.issuingembossingrequest.query(\n after=date(2022, 11, 1),\n before=date(2022, 12, 1)\n)\n\nfor embossing_request in embossing_requests:\n print(embossing_request)\n```\n\n### Get an IssuingEmbossingRequest\n\nAfter its creation, information on an embossing request may be retrieved by its id.\n\n```python\nimport starkinfra\n\nembossing_request = starkinfra.issuingembossingrequest.get(\"5191752558313472\")\n\nprint(embossing_request)\n```\n\n### Query IssuingEmbossingRequest logs\n\nLogs are pretty important to understand the life cycle of an embossing request.\n\n```python\nimport starkinfra\n\nlogs = starkinfra.issuingembossingrequest.log.query(limit=150)\n\nfor log in logs:\n print(log)\n```\n\n### Get an IssuingEmbossingRequest log\n\nYou can get a single log by its id.\n\n```python\nimport starkinfra\n\nlog = starkinfra.issuingembossingrequest.log.get(\"6724771005857792\")\n\nprint(log)\n```\n### Create an IssuingTokenRequest\n\nYou can create a request that provides the required data you must send to the wallet app.\n\n```python\nimport starkinfra\n\nrequest = starkinfra.issuingtokenrequest.create(\n starkinfra.IssuingTokenRequest(\n card_id=\"5189831499972623\",\n wallet_id=\"google\",\n method_code=\"app\"\n )\n)\n\nprint(request)\n```\n\n### Process Token authorizations\n\nIt's easy to process token authorizations delivered to your endpoint.\nRemember to pass the signature header so the SDK can make sure it's StarkInfra that sent you the event.\nIf you do not approve or decline the authorization within 2 seconds, the authorization will be denied.\n\n```python\nimport starkinfra\n\nrequest = listen() # this is the method you made to get the events posted to your tokenAuthorizationUrl endpoint\n\nauthorization = starkinfra.issuingtoken.parse(\n content=request.data.decode(\"utf-8\"),\n signature=request.headers[\"Digital-Signature\"],\n)\n\nsendResponse(\n starkinfra.issuingtoken.response_authorization( # this optional method just helps you build the response JSON\n status=\"approved\",\n activation_methods=[\n {\n \"type\": \"app\",\n \"value\": \"com.subissuer.android\"\n },\n {\n \"type\": \"text\",\n \"value\": \"** *****-5678\"\n }\n ],\n design_id=\"4584031664472031\",\n tags=[\"token\", \"user/1234\"],\n )\n)\n\n# or\n\nsendResponse(\n starkinfra.issuingtoken.response_authorization( # this optional method just helps you build the response JSON\n status=\"denied\",\n reason=\"other\",\n )\n)\n```\n\n### Process Token activations\n\nIt's easy to process token activation notifications delivered to your endpoint.\nRemember to pass the signature header so the SDK can make sure it's Stark Infra that sent you the event.\n\n```python\nimport starkinfra\n\nrequest = listen() # this is the method you made to get the events posted to your tokenActivationUrl endpoint\n\nauthorization = starkinfra.issuingtokenactivation.parse(\n content=request.data.decode(\"utf-8\"),\n signature=request.headers[\"Digital-Signature\"],\n)\n```\n\nAfter that, you may generate the activation code and send it to the cardholder.\nThe cardholder enters the received code in the wallet app. We'll receive and send it to\ntokenAuthorizationUrl for your validation. Completing the provisioning process. \n\n```python\nimport starkinfra\n\nrequest = listen() # this is the method you made to get the events posted to your tokenAuthorizationUrl endpoint\n\nactivation = starkinfra.issuingtoken.parse(\n content=request.data.decode(\"utf-8\"),\n signature=request.headers[\"Digital-Signature\"],\n)\n\nsendResponse(\n starkinfra.issuingtoken.response_activation( # this optional method just helps you build the response JSON\n status=\"approved\",\n tags=[\"token\", \"user/1234\"]\n )\n)\n\n# or\n\nsendResponse(\n starkinfra.issuingtoken.response_activation( # this optional method just helps you build the response JSON\n status=\"denied\",\n reason=\"other\",\n tags=[\"token\", \"user/1234\"]\n )\n)\n```\n\n### Get an IssuingToken\n\nYou can get a single token by its id.\n\n```python\nimport starkinfra\n\ntoken = starkinfra.issuingtoken.get(id=\"5749080709922816\")\n\nprint(token)\n```\n\n### Query IssuingTokens\n\nYou can get a list of created tokens given some filters.\n\n```python\nimport starkinfra\n\ntokens = starkinfra.issuingtoken.query(\n limit=5,\n after=date.today() - timedelta(days=100),\n before=date.today(),\n status=\"active\",\n card_ids=[\"5656565656565656\", \"4545454545454545\"],\n external_ids=[\"DSHRMC00002626944b0e3b539d4d459281bdba90c2588791\", \"DSHRMC00002626941c531164a0b14c66ad9602ee716f1e85\"]\n)\n\nfor token in tokens:\n print(token)\n```\n \n### Update an IssuingToken\n\nYou can update a specific token by its id.\n\n```python\nimport starkinfra\n\ntoken = starkinfra.issuingtoken.update(id=\"5155165527080960\", status=\"blocked\")\n\nprint(token)\n```\n\n### Cancel an IssuingToken\n\nYou can also cancel a token by its id.\n\n```python\nimport starkinfra\n\ntoken = starkinfra.issuingtoken.cancel(id=\"5155165527080960\")\n\nprint(token)\n```\n\n### Get an IssuingTokenDesign\n\nYou can get a single design by its id.\n\n```python\nimport starkinfra\n\ndesign = starkinfra.issuingtokendesign.get(id=\"5749080709922816\")\n\nprint(design)\n```\n### Query IssuingTokenDesigns \n\nYou can get a list of available designs given some filters.\n\n```python\nimport starkinfra\n\ndesigns = starkinfra.issuingtokendesign.query(limit=5)\n\nfor design in designs:\n print(design)\n```\n\n## Get an IssuingTokenDesign PDF\n\nA design PDF can be retrieved by its id. \n\n```python\nimport starkinfra\n\npdf = starkinfra.issuingtokendesign.pdf(id=\"5155165527080960\")\n\nwith open(\"design.pdf\", \"wb\") as file:\n file.write(pdf)\n```\n\n\n### Process Purchase authorizations\n\nIt's easy to process purchase authorizations delivered to your endpoint.\nRemember to pass the signature header so the SDK can make sure it's StarkInfra that sent you the event.\nIf you do not approve or decline the authorization within 2 seconds, the authorization will be denied.\n\n```python\nimport starkinfra\n\nrequest = listen() # this is the method you made to get the events posted to your tokenActivationUrl endpoint\n\nauthorization = starkinfra.issuingpurchase.parse(\n content=request.data.decode(\"utf-8\"),\n signature=request.headers[\"Digital-Signature\"],\n)\n\nsendResponse( # you should also implement this method\n starkinfra.issuingpurchase.response( # this optional method just helps you build the response JSON\n status=\"approved\",\n amount=authorization.amount,\n tags=[\"my-purchase-id/123\"],\n )\n)\n\n# or \n\nsendResponse(\n starkinfra.issuingpurchase.response(\n status=\"denied\",\n reason=\"other\",\n tags=[\"other-id/456\"],\n )\n)\n```\n\n### Query IssuingPurchases\n\nYou can get a list of created purchases given some filters.\n\n```python\nimport starkinfra\nfrom datetime import date\n\npurchases = starkinfra.issuingpurchase.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 an IssuingPurchase\n\nAfter its creation, information on a purchase may be retrieved by its id. \n\n```python\nimport starkinfra\n\npurchase = starkinfra.issuingpurchase.get(\"5155165527080960\")\n\nprint(purchase)\n```\n\n### Update an IssuingPurchase\n\nYou can update a specific IssuingPurchase by its id.\n\n```python\nimport starkinfra\n\npurchase = starkinfra.issuingpurchase.update(\"5155165527080960\", description=\"Dinner\", tags=[\"customer-x\", \"reimbursement\"])\n\nprint(purchase)\n```\n\n### Query IssuingPurchase logs\n\nLogs are pretty important to understand the life cycle of a purchase.\n\n```python\nimport starkinfra\n\nlogs = starkinfra.issuingpurchase.log.query(limit=150)\n\nfor log in logs:\n print(log)\n```\n\n### Get an IssuingPurchase log\n\nYou can get a single log by its id.\n\n```python\nimport starkinfra\n\nlog = starkinfra.issuingpurchase.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n### Create IssuingInvoices\n\nYou can create Pix invoices to transfer money from accounts you have in any bank to your Issuing balance,\nallowing you to run your issuing operation.\n\n```python\nimport starkinfra\n\ninvoice = starkinfra.issuinginvoice.create(\n invoice=starkinfra.IssuingInvoice(\n amount=1000\n )\n)\n\nprint(invoice)\n```\n\n**Note**: Instead of using IssuingInvoice objects, you can also pass each element in dictionary format\n\n### Get an IssuingInvoice\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 starkinfra\n\ninvoice = starkinfra.issuinginvoice.get(\"5155165527080960\")\n\nprint(invoice)\n```\n\n### Query IssuingInvoices\n\nYou can get a list of created invoices given some filters.\n\n```python\nimport starkinfra\nfrom datetime import date\n\ninvoices = starkinfra.issuinginvoice.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### Query IssuingInvoice logs\n\nLogs are pretty important to understand the life cycle of an invoice.\n\n```python\nimport starkinfra\n\nlogs = starkinfra.issuinginvoice.log.query(limit=150)\n\nfor log in logs:\n print(log)\n```\n\n### Get an IssuingInvoice log\n\nYou can also get a specific log by its id.\n\n```python\nimport starkinfra\n\nlog = starkinfra.issuinginvoice.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n### Create IssuingWithdrawals\n\nYou can create withdrawals to send cash back from your Issuing balance to your Banking balance\nby using the IssuingWithdrawal resource.\n\n```python\nimport starkinfra\n\nwithdrawal = starkinfra.issuingwithdrawal.create(\n withdrawal=starkinfra.IssuingWithdrawal(\n amount=10000,\n external_id=\"123\",\n description=\"Sending back\"\n )\n)\n\nprint(withdrawal)\n```\n\n**Note**: Instead of using IssuingWithdrawal objects, you can also pass each element in dictionary format\n\n### Get an IssuingWithdrawal\n\nAfter its creation, information on a withdrawal may be retrieved by its id.\n\n```python\nimport starkinfra\n\ninvoice = starkinfra.issuingwithdrawal.get(\"5155165527080960\")\n\nprint(invoice)\n```\n\n### Query IssuingWithdrawals\n\nYou can get a list of created withdrawals given some filters.\n\n```python\nimport starkinfra\nfrom datetime import date\n\nwithdrawals = starkinfra.issuingwithdrawal.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 IssuingBalance\n\nTo know how much money you have available to run authorizations, run:\n\n```python\nimport starkinfra\n\nbalance = starkinfra.issuingbalance.get()\n\nprint(balance)\n```\n\n### Query IssuingTransactions\n\nTo understand your balance changes (issuing statement), you can query\ntransactions. Note that our system creates transactions for you when\nyou make purchases, withdrawals, receive issuing invoice payments, for example.\n\n```python\nimport starkinfra\nfrom datetime import date\n\ntransactions = starkinfra.issuingtransaction.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 an IssuingTransaction\n\nYou can get a specific transaction by its id:\n\n```python\nimport starkinfra\n\ntransaction = starkinfra.issuingtransaction.get(\"5155165527080960\")\n\nprint(transaction)\n```\n\n### Issuing 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 IssuingRules.\nEither codes (which represents specific MCCs) or types (code groups) will be accepted as filters.\n\n```python\nimport starkinfra\n\ncategories = starkinfra.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 IssuingRules.\n\n```python\nimport starkinfra\n\ncountries = starkinfra.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 IssuingRules.\n\n```python\nimport starkinfra\n\nmethods = starkinfra.cardmethod.query(\n search=\"token\",\n)\n\nfor method in methods:\n print(method)\n```\n\n## Pix\n\n### Create PixRequests\n\nYou can create a Pix request to transfer money from one of your users to anyone else:\n\n```python\nimport starkinfra\n\nrequests = starkinfra.pixrequest.create([\n starkinfra.PixRequest(\n amount=100, # (R$ 1.00)\n external_id=\"141234121\", # so we can block anything you send twice by mistake\n sender_branch_code=\"0000\",\n sender_account_number=\"00000-0\",\n sender_account_type=\"checking\",\n sender_name=\"Tyrion Lannister\",\n sender_tax_id=\"012.345.678-90\",\n receiver_bank_code=\"00000001\",\n receiver_branch_code=\"0001\",\n receiver_account_number=\"00000-1\",\n receiver_account_type=\"checking\",\n receiver_name=\"Jamie Lannister\",\n receiver_tax_id=\"45.987.245/0001-92\",\n end_to_end_id=starkinfra.endtoendid.create(\"20018183\"), # Pass your bank code to create an end to end ID\n description=\"For saving my life\",\n ),\n starkinfra.PixRequest(\n amount=200, # (R$ 2.00)\n external_id=\"2135613462\", # so we can block anything you send twice by mistake\n sender_account_number=\"00000-0\",\n sender_branch_code=\"0000\",\n sender_account_type=\"checking\",\n sender_name=\"Arya Stark\",\n sender_tax_id=\"012.345.678-90\",\n receiver_bank_code=\"00000001\",\n receiver_account_number=\"00000-1\",\n receiver_branch_code=\"0001\",\n receiver_account_type=\"checking\",\n receiver_name=\"John Snow\",\n receiver_tax_id=\"012.345.678-90\",\n end_to_end_id=starkinfra.endtoendid.create(\"20018183\"), # Pass your bank code to create an end to end ID\n tags=[\"Needle\", \"sword\"],\n )\n])\n\nfor request in requests:\n print(request)\n```\n\n**Note**: Instead of using PixRequest objects, you can also pass each element in dictionary format\n\n### Query PixRequests\n\nYou can query multiple Pix requests according to filters.\n\n```python\nimport starkinfra\nfrom datetime import date\n\nrequests = starkinfra.pixrequest.query(\n limit=10,\n after=date(2020, 1, 1),\n before=date(2020, 4, 1),\n status=\"success\",\n tags=[\"iron\", \"suit\"],\n end_to_end_ids=[\"E79457883202101262140HHX553UPqeq\"],\n)\n\nfor request in requests:\n print(request)\n```\n\n### Get a PixRequest\n\nAfter its creation, information on a Pix request may be retrieved by its id. Its status indicates whether it has been paid.\n\n```python\nimport starkinfra\n\nrequest = starkinfra.pixrequest.get(\"5155165527080960\")\n\nprint(request)\n```\n\n### Process inbound PixRequest authorizations\n\nIt's easy to process authorization requests that arrived at your endpoint.\nRemember to pass the signature header so the SDK can make sure it's StarkInfra that sent you the event.\nIf you do not approve or decline the authorization within 1 second, the authorization will be denied.\n\n```python\nimport starkinfra\n\nrequest = listen() # this is your handler to listen for authorization requests\n\npix_request = starkinfra.pixrequest.parse(\n content=request.data.decode(\"utf-8\"),\n signature=request.headers[\"Digital-Signature\"],\n)\n\nprint(pix_request)\n\nsendResponse( # you should also implement this method\n starkinfra.pixrequest.response( # this optional method just helps you build the response JSON\n status=\"approved\",\n )\n)\n\n# or \n\nsendResponse(\n starkinfra.pixrequest.response(\n status=\"denied\",\n reason=\"orderRejected\",\n )\n)\n```\n \n### Query PixRequest logs\n\nYou can query Pix request logs to better understand Pix request life cycles. \n\n```python\nimport starkinfra\nfrom datetime import date\n\nlogs = starkinfra.pixrequest.log.query(\n limit=50, \n after=date(2022, 1, 1),\n before=date(2022, 1, 20),\n)\n\nfor log in logs:\n print(log)\n```\n\n### Get a PixRequest log\n\nYou can also get a specific log by its id.\n\n```python\nimport starkinfra\n\nlog = starkinfra.pixrequest.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n### Create PixReversals\n\nYou can reverse a PixRequest either partially or totally using a PixReversal.\n\n```python\nimport starkinfra\n\nreversal = starkinfra.pixreversal.create([\n starkinfra.PixReversal(\n amount=100,\n end_to_end_id=\"E00000000202201060100rzsJzG9PzMg\",\n external_id=\"17238435823958934\",\n reason=\"bankError\",\n )\n])\n\nprint(reversal)\n```\n\n### Query PixReversals \n\nYou can query multiple Pix reversals according to filters. \n\n```python\nimport starkinfra\nfrom datetime import date\n\nreversals = starkinfra.pixreversal.query(\n limit=10,\n after=date(2020, 1, 1),\n before=date(2020, 4, 1),\n status=\"success\",\n tags=[\"iron\", \"suit\"],\n return_ids=[\"D20018183202202030109X3OoBHG74wo\"],\n)\n\nfor reversal in reversals:\n print(reversal)\n```\n\n### Get a PixReversal\n\nAfter its creation, information on a Pix reversal may be retrieved by its id.\nIts status indicates whether it has been successfully processed.\n\n```python\nimport starkinfra\n\nreversal = starkinfra.pixreversal.get(\"5155165527080960\")\n\nprint(reversal)\n```\n\n### Process inbound PixReversal authorizations\n\nIt's easy to process authorization requests that arrived at your endpoint.\nRemember to pass the signature header so the SDK can make sure it's StarkInfra that sent you the event.\nIf you do not approve or decline the authorization within 1 second, the authorization will be denied.\n\n```python\nimport starkinfra\n\nrequest = listen() # this is your handler to listen for authorization requests\n\nreversal = starkinfra.pixreversal.parse(\n content=request.data.decode(\"utf-8\"),\n signature=request.headers[\"Digital-Signature\"],\n)\n\nprint(reversal)\n\nsendResponse( # you should also implement this method\n starkinfra.pixreversal.response( # this optional method just helps you build the response JSON\n status=\"approved\",\n )\n)\n\n# or \n\nsendResponse(\n starkinfra.pixreversal.response(\n status=\"denied\",\n reason=\"orderRejected\",\n )\n)\n```\n\n### Query PixReversal logs\n\nYou can query Pix reversal logs to better understand their life cycles. \n\n```python\nimport starkinfra\nfrom datetime import date\n\nlogs = starkinfra.pixreversal.log.query(\n limit=50, \n after=date(2020, 1, 1),\n before=date(2020, 1, 20),\n)\n\nfor log in logs:\n print(log)\n```\n\n### Get a PixReversal log\n\nYou can also get a specific log by its id.\n\n```python\nimport starkinfra\n\nlog = starkinfra.pixreversal.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n### Get your PixBalance \n\nTo see how much money you have in your account, run:\n\n```python\nimport starkinfra\n\nbalance = starkinfra.pixbalance.get()\n\nprint(balance)\n```\n\n### Create a PixStatement\n\nStatements are generated directly by the Central Bank and are only available for direct participants.\nTo create a statement of all the transactions that happened on your account during a specific day, run:\n\n```python\nimport starkinfra\nfrom datetime import date\n\nstatement = starkinfra.pixstatement.create(\n starkinfra.PixStatement(\n after=date(2022, 1, 1), # This is the date that you want to create a statement.\n before=date(2022, 1, 1), # After and before must be the same date.\n type=\"transaction\" # Options are \"interchange\", \"interchangeTotal\", \"transaction\".\n )\n)\n\nprint(statement)\n```\n\n### Query PixStatements\n\nYou can query multiple Pix statements according to filters. \n\n```python\nimport starkinfra\n\nstatements = starkinfra.pixstatement.query(\n limit=50, \n)\n\nfor statement in statements:\n print(statement)\n```\n\n### Get a PixStatement\n\nStatements are only available for direct participants. To get a Pix statement by its id:\n\n```python\nimport starkinfra\n\nstatement = starkinfra.pixstatement.get(\"5155165527080960\")\n\nprint(statement)\n```\n\n### Get a PixStatement .csv file\n\nTo get the .csv file corresponding to a Pix statement using its id, run:\n\n```python\nimport starkinfra\n\ncsv = starkinfra.pixstatement.csv(\"5155165527080960\")\n\nwith open(\"test.zip\", \"wb\") as file:\n file.write(csv)\n```\n\n### Create a PixKey\n\nYou can create a Pix Key to link a bank account information to a key id:\n\n```python\nimport starkinfra\nfrom datetime import datetime\n\nkey = starkinfra.pixkey.create(\n starkinfra.PixKey(\n account_created=datetime(2022, 2, 1, 0, 0, 0),\n account_number=\"00000\",\n account_type=\"savings\",\n branch_code=\"0000\",\n name=\"Jamie Lannister\",\n tax_id=\"012.345.678-90\",\n id=\"+5511989898989\",\n )\n)\n\nprint(key)\n```\n\n### Query PixKeys\n\nYou can query multiple Pix keys you own according to filters.\n\n```python\nimport starkinfra\nfrom datetime import date\n\nkeys = starkinfra.pixkey.query(\n limit=1,\n after=date(2022, 1, 1),\n before=date(2020, 1, 12),\n status=\"registered\",\n tags=[\"iron\", \"bank\"],\n ids=[\"+5511989898989\"],\n type=\"phone\"\n)\n\nfor key in keys:\n print(key)\n```\n\n### Get a PixKey\n\nInformation on a Pix key may be retrieved by its id and the tax ID of the consulting agent.\nAn endToEndId must be informed so you can link any resulting purchases to this query,\navoiding sweep blocks by the Central Bank.\n\n```python\nimport starkinfra\n\nkey = starkinfra.pixkey.get(\n \"5155165527080960\",\n payer_id=\"012.345.678-90\",\n end_to_end_id=starkinfra.endtoendid.create(\"20018183\"),\n)\n\nprint(key)\n```\n\n### Update a PixKey\n\nUpdate the account information linked to a Pix Key.\n\n```python\nimport starkinfra\n\nkey = starkinfra.pixkey.update(\n id=\"+5511989898989\",\n reason=\"branchTransfer\",\n name=\"Jamie Lannister\"\n)\n\nprint(key)\n```\n\n### Cancel a PixKey\n\nCancel a specific Pix Key using its id.\n\n```python\nimport starkinfra\n\nkey = starkinfra.pixkey.cancel(\"5155165527080960\")\n\nprint(key)\n```\n\n### Query PixKey logs\n\nYou can query Pix key logs to better understand a Pix key life cycle. \n\n```python\nimport starkinfra\nfrom datetime import date\n\nlogs = starkinfra.pixkey.log.query(\n limit=50, \n ids=[\"5729405850615808\"],\n after=date(2022, 1, 1),\n before=date(2022, 1, 20),\n types=[\"created\"],\n key_ids=[\"+5511989898989\"]\n)\n\nfor log in logs:\n print(log)\n```\n\n### Get a PixKey log\n\nYou can also get a specific log by its id.\n\n```python\nimport starkinfra\n\nlog = starkinfra.pixkey.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n### Create a PixClaim\n\nYou can create a Pix claim to request the transfer of a Pix key from another bank to one of your accounts:\n\n```python\nimport starkinfra\nfrom datetime import datetime\n\nclaim = starkinfra.pixclaim.create(\n starkinfra.PixClaim(\n account_created=datetime(2022, 2, 1, 0, 0, 0),\n account_number=\"5692908409716736\",\n account_type=\"checking\",\n branch_code=\"0000\",\n name=\"testKey\",\n tax_id=\"012.345.678-90\",\n key_id=\"+5511989898989\"\n )\n)\n\nprint(claim)\n```\n\n### Query PixClaims\n\nYou can query multiple Pix claims according to filters.\n\n```python\nimport starkinfra\nfrom datetime import date\n\nclaims = starkinfra.pixclaim.query(\n limit=1,\n after=date(2022, 1, 1),\n before=date(2022, 1, 12),\n status=\"registered\",\n ids=[\"5729405850615808\"],\n bacen_id=\"ccf9bd9c-e99d-999e-bab9-b999ca999f99\",\n type=\"ownership\",\n flow=\"out\",\n key_type=\"phone\",\n key_id=\"+5511989898989\"\n)\n\nfor claim in claims:\n print(claim)\n```\n\n### Get a PixClaim\n\nAfter its creation, information on a Pix claim may be retrieved by its id.\n\n```python\nimport starkinfra\n\nclaim = starkinfra.pixclaim.get(\"5155165527080960\")\n\nprint(claim)\n```\n\n### Update a PixClaim\n\nA Pix Claim can be confirmed or canceled by patching its status.\nA received Pix Claim must be confirmed by the donor to be completed.\nOwnership Pix Claims can only be canceled by the donor if the reason is \"fraud\".\nA sent Pix Claim can also be canceled.\n\n```python\nimport starkinfra\n\nclaim = starkinfra.pixclaim.update(\n id=\"5155165527080960\",\n status=\"confirmed\"\n)\n\nprint(claim)\n```\n\n### Query PixClaim logs\n\nYou can query Pix claim logs to better understand Pix claim life cycles.\n\n```python\nimport starkinfra\nfrom datetime import date\n\nlogs = starkinfra.pixclaim.log.query(\n limit=50, \n ids=[\"5729405850615808\"],\n after=date(2022, 1, 1),\n before=date(2022, 1, 20),\n types=[\"registered\"],\n claim_ids=[\"5719405850615809\"]\n)\n\nfor log in logs:\n print(log)\n```\n\n### Get a PixClaim log\n\nYou can also get a specific log by its id.\n\n```python\nimport starkinfra\n\nlog = starkinfra.pixclaim.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n### Create a PixDirector\n\nTo register the Pix director contact information at the Central Bank, run the following:\n\n```python\nimport starkinfra\n\ndirector = starkinfra.pixdirector.create(\n starkinfra.PixDirector(\n name=\"Edward Stark\",\n tax_id=\"03.300.300/0001-00\",\n phone=\"+5511999999999\",\n email=\"ned.stark@company.com\",\n password=\"12345678\",\n team_email=\"pix.team@company.com\",\n team_phones=[\"+5511988889999\", \"+5511988889998\"],\n )\n)\n\nprint(director)\n```\n\n### Create PixInfractions\n\nPix Infraction reports are used to report transactions that raise fraud suspicion, to request a refund or to \nreverse a refund. Infraction reports can be created by either participant of a transaction.\n\n```python\nimport starkinfra\n\ninfractions = starkinfra.pixinfraction.create(\n infractions=[\n starkinfra.PixInfraction(\n reference_id=\"E20018183202201201450u34sDGd19lz\",\n type=\"reversal\",\n method=\"scam\"\n )\n ]\n)\n\nfor infraction in infractions:\n print(infraction)\n```\n\n### Query PixInfractions\n\nYou can query multiple infraction reports according to filters.\n\n```python\nimport starkinfra\nfrom datetime import date\n\ninfractions = starkinfra.pixinfraction.query(\n limit=1,\n after=date(2022, 1, 1),\n before=date(2022, 1, 12),\n status=\"delivered\",\n ids=[\"5155165527080960\"],\n bacen_id=\"ccf9bd9c-e99d-999e-bab9-b999ca999f99\"\n)\n\nfor infraction in infractions:\n print(infraction)\n```\n\n### Get a PixInfraction\n\nAfter its creation, information on a Pix Infraction may be retrieved by its id.\n\n```python\nimport starkinfra\n\ninfraction = starkinfra.pixinfraction.get(\"5155165527080960\")\n\nprint(infraction)\n```\n\n### Update a PixInfraction\n\nA received Pix Infraction can be confirmed or declined by patching its status.\nAfter a Pix Infraction is patched, its status changes to closed.\n\n```python\nimport starkinfra\n\ninfraction = starkinfra.pixinfraction.update(\n id=\"5155165527080960\",\n result=\"agreed\",\n)\n\nprint(infraction)\n```\n\n### Cancel a PixInfraction\n\nCancel a specific Pix Infraction using its id.\n\n```python\nimport starkinfra\n\ninfraction = starkinfra.pixinfraction.cancel(\"5155165527080960\")\n\nprint(infraction)\n```\n\n### Query PixInfraction logs\n\nYou can query infraction report logs to better understand their life cycles. \n\n```python\nimport starkinfra\nfrom datetime import date\n\nlogs = starkinfra.pixinfraction.log.query(\n limit=50, \n ids=[\"5729405850615808\"],\n after=date(2022, 1, 1),\n before=date(2022, 1, 20),\n types=[\"created\"],\n infraction_ids=[\"5155165527080960\"]\n)\n\nfor log in logs:\n print(log)\n```\n\n### Get a PixInfraction log\n\nYou can also get a specific log by its id.\n\n```python\nimport starkinfra\n\nlog = starkinfra.pixinfraction.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n### Create a PixFraud\n\nPix Frauds can be created by either participant or automatically when a Pix Infraction is accepted.\n\n```python\nimport starkinfra\n\nfrauds = starkinfra.pixfraud.create(\n frauds=[\n starkinfra.PixFraud(\n external_id=\"my_external_id_1234\",\n type=\"mule\",\n tax_id=\"01234567890\",\n )\n ]\n)\n\nfor fraud in frauds:\n print(fraud)\n```\n\n### Query Pix Frauds\n\nYou can query multiple Pix frauds according to filters.\n\n```python\nimport starkinfra\nfrom datetime import date\n\nfrauds = starkinfra.pixfraud.query(\n limit=1,\n after=date(2022, 1, 1),\n before=date(2022, 1, 12),\n status=\"created\",\n ids=[\"5155165527080960\"]\n)\n\nfor fraud in frauds:\n print(fraud)\n```\n\n### Get a PixFraud\n\nAfter its creation, information on a Pix Fraud may be retrieved by its ID.\n\n```python\nimport starkinfra\n\nfraud = starkinfra.pixfraud.get(\"5155165527080960\")\n\nprint(fraud)\n```\n\n### Cancel a PixFraud\n\nCancel a specific Pix Fraud using its id.\n\n```python\nimport starkinfra\n\nfraud = starkinfra.pixfraud.cancel(\"5155165527080960\")\n\nprint(fraud)\n```\n\n### Get a PixUser\n\nYou can get a specific fraud statistics of a user with his taxId.\n\n```python\nimport starkinfra\n\nuser = starkinfra.pixuser.get(\"01234567890\")\n\nprint(user)\n```\n\n### Create PixChargebacks\n\nA Pix chargeback can be created when fraud is detected on a transaction or a system malfunction \nresults in an erroneous transaction.\n\n```python\nimport starkinfra\n\nchargebacks = starkinfra.pixchargeback.create(\n chargebacks=[\n starkinfra.PixChargeback(\n amount=100,\n reference_id=\"E20018183202201201450u34sDGd19lz\",\n reason=\"fraud\",\n )\n ]\n)\n\nfor chargeback in chargebacks:\n print(chargeback)\n```\n\n### Query PixChargebacks\n\nYou can query multiple Pix chargebacks according to filters.\n\n```python\nimport starkinfra\nfrom datetime import date\n\nchargebacks = starkinfra.pixchargeback.query(\n limit=1,\n after=date(2022, 1, 1),\n before=date(2022, 1, 12),\n status=\"registered\",\n ids=[\"5155165527080960\"],\n bacen_id=\"ccf9bd9c-e99d-999e-bab9-b999ca999f99\"\n)\n\nfor chargeback in chargebacks:\n print(chargeback)\n```\n\n### Get a PixChargeback\n\nAfter its creation, information on a Pix Chargeback may be retrieved by its.\n\n```python\nimport starkinfra\n\nchargeback = starkinfra.pixchargeback.get(\"5155165527080960\")\n\nprint(chargeback)\n```\n\n### Update a PixChargeback\n\nA received Pix Chargeback can be accepted or rejected by patching its status.\nAfter a Pix Chargeback is patched, its status changes to closed.\n\n```python\nimport starkinfra\n\nchargeback = starkinfra.pixchargeback.update(\n id=\"5155165527080960\",\n result=\"accepted\",\n reversal_reference_id=starkinfra.returnid.create(\"20018183\"),\n)\n\nprint(chargeback)\n```\n\n### Cancel a PixChargeback\n\nCancel a specific Pix Chargeback using its id.\n\n```python\nimport starkinfra\n\nchargeback = starkinfra.pixchargeback.cancel(\"5155165527080960\")\n\nprint(chargeback)\n```\n\n### Query PixChargeback logs\n\nYou can query Pix chargeback logs to better understand Pix chargeback life cycles. \n\n```python\nimport starkinfra\nfrom datetime import date\n\nlogs = starkinfra.pixchargeback.log.query(\n limit=50, \n ids=[\"5729405850615808\"],\n after=date(2022, 1, 1),\n before=date(2022, 1, 20),\n types=[\"created\"],\n chargeback_ids=[\"5155165527080960\"]\n)\n\nfor log in logs:\n print(log)\n```\n\n### Get a PixChargeback log\n\nYou can also get a specific log by its id.\n\n```python\nimport starkinfra\n\nlog = starkinfra.pixchargeback.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n### Query PixDomains\n\nHere you can list all Pix Domains registered at the Brazilian Central Bank. The Pix Domain object displays the domain \nname and the QR Code domain certificates of registered Pix participants able to issue dynamic QR Codes.\n\n```python\nimport starkinfra\n\ndomains = starkinfra.pixdomain.query()\nfor domain in domains:\n print(domain)\n```\n\n### Create StaticBrcodes\n\nStaticBrcodes store account information via a BR code or an image (QR code)\nthat represents a PixKey and a few extra fixed parameters, such as an amount \nand a reconciliation ID. They can easily be used to receive Pix transactions.\n\n```python\nimport starkinfra\n\nbrcodes = starkinfra.staticbrcode.create([\n starkinfra.StaticBrcode(\n name=\"Jamie Lannister\",\n key_id=\"+5511988887777\",\n amount=100,\n reconciliation_id=\"123\",\n city=\"Rio de Janeiro\"\n )\n])\n\nfor brcode in brcodes:\n print(brcode)\n```\n\n### Query StaticBrcodes\n\nYou can query multiple StaticBrcodes according to filters.\n\n```python\nimport starkinfra\nfrom datetime import date\n\nbrcodes = starkinfra.staticbrcode.query(\n limit=1,\n after=date(2022, 6, 1),\n before=date(2022, 6, 30),\n uuids=[\"5ddde28043a245c2848b08cf315effa2\"]\n)\n\nfor brcode in brcodes:\n print(brcode)\n```\n\n### Get a StaticBrcode\n\nAfter its creation, information on a StaticBrcode may be retrieved by its UUID.\n\n```python\nimport starkinfra\n\nbrcode = starkinfra.staticbrcode.get(\"5ddde28043a245c2848b08cf315effa2\")\n\nprint(brcode)\n```\n\n### Create DynamicBrcodes\n\nBR codes store information represented by Pix QR Codes, which are used to send \nor receive Pix transactions in a convenient way.\nDynamicBrcodes represent charges with information that can change at any time,\nsince all data needed for the payment is requested dynamically to an URL stored\nin the BR Code. Stark Infra will receive the GET request and forward it to your\nregistered endpoint with a GET request containing the UUID of the BR code for\nidentification.\n\n```python\nimport starkinfra\n\nbrcodes = starkinfra.dynamicbrcode.create([\n starkinfra.DynamicBrcode(\n name=\"Jamie Lannister\",\n city=\"Rio de Janeiro\",\n external_id=\"my_unique_id_01\",\n type=\"instant\"\n )\n])\n\nfor brcode in brcodes:\n print(brcode)\n```\n\n### Query DynamicBrcodes\n\nYou can query multiple DynamicBrcodes according to filters.\n\n```python\nimport starkinfra\nfrom datetime import date\n\nbrcodes = starkinfra.dynamicbrcode.query(\n limit=1,\n after=date(2022, 6, 1),\n before=date(2022, 6, 30),\n uuids=[\"ac7caa14e601461dbd6b12bf7e4cc48e\"]\n)\n\nfor brcode in brcodes:\n print(brcode)\n```\n\n### Get a DynamicBrcode\n\nAfter its creation, information on a DynamicBrcode may be retrieved by its UUID.\n\n```python\nimport starkinfra\n\nbrcode = starkinfra.dynamicbrcode.get(\"ac7caa14e601461dbd6b12bf7e4cc48e\")\n\nprint(brcode)\n```\n\n### Verify a DynamicBrcode read\n\nWhen a DynamicBrcode is read by your user, a GET request will be made to your registered URL to \nretrieve additional information needed to complete the transaction.\nUse this method to verify the authenticity of a GET request received at your registered endpoint.\nIf the provided digital signature does not check out with the StarkInfra public key, a stark.exception.InvalidSignatureException will be raised.\n\n```python\nimport starkinfra\n\nrequest = listen() # this is the method you made to get the read requests posted to your registered endpoint\n\nuuid = starkinfra.dynamicbrcode.verify(\n uuid=request.url.get_parameter(\"uuid\"),\n signature=request.headers[\"Digital-Signature\"],\n)\n```\n\n### Answer to a Due DynamicBrcode read\n\nWhen a Due DynamicBrcode is read by your user, a GET request containing \nthe BR code UUID will be made to your registered URL to retrieve additional \ninformation needed to complete the transaction.\n\nThe GET request must be answered in the following format within 5 seconds \nand with an HTTP status code 200.\n\n```python\nimport starkinfra\n\nrequest = listen() # this is the method you made to get the read requests posted to your registered endpoint\n\nuuid = starkinfra.dynamicbrcode.verify(\n uuid=request.url.get_parameter(\"uuid\"),\n signature=request.headers[\"Digital-Signature\"],\n)\n\ninvoice = get_my_invoice(uuid) # you should implement this method to get the information of the BR code from its uuid\n\nsend_response( # you should also implement this method to respond the read request\n starkinfra.dynamicbrcode.response_due(\n version=invoice.version,\n created=invoice.created,\n due=invoice.due,\n key_id=invoice.key_id,\n status=invoice.status,\n reconciliation_id=invoice.reconciliation_id,\n amount=invoice.amount,\n sender_name=invoice.sender_name,\n sender_tax_id=invoice.sender_tax_id,\n receiver_name=invoice.receiver_name,\n receiver_tax_id=invoice.receiver_tax_id,\n receiver_street_line=invoice.receiver_street_line,\n receiver_city=invoice.receiver_city,\n receiver_state_code=invoice.receiver_state_code,\n receiver_zip_code=invoice.receiver_zip_code\n )\n)\n```\n\n### Answer to an Instant DynamicBrcode read\n\nWhen an Instant DynamicBrcode is read by your user, a GET request \ncontaining the BR code UUID will be made to your registered URL to retrieve \nadditional information needed to complete the transaction.\n\nThe get request must be answered in the following format \nwithin 5 seconds and with an HTTP status code 200.\n\n```python\nimport starkinfra\n\nrequest = listen() # this is the method you made to get the read requests posted to your registered endpoint\n\nuuid = starkinfra.dynamicbrcode.verify(\n uuid=request.url.get_parameter(\"uuid\"),\n signature=request.headers[\"Digital-Signature\"],\n)\n\ninvoice = get_my_invoice(uuid) # you should implement this method to get the information of the BR code from its uuid\n\nsend_response( # you should also implement this method to respond the read request\n starkinfra.issuingpurchase.response_instant(\n version=invoice.version,\n created=invoice.created,\n key_id=invoice.key_id,\n status=invoice.status,\n reconciliation_id=invoice.reconciliation_id,\n amount=invoice.amount,\n cashier_type=invoice.cashier_type,\n cashier_bank_code=invoice.cashier_bank_code,\n cash_amount=invoice.cash_amount\n )\n)\n```\n\n## Create BrcodePreviews\n\nYou can create BrcodePreviews to preview BR Codes before paying them.\n\n```python\nimport starkinfra\n\npreviews = starkinfra.brcodepreview.create([\n starkinfra.BrcodePreview(\n id=\"00020126420014br.gov.bcb.pix0120nedstark@hotmail.com52040000530398654075000.005802BR5909Ned Stark6014Rio de Janeiro621605126674869738606304FF71\",\n payer_id=\"012.345.678-90\"\n ),\n starkinfra.BrcodePreview(\n id=\"00020126430014br.gov.bcb.pix0121aryastark@hotmail.com5204000053039865406100.005802BR5910Arya Stark6014Rio de Janeiro6216051262678188104863042BA4\",\n payer_id=\"012.345.678-90\"\n ),\n])\n\nfor preview in previews:\n print(preview)\n```\n\n## Lending\nIf you want to establish a lending operation, you can use Stark Infra to\ncreate a CCB contract. This will enable your business to lend money without\nrequiring a banking license, as long as you use a Credit Fund \nor Securitization company.\n\nThe required steps to initiate the operation are:\n 1. Have funds in your Credit Fund or Securitization account\n 2. Request the creation of an [Identity Check](#create-individualidentities)\nfor the credit receiver (make sure you have their documents and express authorization)\n 3. (Optional) Create a [Credit Simulation](#create-creditpreviews) \nwith the desired installment plan to display information for the credit receiver\n 4. Create a [Credit Note](#create-creditnotes)\nwith the desired installment plan\n\n\n### Create CreditNotes\n\nFor lending operations, you can create a CreditNote to generate a CCB contract.\n\nNote that you must have recently created an identity check for that same Tax ID before\nbeing able to create a credit operation for them.\n\n```python\nimport starkinfra\nfrom datetime import date \n\nnotes = starkinfra.creditnote.create([\n starkinfra.CreditNote(\n template_id=\"0123456789101112\",\n name=\"Jamie Lannister\",\n tax_id=\"012.345.678-90\",\n nominal_amount=100000,\n scheduled=date(2022, 4, 28),\n invoices=[\n starkinfra.creditnote.Invoice(\n due=date(2023, 6, 25),\n amount=120000,\n fine=10,\n interest=2,\n tax_id=\"012.345.678-90\",\n name=\"Jamie Lannister\"\n )\n ],\n payment=starkinfra.creditnote.Transfer(\n bank_code=\"00000000\",\n branch_code=\"1234\",\n account_number=\"129340-1\",\n name=\"Jamie Lannister\",\n tax_id=\"012.345.678-90\",\n amount=100000,\n ),\n payment_type=\"transfer\",\n signers=[\n starkinfra.creditsigner.CreditSigner(\n name=\"Jamie Lannister\",\n contact=\"jamie.lannister@gmail.com\",\n method=\"link\"\n )\n ],\n external_id=\"1234\",\n street_line_1=\"Av. Paulista, 200\",\n street_line_2=\"10 andar\",\n district=\"Bela Vista\",\n city=\"Sao Paulo\",\n state_code=\"SP\",\n zip_code=\"01310-000\",\n )\n])\n\nfor note in notes:\n print(note)\n```\n\n**Note**: Instead of using CreditNote objects, you can also pass each element in dictionary format\n\n### Query CreditNotes\n\nYou can query multiple credit notes according to filters.\n\n```python\nimport starkinfra\nfrom datetime import date\n\nnotes = starkinfra.creditnote.query(\n limit=10,\n after=date(2020, 1, 1),\n before=date(2020, 4, 1),\n status=\"success\",\n tags=[\"iron\", \"suit\"],\n)\n\nfor note in notes:\n print(note)\n```\n\n### Get a CreditNote\n\nAfter its creation, information on a credit note may be retrieved by its id.\n\n```python\nimport starkinfra\n\nnote = starkinfra.creditnote.get(\"5155165527080960\")\n\nprint(note)\n```\n\n### Cancel a CreditNote\n\nYou can cancel a credit note if it has not been signed yet.\n\n```python\nimport starkinfra\n\nnote = starkinfra.creditnote.cancel(\"5155165527080960\")\n\nprint(note)\n```\n \n### Query CreditNote logs\n\nYou can query credit note logs to better understand CreditNote life cycles. \n\n```python\nimport starkinfra\nfrom datetime import date\n\nlogs = starkinfra.creditnote.log.query(\n limit=50, \n after=date(2022, 1, 1),\n before=date(2022, 1, 20),\n)\n\nfor log in logs:\n print(log)\n```\n\n### Get a CreditNote log\n\nYou can also get a specific log by its id.\n\n```python\nimport starkinfra\n\nlog = starkinfra.creditnote.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n### Create CreditPreviews\n\nYou can preview a credit operation before creating them (Currently we only have CreditNote / CCB previews):\n\n```python\nimport starkinfra\nfrom datetime import date\n\npreviews = starkinfra.creditpreview.create([\n starkinfra.CreditPreview(\n type=\"credit-note\",\n credit=starkinfra.creditpreview.CreditNotePreview(\n initial_amount=2478,\n initial_due=date(2022, 7, 22),\n nominal_amount=90583,\n nominal_interest=3.7,\n rebate_amount=23,\n scheduled=date(2022, 6, 28),\n tax_id=\"477.954.506-44\",\n type=\"sac\"\n )\n ),\n starkinfra.CreditPreview(\n type=\"credit-note\",\n credit=starkinfra.creditpreview.CreditNotePreview(\n initial_amount=4449,\n initial_due=date(2022, 7, 16),\n interval=\"year\",\n nominal_amount=96084,\n nominal_interest=3.1,\n rebate_amount=239,\n scheduled=date(2022, 7, 2),\n tax_id=\"81.882.684/0001-02\",\n type=\"price\",\n )\n ),\n starkinfra.CreditPreview(\n type=\"credit-note\",\n credit=starkinfra.creditpreview.CreditNotePreview(\n count=8,\n initial_due=date(2022, 7, 18),\n nominal_amount=6161,\n nominal_interest=3.2,\n scheduled=date(2022, 7, 3),\n tax_id=\"59.352.830/0001-20\",\n type=\"american\"\n )\n ),\n starkinfra.CreditPreview(\n type=\"credit-note\",\n credit=starkinfra.creditpreview.CreditNotePreview(\n initial_due=date(2022, 7, 13),\n nominal_amount=86237,\n nominal_interest=2.6,\n scheduled=date(2022, 7, 3),\n tax_id=\"37.293.955/0001-94\",\n type=\"bullet\"\n )\n ),\n starkinfra.CreditPreview(\n type=\"credit-note\",\n credit=starkinfra.creditpreview.CreditNotePreview(\n invoices=[\n starkinfra.creditnote.Invoice(\n amount=14500,\n due=date(2022, 8, 19)\n ),\n starkinfra.creditnote.Invoice(\n amount=14500,\n due=date(2022, 9, 25)\n )\n ],\n nominal_amount=29000,\n rebate_amount=900,\n scheduled=date(2022, 7, 31),\n tax_id=\"36.084.400/0001-70\",\n type=\"custom\"\n ),\n ),\n])\n\nfor preview in previews:\n print(preview)\n```\n\n**Note**: Instead of using CreditPreview objects, you can also pass each element in dictionary format\n\n### Create CreditHolmes\n\nBefore you request a credit operation, you may want to check previous credit operations\nthe credit receiver has taken.\n\nFor that, open up a CreditHolmes investigation to receive information on all debts and credit\noperations registered for that individual or company inside the Central Bank's SCR.\n\n```python\nimport starkinfra\n\nholmes = starkinfra.creditholmes.create([\n starkinfra.CreditHolmes(\n tax_id=\"123.456.789-00\",\n competence=\"2022-09\"\n ),\n starkinfra.CreditHolmes(\n tax_id=\"123.456.789-00\",\n competence=\"2022-08\"\n ),\n starkinfra.CreditHolmes(\n tax_id=\"123.456.789-00\",\n competence=\"2022-07\"\n )\n])\n\nfor sherlock in holmes:\n print(sherlock)\n```\n\n### Query CreditHolmes\n\nYou can query multiple credit holmes according to filters.\n\n```python\nimport starkinfra\nfrom datetime import date\n\nholmes = starkinfra.creditholmes.query(\n after=date(2022, 6, 1),\n before=date(2022, 10, 30),\n status=\"success\"\n)\n\nfor sherlock in holmes:\n print(sherlock)\n```\n\n### Get a CreditHolmes\n\nAfter its creation, information on a credit holmes may be retrieved by its id.\n\n```python\nimport starkinfra\n\nholmes = starkinfra.creditholmes.get(\"5657818854064128\")\n\nprint(holmes)\n```\n\n### Query CreditHolmes logs\n\nYou can query credit holmes logs to better understand their life cycles. \n\n```python\nimport starkinfra\nfrom datetime import date\n\nlogs = starkinfra.creditholmes.log.query(\n limit=50, \n ids=[\"5729405850615808\"],\n after=date(2022, 1, 1),\n before=date(2022, 1, 20),\n types=[\"created\"]\n)\n\nfor log in logs:\n print(log)\n```\n\n### Get a CreditHolmes log\n\nYou can also get a specific log by its id.\n\n```python\nimport starkinfra\n\nlog = starkinfra.creditholmes.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n## Identity\nSeveral operations, especially credit ones, require that the identity\nof a person or business is validated beforehand.\n\nIdentities are validated according to the following sequence:\n1. The Identity resource is created for a specific Tax ID\n2. Documents are attached to the Identity resource\n3. The Identity resource is updated to indicate that all documents have been attached\n4. The Identity is sent for validation and returns a webhook notification to reflect\nthe success or failure of the operation\n\n### Create IndividualIdentities\n\nYou can create an IndividualIdentity to validate a document of a natural person\n\n```python\nimport starkinfra\n\nidentities = starkinfra.individualidentity.create([\n starkinfra.IndividualIdentity(\n name=\"Walter White\",\n tax_id=\"012.345.678-90\",\n tags=[\"breaking\", \"bad\"]\n )\n])\n\nfor identity in identities:\n print(identity)\n```\n\n**Note**: Instead of using IndividualIdentity objects, you can also pass each element in dictionary format\n\n### Query IndividualIdentity\n\nYou can query multiple individual identities according to filters.\n\n```python\nimport starkinfra\nfrom datetime import date\n\nidentities = starkinfra.individualidentity.query(\n limit=10,\n after=date(2020, 1, 1),\n before=date(2020, 4, 1),\n status=\"success\",\n tags=[\"breaking\", \"bad\"],\n)\n\nfor identity in identities:\n print(identity)\n```\n\n### Get an IndividualIdentity\n\nAfter its creation, information on an individual identity may be retrieved by its id.\n\n```python\nimport starkinfra\n\nidentity = starkinfra.individualidentity.get(\"5155165527080960\")\n\nprint(identity)\n```\n\n### Update an IndividualIdentity\n\nYou can update a specific identity status to \"processing\" for send it to validation.\n\n```python\nimport starkinfra\n\nidentity = starkinfra.individualidentity.update(\"5155165527080960\", status=\"processing\")\n\nprint(identity)\n```\n\n**Note**: Before sending your individual identity to validation by patching its status, you must send all the required documents using the create method of the CreditDocument resource. Note that you must reference the individual identity in the create method of the CreditDocument resource by its id.\n\n### Cancel an IndividualIdentity\n\nYou can cancel an individual identity before updating its status to processing.\n\n```python\nimport starkinfra\n\nidentity = starkinfra.individualidentity.cancel(\"5155165527080960\")\n\nprint(identity)\n```\n\n### Query IndividualIdentity logs\n\nYou can query individual identity logs to better understand individual identity life cycles. \n\n```python\nimport starkinfra\nfrom datetime import date\n\nlogs = starkinfra.individualidentity.log.query(\n limit=50, \n after=date(2022, 1, 1),\n before=date(2022, 1, 20),\n)\n\nfor log in logs:\n print(log)\n```\n\n### Get an IndividualIdentity log\n\nYou can also get a specific log by its id.\n\n```python\nimport starkinfra\n\nlog = starkinfra.individualidentity.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n### Create IndividualDocuments\n\nYou can create an individual document to attach images of documents to a specific individual Identity.\nYou must reference the desired individual identity by its id.\n\n```python\nimport starkinfra\n\ndocuments = starkinfra.individualdocument.create([\n starkinfra.IndividualDocument(\n type=\"identity-front\",\n content=\"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAASABIAAD...\",\n identity_id='5155165527080960',\n tags=[\"breaking\", \"bad\"]\n ),\n starkinfra.IndividualDocument(\n type=\"identity-back\",\n content=\"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAASABIAAD...\",\n identity_id='5155165527080960',\n tags=[\"breaking\", \"bad\"]\n ),\n starkinfra.IndividualDocument(\n type=\"selfie\",\n content=\"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAASABIAAD...\",\n identity_id='5155165527080960',\n tags=[\"breaking\", \"bad\"]\n )\n])\n\nfor document in documents:\n print(document)\n```\n\n**Note**: Instead of using IndividualDocument objects, you can also pass each element in dictionary format\n\n### Query IndividualDocuments\n\nYou can query multiple individual documents according to filters.\n\n```python\nimport starkinfra\nfrom datetime import date\n\ndocuments = starkinfra.individualidentity.query(\n limit=10,\n after=date(2020, 1, 1),\n before=date(2020, 4, 1),\n status=\"success\",\n tags=[\"breaking\", \"bad\"],\n)\n\nfor document in documents:\n print(document)\n```\n\n### Get an IndividualDocument\n\nAfter its creation, information on an individual document may be retrieved by its id.\n\n```python\nimport starkinfra\n\ndocument = starkinfra.individualdocument.get(\"5155165527080960\")\n\nprint(document)\n```\n \n### Query IndividualDocument logs\n\nYou can query individual document logs to better understand individual document life cycles. \n\n```python\nimport starkinfra\nfrom datetime import date\n\nlogs = starkinfra.individualdocument.log.query(\n limit=50, \n after=date(2022, 1, 1),\n before=date(2022, 1, 20),\n)\n\nfor log in logs:\n print(log)\n```\n\n### Get an IndividualDocument log\n\nYou can also get a specific log by its id.\n\n```python\nimport starkinfra\n\nlog = starkinfra.individualdocument.log.get(\"5155165527080960\")\n\nprint(log)\n```\n\n## Webhook\n\n### Create a webhook subscription\n\nTo create a webhook subscription and be notified whenever an event occurs, run:\n\n```python\nimport starkinfra\n\nwebhook = starkinfra.webhook.create(\n url=\"https://webhook.site/dd784f26-1d6a-4ca6-81cb-fda0267761ec\",\n subscriptions=[\n \"credit-note\",\n \"issuing-card\", \"issuing-invoice\", \"issuing-purchase\",\n \"pix-request.in\", \"pix-request.out\", \"pix-reversal.in\", \"pix-reversal.out\", \"pix-claim\", \"pix-key\", \"pix-chargeback\", \"pix-infraction\",\n ],\n)\n\nprint(webhook)\n```\n\n### Query webhook subscriptions\n\nTo search for registered webhook subscriptions, run:\n\n```python\nimport starkinfra\n\nwebhooks = starkinfra.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 starkinfra\n\nwebhook = starkinfra.webhook.get(\"1082736198236817\")\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 starkinfra\n\nwebhook = starkinfra.webhook.delete(\"1082736198236817\")\n\nprint(webhook)\n```\n\n### Process webhook events\n\nIt's easy to process events delivered to your Webhook endpoint.\nRemember to pass the signature header so the SDK can make sure it was StarkInfra that sent you the event.\n\n```python\nimport starkinfra\n\nrequest = listen() # this is the method you made to get the events posted to your webhook endpoint\n\nevent = starkinfra.event.parse(\n content=request.data.decode(\"utf-8\"),\n signature=request.headers[\"Digital-Signature\"],\n)\n\nif \"pix-request\" in event.subscription:\n print(event.log.request)\n\nelif \"pix-reversal\" in event.subscription:\n print(event.log.reversal)\n\nelif \"issuing-card\" in event.subscription:\n print(event.log.card)\n\nelif \"issuing-invoice\" in event.subscription:\n print(event.log.invoice)\n\nelif \"issuing-purchase\" in event.subscription:\n print(event.log.purchase)\n\nelif \"credit-note\" in event.subscription:\n print(event.log.note)\n```\n\n### Query webhook events\n\nTo search for webhooks events, run:\n\n```python\nimport starkinfra\nfrom datetime import date\n\nevents = starkinfra.event.query(after=date(2020, 3, 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 starkinfra\n\nevent = starkinfra.event.get(\"1082736198236817\")\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 starkinfra\n\nevent = starkinfra.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 starkinfra\n\nevent = starkinfra.event.update(id=\"1298371982371921\", 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 starkinfra\nfrom datetime import date\n\nattempts = starkinfra.event.attempt.query(after=date(2020, 3, 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 starkinfra\n\nattempt = starkinfra.event.attempt.get(\"1616161616161616\")\n\nprint(attempt)\n```\n\n# request\n\nThis resource allows you to send HTTP requests to StarkInfra routes.\n\n## GET\n\nYou can perform a GET request to any StarkInfra route.\n\nIt's possible to get a single resource using its id in the path.\n\n```python\nimport starkinfra\n\nexample_id = \"5155165527080960\"\nrequest = starkinfra.request.get(\n path=f'/pix-request/{example_id}'\n).json()\n\nprint(request)\n```\n\nYou can also get the specific resource log,\n\n```python\nimport starkinfra\n\nexample_id = \"5699165527090460\"\nrequest = starkinfra.request.get(\n path=f'/pix-request/log/{example_id}',\n).json()\n\nprint(request)\n```\n\nThis same method will be used to list all created items for the requested resource.\n\n```python\nimport starkinfra\n\nafter = \"2024-01-01\"\nbefore = \"2024-02-01\"\ncursor = None\n\nwhile True:\n request = starkinfra.request.get(\n path=f'/pix-request/',\n query={\n \"after\": after,\n \"before\": before,\n \"cursor\": cursor\n }\n ).json()\n cursor = request[\"cursor\"]\n if cursor is None:\n break\n```\n\nTo list logs, you will use the same logic as for getting a single log.\n\n```python\nimport starkinfra\n\nafter = \"2024-01-01\"\nbefore = \"2024-02-01\"\ncursor = None\n\nwhile True:\n request = starkinfra.request.get(\n path=f'/pix-request/log',\n query={\n \"after\": after,\n \"before\": before,\n \"cursor\": cursor\n }\n ).json()\n cursor = request[\"cursor\"]\n if cursor is None:\n break\n```\n\n## POST\n\nYou can perform a POST request to any StarkInfra route.\n\nThis will create an object for each item sent in your request\n\n**Note**: It's not possible to create multiple resources simultaneously. You need to send separate requests if you want to create multiple resources, such as invoices and boletos.\n\n```python\nimport starkinfra\n\ndata = {\n \"holders\": [\n {\n \"name\": \"Jaime Lannister\",\n \"externalId\": \"my_external_id\",\n \"taxId\": \"012.345.678-90\"\n }\n ]\n}\nrequest = starkinfra.request.post(\n path=\"/issuing-holder\",\n body=data,\n).json()\nprint(request)\n```\n\n## PATCH\n\nYou can perform a PATCH request to any StarkInfra route.\n\nIt's possible to update a single item of a StarkInfra resource.\n```python\nimport starkinfra\n\nexample_id = \"5155165527080960\"\nrequest = starkinfra.request.patch(\n path=f'/issuing-holder/{example_id}',\n body={\n \"tags\": [\"Arya\", \"Stark\"]\n }\n).json()\nprint(request)\n```\n\n## DELETE\n\nYou can perform a DELETE request to any StarkInfra route.\n\nIt's possible to delete a single item of a StarkInfra resource.\n```python\nimport starkinfra\n\nexample_id = \"5155165527080960\"\nrequest = starkinfra.request.delete(\n path=f'/issuing-holder/{example_id}'\n).json()\nprint(request) \n```\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 starkinfra\n\ntry:\n reversal = starkinfra.pixreversal.create([\n starkinfra.PixReversal(\n amount=100,\n end_to_end_id=\"E00000000202201060100rzsJzG9PzMg\",\n external_id=\"1723843582395893\",\n reason=\"bankError\",\n )\n ])\nexcept starkinfra.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 starkinfra.event.parse()\nwhen the provided content and signature do not check out with the Stark Infra 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\n\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "SDK to facilitate Python integrations with Stark Infra",
"version": "0.13.0",
"project_urls": {
"Homepage": "https://github.com/starkinfra/sdk-python"
},
"split_keywords": [
"stark infra",
" starkinfra",
" sdk",
" open banking",
" openbanking",
" banking",
" open",
" stark"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "72c29f12a47c6a56613fdb1ee87bb865b11997f9a3617a5a73609d57f5e87937",
"md5": "1a13cccfa2cd07b0a971b119bae020a4",
"sha256": "bdef8f065aa7a2121ea48ea4e79ee2ebf99fb505944af06043436cada2c3fae1"
},
"downloads": -1,
"filename": "starkinfra-0.13.0.tar.gz",
"has_sig": false,
"md5_digest": "1a13cccfa2cd07b0a971b119bae020a4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 114803,
"upload_time": "2024-09-25T22:42:19",
"upload_time_iso_8601": "2024-09-25T22:42:19.779903Z",
"url": "https://files.pythonhosted.org/packages/72/c2/9f12a47c6a56613fdb1ee87bb865b11997f9a3617a5a73609d57f5e87937/starkinfra-0.13.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-25 22:42:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "starkinfra",
"github_project": "sdk-python",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "starkinfra"
}
JSON
