Overview

Setup

Brcode Payment

Brcode Payment Overview

The Brcode Payment Object

Creating Brcode Payments

Creating Brcode Payments with scheduled, tags parameters

Listing Brcode Payments

Getting a Brcode Payment

Canceling Brcode Payment

Receiving Brcode Payment Webhook

Pix QR Code Payment

We provide the convenience of paying Pix QR codes directly from your Stark Bank account.

In the document below, we will detail the processes related to paying Pix QR codes (both static and dynamic) from Stark Bank or other institutions, providing a clear and comprehensive understanding of the operation and how to manage the lifecycle of this resource.

NOTE: Read Core Concepts before continuing this guide.

RESOURCE SUMMARY
Brcode Payment
Pay Pix QR codes using your Stark Bank balance

Setup

For each environment: (Sandbox or Production)

1. Create an account at Stark Bank.

2. Create a webhook with the following subscriptions to receive events in your desired URL:

brcode-payment

2.1. Via Internet Banking:

Integrations > Webhook > New Webhook

2.2. Via API:

Use the POST /webhook route to create the webhook

Brcode Payment Overview

Brcode Payment is a resource that can be used to pay Pix QR codes (both static and dynamic) from Stark Bank or other institutions.

To create a Brcode Payment, you need to provide the mandatory parameters: brcode, taxId and description.

Optional parameters include scheduled, tags, and rules.

The Brcode Payment Status

Each Brcode Payment has a status that can change over time according to its life cycle:

brcode-payment-status

StatusDescription
CreatedThe Brcode Payment was successfully created in Stark Bank.
ProcessingThe Brcode Payment is being processed by Stark Bank.
SuccessThe Brcode Payment was successfully completed.
FailedThe Brcode Payment was unsuccessful.
CanceledThe Brcode Payment was canceled before processing.

The Brcode Payment Logs

Every time either you or Stark Bank makes a change to a Brcode Payment, we create a Log. Logs are pretty useful for understanding the life cycle of each Brcode Payment and the changes that happened to it. Here you can see the flow of possible logs:

brcode-payment-log

A completed Brcode Payment can be reversed back to its payer. When a reversal occurs, the following flow of logs will happen:

brcode-payment-reversal

Log typeStatusDescription
CreatedCreatedThe Brcode Payment was successfully created in Stark Bank.
SendingProcessingThe Brcode Payment is being sent to the banking network.
SuccessSuccessThe Brcode Payment was successfully completed and credited.
FailedFailedThe Brcode Payment was unsuccessful.
CancelingProcessingThe Brcode Payment cancellation is being processed.
CanceledCanceledThe Brcode Payment was canceled before processing.
ReversingSuccessThe Brcode Payment reversal is being processed.
ReversedSuccessThe Brcode Payment was reversed back to the payer.

The Brcode Payment Object

Attributes

id STRING

Unique id for the brcode payment.

amount INTEGER

Amount in cents to be paid. Example: 1000000 (R$10,000.00).

brcode STRING

Pix QR code string to be paid.

created STRING

Creation datetime. Example: "2020-02-06T16:22:24.664148+00:00".

description STRING

Text to be displayed in your statement.

fee INTEGER

Fee charged in cents.

name STRING

Receiver full name.

rules LIST OF OBJECTS

List of rule objects with key and value to modify brcode payment behavior.

scheduled STRING

Scheduled date or datetime for the brcode payment. Example: "2020-08-14" or "2020-08-14T15:23:26+00:00".

status STRING

Current brcode payment status. Options: "created", "processing", "success", "failed", "canceled".

tags LIST OF STRINGS

Tags associated with the brcode payment.

taxId STRING

Payment payer CPF or CNPJ.

transactionIds LIST OF STRINGS

Ledger transaction IDs linked to the brcode payment.

type STRING

Type of the brcode payment. Options: "dynamic", "static".

updated STRING

Last update datetime. Example: "2020-02-06T16:22:24.664148+00:00".

Creating Brcode Payments

To create a Brcode Payment, fill in the mandatory parameters: brcode, taxId and description.

The brcode parameter must contain a valid Pix QR code string (static or dynamic).

Brcode Payments are available 24/7 and can be scheduled for any date and time.

Python

import starkbank

payments = starkbank.brcodepayment.create([
    starkbank.BrcodePayment(
        brcode="00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
        tax_id="012.345.678-90",
        description="this will be fast"
    )
])

for payment in payments:
    print(payment)

Javascript

const starkbank = require('starkbank');

(async() => {
    let payments = await starkbank.brcodePayment.create([
        {
            brcode: '00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF',
            taxId: '012.345.678-90',
            description: 'this will be fast'
        }
    ])

    for (let payment of payments) {
        console.log(payment);
    }
})();

PHP

$payments = StarkBank\BrcodePayment::create([
    new StarkBank\BrcodePayment([
        "brcode" => "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
        "taxId" => "012.345.678-90",
        "description" => "this will be fast"
    ])
]);

foreach($payments as $payment){
    print_r($payment);
}

Java

import com.starkbank.*;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;

List<BrcodePayment> payments = new ArrayList<>();

HashMap<String, Object> data = new HashMap<>();
data.put("brcode", "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF");
data.put("taxId", "012.345.678-90");
data.put("description", "this will be fast");
payments.add(new BrcodePayment(data));

payments = BrcodePayment.create(payments);

for (BrcodePayment payment : payments){
    System.out.println(payment);
}

Ruby

require('starkbank')

payments = StarkBank::BrcodePayment.create(
    [
        StarkBank::BrcodePayment.new(
            brcode: '00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF',
            tax_id: '012.345.678-90',
            description: 'this will be fast'
        )
    ]
)

payments.each do |payment|
    puts payment
end

Elixir

payments = StarkBank.BrcodePayment.create!([
    %StarkBank.BrcodePayment{
        brcode: "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
        tax_id: "012.345.678-90",
        description: "this will be fast"
    }
])

for payment <- payments do
    payment |> IO.inspect
end

C#

using System;
using System.Collections.Generic;

List<StarkBank.BrcodePayment> payments = StarkBank.BrcodePayment.Create(
    new List<StarkBank.BrcodePayment> {
        new StarkBank.BrcodePayment(
            brcode: "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
            taxID: "012.345.678-90",
            description: "this will be fast"
        )
    }
);

foreach(StarkBank.BrcodePayment payment in payments)
{
    Console.WriteLine(payment);
}

Go

package main

import (
    "fmt"
    "github.com/starkbank/sdk-go/starkbank/brcodepayment"
)

func main() {

    payments, err := brcodepayment.Create(
        []brcodepayment.BrcodePayment{
            {
                Brcode:      "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
                TaxId:       "012.345.678-90",
                Description: "this will be fast",
            },
        }, nil)
    if err.Errors != nil {
        for _, e := range err.Errors {
            fmt.Printf("code: %s, message: %s", e.Code, e.Message)
        }
    }

    for _, payment := range payments {
        fmt.Printf("%+v", payment)
    }
}

Clojure

(def payments
  (starkbank.brcode-payment/create
    [
      {
        :brcode "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF"
        :tax-id "012.345.678-90"
        :description "this will be fast"
      }
    ]))
(dorun (map println payments))

Curl

curl --location --request POST '{{baseUrl}}/v2/brcode-payment' 
--header 'Access-Id: {{accessId}}' 
--header 'Access-Time: {{accessTime}}' 
--header 'Access-Signature: {{accessSignature}}' 
--header 'Content-Type: application/json' 
--data-raw '{
    "payments": [
        {
            "brcode": "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
            "taxId": "012.345.678-90",
            "description": "this will be fast"
        }
    ]
}'
RESPONSE

Python

