public.deposits

Create Sandbox Deposit

Creates a mock deposit for an existing funding account for testing purposes. funding_account_scope defaults to CUSTOMER. Set it to MERCHANT when funding_account_id is the id returned by GET /v1/merchant/funding. Merchant simulations accept currency=NGN with a required amount to credit withdrawal_balance_ngn, or currency=USD with an optional amount to credit withdrawal_balance_usd; omitting both preserves the legacy fixed 10 USD simulation. The endpoint uses the selected scope and does not search both account types. Pass scenario to force a deterministic sandbox deposit lifecycle outcome. payout_scenario is only supported for CUSTOMER deposits. Only available in sandbox.

post/v1/sandbox/deposits

Headers

X-Idempotency-Keystring

Required for MERCHANT funding simulations; reuse the same value when retrying a request

Request body

amountstring

currency'USD' | 'NGN'

Merchant funding simulations only. Omit both fields to preserve the legacy fixed 10 USD simulation.

funding_account_idstring required

funding_account_scope'CUSTOMER' | 'MERCHANT'

payout_scenario'DEFAULT' | 'PROCESSING' | 'SETTLED' | 'FAILED'

scenario'DEFAULT' | 'PROCESSING' | 'COMPLETED' | 'REQUIRES_REVIEW' | 'FAILED'

Example request

{
  "amount": "10000",
  "currency": "NGN",
  "funding_account_scope": "CUSTOMER",
  "payout_scenario": "SETTLED",
  "scenario": "COMPLETED"
}

Response

Accepted

deposit_idstring

messagestring

payout_scenariostring

scenariostring

statusstring

Changes

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