Overview
Setup
Transfer
Creating Transfers
Creating Transfers with accountType and rules parameters
Creating Transfers with description, externalId and tags parameters
Creating Transfers with scheduled parameter
Deleting Transfer
Receiving Transfer webhooks

Transfer

We provide the convenience of transferring funds directly to other accounts.In the document below, we will detail the processes related to the APIs through Transfers, transfers that can be carried out via Pix and TED, providing a clear and comprehensive understanding of the operation and how to perform the transaction.Here is the Transfer log flow, offering a clear and organized perspective of the various stages through which an transfer can go:transfer-log

RESOURCE SUMMARY
Transfer
Create PIX or TED Transactions

Setup in Sandbox/Production

For each environment:1. Create an account at Stark Bank.2. Create asynchronous Webhook subscriptions to receive update Events. Register an URL using the POST Webhook route to receive Events about the following resources:  2.1 Transfer: Creation and updates of Transfer

Creating Transfers

In this section, we will demonstrate how to initiate a transfer via API for billing purposes.Discover how easy it is to create a transfer.To initiate a transfer, ensure that the mandatory parameters are filled, including amount, name, taxId, bankCode, branchCode and accountNumber.If you wish to include optional parameters, you can use accountType, description, externalId, scheduled, tags, and rules. Learn more at: https://starkbank.com/docs/api#transferIt's important to note that when initiating a TED transfer, the bankCode parameter must be filled with the three-digit bank code.If opting for a Pix transfer, the field should be filled with the eight-digit ISPB code of the bank.

Python


import starkbank

transfers = starkbank.transfer.create([
    starkbank.Transfer(
        amount=1000000,
        tax_id="123.456.789-10",
        name="Daenerys Targaryen Stormborn",
        bank_code="20018183",
        branch_code="2201",
        account_number="76543-8"
    )
])

for transfer in transfers:
    print(transfer)

Javascript


const starkbank = require('starkbank');

(async() => {
    let transfers = await starkbank.transfer.create([
        {
            amount: 1000000,
            bankCode: '20018183',
            branchCode: '2201',
            accountNumber: '10000-0',
            taxId: '123.456.789-10',
            name: 'Daenerys Targaryen Stormborn'
        }
    ])

    for (let transfer of transfers) {
        console.log(transfer);
    }
})();

PHP


$transfers = StarkBank\Transfer::create([
    new StarkBank\Transfer([
        "amount" => 1000000,
        "bankCode" => "20018183",
        "branchCode" => "2201",
        "accountNumber" => "10000-0",
        "taxId" => "123.456.789-10",
        "name" => "Daenerys Targaryen Stormborn"
    ])
]);

foreach($transfers as $transfer){
    print_r($transfer);
}

Java


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

List<Transfer> transfers = new ArrayList<>();

HashMap<String, Object> data = new HashMap<>();
data.put("amount", 1000000);
data.put("bankCode", "20018183");
data.put("branchCode", "2201");
data.put("accountNumber", "10000-0");
data.put("taxId", "123.456.789-10");
data.put("name", "Daenerys Targaryen Stormborn");
transfers.add(new Transfer(data));

transfers = Transfer.create(transfers);

for (Transfer transfer : transfers){
    System.out.println(transfer);
}

Ruby


require('starkbank')

transfers = StarkBank::Transfer.create(
    [
        StarkBank::Transfer.new(
            amount: 1000000,
            bank_code: '20018183',
            branch_code: '2201',
            account_number: '10000-0',
            tax_id: '123.456.789-10',
            name: 'Daenerys Targaryen Stormborn'
        )
    ]
)

transfers.each do |transfer|
    puts transfer
end

Elixir


transfers = StarkBank.Transfer.create!([
    %StarkBank.Transfer{
        amount: 1000000,
        bank_code: "20018183",
        branch_code: "2201",
        account_number: "10000-0",
        tax_id: "123.456.789-10",
        name: "Daenerys Targaryen Stormborn"
    }
])

for transfer <- transfers do
    transfer |> IO.inspect
end

C#


using System;
using System.Collections.Generic;

List<StarkBank.Transfer> transfers = StarkBank.Transfer.Create(
    new List<StarkBank.Transfer> {
        new StarkBank.Transfer(
            amount: 1000000,
            bankCode: "20018183",
            branchCode: "2201",
            accountNumber: "10000-0",
            taxID: "123.456.789-10",
            name: "Daenerys Targaryen Stormborn"
        )
    }
);

foreach(StarkBank.Transfer transfer in transfers)
{
    Console.WriteLine(transfer);
}

Go


package main

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

func main() {

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

    transfers, err := transfer.Create(
        []transfer.Transfer{
            {
                Amount:        1000000,
                Name:          "Daenerys Targaryen Stormborn",
                TaxId:         "123.456.789-10",
                BankCode:      "20018183",
                BranchCode:    "2201",
                AccountNumber: "10000-0"
            },
        }, nil)
    if err.Errors != nil {
        for _, e := range err.Errors {
            panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
        }
    }

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

Clojure


(def transfers
  (starkbank.transfer/create
    [
      {
        :amount 1000000
        :bank-code "20018183"
        :branch-code "2201"
        :account-number "10000-0"
        :tax-id "123.456.789-10"
        :name "Daenerys Targaryen Stormborn"
      }
    ]))
(dorun (map println transfers))

Curl


curl --location --request POST '{{baseUrl}}/v2/transfer' 
--header 'Access-Id: {{accessId}}' 
--header 'Access-Time: {{accessTime}}' 
--header 'Access-Signature: {{accessSignature}}' 
--header 'Content-Type: application/json' 
--data-raw '{
    "transfers": [
        {
            "amount": 1000000,
            "taxId": "123.456.789-10",
            "name": "Daenerys Targaryen Stormborn",
            "bankCode": "20018183",
            "branchCode": "2201",
            "accountNumber": "10000-0"
        },
    ]
}'
Response

Python


Transfer(
    account_number=76543-8,
    account_type=savings,
    amount=1000000,
    bank_code=20018183,
    branch_code=2201,
    created=2020-02-06 16:22:24.664134,
    description=Daenerys Targaryen Stormborn (594.739.480-42),
    external_id=my-external-id,
    fee=0,
    id=5412038532661248,
    name=Daenerys Targaryen Stormborn,
    rules=[
        Rule(
            key=resendingLimit,
            value=5
        )
    ],
    scheduled=2020-08-14 10:00:00,
    status=created,
    tags=[],
    tax_id=123.456.789-10,
    transaction_ids=[],
    updated=2020-02-06 16:22:24.664148
)

Javascript


Transfer {
    id: '5412038532661248',
    amount: 1000000,
    name: 'Daenerys Targaryen Stormborn',
    taxId: '276.685.415-00',
    bankCode: '20018183',
    branchCode: '2201',
    accountNumber: '76543-8',
    accountType: 'checking',
    externalId: 'my-external-id',
    scheduled: '2023-08-14T10:00:00+00:00',
    description: 'Daenerys Targaryen Stormborn (594.739.480-42)',
    tags: [ ],
    rules: [ ],
    fee: 0,
    status: 'created',
    created: '2020-02-06T16:22:24.664148+00:00',
    updated: '2020-02-06T16:22:24.664148+00:00',
    transactionIds: []
}

PHP


StarkBank\Transfer Object
(
    [id] => 5412038532661248
    [amount] => 1000000
    [name] => Daenerys Targaryen Stormborn
    [taxId] => 594.739.480-42
    [bankCode] => 20018183
    [branchCode] => 2201
    [accountNumber] => 76543-8
    [accountType] => checking
    [externalId] => my-external-id
    [scheduled] => DateTime Object
        (
            [date] => 2023-08-14 10:00:00.000000
            [timezone_type] => 1
            [timezone] => +00:00
        )

    [description] => Daenerys Targaryen Stormborn (594.739.480-42)
    [tags] => Array
        (
        )

    [rules] => Array
        (
        )

    [fee] => 0
    [status] => created
    [transactionIds] => Array
        (
        )

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

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

)

Java


Transfer({
    "amount": 1000000,
    "name": "Daenerys Targaryen Stormborn",
    "taxId": "594.739.480-42",
    "bankCode": "20018183",
    "branchCode": "2201",
    "accountNumber": "76543-8",
    "accountType": "checking",
    "externalId": "my-external-id",
    "scheduled": "2023-08-14T10:00:00+00:00",
    "description": "Daenerys Targaryen Stormborn (594.739.480-42)",
    "tags": [],
    "rules": [],
    "fee": 0,
    "status": "created",
    "transactionIds": [],
    "created": "2020-02-06T16:22:24.664148+00:00",
    "updated": "2020-02-06T16:22:24.664148+00:00",
    "id": "5412038532661248"
})

Ruby


transfer(
    id: 5412038532661248,
    amount: 1000000,
    name: Daenerys Targaryen Stormborn,
    tax_id: 594.739.480-42,
    bank_code: 20018183,
    branch_code: 2201,
    account_number: 76543-8,
    account_type: checking,
    external_id: my-external-id,
    scheduled: 2023-08-14T10:00:00+00:00,
    description: Daenerys Targaryen Stormborn (594.739.480-42),
    tags: [],
    rules: [],
    fee: 0,
    status: created,
    transaction_ids: [],
    created: 2020-02-06T16:22:24+00:00,
    updated: 2020-02-06T16:22:24+00:00
)

Elixir


%StarkBank.Transfer {
    account_number: "76543-8",
    account_type: "checking",
    amount: 1000000,
    bank_code: "20018183",
    branch_code: "2201",
    created: ~U[2020-02-06 16:22:24.664148Z],
    external_id: "my-external-id",
    fee: 200,
    id: "5412038532661248",
    name: "Daenerys Targaryen Stormborn",
    status: "created",
    scheduled: ~U[2020-08-14 11:00:00Z],
    rules: %Transfer.Rule[],
    description: "Daenerys Targaryen Stormborn (594.739.480-42)",
    tags: [],
    tax_id: "594.739.480-42",
    transaction_ids: [],
    updated: ~U[2020-02-06 16:22:24.664148Z]
}

C#


Transfer(
    Amount: 1000000,
    Name: Daenerys Targaryen Stormborn,
    BranchCode: 2201,
    AccountNumber: 76543-8,
    TaxID: 594.739.480-42,
    AccountType: checking,
    ExternalID: my-external-id,
    Description: Daenerys Targaryen Stormborn (594.739.480-42),
    BankCode: 20018183,
    Scheduled: 07/02/2020 07:00:00,
    Tags: {},
    Rules: {},
    Status: created,
    Fee: 0,
    TransactionIds: {  },
    Created: 06/02/2020 16:22:24,
    Updated: 06/02/2020 16:22:24,
    ID: 5412038532661248
)

Go


{
    Id:5412038532661248
    Amount:1000000
    Name:Daenerys Targaryen Stormborn,
    TaxId:330.731.970-10 
    BankCode:20018183 
    BranchCode:2201 
    AccountNumber:76543-8
    AccountType:checking 
    ExternalId:my-external-id
    Scheduled:2023-02-06 10:00:00 +0000 +0000 
    Description:Daenerys Targaryen Stormborn (594.739.480-42)
    Tags:[] 
    Rules:[]
    Fee:0 
    Status:created 
    TransactionIds:[] 
    Created:2020-02-06 16:22:24.664148 +0000 +0000 
    Updated:2020-02-06 16:22:24.664148 +0000 +0000
}