BrcodePayment(
    amount=1000,
    brcode=00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF,
    created=2020-02-06 16:22:24.664134,
    description=this will be fast,
    fee=0,
    id=5412038532661248,
    name=Stark Bank S.A. - Instituicao de Pagamento,
    rules=[],
    scheduled=2020-02-07 10:00:00,
    status=created,
    tags=[],
    tax_id=012.345.678-90,
    transaction_ids=[],
    type=dynamic,
    updated=2020-02-06 16:22:24.664134
)

Javascript

BrcodePayment {
    id: '5412038532661248',
    amount: 1000,
    brcode: '00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF',
    created: '2020-02-06T16:22:24.664148+00:00',
    description: 'this will be fast',
    fee: 0,
    name: 'Stark Bank S.A. - Instituicao de Pagamento',
    rules: [],
    scheduled: '2020-02-07T10:00:00+00:00',
    status: 'created',
    tags: [ ],
    taxId: '012.345.678-90',
    transactionIds: [],
    type: 'dynamic',
    updated: '2020-02-06T16:22:24.664148+00:00'
}

PHP

StarkBank\BrcodePayment Object
(
    [id] => 5412038532661248
    [amount] => 1000
    [brcode] => 00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF
    [created] => DateTime Object
        (
            [date] => 2020-02-06 16:22:24.664148
            [timezone_type] => 1
            [timezone] => +00:00
        )

    [description] => this will be fast
    [fee] => 0
    [name] => Stark Bank S.A. - Instituicao de Pagamento
    [rules] => Array
        (
        )

    [scheduled] => DateTime Object
        (
            [date] => 2020-02-07 10:00:00.000000
            [timezone_type] => 1
            [timezone] => +00:00
        )

    [status] => created
    [tags] => Array
        (
        )

    [taxId] => 012.345.678-90
    [transactionIds] => Array
        (
        )

    [type] => dynamic
    [updated] => DateTime Object
        (
            [date] => 2020-02-06 16:22:24.664148
            [timezone_type] => 1
            [timezone] => +00:00
        )

)

Java

BrcodePayment({
    "amount": 1000,
    "brcode": "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
    "created": "2020-02-06T16:22:24.664148+00:00",
    "description": "this will be fast",
    "fee": 0,
    "name": "Stark Bank S.A. - Instituicao de Pagamento",
    "rules": [],
    "scheduled": "2020-02-07T10:00:00+00:00",
    "status": "created",
    "tags": [],
    "taxId": "012.345.678-90",
    "transactionIds": [],
    "type": "dynamic",
    "updated": "2020-02-06T16:22:24.664148+00:00",
    "id": "5412038532661248"
})

Ruby

brcodepayment(
    id: 5412038532661248,
    amount: 1000,
    brcode: 00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF,
    created: 2020-02-06T16:22:24+00:00,
    description: this will be fast,
    fee: 0,
    name: Stark Bank S.A. - Instituicao de Pagamento,
    rules: [],
    scheduled: 2020-02-07T10:00:00+00:00,
    status: created,
    tags: [],
    tax_id: 012.345.678-90,
    transaction_ids: [],
    type: dynamic,
    updated: 2020-02-06T16:22:24+00:00
)

Elixir

%StarkBank.BrcodePayment{
    amount: 1000,
    brcode: "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
    created: ~U[2020-02-06 16:22:24.664148Z],
    description: "this will be fast",
    fee: 0,
    id: "5412038532661248",
    name: "Stark Bank S.A. - Instituicao de Pagamento",
    rules: [],
    scheduled: ~U[2020-02-07 10:00:00Z],
    status: "created",
    tags: [],
    tax_id: "012.345.678-90",
    transaction_ids: [],
    type: "dynamic",
    updated: ~U[2020-02-06 16:22:24.664148Z]
}

C#

BrcodePayment(
    Amount: 1000,
    Brcode: 00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF,
    Created: 06/02/2020 16:22:24,
    Description: this will be fast,
    Fee: 0,
    Name: Stark Bank S.A. - Instituicao de Pagamento,
    Rules: {},
    Scheduled: 07/02/2020 10:00:00,
    Status: created,
    Tags: {},
    TaxID: 012.345.678-90,
    TransactionIds: {  },
    Type: dynamic,
    Updated: 06/02/2020 16:22:24,
    ID: 5412038532661248
)

Go

{
    Id:5412038532661248
    Amount:1000
    Brcode:00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF
    Created:2020-02-06 16:22:24.664148 +0000 +0000
    Description:this will be fast
    Fee:0
    Name:Stark Bank S.A. - Instituicao de Pagamento
    Rules:[]
    Scheduled:2020-02-07 10:00:00 +0000 +0000
    Status:created
    Tags:[]
    TaxId:012.345.678-90
    TransactionIds:[]
    Type:dynamic
    Updated:2020-02-06 16:22:24.664148 +0000 +0000
}

Clojure

{:amount 1000,
 :brcode "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
 :created "2020-02-06T16:22:24.664148+00:00",
 :description "this will be fast",
 :fee 0,
 :id "5412038532661248",
 :name "Stark Bank S.A. - Instituicao de Pagamento",
 :rules [],
 :scheduled "2020-02-07T10:00:00+00:00",
 :status "created",
 :tags [],
 :tax-id "012.345.678-90",
 :transaction-ids [],
 :type "dynamic",
 :updated "2020-02-06T16:22:24.664148+00:00"}

Curl

{
    "message": "Brcode Payment(s) successfully created",
    "payments": [
        {
            "amount": 1000,
            "brcode": "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
            "created": "2020-02-06T16:22:24.387022+00:00",
            "description": "this will be fast",
            "fee": 0,
            "id": "5412038532661248",
            "name": "Stark Bank S.A. - Instituicao de Pagamento",
            "rules": [],
            "scheduled": "2020-02-07T10:00:00+00:00",
            "status": "created",
            "tags": [],
            "taxId": "012.345.678-90",
            "transactionIds": [],
            "type": "dynamic",
            "updated": "2020-02-06T16:22:24.387022+00:00"
        }
    ]
}

Creating Brcode Payments with scheduled, tags parameters

Scheduled: Schedule the brcode payment for a specific date.

Today is the default.

Brcode Payments are available 24/7 and can be scheduled for any date and time.

Example: "2020-08-14T15:23:26+00:00" or "2020-08-14"

Tags: Array of strings to tag the entity for future queries. All tags will be converted to lowercase. Example: ["pix", "qrcode/1234"]

Python

import starkbank

payments = starkbank.brcodepayment.create([
    starkbank.BrcodePayment(
        brcode="00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
        tax_id="012.345.678-90",
        description="this will be fast",
        scheduled="2020-08-14",
        tags=["pix", "invoice/1234"]
    )
])

for payment in payments:
    print(payment)

Javascript

const starkbank = require('starkbank');

(async() => {
    let payments = await starkbank.brcodePayment.create([
        {
            brcode: '00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF',
            taxId: '012.345.678-90',
            description: 'this will be fast',
            scheduled: '2020-08-14',
            tags: ['pix', 'invoice/1234']
        }
    ])

    for (let payment of payments) {
        console.log(payment);
    }
})();

PHP

$payments = StarkBank\BrcodePayment::create([
    new StarkBank\BrcodePayment([
        "brcode" => "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
        "taxId" => "012.345.678-90",
        "description" => "this will be fast",
        "scheduled" => "2020-08-14",
        "tags" => ["pix", "invoice/1234"]
    ])
]);

foreach($payments as $payment){
    print_r($payment);
}

Java

import com.starkbank.*;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;

List<BrcodePayment> payments = new ArrayList<>();

HashMap<String, Object> data = new HashMap<>();
data.put("brcode", "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF");
data.put("taxId", "012.345.678-90");
data.put("description", "this will be fast");
data.put("scheduled", "2020-08-14");
data.put("tags", new String[]{"pix", "invoice/1234"});
payments.add(new BrcodePayment(data));

