Skip to content

Read every connected payment provider's sales, failed payments, disputes and payouts

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.

GET
/v1/payments/connections
curl --request GET \  --url https://api.xovris.ai/v1/payments/connections \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

Done.

Media typeapplication/json
object
providers
required
Array<object>
object
connectionId
required
string
provider
required
string
title
required
string
read
required
One of:
object
rung
required
string
Allowed values: first_data read_back
grant
required
object
granted
required
One of:
Array<string>
readFrom
required
One of:
string
sales
required
One of:
object
kind
required
string
count
required
number
total
required
One of:
number
currency
required
One of:
string
failed
required
One of:
object
count
required
number
latest
required
Array<object>
object
id
required
One of:
string
state
required
string
at
required
One of:
string
unplaced
required
Array<string>
disputes
required
One of:
object
kind
required
string
count
required
number
payouts
required
One of:
object
kind
required
string
count
required
number
failed
required
number
refunds
required
boolean
failure
required
One of:
string
at
required
string
empty
required
One of:
string

Example

{  "providers": [    {      "connectionId": "string",      "provider": "string",      "title": "string",      "read": {        "rung": "first_data",        "grant": {          "granted": [            "string"          ],          "readFrom": "string"        },        "sales": {          "kind": "string",          "count": 1,          "total": 1,          "currency": "string"        },        "failed": {          "count": 1,          "latest": [            {              "id": null,              "state": null,              "at": null            }          ]        },        "unplaced": [          "string"        ],        "disputes": {          "kind": "string",          "count": 1        },        "payouts": {          "kind": "string",          "count": 1,          "failed": 1        },        "refunds": true,        "failure": "string",        "at": "string"      }    }  ],  "empty": "string"}

Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

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.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

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.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Any other refusal or failure. The answer says what happened and what to do next.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Ask Xovris

Open the full page

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.