Clojure


{:amount 1000000,
 :fee 200,
 :tags [],
 :branch-code "2201",
 :updated "2020-02-06T16:22:24.664148+00:00",
 :name "Daenerys Targaryen Stormborn",
 :description "Daenerys Targaryen Stormborn (594.739.480-42)",
 :tax-id "594.739.480-42",
 :created "2020-02-06T16:22:24.664148+00:00",
 :status "created",
 :id "5412038532661248",
 :transaction-ids [],
 :account-number "76543-8",
 :bank-code "20018183",
 :account-type: "checking",
 :external-id: "my-external-id"}

Curl


{
    "message": "Transfer(s) successfully created",
    "transfers": [
        {
            "accountNumber": "76543-8",
            "accountType": "checking",
            "amount": 1000000,
            "bankCode": "20018183",
            "branchCode": "2201",
            "created": "2020-02-06T16:22:24.387022+00:00",
            "description": "Daenerys Targaryen Stormborn (594.739.480-42)",
            "externalId": "my-external-id",
            "fee": 0,
            "id": "5412038532661248",
            "name": "Daenerys Targaryen Stormborn",
            "rules": [],
            "scheduled": "2023-08-14T10:00:00+00:00",
            "status": "created",
            "tags": [],
            "taxId": "594.739.480-42",
            "transactionIds": [],
            "updated": "2020-02-06T16:22:24.664148+00:00"
        },
    ]
}

Transfer IntegrationAn easy way to integrate with Transfers is by using the Dict-key resource. You can utilize the dictkey.get method by passing a Pix key and create a Transfer with the returned data.The returned data will include some encrypted parameters, but you shouldn't worry about it. Just pass the values as they come to the Transfer parameters. Note: Try to avoid looking up DICT keys without sending transfers afterwards, since Bacen's system will block users making too many standalone requests in a short timespan. Invalid key searches also count towards this block

Creating Transfers with accountType, rules parameter

AccountType: You can set the receiver's bank account type. Options include "checking," "payment," "savings," and "salary." "checking" is the default.This parameter only takes effect for Pix Transfers.The transfer will fail if the accountType is different from the receiver's bank account.Rules: List of rules for modifying transfer behavior.You can set this parameter using the "resendingLimit" key if you want to specify a re-send limit.

Python


import starkbank

transfers = starkbank.transfer.create([
    starkbank.Transfer(
        amount=1000000,
        tax_id="123.456.789-10",
        name="Daenerys Targaryen Stormborn",
        bank_code="20018183",
        branch_code="2201",
        account_number="76543-8",
        account_type="savings",
        rules=[
            starkbank.transfer.Rule(
                key="resendingLimit",
                value=5
            )
        ]
    )
])

for transfer in transfers:
    print(transfer)

Javascript


const starkbank = require('starkbank');

(async() => {
    let transfers = await starkbank.transfer.create([
        {
            amount: 1000000,
            bankCode: '20018183',
            branchCode: '2201',
            accountNumber: '10000-0',
            accountType: 'savings',
            taxId: '123.456.789-10',
            name: 'Daenerys Targaryen Stormborn',
            rules: [
                {
                    key: 'resendingLimit',
                    value: 5
                }
            ]
        }
    ])

    for (let transfer of transfers) {
        console.log(transfer);
    }
})();

PHP


$transfers = StarkBank\Transfer::create([
    new StarkBank\Transfer([
        "amount" => 1000000,
        "bankCode" => "20018183",
        "branchCode" => "2201",
        "accountNumber" => "10000-0",
        "accountType" => "savings",
        "taxId" => "123.456.789-10",
        "name" => "Daenerys Targaryen Stormborn",
        "rules" => [
            new StarkBank\Transfer\Rule([
                "key" => "resendingLimit",
                "value" => 5
            ])
        ]
    ])
]);

foreach($transfers as $transfer){
    print_r($transfer);
}

Java


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

List<Transfer> transfers = new ArrayList<>();

List<Transfer.Rule> rules = new ArrayList<>();
rules.add(new Transfer.Rule("resendingLimit", 5));

HashMap<String, Object> data = new HashMap<>();
data.put("amount", 1000000);
data.put("bankCode", "20018183");
data.put("branchCode", "2201");
data.put("accountNumber", "10000-0");
data.put("accountType", "savings");
data.put("taxId", "123.456.789-10");
data.put("name", "Daenerys Targaryen Stormborn");
data.put("rules", rules);
transfers.add(new Transfer(data));

transfers = Transfer.create(transfers);

for (Transfer transfer : transfers){
    System.out.println(transfer);
}

Ruby


require('starkbank')

transfers = StarkBank::Transfer.create(
    [
        StarkBank::Transfer.new(
            amount: 1000000,
            bank_code: '20018183',
            branch_code: '2201',
            account_number: '10000-0',
            tax_id: '123.456.789-10',
            name: 'Daenerys Targaryen Stormborn',
            account_type: 'savings',
            rules: [
                StarkBank::Transfer::Rule.new(
                    key: 'resendingLimit',
                    value: 5
                )
            ]
        )
    ]
)

transfers.each do |transfer|
    puts transfer
end

Elixir


transfers = StarkBank.Transfer.create!([
    %StarkBank.Transfer{
        amount: 1000000,
        bank_code: "20018183",
        branch_code: "2201",
        account_number: "10000-0",
        account_type: "savings",
        tax_id: "123.456.789-10",
        name: "Daenerys Targaryen Stormborn",
        rules: [
        %StarkBank.Transfer.Rule{
            key: "resendingLimit",
            value: 5
            }
        ]
    }
])

for transfer <- transfers do
    transfer |> IO.inspect
end

C#


using System;
using System.Collections.Generic;

List<StarkBank.Transfer> transfers = StarkBank.Transfer.Create(
    new List<StarkBank.Transfer> {
        new StarkBank.Transfer(
            amount: 1000000,
            bankCode: "20018183",
            branchCode: "2201",
            accountNumber: "10000-0",
            accountType: "savings",
            taxID: "123.456.789-10",
            name: "Daenerys Targaryen Stormborn",
            externalID: "my-external-id",
            scheduled: DateTime.Today.Date.AddDays(1),
            tags: new List<string> { "daenerys", "invoice/1234" },
            rules: new List<Transfer.Rule>
            {
                new Transfer.Rule(
                    key: "resendingLimit",
                    value: 5
                )
            }
        )
    }
);

foreach(StarkBank.Transfer transfer in transfers)
{
    Console.WriteLine(transfer);
}

Go


package main

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

func main() {

    transfers, err := transfer.Create(
        []transfer.Transfer{
            {
                Amount:        1000000,
                Name:          "Daenerys Targaryen Stormborn",
                TaxId:         "123.456.789-10",
                BankCode:      "20018183",
                BranchCode:    "2201",
                AccountNumber: "10000-0",
                AccoountType:  "savings",
                Rules:         []rule.Rule{{Key: "resendingLimit", Value: 5}},
            },
        }, nil)
    if err.Errors != nil {
        for _, e := range err.Errors {
            panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
        }
    }

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

Clojure


(def transfers
  (starkbank.transfer/create
    [
      {
        :amount 1000000
        :bank-code "20018183"
        :branch-code "2201"
        :account-number "10000-0"
        :account-type "savings"
        :tax-id "123.456.789-10"
        :name "Daenerys Targaryen Stormborn"
      }
    ]))
(dorun (map println transfers))

Curl


curl --location --request POST '{{baseUrl}}/v2/transfer' 
--header 'Access-Id: {{accessId}}' 
--header 'Access-Time: {{accessTime}}' 
--header 'Access-Signature: {{accessSignature}}' 
--header 'Content-Type: application/json' 
--data-raw '{
    "transfers": [
        {
            "amount": 1000000,
            "taxId": "123.456.789-10",
            "name": "Daenerys Targaryen Stormborn",
            "bankCode": "20018183",
            "branchCode": "2201",
            "accountNumber": "10000-0",
            "accountType": "savings",
            "rules": [
                {
                    "key": "resendingLimit",
                    "value": 5
                }
            ]
        },
    ]
}'
Response

Python


Transfer(
    account_number=76543-8,
    account_type=savings,
    amount=1000000,
    bank_code=20018183,
    branch_code=2201,
    created=2020-02-06 16:22:24.664134,
    description=Daenerys Targaryen Stormborn (594.739.480-42),
    external_id=my-external-id,
    fee=0,
    id=5412038532661248,
    name=Daenerys Targaryen Stormborn,
    rules=[
        Rule(
            key=resendingLimit,
            value=5
        )
    ],
    scheduled=2020-08-14 10:00:00,
    status=created,
    tags=[],
    tax_id=123.456.789-10,
    transaction_ids=[],
    updated=2020-02-06 16:22:24.664148
)

Javascript


Transfer {
    id: '5412038532661248',
    amount: 1000000,
    name: 'Daenerys Targaryen Stormborn',
    taxId: '276.685.415-00',
    bankCode: '20018183',
    branchCode: '2201',
    accountNumber: '76543-8',
    accountType: 'savings',
    externalId: 'my-external-id',
    scheduled: '2023-08-14T10:00:00+00:00',
    description: 'Daenerys Targaryen Stormborn (594.739.480-42)',
    tags: [],
    rules: [ 
        { 
            key: 'resendingLimit', 
            value: 5 
        } 
    ],
    fee: 0,
    status: 'created',
    created: '2020-02-06T16:22:24.664148+00:00',
    updated: '2020-02-06T16:22:24.664148+00:00',
    transactionIds: []
}

PHP


StarkBank\Transfer Object
(
    [id] => 5412038532661248
    [amount] => 1000000
    [name] => Daenerys Targaryen Stormborn
    [taxId] => 594.739.480-42
    [bankCode] => 20018183
    [branchCode] => 2201
    [accountNumber] => 76543-8
    [accountType] => savings
    [externalId] => my-external-id
    [scheduled] => DateTime Object
        (
            [date] => 2023-08-14 10:00:00.000000
            [timezone_type] => 1
            [timezone] => +00:00
        )

    [description] => Daenerys Targaryen Stormborn (594.739.480-42)
    [tags] => Array
        (
        )

    [rules] => Array
        (
            [0] => StarkBank\Transfer\Rule Object
                (
                    [key] => resendingLimit
                    [value] => 5
                )

        )

    [fee] => 0
    [status] => created
    [transactionIds] => Array
        (
        )

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

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

)

Java


Transfer({
    "amount": 1000000,
    "name": "Daenerys Targaryen Stormborn",
    "taxId": "594.739.480-42",
    "bankCode": "20018183",
    "branchCode": "2201",
    "accountNumber": "76543-8",
    "accountType": "savings",
    "externalId": "my-external-id",
    "scheduled": "2023-08-14T10:00:00+00:00",
    "description": "Daenerys Targaryen Stormborn (594.739.480-42)",
    "tags": [],
    "rules": [
        {
            "key": "resendingLimit",
            "value": 5
        }
    ],
    "fee": 0,
    "status": "created",
    "transactionIds": [],
    "created": "2020-02-06T16:22:24.664148+00:00",
    "updated": "2020-02-06T16:22:24.664148+00:00",
    "id": "5412038532661248"
})