payments = BrcodePayment.create(payments);

for (BrcodePayment payment : payments){
    System.out.println(payment);
}

Ruby

require('starkbank')

payments = StarkBank::BrcodePayment.create(
    [
        StarkBank::BrcodePayment.new(
            brcode: '00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF',
            tax_id: '012.345.678-90',
            description: 'this will be fast',
            scheduled: '2020-08-14',
            tags: ['pix', 'invoice/1234']
        )
    ]
)

payments.each do |payment|
    puts payment
end

Elixir

payments = StarkBank.BrcodePayment.create!([
    %StarkBank.BrcodePayment{
        brcode: "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
        tax_id: "012.345.678-90",
        description: "this will be fast",
        scheduled: "2020-08-14",
        tags: ["pix", "invoice/1234"]
    }
])

for payment <- payments do
    payment |> IO.inspect
end

C#

using System;
using System.Collections.Generic;

List<StarkBank.BrcodePayment> payments = StarkBank.BrcodePayment.Create(
    new List<StarkBank.BrcodePayment> {
        new StarkBank.BrcodePayment(
            brcode: "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
            taxID: "012.345.678-90",
            description: "this will be fast",
            scheduled: new DateTime(2020, 8, 14),
            tags: new List<string> { "pix", "invoice/1234" }
        )
    }
);

foreach(StarkBank.BrcodePayment payment in payments)
{
    Console.WriteLine(payment);
}

Go

package main

import (
    "fmt"
    "time"
    "github.com/starkbank/sdk-go/starkbank/brcodepayment"
)

func main() {

    scheduled := time.Date(2020, 8, 14, 0, 0, 0, 0, time.UTC)

    payments, err := brcodepayment.Create(
        []brcodepayment.BrcodePayment{
            {
                Brcode:      "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
                TaxId:       "012.345.678-90",
                Description: "this will be fast",
                Scheduled:   &scheduled,
                Tags:        []string{"pix", "invoice/1234"},
            },
        }, nil)
    if err.Errors != nil {
        for _, e := range err.Errors {
            fmt.Printf("code: %s, message: %s", e.Code, e.Message)
        }
    }

    for _, payment := range payments {
        fmt.Printf("%+v", payment)
    }
}

Clojure

(def payments
  (starkbank.brcode-payment/create
    [
      {
        :brcode "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF"
        :tax-id "012.345.678-90"
        :description "this will be fast"
        :scheduled "2020-08-14"
        :tags ["pix" "invoice/1234"]
      }
    ]))
(dorun (map println payments))

Curl

curl --location --request POST '{{baseUrl}}/v2/brcode-payment' 
--header 'Access-Id: {{accessId}}' 
--header 'Access-Time: {{accessTime}}' 
--header 'Access-Signature: {{accessSignature}}' 
--header 'Content-Type: application/json' 
--data-raw '{
    "payments": [
        {
            "brcode": "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
            "taxId": "012.345.678-90",
            "description": "this will be fast",
            "scheduled": "2020-08-14",
            "tags": ["pix", "invoice/1234"]
        }
    ]
}'
RESPONSE

Python

BrcodePayment(
    amount=1000,
    brcode=00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF,
    created=2020-02-06 16:22:24.664134,
    description=this will be fast,
    fee=0,
    id=5412038532661248,
    name=Stark Bank S.A. - Instituicao de Pagamento,
    rules=[],
    scheduled=2020-08-14 10:00:00,
    status=created,
    tags=['pix', 'invoice/1234'],
    tax_id=012.345.678-90,
    transaction_ids=[],
    type=dynamic,
    updated=2020-02-06 16:22:24.664134
)

Javascript

BrcodePayment {
    id: '5412038532661248',
    amount: 1000,
    brcode: '00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF',
    created: '2020-02-06T16:22:24.664148+00:00',
    description: 'this will be fast',
    fee: 0,
    name: 'Stark Bank S.A. - Instituicao de Pagamento',
    rules: [],
    scheduled: '2020-08-14T10:00:00+00:00',
    status: 'created',
    tags: [ 'pix', 'invoice/1234' ],
    taxId: '012.345.678-90',
    transactionIds: [],
    type: 'dynamic',
    updated: '2020-02-06T16:22:24.664148+00:00'
}

PHP

StarkBank\BrcodePayment Object
(
    [id] => 5412038532661248
    [amount] => 1000
    [brcode] => 00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF
    [created] => DateTime Object
        (
            [date] => 2020-02-06 16:22:24.664148
            [timezone_type] => 1
            [timezone] => +00:00
        )

    [description] => this will be fast
    [fee] => 0
    [name] => Stark Bank S.A. - Instituicao de Pagamento
    [rules] => Array
        (
        )

    [scheduled] => DateTime Object
        (
            [date] => 2020-08-14 10:00:00.000000
            [timezone_type] => 1
            [timezone] => +00:00
        )

    [status] => created
    [tags] => Array
        (
            [0] => pix
            [1] => invoice/1234
        )

    [taxId] => 012.345.678-90
    [transactionIds] => Array
        (
        )

    [type] => dynamic
    [updated] => DateTime Object
        (
            [date] => 2020-02-06 16:22:24.664148
            [timezone_type] => 1
            [timezone] => +00:00
        )

)

Java

BrcodePayment({
    "amount": 1000,
    "brcode": "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
    "created": "2020-02-06T16:22:24.664148+00:00",
    "description": "this will be fast",
    "fee": 0,
    "name": "Stark Bank S.A. - Instituicao de Pagamento",
    "rules": [],
    "scheduled": "2020-08-14T10:00:00+00:00",
    "status": "created",
    "tags": ["pix", "invoice/1234"],
    "taxId": "012.345.678-90",
    "transactionIds": [],
    "type": "dynamic",
    "updated": "2020-02-06T16:22:24.664148+00:00",
    "id": "5412038532661248"
})

Ruby

brcodepayment(
    id: 5412038532661248,
    amount: 1000,
    brcode: 00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF,
    created: 2020-02-06T16:22:24+00:00,
    description: this will be fast,
    fee: 0,
    name: Stark Bank S.A. - Instituicao de Pagamento,
    rules: [],
    scheduled: 2020-08-14T10:00:00+00:00,
    status: created,
    tags: ['pix', 'invoice/1234'],
    tax_id: 012.345.678-90,
    transaction_ids: [],
    type: dynamic,
    updated: 2020-02-06T16:22:24+00:00
)

Elixir

%StarkBank.BrcodePayment{
    amount: 1000,
    brcode: "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
    created: ~U[2020-02-06 16:22:24.664148Z],
    description: "this will be fast",
    fee: 0,
    id: "5412038532661248",
    name: "Stark Bank S.A. - Instituicao de Pagamento",
    rules: [],
    scheduled: ~U[2020-08-14 10:00:00Z],
    status: "created",
    tags: ["pix", "invoice/1234"],
    tax_id: "012.345.678-90",
    transaction_ids: [],
    type: "dynamic",
    updated: ~U[2020-02-06 16:22:24.664148Z]
}

C#

BrcodePayment(
    Amount: 1000,
    Brcode: 00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF,
    Created: 06/02/2020 16:22:24,
    Description: this will be fast,
    Fee: 0,
    Name: Stark Bank S.A. - Instituicao de Pagamento,
    Rules: {},
    Scheduled: 14/08/2020 10:00:00,
    Status: created,
    Tags: { pix, invoice/1234 },
    TaxID: 012.345.678-90,
    TransactionIds: {  },
    Type: dynamic,
    Updated: 06/02/2020 16:22:24,
    ID: 5412038532661248
)

Go

