README.md

# 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
        - [StockRule](#create-issuingstockrules): Get notified when a specific IssuingStock reaches a minimum balance
        - [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
        - [Billing Invoices](#issuing-billinginvoice): View your current billing invoices
        - [Billing Transactions](#issuing-billingtransaction): View your current billing transactions
    - [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
        - [PixKeyHolmes](#create-pixkeyholmes): Investigate the registration of a Pix Key in the DICT
        - [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
        - [PixDispute](#create-pixdisputes): Create Pix Disputes
        - [PixPullSubscription](#create-pixpullsubscriptions): Set up recurring Pix debit authorizations
        - [PixPullRequest](#create-pixpullrequests): Trigger automatic Pix debits against a subscription
        - [PixInternalTransactionReport](#create-pixinternaltransactionreports): Report internal transactions to the Central Bank
    - [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
        - [IndividualAccountRequest](#create-individualaccountrequests): Create individual account requests
        - [IndividualAccountAttachment](#create-individualaccountattachments): Create individual account attachments
        - [BusinessIdentity](#create-businessidentities): Create business identities
        - [BusinessAttachment](#create-businessattachments): Create business attachments
    - [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 IssuingStockRules

You can create rules to be notified whenever a specific IssuingStock reaches a minimum balance.

```python
import starkinfra

rules = starkinfra.issuingstockrule.create([
    starkinfra.IssuingStockRule(
        minimum_balance=10000,
        stock_id="5136459887542272",
        emails=["john.doe@enterprise.com"],
        phones=["+55 (11) 91234 5678"]
    )
])

for rule in rules:
    print(rule)
```

### Query IssuingStockRules

You can get a list of created stock rules given some filters.

```python
import starkinfra
from datetime import date

rules = starkinfra.issuingstockrule.query(
    after=date(2022, 11, 1),
    before=date(2022, 12, 1)
)

for rule in rules:
    print(rule)
```

### Get an IssuingStockRule

After its creation, information on a stock rule may be retrieved by its id.

```python
import starkinfra

rule = starkinfra.issuingstockrule.get("5664445921492992")

print(rule)
```

### Update an IssuingStockRule

You can update a specific IssuingStockRule by its id.

```python
import starkinfra

rule = starkinfra.issuingstockrule.update(
    id="5664445921492992",
    minimum_balance=20000
)

print(rule)
```

### Cancel an IssuingStockRule

You can also cancel a specific IssuingStockRule by its id.

```python
import starkinfra

rule = starkinfra.issuingstockrule.cancel("5664445921492992")

print(rule)
```

### 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)
```

### Query IssuingBillingInvoices

You can query multiples available Billing Invoices using this resource.

```python
import starkinfra
from datetime import date

billing_invoices = starkinfra.issuingbillinginvoice.query(
    after=date(2023, 1, 1),
    before=date(2024, 3, 1),
    limit=10
)

for billing_invoice in billing_invoices:
    print(billing_invoice)
```

### Get an IssuingBillingInvoice

```python
import starkinfra

billing_invoice = starkinfra.issuingbillinginvoice.get("9302937674764487")

print(billing_invoice)
```

### Query IssuingBillingTransactions

You can query multiples available Billing Transaction invoices using this resource.

```python
import starkinfra
from datetime import date

billing_transactions = starkinfra.issuingbillingtransaction.query(
    after=date(2023, 1, 1),
    before=date(2024, 3, 1),
    limit=10
)

for billing_transaction in billing_transactions:
    print(billing_transaction)
```

## 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",
        reason="subscriptionFlaw",
    ),
    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"],
        reason="subscriptionFlaw",
    )
])

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. You can inform an optional reason for the requested action.

```python
import starkinfra

key = starkinfra.pixkey.cancel(
    id="5155165527080960",
    reason="fraud",
)

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 PixKeyHolmes

To investigate whether a Pix Key is registered in the Central Bank's DICT,
open up a PixKeyHolmes for it:

```python
import starkinfra

holmes = starkinfra.pixkeyholmes.create([
    starkinfra.PixKeyHolmes(
        key_id="+5511989898989"
    ),
    starkinfra.PixKeyHolmes(
        key_id="valid@sandbox.com",
        tags=["sherlock"]
    )
])

for sherlock in holmes:
    print(sherlock)
```

### Query PixKeyHolmes

You can query multiple PixKeyHolmes according to filters.

```python
import starkinfra
from datetime import date

holmes = starkinfra.pixkeyholmes.query(
    after=date(2022, 6, 1),
    before=date(2022, 10, 30),
    status="solved"
)

for sherlock in holmes:
    print(sherlock)
```

### 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",
            operator_email="fraud@company.com",
            operator_phone="+5511989898989"
        )
    ]
)

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)
```

### Query PixFraud logs

You can query PixFraud logs to better understand their life cycles.

```python
import starkinfra
from datetime import date

logs = starkinfra.pixfraud.log.query(
    limit=50,
    after=date(2022, 1, 1),
    before=date(2022, 1, 20),
)

for log in logs:
    print(log)
```

### Get a PixFraud log

You can also get a specific log by its id.

```python
import starkinfra

log = starkinfra.pixfraud.log.get("5155165527080960")

print(log)
```

### 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.dynamicbrcode.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)
```

### Create PixDisputes

Pix disputes can be created when a fraud is detected creating a chain of transactions in order to reverse the funds to the origin.

```python
import starkinfra

disputes = starkinfra.pixdispute.create([
    starkinfra.PixDispute(
        reference_id="E20018183202512191914WcfANNEIYnt",
        method="scam",
        operator_phone="+5511999999999",
        operator_email="operator@example.com"
    )
])

for dispute in disputes:
    print(dispute)
```

**Note**: Instead of using PixDispute objects, you can also pass each element in dictionary format

### Query PixDisputes

You can query multiple PixDisputes according to filters.

```python
import starkinfra
from datetime import date

disputes = starkinfra.pixdispute.query(
    limit=10,
    after=date(2020, 1, 1),
    before=date(2020, 4, 1),
    status="success",
    tags=["iron", "suit"],
)

for dispute in disputes:
    print(dispute)
```

### Get a PixDispute

After its creation, information on a PixDispute may be retrieved by its id. Its status indicates whether it has been paid.

```python
import starkinfra

dispute = starkinfra.pixdispute.get("5155165527080960")

print(dispute)
```

### Cancel a PixDispute

Cancel a specific PixDispute using its id.

```python
import starkinfra

dispute = starkinfra.pixdispute.cancel("5155165527080960")

print(dispute)
```

### Query PixDispute logs

You can query PixDispute logs to better understand PixDispute life cycles. 

```python
import starkinfra
from datetime import date

logs = starkinfra.pixdispute.log.query(
    limit=50, 
    after=date(2022, 1, 1),
    before=date(2022, 1, 20),
)

for log in logs:
    print(log)
```

### Get a PixDispute log

You can also get a specific log by its id.

```python
import starkinfra

log = starkinfra.pixdispute.log.get("5155165527080960")

print(log)
```

### Create PixPullSubscriptions

You can create recurring Pix debit authorizations to allow a receiver to pull a series of Pix payments from a sender.

```python
import starkinfra
from datetime import datetime

subscriptions = starkinfra.pixpullsubscription.create([
    starkinfra.PixPullSubscription(
        bacen_id="RR2017032900000000000000003",
        external_id="my-subscription-001",
        installment_start=datetime(2026, 4, 1, 12, 0, 0),
        interval="month",
        receiver_name="Edward Stark",
        receiver_tax_id="20.018.183/0001-80",
        receiver_bank_code="20018183",
        reference_code="contract-202604",
        sender_account_number="876543-2",
        sender_bank_code="20018183",
        sender_branch_code="1357-9",
        sender_city_code="3550308",
        sender_tax_id="01234567890",
        type="push",
        amount=11234,
        description="Monthly subscription",
        tags=["employees", "monthly"],
    )
])

for subscription in subscriptions:
    print(subscription)
```

### Query PixPullSubscriptions

You can query multiple PixPullSubscriptions according to filters.

```python
import starkinfra
from datetime import date

subscriptions = starkinfra.pixpullsubscription.query(
    limit=10,
    after=date(2026, 1, 1),
    before=date(2026, 4, 30),
    status=["active"],
    tags=["monthly"],
)

for subscription in subscriptions:
    print(subscription)
```

### Get a PixPullSubscription

After its creation, information on a PixPullSubscription may be retrieved by its id.

```python
import starkinfra

subscription = starkinfra.pixpullsubscription.get("5656565656565656")

print(subscription)
```

### Update a PixPullSubscription

You can update a PixPullSubscription by passing its id.

When patching `status` to `"confirmed"`, `sender_city_code` MUST be present in the patch.

```python
import starkinfra

subscription = starkinfra.pixpullsubscription.update(
    id="5656565656565656",
    status="confirmed",
    sender_city_code="3550308",
)

print(subscription)
```

### Cancel a PixPullSubscription

You can cancel a PixPullSubscription by passing its id and a reason. The reason is sent as a query parameter on the DELETE request.

```python
import starkinfra

subscription = starkinfra.pixpullsubscription.cancel(
    id="5656565656565656",
    reason="accountClosed",
)

print(subscription)
```

### Query PixPullSubscription logs

You can query PixPullSubscription logs to better understand PixPullSubscription life cycles.

```python
import starkinfra
from datetime import date

logs = starkinfra.pixpullsubscription.log.query(
    limit=50,
    after=date(2026, 1, 1),
    before=date(2026, 4, 30),
    subscription_ids=["5656565656565656"],
)

for log in logs:
    print(log)
```

### Get a PixPullSubscription log

You can also get a specific log by its id.

```python
import starkinfra

log = starkinfra.pixpullsubscription.log.get("5155165527080960")

print(log)
```

### Process inbound PixPullSubscription events

Inbound PixPullSubscription events will be POSTed at your registered endpoint. You can use the `parse` function to verify the digital signature and reconstruct the PixPullSubscription object.

```python
import starkinfra

subscription = starkinfra.pixpullsubscription.parse(
    content='{"bacenId": "RR2017032900000000000000003", ...}',
    signature="MEUCIQC7FVhXdripx/aXg5yNLxmNoZlehpyvX3QYDXJ8o3PAZQIgVe1omKFh7Vd54ML4U1z7L+kpx+GHl+G2XLeFTLZeBJk=",
)

print(subscription)
```

### Create PixPullRequests

You can create PixPullRequests to trigger automatic debits against an active PixPullSubscription.

```python
import starkinfra
from datetime import datetime

requests = starkinfra.pixpullrequest.create([
    starkinfra.PixPullRequest(
        amount=11234,
        due=datetime(2026, 4, 15, 12, 0, 0),
        end_to_end_id="E00002649202201172211u34srod19le",
        receiver_account_number="876543-2",
        receiver_account_type="checking",
        receiver_bank_code="20018183",
        reconciliation_id="cycle-202604",
        subscription_id="5656565656565656",
        tags=["monthly"],
    )
])

for request in requests:
    print(request)
```

### Query PixPullRequests

```python
import starkinfra
from datetime import date

requests = starkinfra.pixpullrequest.query(
    limit=10,
    after=date(2026, 1, 1),
    before=date(2026, 4, 30),
    status=["created", "success"],
    subscription_ids=["5656565656565656"],
)

for request in requests:
    print(request)
```

### Get a PixPullRequest

```python
import starkinfra

request = starkinfra.pixpullrequest.get("5656565656565656")
print(request)
```

### Update a PixPullRequest

Change the status to `"scheduled"` or `"denied"`. When denying, `reason` is required.

```python
import starkinfra

request = starkinfra.pixpullrequest.update(
    id="5656565656565656",
    status="denied",
    reason="senderAccountClosed",
)
print(request)
```

### Cancel a PixPullRequest

```python
import starkinfra

request = starkinfra.pixpullrequest.cancel(
    id="5656565656565656",
    reason="senderUserRequested",
)
print(request)
```

### Query PixPullRequest logs

```python
import starkinfra
from datetime import date

logs = starkinfra.pixpullrequest.log.query(
    limit=50,
    after=date(2026, 1, 1),
    before=date(2026, 4, 30),
    request_ids=["5656565656565656"],
)

for log in logs:
    print(log)
```

### Get a PixPullRequest log

```python
import starkinfra

log = starkinfra.pixpullrequest.log.get("5155165527080960")
print(log)
```

### Create PixInternalTransactionReports

Transactions that happen internally, outside of the SPI, must be reported to the
Central Bank so they are reflected in your statements. You can do so by creating
PixInternalTransactionReports:

```python
import starkinfra
from datetime import datetime

reports = starkinfra.pixinternaltransactionreport.create([
    starkinfra.PixInternalTransactionReport(
        amount=10000,
        created=datetime(2024, 1, 1, 12, 0, 0),
        end_to_end_id="E12345678202401011234567890123456",
        method="manual",
        reference_type="request",
        sender_account_number="12345",
        sender_branch_code="0001",
        sender_account_type="checking",
        sender_bank_code="12345678",
        sender_tax_id="123.456.789-01",
        receiver_account_number="67890",
        receiver_branch_code="0001",
        receiver_account_type="savings",
        receiver_bank_code="87654321",
        receiver_tax_id="987.654.321-00",
        receiver_key_id="user@example.com"
    )
])

for report in reports:
    print(report)
```

### Query PixInternalTransactionReports

You can query multiple PixInternalTransactionReports according to filters.

```python
import starkinfra
from datetime import date

reports = starkinfra.pixinternaltransactionreport.query(
    after=date(2024, 1, 1),
    before=date(2024, 1, 30),
    status="success"
)

for report in reports:
    print(report)
```

### Get a PixInternalTransactionReport

After its creation, information on a PixInternalTransactionReport may be retrieved by its id.

```python
import starkinfra

report = starkinfra.pixinternaltransactionreport.get("5656565656565656")

print(report)
```

### Query PixInternalTransactionReport logs

You can query PixInternalTransactionReport logs to better understand their life cycles.

```python
import starkinfra
from datetime import date

logs = starkinfra.pixinternaltransactionreport.log.query(
    limit=50,
    after=date(2024, 1, 1),
    before=date(2024, 1, 20),
)

for log in logs:
    print(log)
```

### Get a PixInternalTransactionReport log

You can also get a specific log by its id.

```python
import starkinfra

log = starkinfra.pixinternaltransactionreport.log.get("5155165527080960")

print(log)
```

## 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",
        rebate_amount=0,
        tags=["War supply"],
        rules=[
            starkinfra.creditnote.Rule(
                key="invoiceCreationMode",
                value="scheduled"
            )
        ],
    )
])

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)
```

### Retrieve CCB disbursement pdf file

To retrieve CCB disbursement pdf file, use the `starkinfra.creditnote.pdf` method with a valid (signed) Credit Note ID.

```python
import starkinfra

pdf = starkinfra.creditnote.pdf("5155165527080960")
with open("credit_note_receipt.pdf", "wb") as file:
    file.write(pdf)
```

### CCB Token Resend

You can resend the CCB token to the signers in case they missed the original email or link.

```python
import starkinfra

note = starkinfra.creditnote.get("5155165527080960")
for signer in note.signers:
    starkinfra.creditsigner.resend_token(signer.id)
``` 

### 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",
        birth_date="1965-09-07",
        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)
```

### Create IndividualAccountRequests

You can create an IndividualAccountRequest to request the opening of an account for a specific individual.

```python
import starkinfra

requests = starkinfra.individualaccountrequest.create([
    starkinfra.IndividualAccountRequest(
        name="Walter White",
        tax_id="012.345.678-90",
        address=starkinfra.individualaccountrequest.Address(
            street="Rua do Estilo Barroco",
            number="648",
            neighborhood="Santo Amaro",
            city="Sao Paulo",
            state="SP",
            zip_code="05724005",
        ),
        income=1000000,
        birth_date="1965-09-07",
        tags=["breaking", "bad"]
    )
])

for request in requests:
    print(request)
```

**Note**: Instead of using IndividualAccountRequest objects, you can also pass each element in dictionary format

### Query IndividualAccountRequests

You can query multiple individual account requests according to filters.

```python
import starkinfra
from datetime import date

requests = starkinfra.individualaccountrequest.query(
    limit=10,
    after=date(2020, 1, 1),
    before=date(2020, 4, 1),
    status="success",
    tags=["breaking", "bad"],
)

for request in requests:
    print(request)
```

### Get an IndividualAccountRequest

After its creation, information on an individual account request may be retrieved by its id.

```python
import starkinfra

request = starkinfra.individualaccountrequest.get("5155165527080960")

print(request)
```

### Update an IndividualAccountRequest

You can update a specific individual account request by passing its id.

```python
import starkinfra

request = starkinfra.individualaccountrequest.update("5155165527080960", status="processing")

print(request)
```

### Query IndividualAccountRequest logs

You can query individual account request logs to better understand individual account request life cycles.

```python
import starkinfra
from datetime import date

logs = starkinfra.individualaccountrequest.log.query(
    limit=50,
    after=date(2022, 1, 1),
    before=date(2022, 1, 20),
)

for log in logs:
    print(log)
```

### Get an IndividualAccountRequest log

You can also get a specific log by its id.

```python
import starkinfra

log = starkinfra.individualaccountrequest.log.get("5155165527080960")

print(log)
```

### Create IndividualAccountAttachments

You can create an IndividualAccountAttachment to attach images of documents to a specific IndividualAccountRequest.
You must reference the desired IndividualAccountRequest by its id. Pass the raw image bytes and a MIME content type;
the SDK encodes them as a data url before sending.

```python
import starkinfra

attachments = starkinfra.individualaccountattachment.create([
    starkinfra.IndividualAccountAttachment(
        type="identity-front",
        content=open("identity-front.png", "rb").read(),
        content_type="image/png",
        account_request_id="5155165527080960",
        tags=["breaking", "bad"]
    ),
    starkinfra.IndividualAccountAttachment(
        type="identity-back",
        content=open("identity-back.png", "rb").read(),
        content_type="image/png",
        account_request_id="5155165527080960",
        tags=["breaking", "bad"]
    ),
    starkinfra.IndividualAccountAttachment(
        type="selfie",
        content=open("selfie.png", "rb").read(),
        content_type="image/png",
        account_request_id="5155165527080960",
        tags=["breaking", "bad"]
    )
])

for attachment in attachments:
    print(attachment)
```

**Note**: Instead of using IndividualAccountAttachment objects, you can also pass each element in dictionary format

### Query IndividualAccountAttachments

You can query multiple individual account attachments according to filters.

```python
import starkinfra
from datetime import date

attachments = starkinfra.individualaccountattachment.query(
    limit=10,
    after=date(2020, 1, 1),
    before=date(2020, 4, 1),
    status="success",
    tags=["breaking", "bad"],
)

for attachment in attachments:
    print(attachment)
```

### Get an IndividualAccountAttachment

After its creation, information on an individual account attachment may be retrieved by its id.

```python
import starkinfra

attachment = starkinfra.individualaccountattachment.get("5155165527080960")

print(attachment)
```

### Cancel an IndividualAccountAttachment

You can delete an individual account attachment by passing its id. The returned object has status "deleted".

```python
import starkinfra

attachment = starkinfra.individualaccountattachment.cancel("5155165527080960")

print(attachment)
```

### Query IndividualAccountAttachment logs

You can query individual account attachment logs to better understand individual account attachment life cycles.

```python
import starkinfra
from datetime import date

logs = starkinfra.individualaccountattachment.log.query(
    limit=50,
    after=date(2022, 1, 1),
    before=date(2022, 1, 20),
)

for log in logs:
    print(log)
```

### Get an IndividualAccountAttachment log

You can also get a specific log by its id.

```python
import starkinfra

log = starkinfra.individualaccountattachment.log.get("5155165527080960")

print(log)
```

### Create BusinessIdentities

You can create a BusinessIdentity to verify the identity of a company (PJ) by its tax ID (CNPJ).

```python
import starkinfra

identities = starkinfra.businessidentity.create([
    starkinfra.BusinessIdentity(
        tax_id="20.018.183/0001-80",
        tags=["onboarding-123"]
    )
])

for identity in identities:
    print(identity)
```

**Note**: Instead of using BusinessIdentity objects, you can also pass each element in dictionary format

### Query BusinessIdentities

You can query multiple business identities according to filters.

```python
import starkinfra
from datetime import date

identities = starkinfra.businessidentity.query(
    limit=10,
    after=date(2020, 1, 1),
    before=date(2020, 4, 1),
    status="success",
    tags=["onboarding-123"],
)

for identity in identities:
    print(identity)
```

### Get a BusinessIdentity

After its creation, information on a business identity may be retrieved by its id.

```python
import starkinfra

identity = starkinfra.businessidentity.get("5155165527080960")

print(identity)
```

### Update a BusinessIdentity

You can update a specific business identity by passing its id. Send it to processing by passing 'processing' in the status (the identity must have attachments).

```python
import starkinfra

identity = starkinfra.businessidentity.update("5155165527080960", status="processing")

print(identity)
```

### Cancel a BusinessIdentity

You can cancel a business identity by passing its id, while it is in the 'created' or 'pending' status.

```python
import starkinfra

identity = starkinfra.businessidentity.cancel("5155165527080960")

print(identity)
```

### Query BusinessIdentity logs

You can query business identity logs to better understand business identity life cycles.

```python
import starkinfra
from datetime import date

logs = starkinfra.businessidentity.log.query(
    limit=50,
    after=date(2022, 1, 1),
    before=date(2022, 1, 20),
)

for log in logs:
    print(log)
```

### Get a BusinessIdentity log

You can also get a specific log by its id.

```python
import starkinfra

log = starkinfra.businessidentity.log.get("5155165527080960")

print(log)
```

### Create BusinessAttachments

You can create a BusinessAttachment to attach a document (e.g. articles of incorporation) to a specific BusinessIdentity.
You must reference the desired business identity by its id. A BusinessIdentity accepts at most 2 attachments.

```python
import starkinfra

attachments = starkinfra.businessattachment.create([
    starkinfra.BusinessAttachment(
        name="articles-of-incorporation.pdf",
        content="data:application/pdf;base64,JVBERi0xLjQ...",
        business_identity_id="5155165527080960",
        tags=["doc-principal"]
    )
])

for attachment in attachments:
    print(attachment)
```

**Note**: Instead of using BusinessAttachment objects, you can also pass each element in dictionary format

### Query BusinessAttachments

You can query multiple business attachments according to filters.

```python
import starkinfra
from datetime import date

attachments = starkinfra.businessattachment.query(
    limit=10,
    after=date(2020, 1, 1),
    before=date(2020, 4, 1),
    status="approved",
    tags=["doc-principal"],
)

for attachment in attachments:
    print(attachment)
```

### Get a BusinessAttachment

After its creation, information on a business attachment may be retrieved by its id. Pass `expand=["content"]` to also retrieve the document content.

```python
import starkinfra

attachment = starkinfra.businessattachment.get("5155165527080960", expand=["content"])

print(attachment)
```

### Cancel a BusinessAttachment

You can cancel a business attachment by passing its id, while it is in the 'created' status.

```python
import starkinfra

attachment = starkinfra.businessattachment.cancel("5155165527080960")

print(attachment)
```

### Query BusinessAttachment logs

You can query business attachment logs to better understand business attachment life cycles.

```python
import starkinfra
from datetime import date

logs = starkinfra.businessattachment.log.query(
    limit=50,
    after=date(2022, 1, 1),
    before=date(2022, 1, 20),
)

for log in logs:
    print(log)
```

### Get a BusinessAttachment log

You can also get a specific log by its id.

```python
import starkinfra

log = starkinfra.businessattachment.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",
        "business-identity",
        "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)

elif "business-identity" in event.subscription:
    print(event.log.identity)
```

### 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