Ruby


transfer(
    id: 5412038532661248,
    amount: 1000000,
    name: Daenerys Targaryen Stormborn,
    tax_id: 594.739.480-42,
    bank_code: 20018183,
    branch_code: 2201,
    account_number: 76543-8,
    account_type: savings,
    external_id: my-external-id,
    scheduled: 2023-08-14T10:00:00+00:00,
    description: Daenerys Targaryen Stormborn (594.739.480-42),
    tags: [],
    rules: [
        rule(
            key: resendingLimit,
            value: 5
        )
    ],
    fee: 0,
    status: created,
    transaction_ids: [],
    created: 2020-02-06T16:22:24+00:00,
    updated: 2020-02-06T16:22:24+00:00
)

Elixir


%StarkBank.Transfer {
    account_number: "76543-8",
    account_type: "savings",
    amount: 1000000,
    bank_code: "20018183",
    branch_code: "2201",
    created: ~U[2020-02-06 16:22:24.664148Z],
    external_id: "my-external-id",
    fee: 200,
    id: "5412038532661248",
    name: "Daenerys Targaryen Stormborn",
    status: "created",
    scheduled: ~U[2020-08-14 11:00:00Z],
    rules: %Transfer.Rule[
        %{
            "key" => "resendingLimit", 
            "value" => 5
        }
    ],
    description: "Daenerys Targaryen Stormborn (594.739.480-42)",
    tags: [],
    tax_id: "594.739.480-42",
    transaction_ids: [],
    updated: ~U[2020-02-06 16:22:24.664148Z]
}

C#


Transfer(
    Amount: 1000000,
    Name: Daenerys Targaryen Stormborn,
    BranchCode: 2201,
    AccountNumber: 76543-8,
    TaxID: 594.739.480-42,
    AccountType: savings,
    ExternalID: my-external-id,
    Description: Daenerys Targaryen Stormborn (594.739.480-42),
    BankCode: 20018183,
    Scheduled: 07/02/2020 07:00:00,
    Tags: {},
    Rules: {
        Rule(
            Key: resendingLimit,
            Value: 5
        )
    },
    Status: created,
    Fee: 0,
    TransactionIds: {  },
    Created: 06/02/2020 16:22:24,
    Updated: 06/02/2020 16:22:24,
    ID: 5412038532661248
)

Go


{
    Id:5412038532661248
    Amount:1000000
    Name:Daenerys Targaryen Stormborn,
    TaxId:330.731.970-10 
    BankCode:20018183 
    BranchCode:2201 
    AccountNumber:76543-8
    AccountType:savings 
    ExternalId:my-external-id
    Scheduled:2023-02-06 10:00:00 +0000 +0000 
    Description:Daenerys Targaryen Stormborn (594.739.480-42)
    Tags:[] 
    Rules:[
        {
            Key:resendingLimit 
            Value:5
        }
    ]
    Fee:0 
    Status:created 
    TransactionIds:[] 
    Created:2020-02-06 16:22:24.664148 +0000 +0000 
    Updated:2020-02-06 16:22:24.664148 +0000 +0000
}

Clojure


{:amount 1000000,
 :fee 200,
 :tags [],
 :branch-code "2201",
 :updated "2020-02-06T16:22:24.664148+00:00",
 :name "Daenerys Targaryen Stormborn",
 :description "Daenerys Targaryen Stormborn (594.739.480-42)",
 :tax-id "594.739.480-42",
 :created "2020-02-06T16:22:24.664148+00:00",
 :status "created",
 :id "5412038532661248",
 :transaction-ids [],
 :account-number "76543-8",
 :bank-code "20018183",
 :account-type: "savings",
 :external-id: "my-external-id"}

Curl


{
    "message": "Transfer(s) successfully created",
    "transfers": [
        {
            "accountNumber": "76543-8",
            "accountType": "savings",
            "amount": 1000000,
            "bankCode": "20018183",
            "branchCode": "2201",
            "created": "2020-02-06T16:22:24.387022+00:00",
            "description": "Daenerys Targaryen Stormborn (594.739.480-42)",
            "externalId": "my-external-id",
            "fee": 0,
            "id": "5412038532661248",
            "name": "Daenerys Targaryen Stormborn",
            "rules": [
                {
                    "key": "resendingLimit",
                    "value": 5
                }
            ],
            "scheduled": "2023-08-14T10:00:00+00:00",
            "status": "created",
            "tags": [],
            "taxId": "594.739.480-42",
            "transactionIds": [],
            "updated": "2020-02-06T16:22:24.664148+00:00"
        },
    ]
}

Creating Transfers with description, externalId, tags parameter

ExternalId: Unique ID to avoid duplicate transfers. Repeated externalIds should cause failures by duplication.By default, it blocks transfers to the same bank account with the same amount on the same day. Example: "my-internal-id"Tag: Array of strings to tag the entity for future queries. All tags will be converted to lowercase. Example: ["daenerys", "invoice/1234"]Description: Optional description to override default description to be shown in the bank statement. Example: "Payment for service #1234"

Python


import starkbank

transfers = starkbank.transfer.create([
    starkbank.Transfer(
        amount=1000000,
        tax_id="123.456.789-10",
        name="Daenerys Targaryen Stormborn",
        bank_code="20018183",
        branch_code="2201",
        account_number="76543-8",
        external_id="my-external-id",
        tags=["daenerys", "invoice/1234"],
        description="Payment for service #1234"
    )
])

for transfer in transfers:
    print(transfer)

Javascript


const starkbank = require('starkbank');

(async() => {
    let transfers = await starkbank.transfer.create([
        {
            amount: 1000000,
            bankCode: '20018183',
            branchCode: '2201',
            accountNumber: '10000-0',
            taxId: '123.456.789-10',
            name: 'Daenerys Targaryen Stormborn',
            externalId: 'my-external-id',
            tags: ['daenerys', 'invoice/1234'],
            description: 'Payment for service #1234'
        }
    ])

    for (let transfer of transfers) {
        console.log(transfer);
    }
})();

PHP


$transfers = StarkBank\Transfer::create([
    new StarkBank\Transfer([
        "amount" => 1000000,
        "bankCode" => "20018183",
        "branchCode" => "2201",
        "accountNumber" => "10000-0",
        "taxId" => "123.456.789-10",
        "name" => "Daenerys Targaryen Stormborn",
        "externalId" => "my-external-id",
        "tags" => ["daenerys", "invoice/1234"],
        "description" => "Payment for service #1234"
    ])
]);

foreach($transfers as $transfer){
    print_r($transfer);
}

Java


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

List<Transfer> transfers = new ArrayList<>();

HashMap<String, Object> data = new HashMap<>();
data.put("amount", 1000000);
data.put("bankCode", "20018183");
data.put("branchCode", "2201");
data.put("accountNumber", "10000-0");
data.put("taxId", "123.456.789-10");
data.put("name", "Daenerys Targaryen Stormborn");
data.put("externalId", "my-external-id");
data.put("tags", new String[]{"daenerys", "invoice/1234"});
data.put("rules", rules);
data.put("description", "Payment for service #1234");
transfers.add(new Transfer(data));

transfers = Transfer.create(transfers);

for (Transfer transfer : transfers){
    System.out.println(transfer);
}

Ruby


require('starkbank')

transfers = StarkBank::Transfer.create(
    [
        StarkBank::Transfer.new(
            amount: 1000000,
            bank_code: '20018183',
            branch_code: '2201',
            account_number: '10000-0',
            tax_id: '123.456.789-10',
            name: 'Daenerys Targaryen Stormborn',
            external_id: 'my-external-id',
            tags: %w[daenerys invoice/1234],
            description: 'Payment for service #1234'
        )
    ]
)

transfers.each do |transfer|
    puts transfer
end

Elixir


transfers = StarkBank.Transfer.create!([
    %StarkBank.Transfer{
        amount: 1000000,
        bank_code: "20018183",
        branch_code: "2201",
        account_number: "10000-0",
        tax_id: "123.456.789-10",
        name: "Daenerys Targaryen Stormborn",
        external_id: "my-external-id",
        tags: ["daenerys", "invoice/1234"],
        description: "Payment for service #1234"
    }
])

for transfer <- transfers do
    transfer |> IO.inspect
end

C#


using System;
using System.Collections.Generic;

List<StarkBank.Transfer> transfers = StarkBank.Transfer.Create(
    new List<StarkBank.Transfer> {
        new StarkBank.Transfer(
            amount: 1000000,
            bankCode: "20018183",
            branchCode: "2201",
            accountNumber: "10000-0",
            taxID: "123.456.789-10",
            name: "Daenerys Targaryen Stormborn",
            externalID: "my-external-id",
            tags: new List<string> { "daenerys", "invoice/1234" },
            description: "Payment for service #1234"
        )
    }
);

foreach(StarkBank.Transfer transfer in transfers)
{
    Console.WriteLine(transfer);
}

Go


package main

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

func main() {

    transfers, err := transfer.Create(
        []transfer.Transfer{
            {
                Amount:        1000000,
                Name:          "Daenerys Targaryen Stormborn",
                TaxId:         "123.456.789-10",
                BankCode:      "20018183",
                BranchCode:    "2201",
                AccountNumber: "10000-0",
                ExternalId:    "my-external-id",
                Tags:          []string{"daenerys", "invoice/1234"},
                Description:   "Payment for service #1234"
            },
        }, nil)
    if err.Errors != nil {
        for _, e := range err.Errors {
            panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
        }
    }

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

Clojure


(def transfers
  (starkbank.transfer/create
    [
      {
        :amount 1000000
        :bank-code "20018183"
        :branch-code "2201"
        :account-number "10000-0"
        :tax-id "123.456.789-10"
        :name "Daenerys Targaryen Stormborn"
        :external-id: "my-external-id"
        :tags ["daenerys" "invoice/1234"]
        :description "Payment for service #1234"
      }
    ]))
(dorun (map println transfers))

Curl


curl --location --request POST '{{baseUrl}}/v2/transfer' 
--header 'Access-Id: {{accessId}}' 
--header 'Access-Time: {{accessTime}}' 
--header 'Access-Signature: {{accessSignature}}' 
--header 'Content-Type: application/json' 
--data-raw '{
    "transfers": [
        {
            "amount": 1000000,
            "taxId": "123.456.789-10",
            "name": "Daenerys Targaryen Stormborn",
            "bankCode": "20018183",
            "branchCode": "2201",
            "accountNumber": "10000-0",
            "externalId": "my-external-id",
            "tags": ["daenerys", "invoice/1234"],
            "description": "Payment for service #1234"
        },
    ]
}'
Response

Python


Transfer(
    account_number=76543-8,
    account_type=checking,
    amount=1000000,
    bank_code=20018183,
    branch_code=2201,
    created=2020-02-06 16:22:24.664134,
    description=Payment for service #1234,
    external_id=my-external-id,
    fee=0,
    id=5412038532661248,
    name=Daenerys Targaryen Stormborn,
    rules=[],
    scheduled=2020-08-14 10:00:00,
    status=created,
    tags=['daenerys', 'invoice/1234'],
    tax_id=123.456.789-10,
    transaction_ids=[],
    updated=2020-02-06 16:22:24.664148
)

Javascript