{
    Id:5412038532661248
    Amount:1000
    Brcode:00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF
    Created:2020-02-06 16:22:24.664148 +0000 +0000
    Description:this will be fast
    Fee:0
    Name:Stark Bank S.A. - Instituicao de Pagamento
    Rules:[]
    Scheduled:2020-08-14 10:00:00 +0000 +0000
    Status:created
    Tags:[pix invoice/1234]
    TaxId:012.345.678-90
    TransactionIds:[]
    Type:dynamic
    Updated:2020-02-06 16:22:24.664148 +0000 +0000
}

Clojure

{:amount 1000,
 :brcode "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
 :created "2020-02-06T16:22:24.664148+00:00",
 :description "this will be fast",
 :fee 0,
 :id "5412038532661248",
 :name "Stark Bank S.A. - Instituicao de Pagamento",
 :rules [],
 :scheduled "2020-08-14T10:00:00+00:00",
 :status "created",
 :tags ["pix" "invoice/1234"],
 :tax-id "012.345.678-90",
 :transaction-ids [],
 :type "dynamic",
 :updated "2020-02-06T16:22:24.664148+00:00"}

Curl

{
    "message": "Brcode Payment(s) successfully created",
    "payments": [
        {
            "amount": 1000,
            "brcode": "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
            "created": "2020-02-06T16:22:24.387022+00:00",
            "description": "this will be fast",
            "fee": 0,
            "id": "5412038532661248",
            "name": "Stark Bank S.A. - Instituicao de Pagamento",
            "rules": [],
            "scheduled": "2020-08-14T10:00:00+00:00",
            "status": "created",
            "tags": ["pix", "invoice/1234"],
            "taxId": "012.345.678-90",
            "transactionIds": [],
            "type": "dynamic",
            "updated": "2020-02-06T16:22:24.387022+00:00"
        }
    ]
}

Listing Brcode Payments

Get a list of Brcode Payments using filters such as after, before, status and tags to narrow the results.

Python

import starkbank

payments = starkbank.brcodepayment.query(
    after="2020-04-01",
    before="2020-04-30",
)

for payment in payments:
    print(payment)

Javascript

const starkbank = require('starkbank');

(async() => {
    let payments = await starkbank.brcodePayment.query({
        after: '2020-04-01',
        before: '2020-04-30',
    });

    for await (let payment of payments) {
        console.log(payment);
    }
})();

PHP

$payments = StarkBank\BrcodePayment::query([
    "after" => "2020-04-01",
    "before" => "2020-04-30"
]);

foreach($payments as $payment){
    print_r($payment);
}

Java

import com.starkbank.*;
import com.starkbank.utils.Generator;
import java.util.HashMap;

HashMap<String, Object> params = new HashMap<>();
params.put("after", "2020-04-01");
params.put("before", "2020-04-30");
Generator<BrcodePayment> payments = BrcodePayment.query(params);

for (BrcodePayment payment : payments){
    System.out.println(payment);
}

Ruby

require('starkbank')

payments = StarkBank::BrcodePayment.query(
    after: '2020-04-01',
    before: '2020-04-30'
)

payments.each do |payment|
    puts payment
end

Elixir

payments = StarkBank.BrcodePayment.query!(
    after: "2020-04-01",
    before: "2020-04-30"
)

for payment <- payments do
    payment |> IO.inspect
end

C#

using System;
using System.Collections.Generic;

IEnumerable<StarkBank.BrcodePayment> payments = StarkBank.BrcodePayment.Query(
    after: new DateTime(2020, 4, 1),
    before: new DateTime(2020, 4, 30)
);

foreach(StarkBank.BrcodePayment payment in payments)
{
    Console.WriteLine(payment);
}

Go

package main

import (
    "fmt"
    "time"
    "github.com/starkbank/sdk-go/starkbank/brcodepayment"
)

func main() {

    var params = map[string]interface{}{}
    params["after"] = time.Date(2020, 4, 1, 0, 0, 0, 0, time.UTC)
    params["before"] = time.Date(2020, 4, 30, 0, 0, 0, 0, time.UTC)

    payments, errorChannel := brcodepayment.Query(params, nil)

    loop:
    for {
        select {
        case err := <-errorChannel:
            if err.Errors != nil {
                for _, e := range err.Errors {
                    fmt.Printf("code: %s, message: %s", e.Code, e.Message)
                }
            }
        case payment, ok := <-payments:
            if !ok {
                break loop
            }
            fmt.Printf("%+v", payment)
        }
    }
}

Clojure

(def payments
    (starkbank.brcode-payment/query
    {
        :after "2020-04-01"
        :before "2020-04-30"
    }))

(dorun (map println payments))

Curl

curl --location --request GET '{{baseUrl}}/v2/brcode-payment?after=2020-04-01&before=2020-04-30' 
--header 'Access-Id: {{accessId}}' 
--header 'Access-Time: {{accessTime}}' 
--header 'Access-Signature: {{accessSignature}}'
RESPONSE

Python

BrcodePayment(
    amount=1000,
    brcode=00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF,
    created=2020-04-24 17:49:10.225810,
    description=this will be fast,
    fee=0,
    id=5950134772826112,
    name=Stark Bank S.A. - Instituicao de Pagamento,
    rules=[],
    scheduled=2020-08-14 10:00:00,
    status=processing,
    tags=['pix', 'invoice/1234'],
    tax_id=012.345.678-90,
    transaction_ids=['5991715760504832'],
    type=dynamic,
    updated=2020-04-24 17:49:10.225810
)

Javascript

BrcodePayment {
    id: '5950134772826112',
    amount: 1000,
    brcode: '00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF',
    created: '2020-04-24T17:49:10.225810+00:00',
    description: 'this will be fast',
    fee: 0,
    name: 'Stark Bank S.A. - Instituicao de Pagamento',
    rules: [],
    scheduled: '2020-08-14T10:00:00+00:00',
    status: 'processing',
    tags: [ 'pix', 'invoice/1234' ],
    taxId: '012.345.678-90',
    transactionIds: [ '5991715760504832' ],
    type: 'dynamic',
    updated: '2020-04-24T17:49:10.225810+00:00'
}

PHP

StarkBank\BrcodePayment Object
(
    [id] => 5950134772826112
    [amount] => 1000
    [brcode] => 00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF
    [created] => DateTime Object
        (
            [date] => 2020-04-24 17:49:10.225810
            [timezone_type] => 1
            [timezone] => +00:00
        )

    [description] => this will be fast
    [fee] => 0
    [name] => Stark Bank S.A. - Instituicao de Pagamento
    [rules] => Array
        (
        )

    [scheduled] => DateTime Object
        (
            [date] => 2020-08-14 10:00:00.000000
            [timezone_type] => 1
            [timezone] => +00:00
        )

    [status] => processing
    [tags] => Array
        (
            [0] => pix
            [1] => invoice/1234
        )

    [taxId] => 012.345.678-90
    [transactionIds] => Array
        (
            [0] => 5991715760504832
        )

    [type] => dynamic
    [updated] => DateTime Object
        (
            [date] => 2020-04-24 17:49:10.225810
            [timezone_type] => 1
            [timezone] => +00:00
        )

)

Java

BrcodePayment({
    "amount": 1000,
    "brcode": "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
    "created": "2020-04-24T17:49:10.225810+00:00",
    "description": "this will be fast",
    "fee": 0,
    "name": "Stark Bank S.A. - Instituicao de Pagamento",
    "rules": [],
    "scheduled": "2020-08-14T10:00:00+00:00",
    "status": "processing",
    "tags": ["pix", "invoice/1234"],
    "taxId": "012.345.678-90",
    "transactionIds": ["5991715760504832"],
    "type": "dynamic",
    "updated": "2020-04-24T17:49:10.225810+00:00",
    "id": "5950134772826112"
})

Ruby

brcodepayment(
    id: 5950134772826112,
    amount: 1000,
    brcode: 00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF,
    created: 2020-04-24T17:49:10+00:00,
    description: this will be fast,
    fee: 0,
    name: Stark Bank S.A. - Instituicao de Pagamento,
    rules: [],
    scheduled: 2020-08-14T10:00:00+00:00,
    status: processing,
    tags: ['pix', 'invoice/1234'],
    tax_id: 012.345.678-90,
    transaction_ids: ['5991715760504832'],
    type: dynamic,
    updated: 2020-04-24T17:49:10+00:00
)

Elixir

%StarkBank.BrcodePayment{
    amount: 1000,
    brcode: "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
    created: ~U[2020-04-24 17:49:10.225810Z],
    description: "this will be fast",
    fee: 0,
    id: "5950134772826112",
    name: "Stark Bank S.A. - Instituicao de Pagamento",
    rules: [],
    scheduled: ~U[2020-08-14 10:00:00Z],
    status: "processing",
    tags: ["pix", "invoice/1234"],
    tax_id: "012.345.678-90",
    transaction_ids: ["5991715760504832"],
    type: "dynamic",
    updated: ~U[2020-04-24 17:49:10.225810Z]
}

C#

BrcodePayment(
    Amount: 1000,
    Brcode: 00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF,
    Created: 24/04/2020 17:49:10,
    Description: this will be fast,
    Fee: 0,
    Name: Stark Bank S.A. - Instituicao de Pagamento,
    Rules: {},
    Scheduled: 14/08/2020 10:00:00,
    Status: processing,
    Tags: { pix, invoice/1234 },
    TaxID: 012.345.678-90,
    TransactionIds: { 5991715760504832 },
    Type: dynamic,
    Updated: 24/04/2020 17:49:10,
    ID: 5950134772826112
)

Go

{
    Id:5950134772826112
    Amount:1000
    Brcode:00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF
    Created:2020-04-24 17:49:10.225810 +0000 +0000
    Description:this will be fast
    Fee:0
    Name:Stark Bank S.A. - Instituicao de Pagamento
    Rules:[]
    Scheduled:2020-08-14 10:00:00 +0000 +0000
    Status:processing
    Tags:[pix invoice/1234]
    TaxId:012.345.678-90
    TransactionIds:[5991715760504832]
    Type:dynamic
    Updated:2020-04-24 17:49:10.225810 +0000 +0000
}

Clojure

{:amount 1000,
 :brcode "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
 :created "2020-04-24T17:49:10.225810+00:00",
 :description "this will be fast",
 :fee 0,
 :id "5950134772826112",
 :name "Stark Bank S.A. - Instituicao de Pagamento",
 :rules [],
 :scheduled "2020-08-14T10:00:00+00:00",
 :status "processing",
 :tags ["pix" "invoice/1234"],
 :tax-id "012.345.678-90",
 :transaction-ids ["5991715760504832"],
 :type "dynamic",
 :updated "2020-04-24T17:49:10.225810+00:00"}

Curl

{
    "cursor": null,
    "payments": [
        {
            "id": "5950134772826112",
            "amount": 1000,
            "brcode": "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
            "created": "2020-04-24T17:49:10.225810+00:00",
            "description": "this will be fast",
            "fee": 0,
            "name": "Stark Bank S.A. - Instituicao de Pagamento",
            "rules": [],
            "scheduled": "2020-08-14T10:00:00+00:00",
            "status": "processing",
            "tags": ["pix", "invoice/1234"],
            "taxId": "012.345.678-90",
            "transactionIds": ["5991715760504832"],
            "type": "dynamic",
            "updated": "2020-04-24T17:49:10.225810+00:00"
        }
    ]
}

Getting a Brcode Payment

Get a single Brcode Payment by its id.

You can use it to check the current status of a Brcode Payment.

Python

import starkbank

payment = starkbank.brcodepayment.get("5950134772826112")

print(payment)

Javascript

const starkbank = require('starkbank');

(async() => {
    let payment = await starkbank.brcodePayment.get('5950134772826112');
    console.log(payment);
})();

PHP

$payment = StarkBank\BrcodePayment::get("5950134772826112");

print_r($payment);

Java

import com.starkbank.*;

BrcodePayment payment = BrcodePayment.get("5950134772826112");

System.out.println(payment);

Ruby

require('starkbank')

payment = StarkBank::BrcodePayment.get('5950134772826112')

puts payment

Elixir

payment = StarkBank.BrcodePayment.get!("5950134772826112")

payment |> IO.inspect

C#

using System;

StarkBank.BrcodePayment payment = StarkBank.BrcodePayment.Get("5950134772826112");

Console.WriteLine(payment);

Go

package main

import (
    "fmt"
    "github.com/starkbank/sdk-go/starkbank/brcodepayment"
)

func main() {

    payment, err := brcodepayment.Get("5950134772826112", nil)
    if err.Errors != nil {
        for _, e := range err.Errors {
            fmt.Printf("code: %s, message: %s", e.Code, e.Message)
        }
    }

    fmt.Println(payment)
}

Clojure

(def payment (starkbank.brcode-payment/get "5950134772826112"))

(println payment)

Curl

curl --location --request GET '{{baseUrl}}/v2/brcode-payment/5950134772826112' 
--header 'Access-Id: {{accessId}}' 
--header 'Access-Time: {{accessTime}}' 
--header 'Access-Signature: {{accessSignature}}'
RESPONSE

Python

BrcodePayment(
    amount=1000,
    brcode=00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF,
    created=2020-04-24 17:49:10.225810,
    description=this will be fast,
    fee=0,
    id=5950134772826112,
    name=Stark Bank S.A. - Instituicao de Pagamento,
    rules=[],
    scheduled=2020-08-14 10:00:00,
    status=processing,
    tags=['pix', 'invoice/1234'],
    tax_id=012.345.678-90,
    transaction_ids=['5991715760504832'],
    type=dynamic,
    updated=2020-04-24 17:49:10.225810
)

Javascript

BrcodePayment {
    id: '5950134772826112',
    amount: 1000,
    brcode: '00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF',
    created: '2020-04-24T17:49:10.225810+00:00',
    description: 'this will be fast',
    fee: 0,
    name: 'Stark Bank S.A. - Instituicao de Pagamento',
    rules: [],
    scheduled: '2020-08-14T10:00:00+00:00',
    status: 'processing',
    tags: [ 'pix', 'invoice/1234' ],
    taxId: '012.345.678-90',
    transactionIds: [ '5991715760504832' ],
    type: 'dynamic',
    updated: '2020-04-24T17:49:10.225810+00:00'
}

PHP

StarkBank\BrcodePayment Object
(
    [id] => 5950134772826112
    [amount] => 1000
    [brcode] => 00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF
    [created] => DateTime Object
        (
            [date] => 2020-04-24 17:49:10.225810
            [timezone_type] => 1
            [timezone] => +00:00
        )

    [description] => this will be fast
    [fee] => 0
    [name] => Stark Bank S.A. - Instituicao de Pagamento
    [rules] => Array
        (
        )

    [scheduled] => DateTime Object
        (
            [date] => 2020-08-14 10:00:00.000000
            [timezone_type] => 1
            [timezone] => +00:00
        )

    [status] => processing
    [tags] => Array
        (
            [0] => pix
            [1] => invoice/1234
        )

    [taxId] => 012.345.678-90
    [transactionIds] => Array
        (
            [0] => 5991715760504832
        )

    [type] => dynamic
    [updated] => DateTime Object
        (
            [date] => 2020-04-24 17:49:10.225810
            [timezone_type] => 1
            [timezone] => +00:00
        )

)

Java

