Sandbox helpers

Top up sandbox balance

Credits the business's Payout wallet, or its Fee or Collection wallet with walletType: FEE or DEPOSIT, with the specified amount and currency. This endpoint is only available in the sandbox environment and will return a 403 Forbidden response in production. Use it during integration development to top up your test balance without making real transfers.

post/api/v1/org/balance/topup

Request

Base URL
https://sandbox.api.afriex.com
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/afriex/apis/afriex-business-api/docs/api/v1/org/balance/topup/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

amountnumber double required

A positive number representing the amount to credit.

currencystring required

Uppercase 3-letter ISO 4217 currency code (e.g. USD, NGN, GBP). Must be a supported Afriex currency.

walletType'DEPOSIT' | 'WITHDRAW' | 'FEE'

The wallet to credit. When omitted, the Payout (WITHDRAW) wallet is credited. Use FEE to top up the wallet that settles transaction fees, or DEPOSIT for the Collection wallet.

Example request

{
  "amount": 500,
  "currency": "USD"
}

Response

Balance successfully topped up. Returns the created transaction record.

Example response

{
  "data": {
    "meta": {
      "failureReason": {
        "code": "AFX_VELOCITY_LIMIT_EXCEEDED"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.