Splits (pass-through)
API Documentation · Zypher Global
Introduction
Authentication
Sandbox
PIX charge (BRL)
SPEI charge (MXN)
USDT charge
PIX withdrawal (key)
BR Code withdrawal
SPEI withdrawal (MXN)
USDT withdrawal
Splits (pass-through)
Check Balance
Convert Currency
Query Transactions
Webhooks
Error handling
Splits automatically forward part of a cash-in net amount to other accounts on the platform. Send the splits field in the cash-in body, it works in every enabled currency, and in BOTH modes (dynamic by amount AND fixed key/CLABE with open amount).
How to send
"splits": [
{ "username": "usuario1", "percentage": 10 },
{ "username": "usuario2", "percentage": 5 }
]
Rules
- Each item has
username(destination user on the platform) andpercentage(percentage of the net amount). - The total sum of percentages, considering Dashboard + payload, cannot exceed 90%. If it does, ALL splits are ignored and 100% of the net stays in the origin account.
- They are applied to the NET amount (after the fee), at the very moment the cash-in is confirmed, each destination into its own balance.
- Cash-out does NOT accept splits (inflow only).
By currency
- BRL — forwarded in reais, into the destination BRL balance (net after the PIX fee).
- MXN — forwarded in pesos, into the destination MXN balance (net after the SPEI fee).
- USDT — the split is on the credited USDT, into the destination USDT balance (applied when the on-chain deposit confirms).
In both modes
- Dynamic charge (with
amount): the splits apply only to THAT payment. - Fixed PIX key / CLABE (without
amount): the splits are BOUND to the key and applied on every payment it receives. Resendingsplitsin a new call updates the key rule.
The cascade rule and cap (90%) apply the same in both modes. Details of each flow in Cash In · Charges.
Was this page helpful?