Transfer {
    id: '5412038532661248',
    amount: 1000000,
    name: 'Daenerys Targaryen Stormborn',
    taxId: '276.685.415-00',
    bankCode: '20018183',
    branchCode: '2201',
    accountNumber: '76543-8',
    accountType: 'checking',
    externalId: 'my-external-id',
    scheduled: '2023-08-14T10:00:00+00:00',
    description: 'Payment for service #1234',
    tags: [ 'daenerys', 'invoice/1234' ],
    rules: [],
    fee: 0,
    status: 'created',
    created: '2020-02-06T16:22:24.664148+00:00',
    updated: '2020-02-06T16:22:24.664148+00:00',
    transactionIds: []
}

PHP


StarkBank\Transfer Object
(
    [id] => 5412038532661248
    [amount] => 1000000
    [name] => Daenerys Targaryen Stormborn
    [taxId] => 594.739.480-42
    [bankCode] => 20018183
    [branchCode] => 2201
    [accountNumber] => 76543-8
    [accountType] => checking
    [externalId] => my-external-id
    [scheduled] => DateTime Object
        (
            [date] => 2023-08-14 10:00:00.000000
            [timezone_type] => 1
            [timezone] => +00:00
        )

    [description] => Payment for service #1234
    [tags] => Array
        (
            [0] => daenerys
            [1] => invoice/1234
        )

    [rules] => Array
        (
        )

    [fee] => 0
    [status] => created
    [transactionIds] => Array
        (
        )

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

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

)

Java


Transfer({
    "amount": 1000000,
    "name": "Daenerys Targaryen Stormborn",
    "taxId": "594.739.480-42",
    "bankCode": "20018183",
    "branchCode": "2201",
    "accountNumber": "76543-8",
    "accountType": "checking",
    "externalId": "my-external-id",
    "scheduled": "2023-08-14T10:00:00+00:00",
    "description": "Payment for service #1234",
    "tags": [
        "daenerys",
        "invoice/1234"
    ],
    "rules": [
        {}
    ],
    "fee": 0,
    "status": "created",
    "transactionIds": [],
    "created": "2020-02-06T16:22:24.664148+00:00",
    "updated": "2020-02-06T16:22:24.664148+00:00",
    "id": "5412038532661248"
})

Ruby


transfer(
    id: 5412038532661248,
    amount: 1000000,
    name: Daenerys Targaryen Stormborn,
    tax_id: 594.739.480-42,
    bank_code: 20018183,
    branch_code: 2201,
    account_number: 76543-8,
    account_type: checking,
    external_id: my-external-id,
    scheduled: 2023-08-14T10:00:00+00:00,
    description: Payment for service #1234,
    tags: ["daenerys", "invoice/1234"],
    rules: [
        rule()
    ],
    fee: 0,
    status: created,
    transaction_ids: [],
    created: 2020-02-06T16:22:24+00:00,
    updated: 2020-02-06T16:22:24+00:00
)

Elixir


%StarkBank.Transfer {
    account_number: "76543-8",
    account_type: "checking",
    amount: 1000000,
    bank_code: "20018183",
    branch_code: "2201",
    created: ~U[2020-02-06 16:22:24.664148Z],
    external_id: "my-external-id",
    fee: 200,
    id: "5412038532661248",
    name: "Daenerys Targaryen Stormborn",
    status: "created",
    scheduled: ~U[2020-08-14 11:00:00Z],
    rules: %Transfer.Rule[],
    description: "Payment for service #1234",
    tags: ["daenerys", "invoice/1234"],
    tax_id: "594.739.480-42",
    transaction_ids: [],
    updated: ~U[2020-02-06 16:22:24.664148Z]
}

C#


Transfer(
    Amount: 1000000,
    Name: Daenerys Targaryen Stormborn,
    BranchCode: 2201,
    AccountNumber: 76543-8,
    TaxID: 594.739.480-42,
    AccountType: checking,
    ExternalID: my-external-id,
    Description: Payment for service #1234,
    BankCode: 20018183,
    Scheduled: 07/02/2020 07:00:00,
    Tags: { daenerys, invoice/1234 },
    Rules: {},
    Status: created,
    Fee: 0,
    TransactionIds: {  },
    Created: 06/02/2020 16:22:24,
    Updated: 06/02/2020 16:22:24,
    ID: 5412038532661248
)

Go


{
    Id:5412038532661248
    Amount:1000000
    Name:Daenerys Targaryen Stormborn,
    TaxId:330.731.970-10 
    BankCode:20018183 
    BranchCode:2201 
    AccountNumber:76543-8
    AccountType:checking 
    ExternalId:my-external-id
    Scheduled:2023-02-06 10:00:00 +0000 +0000 
    Description:Payment for service #1234
    Tags:[daenerys invoice/1234] 
    Rules:[]
    Fee:0 
    Status:created 
    TransactionIds:[] 
    Created:2020-02-06 16:22:24.664148 +0000 +0000 
    Updated:2020-02-06 16:22:24.664148 +0000 +0000
}

Clojure


{:amount 1000000,
 :fee 200,
 :tags ["daenerys" "invoice/1234"],
 :branch-code "2201",
 :updated "2020-02-06T16:22:24.664148+00:00",
 :name "Daenerys Targaryen Stormborn",
 :description "Payment for service #1234",
 :tax-id "594.739.480-42",
 :created "2020-02-06T16:22:24.664148+00:00",
 :status "created",
 :id "5412038532661248",
 :transaction-ids [],
 :account-number "76543-8",
 :bank-code "20018183",
 :account-type: "checking",
 :external-id: "my-external-id"}

Curl


{
    "message": "Transfer(s) successfully created",
    "transfers": [
        {
            "accountNumber": "76543-8",
            "accountType": "checking",
            "amount": 1000000,
            "bankCode": "20018183",
            "branchCode": "2201",
            "created": "2020-02-06T16:22:24.387022+00:00",
            "description": "Payment for service #1234",
            "externalId": "my-external-id",
            "fee": 0,
            "id": "5412038532661248",
            "name": "Daenerys Targaryen Stormborn",
            "rules": [],
            "scheduled": "2023-08-14T10:00:00+00:00",
            "status": "created",
            "tags": [
                "daenerys",
                "invoice/1234"
            ],
            "taxId": "594.739.480-42",
            "transactionIds": [],
            "updated": "2020-02-06T16:22:24.664148+00:00"
        },
    ]
}

Creating Transfers with scheduled parameter

Scheduled: Schedule the transfer for a specific date.Today is the default.TED Transfer’s schedules for today will be accepted until 16:00 (BRT) and will be pushed to the next business day afterwards.Pix Transfers 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"

Python


import starkbank

transfers = starkbank.transfer.create([
    starkbank.Transfer(
        amount=1000000,
        tax_id="123.456.789-10",
        name="Daenerys Targaryen Stormborn",
        bank_code="20018183",
        branch_code="2201",
        account_number="76543-8",
        scheduled="2020-08-14"
    )
])

for transfer in transfers:
    print(transfer)

Javascript


const starkbank = require('starkbank');

(async() => {
    let transfers = await starkbank.transfer.create([
        {
            amount: 1000000,
            bankCode: '20018183',
            branchCode: '2201',
            accountNumber: '10000-0',
            taxId: '123.456.789-10',
            name: 'Daenerys Targaryen Stormborn',
            scheduled: '2020-08-14',
        }
    ])

    for (let transfer of transfers) {
        console.log(transfer);
    }
})();

PHP


$transfers = StarkBank\Transfer::create([
    new StarkBank\Transfer([
        "amount" => 1000000,
        "bankCode" => "20018183",
        "branchCode" => "2201",
        "accountNumber" => "10000-0",
        "taxId" => "123.456.789-10",
        "name" => "Daenerys Targaryen Stormborn",
        "scheduled" => "2020-08-14"
    ])
]);

foreach($transfers as $transfer){
    print_r($transfer);
}

Java


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

List<Transfer> transfers = new ArrayList<>();

HashMap<String, Object> data = new HashMap<>();
data.put("amount", 1000000);
data.put("bankCode", "20018183");
data.put("branchCode", "2201");
data.put("accountNumber", "10000-0");
data.put("taxId", "123.456.789-10");
data.put("name", "Daenerys Targaryen Stormborn");
data.put("scheduled", "2020-08-14");
transfers.add(new Transfer(data));

transfers = Transfer.create(transfers);

for (Transfer transfer : transfers){
    System.out.println(transfer);
}

Ruby


require('starkbank')

transfers = StarkBank::Transfer.create(
    [
        StarkBank::Transfer.new(
            amount: 1000000,
            bank_code: '20018183',
            branch_code: '2201',
            account_number: '10000-0',
            tax_id: '123.456.789-10',
            name: 'Daenerys Targaryen Stormborn',
            scheduled: "2020-08-14"
        )
    ]
)

transfers.each do |transfer|
    puts transfer
end

Elixir


transfers = StarkBank.Transfer.create!([
    %StarkBank.Transfer{
        amount: 1000000,
        bank_code: "20018183",
        branch_code: "2201",
        account_number: "10000-0",
        tax_id: "123.456.789-10",
        name: "Daenerys Targaryen Stormborn",
        scheduled: "2020-08-14",
    }
])

for transfer <- transfers do
    transfer |> IO.inspect
end

C#


using System;
using System.Collections.Generic;

List<StarkBank.Transfer> transfers = StarkBank.Transfer.Create(
    new List<StarkBank.Transfer> {
        new StarkBank.Transfer(
            amount: 1000000,
            bankCode: "20018183",
            branchCode: "2201",
            accountNumber: "10000-0",
            taxID: "123.456.789-10",
            name: "Daenerys Targaryen Stormborn",
            scheduled: DateTime.Today.Date.AddDays(1),
        )
    }
);

foreach(StarkBank.Transfer transfer in transfers)
{
    Console.WriteLine(transfer);
}

Go


package main

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

func main() {

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

    transfers, err := transfer.Create(
        []transfer.Transfer{
            {
                Amount:        1000000,
                Name:          "Daenerys Targaryen Stormborn",
                TaxId:         "123.456.789-10",
                BankCode:      "20018183",
                BranchCode:    "2201",
                AccountNumber: "10000-0",
                Scheduled:     &scheduled,
            },
        }, nil)
    if err.Errors != nil {
        for _, e := range err.Errors {
            panic(fmt.Sprintf("code: %s, message: %s", e.Code, e.Message))
        }
    }

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

Clojure


(def transfers
  (starkbank.transfer/create
    [
      {
        :amount 1000000
        :bank-code "20018183"
        :branch-code "2201"
        :account-number "10000-0"
        :tax-id "123.456.789-10"
        :name "Daenerys Targaryen Stormborn"
        :scheduled (date/future-datetime)
      }
    ]))
(dorun (map println transfers))

Curl


curl --location --request POST '{{baseUrl}}/v2/transfer' 
--header 'Access-Id: {{accessId}}' 
--header 'Access-Time: {{accessTime}}' 
--header 'Access-Signature: {{accessSignature}}' 
--header 'Content-Type: application/json' 
--data-raw '{
    "transfers": [
        {
            "amount": 1000000,
            "taxId": "123.456.789-10",
            "name": "Daenerys Targaryen Stormborn",
            "bankCode": "20018183",
            "branchCode": "2201",
            "accountNumber": "10000-0",
            "scheduled": "2020-08-14",
        },
    ]
}'
Response

