Skip to content

Connect any payment provider by its own API description

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.

POST
/v1/payments/connections
curl --request POST \  --url https://api.xovris.ai/v1/payments/connections \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "provider": null, "domain": null, "description": null, "credential": null, "baseUrl": null }'

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

Media typeapplication/json
object
provider
domain
description
credential
baseUrl

Example

{  "provider": null,  "domain": null,  "description": null,  "credential": null,  "baseUrl": null}

Done.

Media typeapplication/json
object

Example generated

{}

Done: something new was made, and the answer is it.

Media typeapplication/json
object
met
required
boolean
provider
required
string
connectionId
required
string
read
required
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

Example

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

Started: the answer says where to follow it.

Media typeapplication/json
object
met
required
boolean
provider
required
string
tried
required
Array<string>
missing
required
Array<string>
next
required
string

Example

{  "met": true,  "provider": "string",  "tried": [    "string"  ],  "missing": [    "string"  ],  "next": "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.