BrcodePayment({
    "amount": 1000,
    "brcode": "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
    "created": "2020-04-24T17:49:10.225810+00:00",
    "description": "this will be fast",
    "fee": 0,
    "name": "Stark Bank S.A. - Instituicao de Pagamento",
    "rules": [],
    "scheduled": "2020-08-14T10:00:00+00:00",
    "status": "processing",
    "tags": ["pix", "invoice/1234"],
    "taxId": "012.345.678-90",
    "transactionIds": ["5991715760504832"],
    "type": "dynamic",
    "updated": "2020-04-24T17:49:10.225810+00:00",
    "id": "5950134772826112"
})

Ruby

brcodepayment(
    id: 5950134772826112,
    amount: 1000,
    brcode: 00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF,
    created: 2020-04-24T17:49:10+00:00,
    description: this will be fast,
    fee: 0,
    name: Stark Bank S.A. - Instituicao de Pagamento,
    rules: [],
    scheduled: 2020-08-14T10:00:00+00:00,
    status: processing,
    tags: ['pix', 'invoice/1234'],
    tax_id: 012.345.678-90,
    transaction_ids: ['5991715760504832'],
    type: dynamic,
    updated: 2020-04-24T17:49:10+00:00
)

Elixir

%StarkBank.BrcodePayment{
    amount: 1000,
    brcode: "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
    created: ~U[2020-04-24 17:49:10.225810Z],
    description: "this will be fast",
    fee: 0,
    id: "5950134772826112",
    name: "Stark Bank S.A. - Instituicao de Pagamento",
    rules: [],
    scheduled: ~U[2020-08-14 10:00:00Z],
    status: "processing",
    tags: ["pix", "invoice/1234"],
    tax_id: "012.345.678-90",
    transaction_ids: ["5991715760504832"],
    type: "dynamic",
    updated: ~U[2020-04-24 17:49:10.225810Z]
}

C#

BrcodePayment(
    Amount: 1000,
    Brcode: 00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF,
    Created: 24/04/2020 17:49:10,
    Description: this will be fast,
    Fee: 0,
    Name: Stark Bank S.A. - Instituicao de Pagamento,
    Rules: {},
    Scheduled: 14/08/2020 10:00:00,
    Status: processing,
    Tags: { pix, invoice/1234 },
    TaxID: 012.345.678-90,
    TransactionIds: { 5991715760504832 },
    Type: dynamic,
    Updated: 24/04/2020 17:49:10,
    ID: 5950134772826112
)

Go

{
    Id:5950134772826112
    Amount:1000
    Brcode:00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF
    Created:2020-04-24 17:49:10.225810 +0000 +0000
    Description:this will be fast
    Fee:0
    Name:Stark Bank S.A. - Instituicao de Pagamento
    Rules:[]
    Scheduled:2020-08-14 10:00:00 +0000 +0000
    Status:processing
    Tags:[pix invoice/1234]
    TaxId:012.345.678-90
    TransactionIds:[5991715760504832]
    Type:dynamic
    Updated:2020-04-24 17:49:10.225810 +0000 +0000
}

Clojure

{:amount 1000,
 :brcode "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
 :created "2020-04-24T17:49:10.225810+00:00",
 :description "this will be fast",
 :fee 0,
 :id "5950134772826112",
 :name "Stark Bank S.A. - Instituicao de Pagamento",
 :rules [],
 :scheduled "2020-08-14T10:00:00+00:00",
 :status "processing",
 :tags ["pix" "invoice/1234"],
 :tax-id "012.345.678-90",
 :transaction-ids ["5991715760504832"],
 :type "dynamic",
 :updated "2020-04-24T17:49:10.225810+00:00"}

Curl

{
    "payment": {
        "id": "5950134772826112",
        "amount": 1000,
        "brcode": "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
        "created": "2020-04-24T17:49:10.225810+00:00",
        "description": "this will be fast",
        "fee": 0,
        "name": "Stark Bank S.A. - Instituicao de Pagamento",
        "rules": [],
        "scheduled": "2020-08-14T10:00:00+00:00",
        "status": "processing",
        "tags": ["pix", "invoice/1234"],
        "taxId": "012.345.678-90",
        "transactionIds": ["5991715760504832"],
        "type": "dynamic",
        "updated": "2020-04-24T17:49:10.225810+00:00"
    }
}

Canceling Brcode Payment

This method will allow the cancellation of a brcode payment.

It's important to note that it's only possible to cancel brcode payments before the start of processing.

Python

import starkbank

payment = starkbank.brcodepayment.delete("6693962735681536")

print(payment)

Javascript

const starkbank = require('starkbank');

(async() => {
    let payment = await starkbank.brcodePayment.delete('6693962735681536');
    console.log(payment);
})();

PHP

$payment = StarkBank\BrcodePayment::delete("6693962735681536");

print_r($payment);

Java

import com.starkbank.*;

BrcodePayment payment = BrcodePayment.delete("6693962735681536");

System.out.println(payment);

Ruby

require('starkbank')

payment = StarkBank::BrcodePayment.delete('6693962735681536')

puts payment

Elixir

payment = StarkBank.BrcodePayment.delete!("6693962735681536")

payment |> IO.inspect

C#

using System;

StarkBank.BrcodePayment payment = StarkBank.BrcodePayment.Delete("6693962735681536");

Console.WriteLine(payment);

Go

package main

import (
    "fmt"
    "github.com/starkbank/sdk-go/starkbank/brcodepayment"
)

func main() {

    payment, err := brcodepayment.Delete("6693962735681536", nil)
    if err.Errors != nil {
        for _, e := range err.Errors {
            fmt.Printf("code: %s, message: %s", e.Code, e.Message)
        }
    }

    fmt.Println(payment)
}

Clojure

(def payment (starkbank.brcode-payment/delete "6693962735681536"))

(println payment)

Curl

curl --location --request DELETE '{{baseUrl}}/v2/brcode-payment/6693962735681536' 
--header 'Access-Id: {{accessId}}' 
--header 'Access-Time: {{accessTime}}' 
--header 'Access-Signature: {{accessSignature}}'
RESPONSE

Python

BrcodePayment(
    amount=1000,
    brcode=00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF,
    created=2020-04-24 17:49:10.225810,
    description=this will be fast,
    fee=0,
    id=6693962735681536,
    name=Stark Bank S.A. - Instituicao de Pagamento,
    rules=[],
    scheduled=2020-08-14 10:00:00,
    status=canceled,
    tags=['pix', 'invoice/1234'],
    tax_id=012.345.678-90,
    transaction_ids=[],
    type=dynamic,
    updated=2020-04-24 17:49:10.225810
)

Javascript

BrcodePayment {
    id: '6693962735681536',
    amount: 1000,
    brcode: '00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF',
    created: '2020-04-24T17:49:10.225810+00:00',
    description: 'this will be fast',
    fee: 0,
    name: 'Stark Bank S.A. - Instituicao de Pagamento',
    rules: [],
    scheduled: '2020-08-14T10:00:00+00:00',
    status: 'canceled',
    tags: [ 'pix', 'invoice/1234' ],
    taxId: '012.345.678-90',
    transactionIds: [],
    type: 'dynamic',
    updated: '2020-04-24T17:49:10.225810+00:00'
}

PHP

StarkBank\BrcodePayment Object
(
    [id] => 6693962735681536
    [amount] => 1000
    [brcode] => 00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF
    [created] => DateTime Object
        (
            [date] => 2020-04-24 17:49:10.225810
            [timezone_type] => 1
            [timezone] => +00:00
        )

    [description] => this will be fast
    [fee] => 0
    [name] => Stark Bank S.A. - Instituicao de Pagamento
    [rules] => Array
        (
        )

    [scheduled] => DateTime Object
        (
            [date] => 2020-08-14 10:00:00.000000
            [timezone_type] => 1
            [timezone] => +00:00
        )

    [status] => canceled
    [tags] => Array
        (
            [0] => pix
            [1] => invoice/1234
        )

    [taxId] => 012.345.678-90
    [transactionIds] => Array
        (
        )

    [type] => dynamic
    [updated] => DateTime Object
        (
            [date] => 2020-04-24 17:49:10.225810
            [timezone_type] => 1
            [timezone] => +00:00
        )

)