Python


Transfer(
    account_number=76543-8,
    account_type=checking,
    amount=1000000,
    bank_code=20018183,
    branch_code=2201,
    created=2020-02-06 16:22:24.664134,
    description=Daenerys Targaryen Stormborn (594.739.480-42),
    external_id=my-external-id,
    fee=0,
    id=5412038532661248,
    name=Daenerys Targaryen Stormborn,
    rules=[],
    scheduled=2020-08-14 10:00:00,
    status=created,
    tags=[],
    tax_id=123.456.789-10,
    transaction_ids=[],
    updated=2020-02-06 16:22:24.664148
)

Javascript


Transfer {
    id: '5412038532661248',
    amount: 1000000,
    name: 'Daenerys Targaryen Stormborn',
    taxId: '276.685.415-00',
    bankCode: '20018183',
    branchCode: '2201',
    accountNumber: '76543-8',
    accountType: 'checking',
    externalId: 'my-external-id',
    scheduled: '2023-08-14T10:00:00+00:00',
    description: 'Daenerys Targaryen Stormborn (594.739.480-42)',
    tags: [],
    rules: [],
    fee: 0,
    status: 'created',
    created: '2020-02-06T16:22:24.664148+00:00',
    updated: '2020-02-06T16:22:24.664148+00:00',
    transactionIds: []
}

PHP


StarkBank\Transfer Object
(
    [id] => 5412038532661248
    [amount] => 1000000
    [name] => Daenerys Targaryen Stormborn
    [taxId] => 594.739.480-42
    [bankCode] => 20018183
    [branchCode] => 2201
    [accountNumber] => 76543-8
    [accountType] => checking
    [externalId] => my-external-id
    [scheduled] => DateTime Object
        (
            [date] => 2023-08-14 10:00:00.000000
            [timezone_type] => 1
            [timezone] => +00:00
        )

    [description] => Daenerys Targaryen Stormborn (594.739.480-42)
    [tags] => Array
        (
        )

    [rules] => Array
        (
        )

    [fee] => 0
    [status] => created
    [transactionIds] => Array
        (
        )

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

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

)

Java


Transfer({
    "amount": 1000000,
    "name": "Daenerys Targaryen Stormborn",
    "taxId": "594.739.480-42",
    "bankCode": "20018183",
    "branchCode": "2201",
    "accountNumber": "76543-8",
    "accountType": "checking",
    "externalId": "my-external-id",
    "scheduled": "2023-08-14T10:00:00+00:00",
    "description": "Daenerys Targaryen Stormborn (594.739.480-42)",
    "tags": [],
    "rules": [],
    "fee": 0,
    "status": "created",
    "transactionIds": [],
    "created": "2020-02-06T16:22:24.664148+00:00",
    "updated": "2020-02-06T16:22:24.664148+00:00",
    "id": "5412038532661248"
})

Ruby


transfer(
    id: 5412038532661248,
    amount: 1000000,
    name: Daenerys Targaryen Stormborn,
    tax_id: 594.739.480-42,
    bank_code: 20018183,
    branch_code: 2201,
    account_number: 76543-8,
    account_type: checking,
    external_id: my-external-id,
    scheduled: 2023-08-14T10:00:00+00:00,
    description: Daenerys Targaryen Stormborn (594.739.480-42),
    tags: [],
    rules: [],
    fee: 0,
    status: created,
    transaction_ids: [],
    created: 2020-02-06T16:22:24+00:00,
    updated: 2020-02-06T16:22:24+00:00
)

Elixir


%StarkBank.Transfer {
    account_number: "76543-8",
    account_type: "checking",
    amount: 1000000,
    bank_code: "20018183",
    branch_code: "2201",
    created: ~U[2020-02-06 16:22:24.664148Z],
    external_id: "my-external-id",
    fee: 200,
    id: "5412038532661248",
    name: "Daenerys Targaryen Stormborn",
    status: "created",
    scheduled: ~U[2020-08-14 11:00:00Z],
    rules: %Transfer.Rule[],
    description: "Daenerys Targaryen Stormborn (594.739.480-42)",
    tags: [],
    tax_id: "594.739.480-42",
    transaction_ids: [],
    updated: ~U[2020-02-06 16:22:24.664148Z]
}

C#


Transfer(
    Amount: 1000000,
    Name: Daenerys Targaryen Stormborn,
    BranchCode: 2201,
    AccountNumber: 76543-8,
    TaxID: 594.739.480-42,
    AccountType: checking,
    ExternalID: my-external-id,
    Description: Daenerys Targaryen Stormborn (594.739.480-42),
    BankCode: 20018183,
    Scheduled: 07/02/2020 07:00:00,
    Tags: {},
    Rules: {},
    Status: created,
    Fee: 0,
    TransactionIds: {  },
    Created: 06/02/2020 16:22:24,
    Updated: 06/02/2020 16:22:24,
    ID: 5412038532661248
)

Go


{
    Id:5412038532661248
    Amount:1000000
    Name:Daenerys Targaryen Stormborn,
    TaxId:330.731.970-10 
    BankCode:20018183 
    BranchCode:2201 
    AccountNumber:76543-8
    AccountType:checking 
    ExternalId:my-external-id
    Scheduled:2023-02-06 10:00:00 +0000 +0000 
    Description:Daenerys Targaryen Stormborn (594.739.480-42)
    Tags:[] 
    Rules:[]
    Fee:0 
    Status:created 
    TransactionIds:[] 
    Created:2020-02-06 16:22:24.664148 +0000 +0000 
    Updated:2020-02-06 16:22:24.664148 +0000 +0000
}

Clojure


{:amount 1000000,
 :fee 200,
 :tags [],
 :branch-code "2201",
 :updated "2020-02-06T16:22:24.664148+00:00",
 :name "Daenerys Targaryen Stormborn",
 :description "Daenerys Targaryen Stormborn (594.739.480-42)",
 :tax-id "594.739.480-42",
 :created "2020-02-06T16:22:24.664148+00:00",
 :status "created",
 :id "5412038532661248",
 :transaction-ids [],
 :account-number "76543-8",
 :bank-code "20018183",
 :account-type: "checking",
 :external-id: "my-external-id"}

Curl


{
    "message": "Transfer(s) successfully created",
    "transfers": [
        {
            "accountNumber": "76543-8",
            "accountType": "checking",
            "amount": 1000000,
            "bankCode": "20018183",
            "branchCode": "2201",
            "created": "2020-02-06T16:22:24.387022+00:00",
            "description": "Daenerys Targaryen Stormborn (594.739.480-42)",
            "externalId": "my-external-id",
            "fee": 0,
            "id": "5412038532661248",
            "name": "Daenerys Targaryen Stormborn",
            "rules": [],
            "scheduled": "2023-08-14T10:00:00+00:00",
            "status": "created",
            "tags": [],
            "taxId": "594.739.480-42",
            "transactionIds": [],
            "updated": "2020-02-06T16:22:24.664148+00:00"
        },
    ]
}

Deleting Transfer

The method will allow the cancellation of a transfer.It's important to note that it's only possible to cancel transfers before the start of processing.

Python


import starkbank

transfer = starkbank.transfer.delete("6693962735681536")

print(transfer)

Javascript


const starkbank = require('starkbank');

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

PHP


$transfer = StarkBank\Transfer::delete("6693962735681536");

print_r($transfer);

Java


import com.starkbank.*;

Transfer transfer = Transfer.delete("6693962735681536");

System.out.println(transfer);

Ruby


require('starkbank')

transfer = StarkBank::Transfer.delete('6693962735681536')

puts transfer

Elixir


transfer = StarkBank.Transfer.delete!("6693962735681536")

transfer |> IO.inspect

C#


using System;

StarkBank.Transfer transfer = StarkBank.Transfer.Delete("6693962735681536");

Console.WriteLine(transfer);

Go


package main

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

func main() {

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

    fmt.Println(transfer)
}

Clojure


(def transfer (starkbank.transfer/delete "6693962735681536"))

(println transfer)

Curl


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

Python


Transfer(
    account_number=76543-8,
    account_type=checking,
    amount=100000000,
    bank_code=341,
    branch_code=2201,
    created=2020-04-24 17:49:10.225810,
    description=Daenerys Targaryen Stormborn (594.739.480-42),
    external_id=my-external-id,
    fee=200,
    id=6693962735681536,
    name=Daenerys Targaryen Stormborn,
    rules=[
        Rule(
            key=resendingLimit,
            value=5
        )
    ],
    status=canceled,
    scheduled=2020-08-14 11:00:00,
    tags=['daenerys', 'invoice/1234'],
    tax_id=594.739.480-42,
    transaction_ids=['5991715760504832'],
    updated=2020-04-24 17:49:10.225810
)

Javascript


