API Reference

Split of Settlements

The Settlement Split is the solution that divides a transaction into parts (recipients) so that each participant in the sale receives their respective amount.
This feature makes sense when we think about business models such as marketplaces: platforms that connect different merchants to countless buyers in a single environment.

How to enable it?

  1. The company must be registered internally in our platform as a Marketplace type.

VTEX

To enable it in VTEX, you need to go to "Gateway Affiliations" and select:

example 1

Examples

A situation will be presented below to explain how a settlement split calculation is executed:

In this example, there will be a Marketplace and two registered Sellers.

  1. The marketplace is registered with a 10% service fee and a transaction fee of 0.80.
  2. Seller X will have a registered commission of 16%
  3. Seller Y will have a registered commission of 20%

The cart will contain products from Seller X, Seller Y, and the Marketplace. Then it will be sent with the values below:

  • 69.90 for the Marketplace
  • 87.12 for Seller X
  • 42.60 for Seller Y

The total purchase amount will be 199.62

Example where everyone is configured to pay the fees

Capture

Seller

Total amount

Commission

Recipient amount

Pagaleve service fee

Intermediate amount

Pagaleve transaction fee

Transfer amount

Marketplace

69.90

69.90 + (13.94 + 8.52) = 92.36

9.24

83.12 (46.27%)

0.37

82.75

Seller X

87.12

13.94

73.18

7.32

65.86 (36.66%)

0.29

65.57

Seller Y

42.60

8.52

34.08

3.41

30.67 (17.07%)

0.14

30.53

Total service fee: 19.96
Total transaction fee: 0.80 Total Pagaleve fees: 20.76 Total commissions paid: 22.46

Refund

In this example, Seller X requested a refund of 10.00

SellerTotal amountCommissionRecipient amountPagaleve service feePagaleve transaction feeTransfer amount
Marketplace1.600.1601.44
Seller X10.001.608.400.8407.56

Billing variables (chargeProcessingFee and chargebackLiable)


example 2

Example of billing variables configuration in VTEX

The billing variables are the two variables responsible for enabling or disabling the charging of fees.

The chargeProcessingFee enables/disables charges on payment transactions, and the chargebackLiable enables/disables charges on refund transactions.

Although these variables can disable the charging of fees for a specific recipient, these fees must be charged to another recipient in the same transaction. To allow this behavior, we have a sequence of rules to evaluate who is the charged recipient. See the rules below in order of priority:

  1. The first rule is to try to get the marketplace (there must be only one) that has the respective billing variable enabled. Again, if it is a payment transaction, it will evaluate chargeProcessingFee, otherwise chargebackLiable. All unpaid fees must be charged to it.
  2. If a marketplace with the billing variable enabled is not found, the second rule will try to find some recipient (a seller, since the marketplace has already been evaluated) with this state. All unpaid fees will be charged to them.
  3. If the two other rules fail, the last rule will make the first recipient on the merchant list responsible for the charges. All unpaid fees must be charged to them.

Examples with billing variables in different combinations (Capture)

The marketplace and only one seller pay the fees

Seller

Total amount

Commission

Recipient amount

Pagaleve service fee

Intermediate amount

Pagaleve transaction fee

Transfer amount

Responsible for fees

Marketplace

69.90

69.90 + (13.94 + 8.52) = 92.36

9.24

92.36 - 9.24 - 7.32 = 75.80 (42.19%)

0.34

75.80 - 0.34 - 0.32 = 75.14

Yes

Seller X

87.12

13.94

73.18

7.32

73.18 (40.73%)

0.33

73.18

No

Seller Y

42.60

8.52

34.08

3.41

34.08 - 3.41 = 30.67 (17.07%)

0.14

30.53

Yes

Only the marketplace pays the fees

Seller

Total amount

Commission

Recipient amount

Pagaleve service fee

Intermediate amount

Pagaleve transaction fee

Transfer amount

Responsible for fees

Marketplace

69.90

69.90 + (13.94 + 8.52) = 92.36

9.24

92.36 - 9.24 - 7.32 - 3.41 = 72.39 (40.29%)

0.32

72.39 - 0.80 = 71.59

Yes

Seller X

87.12

13.94

73.18

7.32

73.18 (40.73%)

0.33

73.18

No

Seller Y

42.60

8.52

34.08

3.41

34.08 (18.97%)

0.15

34.08

No

Only the sellers pay the fees

Seller

Total amount

Commission

Recipient amount

Pagaleve service fee

Intermediate amount

Pagaleve transaction fee

Transfer amount

Responsible for fees

Marketplace

13.94 + 8.52 = 22.46

22.46 (19.28%)

0

22.46

No

Seller X

87.12

13.94

73.18

7.32 + 2.25 = 9.57

73.18 - 7.32 - 2.25 = 63.61 (54.46%)

0.59

63.61 - 0.44 - 0.15 = 63.02

Yes

Seller Y

42.60

8.52

34.08

3.41

34.08 - 3.41 = 30.67 (26.26%)

0.21

30.67 - 0.21 = 30.46

Yes

Examples with billing variables in different combinations (Refund)

SellerTotal amountCommissionRecipient amountPagaleve service feePagaleve transaction feeTransfer amountResponsible for fees
Marketplace1.600.1601.60 - 0.16 - 0.84 = 0.60Yes
Seller X10.001.608.400.8408.40No