Skip to content

Split Links Documentation

General Information

  • It is now possible to create Payment Links of type: "split".
  • This enables our customers to share the received payment with other SecPaid customers.
  • You can add a recipient to the body of our API requests: This is a JSON object with recipient_token (string) and the relative share (double).

Usage

  • The split link feature allows you to distribute a single payment among multiple recipients.
  • Each recipient receives their share minus the individual service fee set for that recipient.
  • The total amount paid by the customer remains the same, regardless of the split distribution.

Body - Schema

json { "recipients": [ { "token": "recipient_token", "share": 50.00 }, { "token": "another_recipient_token", "share": 50.00 } ], "amount": 100.00, "recipient_note": "Payment for shared services" }

Examples with Calculations

Let's consider three scenarios:

Scenario 1: Equal Split

Customer pays €100. Two recipients, each getting 50%.

json { "recipients": [ { "token": "recipient1_token", "share": 50 }, { "token": "recipient2_token", "share": 50 } ], "amount": 100.00, "recipient_note": "Equal split payment" }

Calculation: - Total amount: €100 - Recipient 1 gets: €50 (minus their service fee) - Recipient 2 gets: €50 (minus their service fee)

Scenario 2: Unequal Split

Customer pays €150. Three recipients with different shares.

json { "recipients": [ { "token": "main_service_token", "share": 60 }, { "token": "addon_service_token", "share": 30 }, { "token": "consultant_token", "share": 10 } ], "amount": 150.00, "recipient_note": "Complex service package" }

Calculation: - Total amount: €150 - Main Service gets: €90 (minus their service fee) - Add-on Service gets: €45 (minus their service fee) - Consultant gets: €15 (minus their service fee)

Scenario 3: Single Recipient (for comparison)

Customer pays €200. One recipient gets 100%.

json { "recipients": [ { "token": "sole_provider_token", "share": 100 } ], "amount": 200.00, "recipient_note": "Full payment to single provider" }

Calculation: - Total amount: €200 - Sole Provider gets: €200 (minus their service fee)

Important Notes

  1. Individual Service Fees: Each recipient's service fee is calculated separately based on their individual agreement with SecPaid. This means that even if recipients receive equal shares, they may end up with slightly different amounts due to varying service fees.

  2. Precision: Due to rounding, small discrepancies may occur in the final distribution. These are handled according to SecPaid's rounding policy.

  3. Minimum Amounts: Ensure that each recipient's share meets the minimum payout threshold after deducting the service fee.

  4. API Usage: When using the API, make sure to include all required fields and validate the total share percentage (should sum to 100%).

  5. Customer Experience: From the customer's perspective, they pay a single amount. The split happens behind the scenes.

By utilizing Split Links effectively, you can create complex payment distributions while maintaining transparency for both customers and recipients. Remember to account for individual service fees when calculating expected payouts.