GET
/
api
/
v1
/
safe
/
config
Retrieve Safe Configuration
const url = 'https://api.gnosispay.com/api/v1/safe/config';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}, body: undefined};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
{
  "hasNoApprovals": false,
  "isDeployed": true,
  "address": "0xabcdef1234567890abcdef1234567890abcdef12",
  "tokenSymbol": "EURe",
  "fiatSymbol": "EUR",
  "accountStatus": 0,
  "accountAllowance": {
    "balance": "1000000000000000000",
    "refill": "2000000000000000000",
    "period": "86400",
    "nextRefill": "1633046400"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Successfully retrieved Safe configuration.

​
hasNoApprovals
boolean

Indicates whether the safe has no approvals.

Example:

false

​
isDeployed
boolean

Indicates whether the safe is deployed.

Example:

true

​
address
string | null

The address of the safe, if available.

Example:

"0xabcdef1234567890abcdef1234567890abcdef12"

​
tokenSymbol
string | null

The token symbol associated with the safe.

Example:

"EURe"

​
fiatSymbol
string | null

The fiat symbol derived from the token symbol.

Example:

"EUR"

​
accountStatus
enum<integer>

The integrity status of the account.

Possible values:

  • Ok (0): The account is in good standing with no issues
  • SafeNotDeployed (1): The Safe account has not been deployed yet
  • SafeMisconfigured (2): The Safe account has configuration issues
  • RolesNotDeployed (3): The Roles module has not been deployed
  • RolesMisconfigured (4): The Roles module has configuration issues
  • DelayNotDeployed (5): The Delay module has not been deployed
  • DelayMisconfigured (6): The Delay module has configuration issues
  • DelayQueueNotEmpty (7): The Delay queue contains pending transactions
  • UnexpectedError (8): An unexpected error occurred during validation
Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8
Example:

0

​
accountAllowance
object

The allowance details for the account.