Your organisation's payment rules

GET

/v1/rules

const url = 'https://api.sotirea.com/v1/rules';
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.sotirea.com/v1/rules \
  --header 'Authorization: Bearer <token>'

The rules every payment is checked against before it is priced, as people in your organisation set them in the console. A rule for one network and asset wins over a general one.

Authorizations

bearer

Responses

200

Done.

application/json

object

data

required

Array<object>

object

allowlist_only

required

Whether money may go only to approved addresses.

boolean

approval_threshold

A payment of this much or more waits for approval.

string

approvals_required

How many people must approve a payment that waits.

integer

asset

required

Native, a token’s contract, or empty for every asset.

string

chain_id

required

The network, or empty for a rule that applies to every network.

string

max_per_transfer

The most one payment may move, in the asset’s smallest unit.

string

max_per_window

The most payments may move together within window_seconds.

string

new_address_wait_seconds

required

How long a newly approved address waits before it can be paid; 0 is off.

integer

template

required

Open, limited, allowlist or dual_control.

string

window_seconds

integer

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.

application/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
}