Links
Comment on page

Split Payments

Overview

Split Payments, or instructional funding, is a powerful feature that enables merchants and partners to manage their financial transactions efficiently. With Split Payments, you can effortlessly allocate a specified portion of the funds from processing transactions into a designated secondary bank account. This functionality streamlines revenue distribution, making it a valuable tool for various businesses and organizations.

Key Features and Benefits

  • Streamlined Fund Allocation: Split Payments simplify distributing funds, ensuring the right amounts go to the correct accounts. This feature is handy when separating revenue streams or allocating funds for specific purposes.
  • Customization: You have the flexibility to define the precise amounts to be directed to a secondary bank account, allowing you to adapt the allocation strategy to your unique needs.
  • Efficiency and Accuracy: Split Payments reduce the manual effort required to allocate funds, minimizing the risk of errors and ensuring a precise and efficient distribution of financial resources.
  • Improved Financial Management: Gain more control over your finances by effectively segregating revenue streams, which can simplify accounting, reporting, and financial planning.

Getting Started with Split Payments

You must ensure your account is correctly set up to benefit from Split Payments. Please reach out to our support team at [email protected]. They will guide you through the setup process and assist you in configuring Split Payments to suit your specific requirements.
Start using Split Payments today and experience the convenience and efficiency of managing your funds precisely and efficiently.

Who can transfer to whom?

  1. 1.
    Partner → Merchant
  2. 2.
    Partner → Sub-Merchant
  3. 3.
    Merchant → Partner
  4. 4.
    Merchant → Sub-Merchant

Basic parameters

Name
Required
Description
xCommand
Yes
Set to ‘xfer:out
xTransferMerchantId
Yes
The Cardknox MID of the merchant or partner you wish to transfer funds to
xAmount
Yes
The total amount you wish to transfer.
xKey
Yes
Your Cardknox API Key
xVersion
Yes
Gateway API Version
xSoftwareName
Yes
Name of your software
xSoftwareVersion
Yes
The version number of your software
xAllowDuplicate
No
By default, Cardknox rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.
xSupports64BitsRefum
No
True/False value indicating that the user’s system can handle a 64-bit reference number getting returned on request to the transaction.

Sample Request Payload

{
"xkey": "xxxxxxxx8e6772f739c44x8xx36168x24x01xx32",
"xversion": "4.5.9",
"xsoftwarename": "Test",
"xsoftwareversion": "2.0",
"xallowduplicate": "1",
"xamount": "1.50",
"xcommand": "xfer:out",
"xtransfermerchantid": "123"
}

Sample Response

For a complete list of response codes, see the table on the Introduction page.
{
"xResult": "A",
"xStatus": "Approved",
"xError": "",
"xErrorCode": "00000",
"xRefNum": "10112415034",
"xBatch": "21559791",
"xAvsResultCode": "",
"xAvsResult": "Unmapped AVS response",
"xCvvResultCode": "",
"xCvvResult": "No CVV data available",
"xAuthAmount": "1.50",
"xCardType": "Unknown",
"xDate": "10/12/2023 11:28:40 AM",
"xEntryMethod": "Unknown"
}

Reporting

The Cardknox Reporting API enables you to generate transaction reports based on specified parameters, such as date ranges. Reports can be created for single accounts or multiple accounts. See full documentation.

Endpoints

Cardknox reporting API allows you to send the data in FormData and JSON formats.
Add to the base URL any of the following formats to indicate which format you are sending it as:
FormData
/report
https://x1.cardknox.com/report
JSON
/repotjson
https://x1.cardknox.com/reportjson
Request Method
The Cardknox gateway requires the POST method to be used for enhanced security. We do not support the GET method.

Reporting Parameters

post
https://x1.cardknox.com
See the complete Reporting API documentation for filtering and pagination options.