Sandbox: act as the customer
Sandbox keys only. start moves the session as if the customer opened the link; submit as if they sent the funding request. The customer.request_started and customer.request_submitted events fire as they would live.
AuthorizationBearer <token>
An access token from POST /oauth/token. Valid for one hour. Preferred, because a leaked request log then exposes an hour rather than a permanent credential.
In: header
Path Parameters
id*string
The session id.
Match
^ses_[0-9a-f]{24}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
Shell
curl -X POST "https://sandbox.capvant.com/sessions/string/simulate" \ -H "Content-Type: application/json" \ -d '{ "event": "start" }'JSON
{ "id": "string", "object": "session", "status": "open", "environment": "live", "market": "UK", "partner_customer_id": "string", "launch_url": "string", "expires_at": "2019-08-24T14:15:22Z", "prefilled": [ "string" ], "asks_for": [ "string" ], "business": { "legal_name": "string", "company_number": "string", "ein": "string" }, "request": { "id": "string", "submitted_at": "2019-08-24T14:15:22Z" }, "return_url": "string", "created_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z", "submitted_at": "2019-08-24T14:15:22Z", "cancelled_at": "2019-08-24T14:15:22Z"}