Java

BrcodePayment({
    "amount": 1000,
    "brcode": "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
    "created": "2020-04-24T17:49:10.225810+00:00",
    "description": "this will be fast",
    "fee": 0,
    "name": "Stark Bank S.A. - Instituicao de Pagamento",
    "rules": [],
    "scheduled": "2020-08-14T10:00:00+00:00",
    "status": "canceled",
    "tags": ["pix", "invoice/1234"],
    "taxId": "012.345.678-90",
    "transactionIds": [],
    "type": "dynamic",
    "updated": "2020-04-24T17:49:10.225810+00:00",
    "id": "6693962735681536"
})

Ruby

brcodepayment(
    id: 6693962735681536,
    amount: 1000,
    brcode: 00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF,
    created: 2020-04-24T17:49:10+00:00,
    description: this will be fast,
    fee: 0,
    name: Stark Bank S.A. - Instituicao de Pagamento,
    rules: [],
    scheduled: 2020-08-14T10:00:00+00:00,
    status: canceled,
    tags: ['pix', 'invoice/1234'],
    tax_id: 012.345.678-90,
    transaction_ids: [],
    type: dynamic,
    updated: 2020-04-24T17:49:10+00:00
)

Elixir

%StarkBank.BrcodePayment{
    amount: 1000,
    brcode: "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
    created: ~U[2020-04-24 17:49:10.225810Z],
    description: "this will be fast",
    fee: 0,
    id: "6693962735681536",
    name: "Stark Bank S.A. - Instituicao de Pagamento",
    rules: [],
    scheduled: ~U[2020-08-14 10:00:00Z],
    status: "canceled",
    tags: ["pix", "invoice/1234"],
    tax_id: "012.345.678-90",
    transaction_ids: [],
    type: "dynamic",
    updated: ~U[2020-04-24 17:49:10.225810Z]
}

C#

BrcodePayment(
    Amount: 1000,
    Brcode: 00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF,
    Created: 24/04/2020 17:49:10,
    Description: this will be fast,
    Fee: 0,
    Name: Stark Bank S.A. - Instituicao de Pagamento,
    Rules: {},
    Scheduled: 14/08/2020 10:00:00,
    Status: canceled,
    Tags: { pix, invoice/1234 },
    TaxID: 012.345.678-90,
    TransactionIds: {  },
    Type: dynamic,
    Updated: 24/04/2020 17:49:10,
    ID: 6693962735681536
)

Go

{
    Id:6693962735681536
    Amount:1000
    Brcode:00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF
    Created:2020-04-24 17:49:10.225810 +0000 +0000
    Description:this will be fast
    Fee:0
    Name:Stark Bank S.A. - Instituicao de Pagamento
    Rules:[]
    Scheduled:2020-08-14 10:00:00 +0000 +0000
    Status:canceled
    Tags:[pix invoice/1234]
    TaxId:012.345.678-90
    TransactionIds:[]
    Type:dynamic
    Updated:2020-04-24 17:49:10.225810 +0000 +0000
}

Clojure

{:amount 1000,
 :brcode "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
 :created "2020-04-24T17:49:10.225810+00:00",
 :description "this will be fast",
 :fee 0,
 :id "6693962735681536",
 :name "Stark Bank S.A. - Instituicao de Pagamento",
 :rules [],
 :scheduled "2020-08-14T10:00:00+00:00",
 :status "canceled",
 :tags ["pix" "invoice/1234"],
 :tax-id "012.345.678-90",
 :transaction-ids [],
 :type "dynamic",
 :updated "2020-04-24T17:49:10.225810+00:00"}

Curl

{
    "payment": {
        "id": "6693962735681536",
        "amount": 1000,
        "brcode": "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
        "created": "2020-04-24T17:49:10.225810+00:00",
        "description": "this will be fast",
        "fee": 0,
        "name": "Stark Bank S.A. - Instituicao de Pagamento",
        "rules": [],
        "scheduled": "2020-08-14T10:00:00+00:00",
        "status": "canceled",
        "tags": ["pix", "invoice/1234"],
        "taxId": "012.345.678-90",
        "transactionIds": [],
        "type": "dynamic",
        "updated": "2020-04-24T17:49:10.225810+00:00"
    }
}

Receiving Brcode Payment Webhook

After creation, you can use asynchronous Webhooks to monitor status changes of the entity. The Brcode Payment will follow the following life cycle:

Every time we change a Brcode Payment, we create a Log. Logs are pretty useful for understanding the life cycle of each Brcode Payment. Whenever a new Log is created, we will fire a Webhook to your registered URL.

NOTE: Check the Webhook Get Started for more details on how to receive and process Webhook events.

NOTE: A brcode-payment subscription is required to receive this event.

RESPONSE

Python

{
  "event": {
    "id": "5258020443389952",
    "subscription": "brcode-payment",
    "workspaceId": "6341320293482496",
    "created": "2024-02-01T02:06:27.872660+00:00",
    "log": {
      "id": "4638457385189376",
      "type": "success",
      "created": "2024-02-01T02:06:26.317809+00:00",
      "errors": [],
      "payment": {
        "id": "6679150966341632",
        "amount": 1000,
        "brcode": "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
        "created": "2024-02-01T02:06:26.294998+00:00",
        "description": "this will be fast",
        "fee": 0,
        "name": "Stark Bank S.A. - Instituicao de Pagamento",
        "rules": [],
        "scheduled": "2024-02-02T10:00:00+00:00",
        "status": "success",
        "tags": [
          "order/123",
          "customer/456"
        ],
        "taxId": "012.345.678-90",
        "transactionIds": ["6341320293482496"],
        "type": "dynamic",
        "updated": "2024-02-01T02:06:26.294998+00:00"
      }
    }
  }
}

Javascript

{
  "event": {
    "id": "5258020443389952",
    "subscription": "brcode-payment",
    "workspaceId": "6341320293482496",
    "created": "2024-02-01T02:06:27.872660+00:00",
    "log": {
      "id": "4638457385189376",
      "type": "success",
      "created": "2024-02-01T02:06:26.317809+00:00",
      "errors": [],
      "payment": {
        "id": "6679150966341632",
        "amount": 1000,
        "brcode": "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
        "created": "2024-02-01T02:06:26.294998+00:00",
        "description": "this will be fast",
        "fee": 0,
        "name": "Stark Bank S.A. - Instituicao de Pagamento",
        "rules": [],
        "scheduled": "2024-02-02T10:00:00+00:00",
        "status": "success",
        "tags": [
          "order/123",
          "customer/456"
        ],
        "taxId": "012.345.678-90",
        "transactionIds": ["6341320293482496"],
        "type": "dynamic",
        "updated": "2024-02-01T02:06:26.294998+00:00"
      }
    }
  }
}

PHP

{
  "event": {
    "id": "5258020443389952",
    "subscription": "brcode-payment",
    "workspaceId": "6341320293482496",
    "created": "2024-02-01T02:06:27.872660+00:00",
    "log": {
      "id": "4638457385189376",
      "type": "success",
      "created": "2024-02-01T02:06:26.317809+00:00",
      "errors": [],
      "payment": {
        "id": "6679150966341632",
        "amount": 1000,
        "brcode": "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
        "created": "2024-02-01T02:06:26.294998+00:00",
        "description": "this will be fast",
        "fee": 0,
        "name": "Stark Bank S.A. - Instituicao de Pagamento",
        "rules": [],
        "scheduled": "2024-02-02T10:00:00+00:00",
        "status": "success",
        "tags": [
          "order/123",
          "customer/456"
        ],
        "taxId": "012.345.678-90",
        "transactionIds": ["6341320293482496"],
        "type": "dynamic",
        "updated": "2024-02-01T02:06:26.294998+00:00"
      }
    }
  }
}

