Split Receivables | STARK BANK Documentation

Split Profile Overview

The Split Profile defines the default behavior for transferring funds from your Workspace to the Split Receivers.

Two parameters are essential for the transfer to occur: the Interval and the Delay.

Setting up a Split Profile

Use the Split Profile to configure how and when split funds are transferred to receivers.

Interval

The period during which the transfer of funds from the Workspace to the receiver's destination account will be conducted.

You can choose from four methods to execute the interval:

Period	When
Instantaneous	-
Daily	Everyday at 7a.m
Weekly	Mondays at 7a.m
Monthly	Every 1st at 7a.m

Delay

The period during which the value will be "retained" in the main Workspace until it is transferred to the receiver's destination account.

The Delay is configured by the client, allowing it to determine how long the value should be "retained" before the transfer occurs.

For clients who do not configure the Split Profile rules for interval and delay as desired, by default, the Payment Split will have the following properties:

Interval - monthly

Delay - 7 days

Split Receiver Overview

Before creating an Invoice or Boleto with splits, you need to create a Split Receiver for each party that will receive part of the payment.

Provide the receiver's name, tax ID (CPF or CNPJ), and bank account details.

Creating a Split Receiver

Create a Split Receiver by providing the receiver's bank account details. You can create multiple receivers at once.

Listing Split Receivers

You can list all Split Receivers that match your filters.

Getting a Split Receiver

You can get a specific Split Receiver by its ID.

Listing Split Receiver Logs

You can list all Split Receiver Logs to track status changes.

Getting a Split Receiver Log

You can get a specific Split Receiver Log by its ID.

Split Overview

When an Invoice or Boleto with splits is paid, a Split entity is created for each receiver. You can track these Splits to confirm when each receiver's share has been transferred.

Creating an Invoice with Split

After creating your Split Receivers, you can create an Invoice with the splits parameter.

Each split entry includes a receiver ID and the amount they should receive.

Creating a Boleto with Split

You can also create a Boleto with the splits parameter. Each split entry includes a receiver ID and the amount they should receive.

If there are 3 parties in the transaction, include 3 entries — each with the receiver ID and their share.

Listing Splits

You can list all Splits that match your filters. Use the after and before parameters to filter by creation date.

Getting a Split

You can get a specific Split by its ID.

Listing Split Logs

You can list all Split Logs to track status changes throughout the transaction lifecycle.

Getting a Split Log

You can get a specific Split Log by its ID.

Split Profile

Split Receiver

Split

Split

Split Profile Overview

Setting up a Split Profile

Parameters

Python

Javascript

PHP

Java

Ruby

Elixir

C#

Go

Clojure

Curl

Python

Javascript

PHP

Java

Ruby

Elixir

C#

Go

Clojure

Curl

Split Receiver Overview

Creating a Split Receiver

Parameters

Python

Javascript

PHP

Java

Ruby

Elixir

C#

Go

Clojure

Curl

Python

Javascript

PHP

Java

Ruby

Elixir

C#

Go

Clojure

Curl

Listing Split Receivers

Parameters

Python

Javascript

PHP

Java

Ruby

Elixir

C#

Go

Clojure

Curl

Python

Javascript

PHP

Java

Ruby

Elixir

C#

Go

Clojure

Curl

Getting a Split Receiver

Parameters

Python

Javascript

PHP

Java

Ruby

Elixir