Read your Stripe payments health
What you can call today
Every example here runs against api.xovris.ai with a key from your account’s settings. GET /v1/health and GET /v1/public/status answer without one.
const url = 'https://api.xovris.ai/v1/stripe';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.xovris.ai/v1/stripe \ --header 'Authorization: Bearer <token>'A token that can read is enough.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Done.
object
object
object
object
object
object
object
object
Example
{ "connections": [ { "id": "string", "mode": "string", "account": { "id": "string", "name": "string" }, "connectedAt": "string", "lastSyncedAt": "string", "problem": "string" } ], "last24h": { "sales": [ { "currency": "string", "count": 1, "amount": 1 } ], "failedPayments": 1, "disputesOpened": 1, "payoutsFailed": 1, "refunds": 1, "subscriptionsStarted": 1, "subscriptionsCancelled": 1, "invoicesPaid": 1, "invoicesFailed": 1, "reviewsOpened": 1, "earlyFraudWarnings": 1 }, "last7d": { "sales": [ { "currency": "string", "count": 1, "amount": 1 } ], "failedPayments": 1, "disputesOpened": 1, "payoutsFailed": 1, "refunds": 1, "subscriptionsStarted": 1, "subscriptionsCancelled": 1, "invoicesPaid": 1, "invoicesFailed": 1, "reviewsOpened": 1, "earlyFraudWarnings": 1 }, "disputesOpen": 1, "latestFailures": [ { "eventId": "string", "at": "string", "amount": 1, "currency": "string", "reason": "string" } ], "recent": [ { "eventId": "string", "type": "string", "at": "string", "amount": 1, "currency": "string", "status": "string", "alerted": true } ], "accounts": [ { "connectionId": "string", "readAt": "string", "balance": { "available": [ { "amount": 1, "currency": "string" } ], "pending": [ { "amount": 1, "currency": "string" } ] }, "subscriptions": { "active": 1, "mrr": [ { "currency": "string", "amount": 1 } ], "floor": true }, "negative": true } ], "invoices": { "latestFailures": [ { "invoice": "string", "at": "string", "amount": 1, "currency": "string", "attempt": "string", "subscription": "string" } ] }, "radar": { "reviewsOpen": [ { "review": "string", "connectionId": "string", "payment": "string", "reason": "string", "openedAt": "string" } ], "earlyFraudWarnings": [ { "warning": "string", "charge": "string", "fraudType": "string", "at": "string" } ] }, "empty": "string"}Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}Signed in, but this token or role may not do this. The answer names the permission it needs.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}Nothing with that id here, or it belongs to another workspace. Nothing was changed.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}default
Section titled “default”Any other refusal or failure. The answer says what happened and what to do next.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}Your data is never used to train our AI. How your data is kept
A problem is called fixed only once it works again. How each fix is checked
XOVRIS LTD, registered in England and Wales, company number 17499910. Registered office: 66 Paul Street, London EC2A 4NA.