Split Payments
"Split Payment" is the Splitting of a Deposit Amount to multiple (2 or more) different Merchant Accounts. The Deposit can be a Guest Payment or a Technical Account Payments, and it's Status must be "Captured".
The "Split Payment" will only become Booked to the Merchant Account once the "Captured" Deposit does.
Create the Split Payments
We use a Guest Payment directed to the "Transition Account", with a "Captured" Amount of 50.00 EUR and Transaction Reference "q1W2e3E4t5Y6u7I8o9P0". The Amount will be split between the "1st Merchant" and the "2nd Merchant".
The "Captured" Deposit's Transaction Reference must be specified in the "depositReference" parameter
KC-Debit Account Request (1st Merchant)
Of the 50.00 EUR directed to the Transition Account (the "TRANSITION-DE-0000" Account) we forward 20.00 EUR to the 1st Merchant (the "MERCHANT-DE-1111" Account) using the 1.121 KC-Debit Account API method.
Path:
PUT {baseURL}/payment/kc-debitAccount
Header:
Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=
{
"partnerReference": "DEV-SVR001-DE_SPLIT-PAY-TRA-001",
"depositReference": "q1W2e3E4t5Y6u7I8o9P0",
"merchantProgramCode": "ACMEPROG",
"merchantAccno": "MERCHANT-DE-1111",
"programAccno": "1234567890",
"accno": "TRANSITION-DE-0000",
"accnoType": "00",
"paymentAmount": 20.00,
"paymentCurrCode": "EUR",
"paymentUsage": "Split-Pay-Transition-001",
"useDifferentBillingAddress": false,
"localDate": "2019-12-31",
"localTime": "235959"
}
KC-Debit Account Response
Status Code:
200 (OK)
Header:
Content-Type: text/plain
Accept-Language: en-US
{
"uniqueReference": "a1B2c3D4e5F6g7H8i9J0",
"accno": "TRANSITION-DE-0000",
"programAccno": "1234567890",
"merchantAccno": "MERCHANT-DE-1111",
"merchantProgramCode": "ACMEPROG"
"paymentAmount": 20.00,
"paymentCurrCode": "EUR",
"paymentUsage": "Split-Pay-Transition-001",
"fxRate": 1.0,
"statusCode": "CAPTURED",
"partnerReference": "DEV-SVR001-DE_SPLIT-PAY-TRA-001",
"localDate": "2019-12-31",
"localTime": "235959",
"sysDate": "2019-12-31",
"sysTime": "225959",
"responseCode": "0000",
"responseDescription": "Successful execution.",
"additionalInformation": {
"requestId": "aff2728481a181dc36daedc14055b516"
}
}
KC-Debit Account Request (2nd Merchant)
With 30.00 EUR remaining to the Transition Account (20.00 EUR already forwarded to the 1st Merchant) we can forward this amount to the 2nd Merchant (the "MERCHANT-DE-2222" Account).
Path:
PUT {baseURL}/payment/kc-debitAccount
Header:
Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=
{
"partnerReference": "DEV-SVR001-DE_SPLIT-PAY-TRA-002",
"depositReference": "q1W2e3E4t5Y6u7I8o9P0",
"merchantProgramCode": "ACMEPROG",
"merchantAccno": "MERCHANT-DE-2222",
"programAccno": "1234567890",
"accno": "TRANSITION-DE-0000",
"accnoType": "00",
"paymentAmount": 30.00,
"paymentCurrCode": "EUR",
"paymentUsage": "Split-Pay-Transition-002",
"useDifferentBillingAddress": false,
"localDate": "2019-12-31",
"localTime": "235959"
}
KC-Debit Account Response
Status Code:
200 (OK)
Header:
Content-Type: text/plain
Accept-Language: en-US
{
"uniqueReference": "q1A2z3W4s5X6e7D8c9R0",
"accno": "TRANSITION-DE-0000",
"programAccno": "1234567890",
"merchantAccno": "MERCHANT-DE-2222",
"merchantProgramCode": "ACMEPROG"
"paymentAmount": 30.00,
"paymentCurrCode": "EUR",
"paymentUsage": "Split-Pay-Transition-002",
"fxRate": 1.0,
"statusCode": "CAPTURED",
"partnerReference": "DEV-SVR001-DE_SPLIT-PAY-TRA-002",
"localDate": "2019-12-31",
"localTime": "235959",
"sysDate": "2019-12-31",
"sysTime": "225959",
"responseCode": "0000",
"responseDescription": "Successful execution.",
"additionalInformation": {
"requestId": "aff2728481a181dc36daedc14055b516"
}
}
The "Split Payment" will only become Booked to the Merchant once the "Captured" Deposit does
Any number of "Split Payments" can be made, up to the Full Amount of the "Captured" Deposit