6

API Docs

Last Update há 11 dias

Virtual Account Nigerian Transfers Rate Limiting Web Hooks Card Charge

Split Payment

splitting transaction in different sub-wallet account

Charles

Last Update há 3 meses

Introduction

Split payments enables a merchant to split the transaction amount(fee included) into different sub-wallets during transaction initialization. With this option merchant can specify where the money goes into. 

There are 2 types of splits: 

FLAT: This type of split is specified using a flat fee from the original transaction amount.

PERCENTAGE: This type of split is specified using a percentage on the original transaction amount 

How to Initialize a split transaction

Sub-Wallet

Before a transaction can be splitted, a sub wallet account needs to be created. A sub wallet is simply an additional wallet that can hold funds. To create a sub-wallet, invoke the create sub wallet endpoint from the api reference documentation.

  • The currency should be NGN. Only NGN is currently supported

  • The settlementBankId is the bankId of any nigerian bank. The list of banks can be fetched from the bank endpoint

  • The settlementAccountName and the settlementAccountNumber is your bank account information and it should be accurate
Ensure the settlement account details provided is accurate, we will not be liable for payouts to the wrong account

After creating a sub-wallet, a unique tagName is returned. The tagName is what is specified in the splitPayment array during initialize transaction.

Splitting Transaction

To split a transaction, merchant must specify a splitPayment array with the split information in the init transaction endpoint. These information are: subWalletTagName, splitType and splitAmount.
  • The subWalletTagName is the tagName of the subwallet returned during sub-wallet account creation. Ensure that the correct subWallet tagName is used and created with your own credentials.

  •  The splitType can be FLAT or PERCENTAGE. If the splitType is FLAT, then a flat amount should be specified in the "splitAmount" property. If the splitType is PERCENTAGE, then the % value is specified in the "splitAmount" property. Note, the splits cannot exceed the original amount. For example, if you the amount is N1000 and in the splitPayment array, you have "splitType" set to FLAT and splitAmount set to N2000, the split payment would not be successful.

  • The splitAmount is the amount to the splitted. The splitAmount is deducted from the original amount and settled in the merchant sub-wallet and the remaining original amount get settled in the merchant main wallet.

At the end of the day, all balance in the merchant wallet and sub-wallet would be settled in their respective merchant settlement bank accounts.

Was this article helpful?

0 out of 0 liked this article

Still need help? Message Us