Skip to main content

Documentation Index

Fetch the complete documentation index at: https://stabyl.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Simulation endpoints are available only outside production. Use them to test integration behavior without moving real funds.
EndpointPurpose
POST /simulate/fiat/depositsCredit a test NGN fiat deposit
POST /simulate/fiat/withdrawalsCreate a test fiat withdrawal transaction
POST /simulate/crypto/depositsCredit a test USD stablecoin deposit
POST /simulate/crypto/withdrawalsCreate a test stablecoin withdrawal transaction
POST /simulate/kyb/statusSet a test user’s KYB status
POST /simulate/notifications/product-updatesInsert a test product update notification
Simulated withdrawals are sandbox records for integration testing. Production withdrawals are initiated from the Stabyl Pro web account, not through the API.

​
How To Use Simulation Safely

Simulation is for exercising your client behavior:
  • deposit credit handling
  • transaction timeline reconciliation
  • failed or pending record handling
  • KYB-gated flows in staging
  • notification rendering and delivery tests
Do not reuse simulation payloads as production assumptions. Production money movement can have additional timing and review states.

​
Example Stablecoin Deposit Simulation

curl https://api-staging.stabyl.com/v1/simulate/crypto/deposits \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "email": "ops@example.com",
    "chain": "tron",
    "asset": "USDT",
    "amount": "25.00"
  }'
After creating a simulated deposit, read wallet transactions and verify that your system upserts the record by transaction ID.

​
Example Fiat Deposit Simulation

curl https://api-staging.stabyl.com/v1/simulate/fiat/deposits \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "email": "ops@example.com",
    "amount": "50000.00",
    "currency": "NGN"
  }'

​
Required Headers

Simulation endpoints are public in non-production environments. Send Content-Type: application/json for JSON request bodies.

​
Common Failures

StatusMeaning
400Request body is invalid
403Simulation is not available in the current environment
404Referenced test account or resource was not found
Use simulation responses to verify your reconciliation and notification handling before production access.