Search Overlay

Overview

  • Onboarding
  • Payments
  • United States
  • Legacy

The Split Payouts capability enables:

  • Platforms to receive their service fees directly from their merchants' accounts as a part of each transaction
  • Merchants to share and distribute payments among multiple accounts. For example, an educational institution maintains different ledgers for different departments, and wants to split the payment from a transaction between the different ledgers, and thence into the different bank accounts.
  • Merchants to issue refunds/credits and retrieve funds from multiple accounts with which they shared payments.

To be able to use Split Payouts, the platform or merchant must first be linked to the other accounts during onboarding. Platforms are configured with Split Payouts so that when they onboard merchants, the merchant accounts inherit the capability.

Only accounts settling in the same currency can be linked.

Split Payouts can be applied to Purchase (settlement with authorization), Settlement (settlement after authorization) and Refund transactions through the Card Payment API, and for Purchase and Standalone Credit transactions through the Direct Debit API. The payment or refund/credit share allotted to each linked account depends on the Split Payouts values specified in the transaction request, and can be either a fixed amount or a percentage of the total payment.

Split Payouts API Requests

Split Payouts uses the following API requests:

Split Payouts details are also returned when looking up transaction details, as described in the Card and Direct Debit API Reference sections.

For the Card Refund or Direct Debit Standalone Credit, the merchant or platform initiating the transaction needs to specify the splits and the corresponding linked accounts they want these splits retrieved from, if required. In other words, processing a Refund/Standalone Credit without adding any splits in the request will not automatically retrieve any funds from the linked accounts even if the original transaction was a Split Payout.

When Card chargebacks or Direct Debit Returns get posted for a Split Payout transaction, the merchant or platform initiating the transaction needs to transfer the corresponding balances between linked accounts to offset, if required, any portions originally transferred between them through Split Payouts.

Split Payouts Error Scenarios

Certain conditions must be met for a Split Payouts request to be processed successfully; if any of them are not met, an error is returned.

  • Error 5040 is returned if the merchant or platform account initiating the transaction does not have Split Pay enabled.
  • Error 5068 is returned in the following scenarios:
    • The merchant/platform account and a linked account are the same.
    • A linked account is not linked to the specified merchant/platform.
    • Both an amount and a percent are specified for a linked account.
    • Neither an amount nor a percent are specified for a linked account.
    • The total amount (total of amounts and percentages) split is more than the total amount in the transaction.