Payment API

Commissions

Payment Facilitator

SplitPay®

DOWNLOAD

One of the great features ProPay offers Payment Facilitators is the ability to "split" a portion of the funds from a card transaction to another ProPay Account. This is perfect for convenience fee merchants, or to provide a way for Payment Facilitators to collect their fees. SplitPay causes that a portion of funds collected as part of a credit or debit card transaction is moved from the original processing account to a second ProPay account at the time the transaction is "settled" to the first. A second transaction is created at that time, but the cardholder only sees an authorization that takes place to move money from his or her credit card to the account of the original merchant. (The merchant sees both transactions.)

You Control the Split Amount

ProPay does not require that you pre-configure a split amount, or do any setup prior to making the SplitPay call. Instead, you are given the flexibility of specifying the amount when you instruct our system to provision the split. You do so by specifying both the SplitPay destination account number, and the amount of the secondary transaction. This flexibility is only subject to the limitation defined by original transaction amount less ProPay's own processing fees.

Complexity Surrounding SplitPay Reversals and Chargebacks

The most challenging aspect of your creating a SplitPay program will be how you deal with the eventual need to handle refunds, voids, and the chargebacks that will inevitably occur.

Your sales representative can provide you with advice on how to handle SplitPay reversals. Because there are several nuances to this, we ask that you reach out and consult prior to our offering up the appropriate API methods associated with what you intend to accomplish.

Multiple Options for the SplitPay "Flow" on your Website

There are a few ways to implement SplitPay in your transaction flow, and the mechanism you use will depend greatly on the interfaces you initially use to process credit and debit card transactions. Here are some of the most common approaches to implementing SplitPay:

  1. Users of either the ProtectPay or ProPay APIs can integrate a single SplitPay API call that allows you to specify processing account, split recipient account, processing amount, and split amount. This method is only appropriate for those users who are comfortable managing their own PCI DSS compliance as it does not utilize one of the ProtectPay Payer Management Interfaces.
  2. Users of the ProtectPay Hosted Payment Page or ProtectPay Seamless Payment Interface can configure either interfaces only to store payment information and issue a token. Those users can then switch to option 1 to process the transaction as an all-in-one SplitPay.
  3. Users of the ProtectPay Hosted Payment Page or ProtectPay Seamless Payment Interface can configure either interface to process a credit card transaction. This process returns a unique transaction identifier. The user can then subsequently "split" fund from a transaction. This subsequent "split" will complete upon settlement and perform the split portion of SplitPay. The following code example is based on this third option.

Example Requests and Responses

How to call this method:

HTTP URL's
HTTP Method PUT
HTTP Header Authorization
Example Request
Example Response
Versions: | |
Method Implementation
Versions: |
Method Implementation
Versions: | |
Method Implementation
Dependencies
Versions: | |
Method Implementation Header
Method Implementation
Request Submission
Versions: | |
Method Implementation
Request Submission
Versions: |
Method Implementation
Request Submission
Versions:
Method Implementation
Request Submission
Version:
Method Implementation
Request Submission
Request Values
Element Type Max Required Notes
accountNum Integer Required ProPay account identifier. This is the "from" account and the account upon which the cc transaction was initially performed.
recAccntNum Integer Required ProPay account identifier. This is the account to which the split will be sent when the transaction settles.
amount Integer Required The amount to be split off to the secondary account when the transaction settles.
transNum Integer Required ProPay transaction identifier. It is when this transaction settles that the timed pull will occur.
invNum String 50 Optional Optional Invoice Number for external tracking.
comment1 String 120 Optional Optional Comment Line 1.
comment2 String 120 Optional Optional Comment Line 2.
Response Values
Element Type Notes
accountNum Integer The accountNum of the original merchant.
status String See section 4 for explanation of each status.
transNum Integer Transaction identifier for the recipient's account.
Data from ProPay, Inc PCI documentation.