Transfer {
    id: '6693962735681536',
    amount: 100000000,
    name: 'Daenerys Targaryen Stormborn',
    taxId: '594.739.480-42',
    bankCode: '341',
    branchCode: '2201',
    accountNumber: '10000-0',
    accountType: 'checking',
    externalId: 'my-external-id',
    description: 'Daenerys Targaryen Stormborn (594.739.480-42)',
    tags: [ 'daenerys', 'invoice/1234 ],
    rules: [ 
        { 
            key: 'resendingLimit', 
            value: 5 
        } 
    ],
    fee: 200,
    status: 'canceled',
    scheduled: '2020-08-14T11:00:00+00:00',
    created: '2020-04-24T17:49:10.225810+00:00',
    updated: '2020-04-24T17:49:10.225810+00:00',
    transactionIds: [ '5991715760504832' ]
}

PHP


StarkBank\Transfer Object
(
    [id] => 6693962735681536
    [amount] => 100000000
    [name] => Daenerys Targaryen Stormborn
    [taxId] => 594.739.480-42
    [bankCode] => 341
    [branchCode] => 2201
    [accountNumber] => 76543-8
    [accountType] => checking
    [externalId] => my-external-id
    [description] => Daenerys Targaryen Stormborn (594.739.480-42)
    [tags] => Array
        (
            [0] => daenerys
            [1] => invoice/1234
        )

    [rules] => Array
        (
            [0] => StarkBank\Transfer\Rule Object
                (
                    [key] => resendingLimit
                    [value] => 5
                )

        )

    [fee] => 200
    [status] => canceled
    [scheduled] => DateTime Object
        (
            [date] => 2020-08-14 11:00:00
            [timezone_type] => 1
            [timezone] => +00:00
        )

    [transactionIds] => Array
        (
            [0] => 5991715760504832
        )

    [created] => DateTime Object
        (
            [date] => 2020-04-09 16:26:08.988538
            [timezone_type] => 1
            [timezone] => +00:00
        )

    [updated] => DateTime Object
        (
            [date] => 2020-04-09 16:26:10.280537
            [timezone_type] => 1
            [timezone] => +00:00
        )

)

Java


Transfer({
    "id": "6693962735681536",
    "amount": 100000000,
    "name": "Daenerys Targaryen Stormborn",
    "taxId": "594.739.480-42",
    "bankCode": "341",
    "branchCode": "2201",
    "accountNumber": "76543-8",
    "accountType": "checking",
    "externalId": "my-external-id",
    "description": "Daenerys Targaryen Stormborn (594.739.480-42)",
    "tags": [
        "daenerys",
        "invoice/1234"
    ],
    "rules": [
        {
            "key": "resendingLimit",
            "value": 5
        }
    ],
    "transactionIds": ["5991715760504832"],
    "fee": 200,
    "status": "canceled",
    "scheduled": '2020-08-14T11:00:00+00:00',
    "created": "2020-04-11T01:08:29+00:00",
    "updated": "2020-04-11T01:08:31+00:00"
})

Ruby


transfer(
    id: 6693962735681536,
    amount: 100000000,
    name: Daenerys Targaryen Stormborn,
    tax_id: 594.739.480-42,
    bank_code: 341,
    branch_code: 2201,
    account_number: 76543-8,
    account_type: checking,
    external_id: my-external-id,
    description: Daenerys Targaryen Stormborn (594.739.480-42),
    transaction_ids: ["5991715760504832"],
    fee: 200,
    tags: ["daenerys", "invoice/1234"],
    rules: [
        rule(
            key: resendingLimit,
            value: 5
        )
    ],
    status: canceled,
    scheduled: 2020-08-14T11:00:00+00:00,
    created: 2020-04-11T01:08:29+00:00,
    updated: 2020-04-11T01:08:31+00:00
)

Elixir


%StarkBank.Transfer {
    account_number: "76543-8",
    account_type: "checking",
    amount: 100000000,
    bank_code: "341",
    branch_code: "2201",
    created: ~U[2020-04-24 17:49:10.039009Z],
    external_id: "my-external-id",
    fee: 200,
    id: "6693962735681536",
    name: "Daenerys Targaryen Stormborn",
    status: "canceled",
    scheduled: ~U[2020-08-14 11:00:00Z],
    rules: %Transfer.Rule[
    %{"key" => "resendingLimit", "value" => 5}
    ],
    description: "Daenerys Targaryen Stormborn (594.739.480-42)",
    tags: ["daenerys", "invoice/1234"],
    tax_id: "594.739.480-42",
    transaction_ids: ["5991715760504832"],
    updated: ~U[2020-04-24 17:49:10.611646Z]
}

C#


Transfer(
    Amount: 100000000,
    Name: Daenerys Targaryen Stormborn,
    TaxID: 594.739.480-42,
    BankCode: 341,
    BranchCode: 2201,
    AccountNumber: 76543-8,
    AccountType: checking,
    ExternalID: my-external-id,
    Description: Daenerys Targaryen Stormborn (594.739.480-42),
    TransactionIds: { 5991715760504832 },
    Fee: 200,
    Tags: { daenerys, invoice/1234 },
    Rules: {
        Rule(
            Key: resendingLimit,
            Value: 5
        )
    },
    Status: canceled,
    Scheduled: 08/14/2020 11:00:00,
    Created: 04/14/2020 17:49:10,
    Updated: 04/14/2020 17:49:10,
    ID: 6693962735681536
)

Go


{
    Id:6693962735681536 
    Amount:100000000 
    Name:Daenerys Targaryen Stormborn
    TaxId:594.739.480-42
    BankCode:001 
    BranchCode:1234 
    AccountNumber:123456-0 
    AccountType:checking 
    ExternalId:my-external-id 
    Scheduled:2020-08-14 11:00:00 +0000 +0000 
    Description:Daenerys Targaryen Stormborn (594.739.480-42) 
    Tags:[daenerys invoice/1234] 
    Rules:[
        {
            Key:resendingLimit 
            Value:5
        }
    ]
    Fee:200
    Status:canceled 
    TransactionIds:[5991715760504832] 
    Created:2020-04-24 17:49:10.611646Z +0000 +0000 
    Updated:2020-04-24 17:49:10.611646Z +0000 +0000
}

Clojure


{
    :amount 100000000,
    :fee 200,
    :tags [daenerys invoice/1234],
    :branch-code 0001,
    :updated 2020-04-24T17:49:10.225810+00:00,
    :name Daenerys Targaryen Stormborn,
    :description "Daenerys Targaryen Stormborn (594.739.480-42)",
    :tax-id 012.345.678-90,
    :created 2020-12-05T01:08:39.415347+00:00,
    :status canceled,
    :id 6693962735681536,
    :scheduled 2020-08-14T11:00:0.000000+00:00,
    :transaction-ids [5991715760504832],
    :account-number 00000-0,
    :bank-code 60701190,
    :account-type: "checking",
    :external-id: "my-external-id"
}

Curl


{
    "transfer": {
        "id": "6693962735681536",
        "status": "canceled",
        "amount": 100000000,
        "name": "Daenerys Targaryen Stormborn",
        "rules": [
            {
                "key": "resendingLimit",
                "value": 5
            }
        ],
        "taxId": "594.739.480-42",
        "bankCode": "341",
        "branchCode": "2201",
        "accountNumber": "76543-8",
        "accountType": "checking",
        "scheduled": "2020-08-14T11:00:00+00:00",
        "tags": ["daenerys", "invoice/1234"],
        "created": "2020-03-25T19:59:02.130246+00:00",
        "description": "Daenerys Targaryen Stormborn (594.739.480-42)",
        "externalId": "my-external-id",
        "updated": "2020-04-24T17:49:10.225810+00:00",
        "transactionIds": ["5991715760504832"],
        "fee": 200,
    }
}

Transfer Webhook

Listen to Transfer WebhooksAfter creation, you can use asynchronous Webhooks to monitor status changes of the entity. The Transfer will follow the following life cycle:Every time we change a Transfer, we create a Log. Logs are pretty useful for understanding the life cycle of each Transfer. Whenever a new Log is created, we will fire a Webhook to your registered URL.

Python


    import starkbank
    
    
    request = listen()  # this is the method you made to get the events posted to your Webhook endpoint
    
    event = starkbank.event.parse(
        content=request.data.decode("utf-8"),
        signature=request.headers["Digital-Signature"],
    )
    
    if "transfer" in event.subscription:
        print(event.log.request)

Javascript


    const starkbank = require('starkbank');
    const express = require('express')
    const app = express()
    
    app.use(express.raw({type: "*/*"}));
    
    const port = 3000
    app.get('/', async (req, res) => {
        try {
            let event = await starkbank.event.parse({
                content: req.body.toString(),
                signature: req.headers['Digital-Signature']
            });
            if (event.subscription === 'transfer') {
                console.log(event.log.request);
            }
            res.end()
        }
        catch (err) {
            console.log(err)
            res.status(400).end()
        }
    })
    app.listen(port, () => console.log('Example app listening at http://localhost:{port}'))

PHP


    use StarkBank\Event;
    
    
    $response = listen()  # this is the method you made to get the events posted to your Webhook
    
    $event = Event::parse(
        $response->content, 
        $response->headers["Digital-Signature"]
    );
    
    if ($event->subscription == "transfer"){
        print_r($event->log->request);

Java


    import com.starkbank.*;
    
    
    Request request = Listener.listen(); // this is the method you made to get the events posted to your Webhook
    
    String content = request.content.toString();
    String signature = request.headers.get("Digital-Signature");
    
    Event event = Event.parse(content, signature);
    if(event.subscription == "transfer"){) {
        Transfer.Log log = ((Event.Transfer) event).log;
        System.out.println(log.request);
    }

Ruby


    require('starkbank')
    
    
    request = listen()  # this is the method you made to get the events posted to your Webhook
    
    event = StarkBank::Event.parse(
        content: request.body.read, 
        signature: request.headers['Digital-Signature']
    )
    
    if event.subscription == 'transfer'
        puts event.log.request
    end

Elixir


    response = listen()  # this is the function you made to get the events posted to your Webhook
    
    {event, cache_pid} = StarkBank.Event.parse!(
        content: response.content,
        signature: response.headers["Digital-Signature"]
    ) |> IO.inspect

C#


    using System;
    
    
    Response response = listen();  // this is the method you made to get the events posted to your Webhook endpoint
    
    StarkBank.Event parsedEvent = StarkBank.Event.Parse(
        content: response.Content,
        signature: response.Headers["Digital-Signature"]
    );
    
    if (parsedEvent.Subscription == "transfer") {
        StarkBank.Transfer.Log log = transfer.Log as StarkBank.Transfer.Log;
        Console.WriteLine(log.request);
    }

Go


                

                

                    
Clojure

                    

                

                

                    
Curl

                    

                

            

        

    







    
2.1. Success Webhook Example



    

        
        

            

                
                
                
                
                
                
                
                
                
                

                

                

                

                

                    
Python

                    

        {
            "event": {
                    "created": "2024-02-01T02:06:27.872660+00:00",
                    "id": "5258020443389952",
                    "log": {
                        "created": "2024-02-01T02:06:26.317809+00:00",
                        "errors": [],
                        "id": "4638457385189376",
                        "transfer": {
                            "accountNumber": "123456-0",
                            "accountType": "checking",
                            "amount": 10000,
                            "bankCode": "001",
                            "branchCode": "1234",
                            "created": "2024-02-01T02:06:26.294998+00:00",
                            "description": "Payment for service #1234",
                            "externalId": "my_external_id",
                            "fee": 0,
                            "id": "6679150966341632",
                            "metadata": {},
                            "name": "Steve Rogers",
                            "rules": [
                                {
                                    "key": "resendingLimit",
                                    "value": 5
                                }
                            ],
                            "scheduled": "2024-12-02T10:00:00+00:00",
                            "status": "success",
                            "tags": [
                            "debts",
                            "food"
                            ],
                            "taxId": "330.731.970-10",
                            "transactionIds": [],
                            "updated": "2024-02-01T02:06:26.317865+00:00"
                        },
                    "type": "success"
                },
            "subscription": "transfer",
            "workspaceId": "6341320293482496"
            }
        }
        

                

                

                    
Javascript

                    

        {
            "event": {
                    "created": "2024-02-01T02:06:27.872660+00:00",
                    "id": "5258020443389952",
                    "log": {
                        "created": "2024-02-01T02:06:26.317809+00:00",
                        "errors": [],
                        "id": "4638457385189376",
                        "transfer": {
                            "accountNumber": "123456-0",
                            "accountType": "checking",
                            "amount": 10000,
                            "bankCode": "001",
                            "branchCode": "1234",
                            "created": "2024-02-01T02:06:26.294998+00:00",
                            "description": "Payment for service #1234",
                            "externalId": "my_external_id",
                            "fee": 0,
                            "id": "6679150966341632",
                            "metadata": {},
                            "name": "Steve Rogers",
                            "rules": [
                                {
                                    "key": "resendingLimit",
                                    "value": 5
                                }
                            ],
                            "scheduled": "2024-12-02T10:00:00+00:00",
                            "status": "success",
                            "tags": [
                            "debts",
                            "food"
                            ],
                            "taxId": "330.731.970-10",
                            "transactionIds": [],
                            "updated": "2024-02-01T02:06:26.317865+00:00"
                        },
                    "type": "success"
                },
            "subscription": "transfer",
            "workspaceId": "6341320293482496"
            }
        }
        

                

                

                    
PHP

                    

        {
            "event": {
                    "created": "2024-02-01T02:06:27.872660+00:00",
                    "id": "5258020443389952",
                    "log": {
                        "created": "2024-02-01T02:06:26.317809+00:00",
                        "errors": [],
                        "id": "4638457385189376",
                        "transfer": {
                            "accountNumber": "123456-0",
                            "accountType": "checking",
                            "amount": 10000,
                            "bankCode": "001",
                            "branchCode": "1234",
                            "created": "2024-02-01T02:06:26.294998+00:00",
                            "description": "Payment for service #1234",
                            "externalId": "my_external_id",
                            "fee": 0,
                            "id": "6679150966341632",
                            "metadata": {},
                            "name": "Steve Rogers",
                            "rules": [
                                {
                                    "key": "resendingLimit",
                                    "value": 5
                                }
                            ],
                            "scheduled": "2024-12-02T10:00:00+00:00",
                            "status": "success",
                            "tags": [
                            "debts",
                            "food"
                            ],
                            "taxId": "330.731.970-10",
                            "transactionIds": [],
                            "updated": "2024-02-01T02:06:26.317865+00:00"
                        },
                    "type": "success"
                },
            "subscription": "transfer",
            "workspaceId": "6341320293482496"
            }
        }
        

                

                

                    
Java

                    

        {
            "event": {
                    "created": "2024-02-01T02:06:27.872660+00:00",
                    "id": "5258020443389952",
                    "log": {
                        "created": "2024-02-01T02:06:26.317809+00:00",
                        "errors": [],
                        "id": "4638457385189376",
                        "transfer": {
                            "accountNumber": "123456-0",
                            "accountType": "checking",
                            "amount": 10000,
                            "bankCode": "001",
                            "branchCode": "1234",
                            "created": "2024-02-01T02:06:26.294998+00:00",
                            "description": "Payment for service #1234",
                            "externalId": "my_external_id",
                            "fee": 0,
                            "id": "6679150966341632",
                            "metadata": {},
                            "name": "Steve Rogers",
                            "rules": [
                                {
                                    "key": "resendingLimit",
                                    "value": 5
                                }
                            ],
                            "scheduled": "2024-12-02T10:00:00+00:00",
                            "status": "success",
                            "tags": [
                            "debts",
                            "food"
                            ],
                            "taxId": "330.731.970-10",
                            "transactionIds": [],
                            "updated": "2024-02-01T02:06:26.317865+00:00"
                        },
                    "type": "success"
                },
            "subscription": "transfer",
            "workspaceId": "6341320293482496"
            }
        }
        

                

                

                    
Ruby

                    

        {
            "event": {
                    "created": "2024-02-01T02:06:27.872660+00:00",
                    "id": "5258020443389952",
                    "log": {
                        "created": "2024-02-01T02:06:26.317809+00:00",
                        "errors": [],
                        "id": "4638457385189376",
                        "transfer": {
                            "accountNumber": "123456-0",
                            "accountType": "checking",
                            "amount": 10000,
                            "bankCode": "001",
                            "branchCode": "1234",
                            "created": "2024-02-01T02:06:26.294998+00:00",
                            "description": "Payment for service #1234",
                            "externalId": "my_external_id",
                            "fee": 0,
                            "id": "6679150966341632",
                            "metadata": {},
                            "name": "Steve Rogers",
                            "rules": [
                                {
                                    "key": "resendingLimit",
                                    "value": 5
                                }
                            ],
                            "scheduled": "2024-12-02T10:00:00+00:00",
                            "status": "success",
                            "tags": [
                            "debts",
                            "food"
                            ],
                            "taxId": "330.731.970-10",
                            "transactionIds": [],
                            "updated": "2024-02-01T02:06:26.317865+00:00"
                        },
                    "type": "success"
                },
            "subscription": "transfer",
            "workspaceId": "6341320293482496"
            }
        }
        

                

                

                    
Elixir

                    

        {
            "event": {
                    "created": "2024-02-01T02:06:27.872660+00:00",
                    "id": "5258020443389952",
                    "log": {
                        "created": "2024-02-01T02:06:26.317809+00:00",
                        "errors": [],
                        "id": "4638457385189376",
                        "transfer": {
                            "accountNumber": "123456-0",
                            "accountType": "checking",
                            "amount": 10000,
                            "bankCode": "001",
                            "branchCode": "1234",
                            "created": "2024-02-01T02:06:26.294998+00:00",
                            "description": "Payment for service #1234",
                            "externalId": "my_external_id",
                            "fee": 0,
                            "id": "6679150966341632",
                            "metadata": {},
                            "name": "Steve Rogers",
                            "rules": [
                                {
                                    "key": "resendingLimit",
                                    "value": 5
                                }
                            ],
                            "scheduled": "2024-12-02T10:00:00+00:00",
                            "status": "success",
                            "tags": [
                            "debts",
                            "food"
                            ],
                            "taxId": "330.731.970-10",
                            "transactionIds": [],
                            "updated": "2024-02-01T02:06:26.317865+00:00"
                        },
                    "type": "success"
                },
            "subscription": "transfer",
            "workspaceId": "6341320293482496"
            }
        }
        

                

                

                    
C#

                    

        {
            "event": {
                    "created": "2024-02-01T02:06:27.872660+00:00",
                    "id": "5258020443389952",
                    "log": {
                        "created": "2024-02-01T02:06:26.317809+00:00",
                        "errors": [],
                        "id": "4638457385189376",
                        "transfer": {
                            "accountNumber": "123456-0",
                            "accountType": "checking",
                            "amount": 10000,
                            "bankCode": "001",
                            "branchCode": "1234",
                            "created": "2024-02-01T02:06:26.294998+00:00",
                            "description": "Payment for service #1234",
                            "externalId": "my_external_id",
                            "fee": 0,
                            "id": "6679150966341632",
                            "metadata": {},
                            "name": "Steve Rogers",
                            "rules": [
                                {
                                    "key": "resendingLimit",
                                    "value": 5
                                }
                            ],
                            "scheduled": "2024-12-02T10:00:00+00:00",
                            "status": "success",
                            "tags": [
                            "debts",
                            "food"
                            ],
                            "taxId": "330.731.970-10",
                            "transactionIds": [],
                            "updated": "2024-02-01T02:06:26.317865+00:00"
                        },
                    "type": "success"
                },
            "subscription": "transfer",
            "workspaceId": "6341320293482496"
            }
        }
        

                

                

                    
Go

                    

        {
            "event": {
                    "created": "2024-02-01T02:06:27.872660+00:00",
                    "id": "5258020443389952",
                    "log": {
                        "created": "2024-02-01T02:06:26.317809+00:00",
                        "errors": [],
                        "id": "4638457385189376",
                        "transfer": {
                            "accountNumber": "123456-0",
                            "accountType": "checking",
                            "amount": 10000,
                            "bankCode": "001",
                            "branchCode": "1234",
                            "created": "2024-02-01T02:06:26.294998+00:00",
                            "description": "Payment for service #1234",
                            "externalId": "my_external_id",
                            "fee": 0,
                            "id": "6679150966341632",
                            "metadata": {},
                            "name": "Steve Rogers",
                            "rules": [
                                {
                                    "key": "resendingLimit",
                                    "value": 5
                                }
                            ],
                            "scheduled": "2024-12-02T10:00:00+00:00",
                            "status": "success",
                            "tags": [
                            "debts",
                            "food"
                            ],
                            "taxId": "330.731.970-10",
                            "transactionIds": [],
                            "updated": "2024-02-01T02:06:26.317865+00:00"
                        },
                    "type": "success"
                },
            "subscription": "transfer",
            "workspaceId": "6341320293482496"
            }
        }
        

                

                

                    
Clojure

                    

        {
            "event": {
                    "created": "2024-02-01T02:06:27.872660+00:00",
                    "id": "5258020443389952",
                    "log": {
                        "created": "2024-02-01T02:06:26.317809+00:00",
                        "errors": [],
                        "id": "4638457385189376",
                        "transfer": {
                            "accountNumber": "123456-0",
                            "accountType": "checking",
                            "amount": 10000,
                            "bankCode": "001",
                            "branchCode": "1234",
                            "created": "2024-02-01T02:06:26.294998+00:00",
                            "description": "Payment for service #1234",
                            "externalId": "my_external_id",
                            "fee": 0,
                            "id": "6679150966341632",
                            "metadata": {},
                            "name": "Steve Rogers",
                            "rules": [
                                {
                                    "key": "resendingLimit",
                                    "value": 5
                                }
                            ],
                            "scheduled": "2024-12-02T10:00:00+00:00",
                            "status": "success",
                            "tags": [
                            "debts",
                            "food"
                            ],
                            "taxId": "330.731.970-10",
                            "transactionIds": [],
                            "updated": "2024-02-01T02:06:26.317865+00:00"
                        },
                    "type": "success"
                },
            "subscription": "transfer",
            "workspaceId": "6341320293482496"
            }
        }
        

                

                

                    
Curl

                    

        {
            "event": {
                    "created": "2024-02-01T02:06:27.872660+00:00",
                    "id": "5258020443389952",
                    "log": {
                        "created": "2024-02-01T02:06:26.317809+00:00",
                        "errors": [],
                        "id": "4638457385189376",
                        "transfer": {
                            "accountNumber": "123456-0",
                            "accountType": "checking",
                            "amount": 10000,
                            "bankCode": "001",
                            "branchCode": "1234",
                            "created": "2024-02-01T02:06:26.294998+00:00",
                            "description": "Payment for service #1234",
                            "externalId": "my_external_id",
                            "fee": 0,
                            "id": "6679150966341632",
                            "metadata": {},
                            "name": "Steve Rogers",
                            "rules": [
                                {
                                    "key": "resendingLimit",
                                    "value": 5
                                }
                            ],
                            "scheduled": "2024-12-02T10:00:00+00:00",
                            "status": "success",
                            "tags": [
                            "debts",
                            "food"
                            ],
                            "taxId": "330.731.970-10",
                            "transactionIds": [],
                            "updated": "2024-02-01T02:06:26.317865+00:00"
                        },
                    "type": "success"
                },
            "subscription": "transfer",
            "workspaceId": "6341320293482496"
            }
        }
        

                

            

        

    







    
2.2 Failed Webhook Example



    

        
        

            

                
                
                
                
                
                
                
                
                
                

                

                

                

                

                    
Python

                    

        {
            "event": {
                "created": "2024-02-01T02:06:27.872660+00:00",
                "id": "5258020443389952",
                "log": {
                "created": "2024-02-01T02:06:26.317809+00:00",
                "errors": [],
                "id": "4638457385189376",
                "transfer": {
                    "accountNumber": "123456-0",
                    "accountType": "checking",
                    "amount": 10000,
                    "bankCode": "001",
                    "branchCode": "1234",
                    "created": "2024-02-01T02:06:26.294998+00:00",
                    "description": "Payment for service #1234",
                    "externalId": "my_external_id",
                    "fee": 0,
                    "id": "6679150966341632",
                    "metadata": {},
                    "name": "Steve Rogers",
                    "rules": [
                    {
                        "key": "resendingLimit",
                        "value": 5
                    }
                    ],
                    "scheduled": "2024-12-02T10:00:00+00:00",
                    "status": "failed",
                    "tags": [
                    "debts",
                    "food"
                    ],
                    "taxId": "330.731.970-10",
                    "transactionIds": [],
                    "updated": "2024-02-01T02:06:26.317865+00:00"
                },
                "type": "failed"
            },
            "subscription": "transfer",
            "workspaceId": "6341320293482496"
            }
        }
        

                

                

                    
Javascript

                    

        {
            "event": {
                "created": "2024-02-01T02:06:27.872660+00:00",
                "id": "5258020443389952",
                "log": {
                "created": "2024-02-01T02:06:26.317809+00:00",
                "errors": [],
                "id": "4638457385189376",
                "transfer": {
                    "accountNumber": "123456-0",
                    "accountType": "checking",
                    "amount": 10000,
                    "bankCode": "001",
                    "branchCode": "1234",
                    "created": "2024-02-01T02:06:26.294998+00:00",
                    "description": "Payment for service #1234",
                    "externalId": "my_external_id",
                    "fee": 0,
                    "id": "6679150966341632",
                    "metadata": {},
                    "name": "Steve Rogers",
                    "rules": [
                    {
                        "key": "resendingLimit",
                        "value": 5
                    }
                    ],
                    "scheduled": "2024-12-02T10:00:00+00:00",
                    "status": "failed",
                    "tags": [
                    "debts",
                    "food"
                    ],
                    "taxId": "330.731.970-10",
                    "transactionIds": [],
                    "updated": "2024-02-01T02:06:26.317865+00:00"
                },
                "type": "failed"
            },
            "subscription": "transfer",
            "workspaceId": "6341320293482496"
            }
        }
        

                

                

                    
PHP

                    

        {
            "event": {
                "created": "2024-02-01T02:06:27.872660+00:00",
                "id": "5258020443389952",
                "log": {
                "created": "2024-02-01T02:06:26.317809+00:00",
                "errors": [],
                "id": "4638457385189376",
                "transfer": {
                    "accountNumber": "123456-0",
                    "accountType": "checking",
                    "amount": 10000,
                    "bankCode": "001",
                    "branchCode": "1234",
                    "created": "2024-02-01T02:06:26.294998+00:00",
                    "description": "Payment for service #1234",
                    "externalId": "my_external_id",
                    "fee": 0,
                    "id": "6679150966341632",
                    "metadata": {},
                    "name": "Steve Rogers",
                    "rules": [
                    {
                        "key": "resendingLimit",
                        "value": 5
                    }
                    ],
                    "scheduled": "2024-12-02T10:00:00+00:00",
                    "status": "failed",
                    "tags": [
                    "debts",
                    "food"
                    ],
                    "taxId": "330.731.970-10",
                    "transactionIds": [],
                    "updated": "2024-02-01T02:06:26.317865+00:00"
                },
                "type": "failed"
            },
            "subscription": "transfer",
            "workspaceId": "6341320293482496"
            }
        }
        

                

                

                    
Java

                    

        {
            "event": {
                "created": "2024-02-01T02:06:27.872660+00:00",
                "id": "5258020443389952",
                "log": {
                "created": "2024-02-01T02:06:26.317809+00:00",
                "errors": [],
                "id": "4638457385189376",
                "transfer": {
                    "accountNumber": "123456-0",
                    "accountType": "checking",
                    "amount": 10000,
                    "bankCode": "001",
                    "branchCode": "1234",
                    "created": "2024-02-01T02:06:26.294998+00:00",
                    "description": "Payment for service #1234",
                    "externalId": "my_external_id",
                    "fee": 0,
                    "id": "6679150966341632",
                    "metadata": {},
                    "name": "Steve Rogers",
                    "rules": [
                    {
                        "key": "resendingLimit",
                        "value": 5
                    }
                    ],
                    "scheduled": "2024-12-02T10:00:00+00:00",
                    "status": "failed",
                    "tags": [
                    "debts",
                    "food"
                    ],
                    "taxId": "330.731.970-10",
                    "transactionIds": [],
                    "updated": "2024-02-01T02:06:26.317865+00:00"
                },
                "type": "failed"
            },
            "subscription": "transfer",
            "workspaceId": "6341320293482496"
            }
        }
        

                

                

                    
Ruby

                    

        {
            "event": {
                "created": "2024-02-01T02:06:27.872660+00:00",
                "id": "5258020443389952",
                "log": {
                "created": "2024-02-01T02:06:26.317809+00:00",
                "errors": [],
                "id": "4638457385189376",
                "transfer": {
                    "accountNumber": "123456-0",
                    "accountType": "checking",
                    "amount": 10000,
                    "bankCode": "001",
                    "branchCode": "1234",
                    "created": "2024-02-01T02:06:26.294998+00:00",
                    "description": "Payment for service #1234",
                    "externalId": "my_external_id",
                    "fee": 0,
                    "id": "6679150966341632",
                    "metadata": {},
                    "name": "Steve Rogers",
                    "rules": [
                    {
                        "key": "resendingLimit",
                        "value": 5
                    }
                    ],
                    "scheduled": "2024-12-02T10:00:00+00:00",
                    "status": "failed",
                    "tags": [
                    "debts",
                    "food"
                    ],
                    "taxId": "330.731.970-10",
                    "transactionIds": [],
                    "updated": "2024-02-01T02:06:26.317865+00:00"
                },
                "type": "failed"
            },
            "subscription": "transfer",
            "workspaceId": "6341320293482496"
            }
        }
        

                

                

                    
Elixir

                    

        {
            "event": {
                "created": "2024-02-01T02:06:27.872660+00:00",
                "id": "5258020443389952",
                "log": {
                "created": "2024-02-01T02:06:26.317809+00:00",
                "errors": [],
                "id": "4638457385189376",
                "transfer": {
                    "accountNumber": "123456-0",
                    "accountType": "checking",
                    "amount": 10000,
                    "bankCode": "001",
                    "branchCode": "1234",
                    "created": "2024-02-01T02:06:26.294998+00:00",
                    "description": "Payment for service #1234",
                    "externalId": "my_external_id",
                    "fee": 0,
                    "id": "6679150966341632",
                    "metadata": {},
                    "name": "Steve Rogers",
                    "rules": [
                    {
                        "key": "resendingLimit",
                        "value": 5
                    }
                    ],
                    "scheduled": "2024-12-02T10:00:00+00:00",
                    "status": "failed",
                    "tags": [
                    "debts",
                    "food"
                    ],
                    "taxId": "330.731.970-10",
                    "transactionIds": [],
                    "updated": "2024-02-01T02:06:26.317865+00:00"
                },
                "type": "failed"
            },
            "subscription": "transfer",
            "workspaceId": "6341320293482496"
            }
        }
        

                

                

                    
C#

                    

        {
            "event": {
                "created": "2024-02-01T02:06:27.872660+00:00",
                "id": "5258020443389952",
                "log": {
                "created": "2024-02-01T02:06:26.317809+00:00",
                "errors": [],
                "id": "4638457385189376",
                "transfer": {
                    "accountNumber": "123456-0",
                    "accountType": "checking",
                    "amount": 10000,
                    "bankCode": "001",
                    "branchCode": "1234",
                    "created": "2024-02-01T02:06:26.294998+00:00",
                    "description": "Payment for service #1234",
                    "externalId": "my_external_id",
                    "fee": 0,
                    "id": "6679150966341632",
                    "metadata": {},
                    "name": "Steve Rogers",
                    "rules": [
                    {
                        "key": "resendingLimit",
                        "value": 5
                    }
                    ],
                    "scheduled": "2024-12-02T10:00:00+00:00",
                    "status": "failed",
                    "tags": [
                    "debts",
                    "food"
                    ],
                    "taxId": "330.731.970-10",
                    "transactionIds": [],
                    "updated": "2024-02-01T02:06:26.317865+00:00"
                },
                "type": "failed"
            },
            "subscription": "transfer",
            "workspaceId": "6341320293482496"
            }
        }
        

                

                

                    
Go

                    

        {
            "event": {
                "created": "2024-02-01T02:06:27.872660+00:00",
                "id": "5258020443389952",
                "log": {
                "created": "2024-02-01T02:06:26.317809+00:00",
                "errors": [],
                "id": "4638457385189376",
                "transfer": {
                    "accountNumber": "123456-0",
                    "accountType": "checking",
                    "amount": 10000,
                    "bankCode": "001",
                    "branchCode": "1234",
                    "created": "2024-02-01T02:06:26.294998+00:00",
                    "description": "Payment for service #1234",
                    "externalId": "my_external_id",
                    "fee": 0,
                    "id": "6679150966341632",
                    "metadata": {},
                    "name": "Steve Rogers",
                    "rules": [
                    {
                        "key": "resendingLimit",
                        "value": 5
                    }
                    ],
                    "scheduled": "2024-12-02T10:00:00+00:00",
                    "status": "failed",
                    "tags": [
                    "debts",
                    "food"
                    ],
                    "taxId": "330.731.970-10",
                    "transactionIds": [],
                    "updated": "2024-02-01T02:06:26.317865+00:00"
                },
                "type": "failed"
            },
            "subscription": "transfer",
            "workspaceId": "6341320293482496"
            }
        }
        

                

                

                    
Clojure

                    

        {
            "event": {
                "created": "2024-02-01T02:06:27.872660+00:00",
                "id": "5258020443389952",
                "log": {
                "created": "2024-02-01T02:06:26.317809+00:00",
                "errors": [],
                "id": "4638457385189376",
                "transfer": {
                    "accountNumber": "123456-0",
                    "accountType": "checking",
                    "amount": 10000,
                    "bankCode": "001",
                    "branchCode": "1234",
                    "created": "2024-02-01T02:06:26.294998+00:00",
                    "description": "Payment for service #1234",
                    "externalId": "my_external_id",
                    "fee": 0,
                    "id": "6679150966341632",
                    "metadata": {},
                    "name": "Steve Rogers",
                    "rules": [
                    {
                        "key": "resendingLimit",
                        "value": 5
                    }
                    ],
                    "scheduled": "2024-12-02T10:00:00+00:00",
                    "status": "failed",
                    "tags": [
                    "debts",
                    "food"
                    ],
                    "taxId": "330.731.970-10",
                    "transactionIds": [],
                    "updated": "2024-02-01T02:06:26.317865+00:00"
                },
                "type": "failed"
            },
            "subscription": "transfer",
            "workspaceId": "6341320293482496"
            }
        }
        

                

                

                    
Curl

                    

        {
            "event": {
                "created": "2024-02-01T02:06:27.872660+00:00",
                "id": "5258020443389952",
                "log": {
                "created": "2024-02-01T02:06:26.317809+00:00",
                "errors": [],
                "id": "4638457385189376",
                "transfer": {
                    "accountNumber": "123456-0",
                    "accountType": "checking",
                    "amount": 10000,
                    "bankCode": "001",
                    "branchCode": "1234",
                    "created": "2024-02-01T02:06:26.294998+00:00",
                    "description": "Payment for service #1234",
                    "externalId": "my_external_id",
                    "fee": 0,
                    "id": "6679150966341632",
                    "metadata": {},
                    "name": "Steve Rogers",
                    "rules": [
                    {
                        "key": "resendingLimit",
                        "value": 5
                    }
                    ],
                    "scheduled": "2024-12-02T10:00:00+00:00",
                    "status": "failed",
                    "tags": [
                    "debts",
                    "food"
                    ],
                    "taxId": "330.731.970-10",
                    "transactionIds": [],
                    "updated": "2024-02-01T02:06:26.317865+00:00"
                },
                "type": "failed"
            },
            "subscription": "transfer",
            "workspaceId": "6341320293482496"
            }
        }