Deposit Accounts

Use the bank-income endpoint to retrieve the account details where your merchant should send funds to top up its balance.

Endpoint

GET /api/v1/organizations/{organizationId}/merchants/{merchantId}/bankIncome/accounts

This endpoint returns deposit instructions that vary by country and provider.

What You Receive

Depending on the country, the response can contain:

a virtual account number or CLABE/CVU-style identifier
an alias when supported
a routing number for US funding flows
fixed beneficiary bank details for some countries

Typical Funding Flow

Fetch deposit instructions

Retrieve the merchant’s current funding details from the bank-income endpoint.

Send the bank transfer

Initiate the transfer from your treasury or operations bank account.

Wait for balance credit

Once the transfer settles, the merchant balance becomes available for PAYOUT, transfers, or crypto operations.

Verify balances

Confirm the funds with the balances endpoints before creating downstream orders.

Example


curl -X GET 'https://api-sandbox.koywe.com/api/v1/organizations/YOUR_ORG_ID/merchants/YOUR_MERCHANT_ID/bankIncome/accounts' \
  -H 'Authorization: Bearer YOUR_TOKEN'

GET /api/v1/organizations/{organizationId}/merchants/{merchantId}/accounts/balances
GET /api/v1/organizations/{organizationId}/balances

Use the merchant balances endpoint for execution decisions and the organization balances endpoint for a consolidated treasury view.

Best Practices

Do not cache deposit instructions indefinitely; fetch current details when building an operational workflow.
Match the merchant and organization IDs you use for funding with the same ones you use for downstream payouts.
Wait for confirmed balance credit before creating balance-dependent flows such as PAYOUT or ONRAMP.