Java

{
  "event": {
    "id": "5258020443389952",
    "subscription": "brcode-payment",
    "workspaceId": "6341320293482496",
    "created": "2024-02-01T02:06:27.872660+00:00",
    "log": {
      "id": "4638457385189376",
      "type": "success",
      "created": "2024-02-01T02:06:26.317809+00:00",
      "errors": [],
      "payment": {
        "id": "6679150966341632",
        "amount": 1000,
        "brcode": "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
        "created": "2024-02-01T02:06:26.294998+00:00",
        "description": "this will be fast",
        "fee": 0,
        "name": "Stark Bank S.A. - Instituicao de Pagamento",
        "rules": [],
        "scheduled": "2024-02-02T10:00:00+00:00",
        "status": "success",
        "tags": [
          "order/123",
          "customer/456"
        ],
        "taxId": "012.345.678-90",
        "transactionIds": ["6341320293482496"],
        "type": "dynamic",
        "updated": "2024-02-01T02:06:26.294998+00:00"
      }
    }
  }
}

Ruby

{
  "event": {
    "id": "5258020443389952",
    "subscription": "brcode-payment",
    "workspaceId": "6341320293482496",
    "created": "2024-02-01T02:06:27.872660+00:00",
    "log": {
      "id": "4638457385189376",
      "type": "success",
      "created": "2024-02-01T02:06:26.317809+00:00",
      "errors": [],
      "payment": {
        "id": "6679150966341632",
        "amount": 1000,
        "brcode": "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
        "created": "2024-02-01T02:06:26.294998+00:00",
        "description": "this will be fast",
        "fee": 0,
        "name": "Stark Bank S.A. - Instituicao de Pagamento",
        "rules": [],
        "scheduled": "2024-02-02T10:00:00+00:00",
        "status": "success",
        "tags": [
          "order/123",
          "customer/456"
        ],
        "taxId": "012.345.678-90",
        "transactionIds": ["6341320293482496"],
        "type": "dynamic",
        "updated": "2024-02-01T02:06:26.294998+00:00"
      }
    }
  }
}

Elixir

{
  "event": {
    "id": "5258020443389952",
    "subscription": "brcode-payment",
    "workspaceId": "6341320293482496",
    "created": "2024-02-01T02:06:27.872660+00:00",
    "log": {
      "id": "4638457385189376",
      "type": "success",
      "created": "2024-02-01T02:06:26.317809+00:00",
      "errors": [],
      "payment": {
        "id": "6679150966341632",
        "amount": 1000,
        "brcode": "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
        "created": "2024-02-01T02:06:26.294998+00:00",
        "description": "this will be fast",
        "fee": 0,
        "name": "Stark Bank S.A. - Instituicao de Pagamento",
        "rules": [],
        "scheduled": "2024-02-02T10:00:00+00:00",
        "status": "success",
        "tags": [
          "order/123",
          "customer/456"
        ],
        "taxId": "012.345.678-90",
        "transactionIds": ["6341320293482496"],
        "type": "dynamic",
        "updated": "2024-02-01T02:06:26.294998+00:00"
      }
    }
  }
}

C#

{
  "event": {
    "id": "5258020443389952",
    "subscription": "brcode-payment",
    "workspaceId": "6341320293482496",
    "created": "2024-02-01T02:06:27.872660+00:00",
    "log": {
      "id": "4638457385189376",
      "type": "success",
      "created": "2024-02-01T02:06:26.317809+00:00",
      "errors": [],
      "payment": {
        "id": "6679150966341632",
        "amount": 1000,
        "brcode": "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
        "created": "2024-02-01T02:06:26.294998+00:00",
        "description": "this will be fast",
        "fee": 0,
        "name": "Stark Bank S.A. - Instituicao de Pagamento",
        "rules": [],
        "scheduled": "2024-02-02T10:00:00+00:00",
        "status": "success",
        "tags": [
          "order/123",
          "customer/456"
        ],
        "taxId": "012.345.678-90",
        "transactionIds": ["6341320293482496"],
        "type": "dynamic",
        "updated": "2024-02-01T02:06:26.294998+00:00"
      }
    }
  }
}

Go

{
  "event": {
    "id": "5258020443389952",
    "subscription": "brcode-payment",
    "workspaceId": "6341320293482496",
    "created": "2024-02-01T02:06:27.872660+00:00",
    "log": {
      "id": "4638457385189376",
      "type": "success",
      "created": "2024-02-01T02:06:26.317809+00:00",
      "errors": [],
      "payment": {
        "id": "6679150966341632",
        "amount": 1000,
        "brcode": "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
        "created": "2024-02-01T02:06:26.294998+00:00",
        "description": "this will be fast",
        "fee": 0,
        "name": "Stark Bank S.A. - Instituicao de Pagamento",
        "rules": [],
        "scheduled": "2024-02-02T10:00:00+00:00",
        "status": "success",
        "tags": [
          "order/123",
          "customer/456"
        ],
        "taxId": "012.345.678-90",
        "transactionIds": ["6341320293482496"],
        "type": "dynamic",
        "updated": "2024-02-01T02:06:26.294998+00:00"
      }
    }
  }
}

Clojure

{
  "event": {
    "id": "5258020443389952",
    "subscription": "brcode-payment",
    "workspaceId": "6341320293482496",
    "created": "2024-02-01T02:06:27.872660+00:00",
    "log": {
      "id": "4638457385189376",
      "type": "success",
      "created": "2024-02-01T02:06:26.317809+00:00",
      "errors": [],
      "payment": {
        "id": "6679150966341632",
        "amount": 1000,
        "brcode": "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
        "created": "2024-02-01T02:06:26.294998+00:00",
        "description": "this will be fast",
        "fee": 0,
        "name": "Stark Bank S.A. - Instituicao de Pagamento",
        "rules": [],
        "scheduled": "2024-02-02T10:00:00+00:00",
        "status": "success",
        "tags": [
          "order/123",
          "customer/456"
        ],
        "taxId": "012.345.678-90",
        "transactionIds": ["6341320293482496"],
        "type": "dynamic",
        "updated": "2024-02-01T02:06:26.294998+00:00"
      }
    }
  }
}

Curl

{
  "event": {
    "id": "5258020443389952",
    "subscription": "brcode-payment",
    "workspaceId": "6341320293482496",
    "created": "2024-02-01T02:06:27.872660+00:00",
    "log": {
      "id": "4638457385189376",
      "type": "success",
      "created": "2024-02-01T02:06:26.317809+00:00",
      "errors": [],
      "payment": {
        "id": "6679150966341632",
        "amount": 1000,
        "brcode": "00020101021226890014br.gov.bcb.pix2567brcode-h.sandbox.starkinfra.com/v2/ace289aac1ce453b9ca64fb12ec525855204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63044DDF",
        "created": "2024-02-01T02:06:26.294998+00:00",
        "description": "this will be fast",
        "fee": 0,
        "name": "Stark Bank S.A. - Instituicao de Pagamento",
        "rules": [],
        "scheduled": "2024-02-02T10:00:00+00:00",
        "status": "success",
        "tags": [
          "order/123",
          "customer/456"
        ],
        "taxId": "012.345.678-90",
        "transactionIds": ["6341320293482496"],
        "type": "dynamic",
        "updated": "2024-02-01T02:06:26.294998+00:00"
      }
    }
  }
}