Simulations

Sandbox-only APIs for simulating time-sensitive events during testing and integration. Use these endpoints to trigger scenarios like offer expiry without waiting for real timers.

Trigger a simulated action

post

https://api-sandbox.todaypay.mehttps://api.todaypay.mehttps://api-staging.todaypay.tech

/v2/simulations

Sandbox only. Triggers a simulated event or state transition identified by action. Use this endpoint to drive your integration through states that would otherwise require real-world timing or external actors (e.g. waiting for an offer to expire).

The payload object is action-specific. Each supported action is documented below under SimulationAction.

Authorizations

basicAuth

AuthorizationstringRequired

Basic authentication — Username: apiKeyID, Password: apiSecret

Body

application/json

actionstring · enumRequired

Identifies which simulation to run. Treat this as an open enum — new actions will be introduced without a breaking version bump.

Action	Description
instarefund-offer-expiry	Immediately expires an instarefund® offer, causing it to transition to an expired state as if its expires_at timestamp had been reached.

Example: instarefund-offer-expiryPossible values:

Responses

200

Simulation triggered successfully

application/json

statusstringRequiredExample: success

actionstringRequired

The action that was simulated.

Example: instarefund-offer-expiry

messagestringOptional

Human-readable description of what was triggered.

Example: Instarefund offer iro_a1b2c3 has been expired.

400

Bad request — unknown action, missing required payload fields, or the target resource is not in a state that allows the simulation (e.g. the offer has already expired or been claimed).

application/json

401

Unauthorized

403

Forbidden — this endpoint is not available outside the sandbox environment.

404

The resource referenced in payload (e.g. the instarefund offer id) was not found.

application/json

post

/v2/simulations

HTTPcURLJavaScriptPython

POST /v2/simulations HTTP/1.1
Host: api-sandbox.todaypay.me
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "action": "instarefund-offer-expiry",
  "payload": {
    "id": "iro_a1b2c3"
  }
}

{
  "status": "success",
  "action": "instarefund-offer-expiry",
  "message": "Instarefund offer iro_a1b2c3 has been expired."
}