Open a vault, or have back the one with this reference

POST

/v1/vaults

curl --request POST \
  --url https://api.sotirea.com/v1/vaults \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "reference": "example" }'

Opens a vault with an address on every network of your environment; nothing touches a network until it is first paid out of. Give a reference, your own id such as your customer’s, to open one vault per customer: the same reference again answers that vault, 200, and the same reference with a different name is refused 409. A new vault is answered 201.

Authorizations

• bearer

Request Body^required

Media typeapplication/json

object

name

What to call the vault, at most 80 characters. Without it, the reference names it.

string

reference

Your own id for the vault, 1 to 128 characters with no spaces, unique in your organisation.

string

Example ^generated

{
  "name": "example",
  "reference": "example"
}

Responses

200

The reference already named a vault, so that vault is answered, unchanged.

Media typeapplication/json

object

data

required

object

addresses

required

Where to pay the vault, one address per network.

Array<object>

object

address

required

string

chain_id

required

The network, in CAIP-2 form, like eip155:1.

string

chain_name

required

string

paused

required

The network is not available right now: money sent here is still credited, but do not show this address to be paid until it is available again.

boolean

created_at

required

string format: date-time

id

required

integer

name

required

string

reference

required

Any of:

string

string

null

null

meta

object

request_id

Quote it when asking about a request; it is in the X-Request-Id header too.

string

success

required

Example

{
  "success": true
}

201

Done.

Media typeapplication/json

object

data

required

object

addresses

required

Where to pay the vault, one address per network.

Array<object>

object

address

required

string

chain_id

required

The network, in CAIP-2 form, like eip155:1.

string

chain_name

required

string

paused

required

The network is not available right now: money sent here is still credited, but do not show this address to be paid until it is available again.

boolean

created_at

required

string format: date-time

id

required

integer

name

required

string

reference

required

Any of:

string

string

null

null

meta

object

request_id

Quote it when asking about a request; it is in the X-Request-Id header too.

string

success

required

Example

{
  "success": true
}

default

Refused or failed, in words a person can act on.

Media typeapplication/json

object

error

required

object

code

required

string

fields

object

key

additional properties

string

message

required

string

meta

object

request_id

Quote it when asking about a request.

string

success

required

Example

{
  "success": false
}