Skip to main content
GET
Get merchant funding

Overview

Returns the merchant’s funding setup status, permanent NGN collection account, supported crypto wallet deposit addresses, and current NGN settlement preference. Merchant funding deposits top up the merchant withdrawal balance. By default, NGN funding deposits are converted to USD at the current rate and credited to withdrawal_balance_usd. Merchants that operate in Naira can opt into NGN_BALANCE; future NGN deposits are then retained and credited directly to withdrawal_balance_ngn without FX conversion. Use PATCH /v1/merchant/funding/settlement-destination to change this merchant-level preference. In sandbox, every merchant is treated as verified and receives an active Base funding address. Use the returned data.id with POST /v1/sandbox/deposits, set funding_account_scope to MERCHANT, and send an X-Idempotency-Key header to simulate funding the merchant balance safely. Include currency: NGN and a positive amount to credit the sandbox NGN withdrawal balance.

Authentication

string
required
Your merchant API key

Request Example

Response

object
required
Merchant funding details.

Notes

  • Merchant funding surfaces include a permanent NGN virtual account plus crypto deposit addresses.
  • Sandbox merchant funding returns a Base address and an account id that can be used with the sandbox deposit simulation endpoint.
  • USD_BALANCE is the default for existing and new merchants, preserving automatic NGN-to-USD conversion.
  • NGN_BALANCE retains future NGN deposits in withdrawal_balance_ngn without using an FX rate.
  • The preference applies at merchant level, not per deposit. Changing it does not alter deposits that are already settled.
  • Successful funding credits trigger an email notification to the merchant.