This page's content:

Payment with Split Page API

You can split a payment between 2 or more recipients.

In order to do this, you need to send an array with the split rules within the payment object.

For each payment rule, the following parameters must be informed:

recipient_code string

Your code representing a recipient identificator.

percentage float

A percentage of amount total value part.. E.g.,: 25

amount float

A amount to send to the recipient. Maximum two decimal places. E.g.,: 55.90

liable boolean

If is responsible for chargebacks. The rule is at least one recipient is responsible or all of them.

charge_fee boolean

If you will be charged for a fee.

To split a payment between the recipients some rules must be respected:

  • Only one of the values ​​(amount or percentage) must be sent in all split rules. If more than one value is sent, the request is denied.
    • If percentage is used, the sum of all split rules must be equal to 100%.
    • If using amount, the sum of all amounts should be the same as the amount informed in payment amount_total value.
  • At least one of the recipients should be responsible for any chargebacks.
  • At least one of the recipients must be responsible for the charge fee.
  • Eventual fees and receivables remainders of division will be credited to the first recipient in the split array.

An skeleton of split rules for more than one recipient with percentage parameter:

An skeleton of split rules for more than one recipient with amount parameter:

Boleto Bancário – Split

An example of payment with split rules for more than one recipient:

Credit card – Split

An example of payment with split rules for more than one recipient: