search

Merchant balance to Fiat

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

1

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

{
    "USD": 761
}
2

hashtag
Call Get currenciesarrow-up-right:

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

3

hashtag
Call Get order limits with:

  • depositPaymentChannel: "merchant_balance"

  • depositCurrencyType: "merchant_balance"

  • depositCurrencyCode: "USD"

  • payoutPaymentChannel: "bank"

  • payoutCurrencyType: "fiat"

  • payoutCurrencyCode: "NGN"

Example response
{
    "deposit": {
        "min": 1,
        "max": 500,
        "minUsd": 1,
        "maxUsd": 500
    },
    "payout": {
        "min": 1412,
        "max": 705782,
        "minUsd": 1,
        "maxUsd": 500
    }
}

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.

4

hashtag
Call Create quote:

Example request
{
  "deposit": {
    "paymentChannel": "merchant_balance",
    "currencyType": "merchant_balance",
    "currencyCode": "USD",
    "amount": 100
  },
  "payout": {
    "paymentChannel": "bank",
    "currencyType": "fiat",
    "currencyCode": "NGN",
    "countryIsoCode": "NG"
  }
}

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)

5

hashtag
Create the order via Create order:

6

hashtag
Call Confirm order:

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

Example request

{
  "orderId": "692ef363ee270426b27cd0b6"
}
7

hashtag
The system validates the deposit and processes payout.

8

hashtag
Use Get order to track status until " payout_successful".

PreviousFiat to Merchant balanceNextCrypto to Merchant balance

Last updated