Merchant balance -> Fiat

Let’s do a merchant balance USD deposit to NGN bank payout.

First, call the Get merchant balance endpoint to understand how much money is at your disposal.

{
    "USD": 761
}

Then call Get currencies:

We see that NGN supports deposit and payout. Merchant balance supports both deposit and payout too. So we can do NGN -> Merchant balance USD.

Next, call Get order limits with:

  • depositPaymentChannel: "merchant_balance"

  • depositCurrencyType: "merchant_balance"

  • depositCurrencyCode: "USD"

  • payoutPaymentChannel: "bank"

  • payoutCurrencyType: "fiat"

  • payoutCurrencyCode: "NGN"

We see that the minimum deposit is 1 USD and the maximum is 500 USD, a user can receive from 1412 NGN to 705782 NGN.

Assume the merchant wants to send 100 USD. Reuse the KYC requirements checklist to confirm the customer has passed the appropriate tier. With the example rules, this amount again requires the advanced document set before you continue.

Then Create quote:

A user will receive 141156 NGN for 100 USD of merchant balance. Collect these fields:

  • phoneNumber

  • bankCode

  • bankAccountNumber

  • depositSandboxForcedFlow (sandbox optional field to simulate deposit success/failure/underpayment/overpayment)

  • payoutSandboxForcedFlow (sandbox optional field to simulate payout success/failure)

Create the order via Create order:

Then call Confirm order. Its a merchant balance deposit, so no fields are required, your balance will be debited automatically.

Example request

The system validates the deposit and processes payout. Use Get order to track status until " payout_successful".

PreviousFiat -> Merchant balanceNextServers

Last updated