Reset all sandbox data for your business (destructive)

DELETE

/api/v1/sandbox/reset

Sandbox

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Reset complete

Body

🟠400Bad Request

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE '/api/v1/sandbox/reset' \
--header 'x-business-id;' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "confirm": true
}'

Response Example

200 - sample

{
    "success": true,
    "message": "Sandbox data reset successfully",
    "deleted": {
        "transactions": 10,
        "invoices": 2,
        "paymentLinks": 1,
        "settlements": 0
    }
}

Modified at 2025-09-15 21:23:04

Get sandbox environment info

Start the sandbox transaction simulator