Balance Transfer

Transfer balance between you and your sub-merchant

Create a Balance Transfer

(1) Setup

As a Platform Merchant, you can initiate a balance transfer to transfer funds from your balance to your sub-merchant's balance or vice versa.

However, the balance must be equal to or greater than the transfer amount, otherwise, the request will get failed.

(2) Fund flow logic

Case 1: Transfer from Platform Merchant to a Sub-merchant

Please request Balance: Transfer API to initiate a balance transfer from you to a sub-merchant.

curl https://komoju.com/api/v1/balances/currency/transfer \
-u degica-mart-test: \
-X POST \
-H "Content-Type: application/json" \
-d '{
    "to": "seller_merchant_id",
    "amount": 300
}'

Fund flow illustration:

Balance Transfer - From Platform Merchant to Sub-merchant

Case 2: Transfer from a Sub-merchant to Platform Merchant

Please request Balance: Transfer API to initiate a balance transfer from a sub-merchant to you.

curl https://komoju.com/api/v1/merchants/{merchant_id}/balances/{currency}/transfer \
-u degica-mart-test: \
-X POST \
-H "Content-Type: application/json" \
-d '{
    "to": "degica-mart-test",
    "amount": 300
}'

Fund flow illustration:

Balance Transfer - From Sub-merchant to Platform Merchant

Summary of transaction record types

Based on all the actions above, some records will be generated. Below is the summary:

Record typeDescriptionDeposit/Debit
Balance TransferThe transfer of account balance between you and your sub-merchantCan be deposit or debit depending on who is the beneficiary.