Credit test money into an entity's sandbox wallet

POST

/entity-sandbox-fundings

Live-server-facing endpoint that credits test money into the shadow (sandbox) version of one of your entities, so you can simulate having funds available without a real inflow. This endpoint resolves the target shadow entity from your entity_id (and optional sandbox_id), then proxies a single call to the sandbox server's test-money funding primitive using your identity's sandbox master key. No funding state is persisted on the live server — the sandbox server is the source of truth for the resulting balance, and the response body returned here is passed through verbatim from that call.

The authenticated identity must have can_edit_entity (or wildcard *) ACL access on entity_id, and the target sandbox (the one identified by sandbox_id, or the entity's default sandbox if sandbox_id is omitted) must already exist with activation_status completed — sandboxes are provisioned separately via the entity-sandboxes endpoints and can take a moment to activate.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

The sandbox wallet was credited successfully. The response body is passed through verbatim from the sandbox server's funding call.

Bodyapplication/json

🟠400

🟠401

🟠403

Request Example

Shell

JavaScript

Java

Swift

cURL

Required fields only, funding the default sandboxFunding a specific named sandbox, idempotently

curl --location '/entity-sandbox-fundings' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "entity_id": "01HQZR2BKPFQ8MXJVT3G7LWNE",
    "currency": "NGN",
    "amount": 500000
}'

Response Example

201 - Success

{
    "message": "Entity sandbox funding created successfully",
    "status": "success",
    "data": {
        "id": "01J8Z3K9F8YV7Q6R2N4T6W1XYZ",
        "entity_id": "sbx_ent_9f3c7a2b",
        "account_id": "01HQZR9F3K7Q8MXJVT3G7LABC",
        "currency": "NGN",
        "amount": 500000,
        "status": "successful",
        "created": 1735689600000
    }
}

Modified at 2026-09-30 00:29:30

Apply an action to a payout intent's schedule

Reset a shadow entity's sandbox