Checking Account

This is our smart account where the funds will be held in custody.

Create an Account

POST/api/v1/checking-account

Authorization

JWT

Body

application/json

networkenum

The network on which the account will be deployed

ethereum_mainnetethereum_goerlipolygon_mainnetpolygon_mumbaicelo_alfajores

contractIdstring

The ID of the contract that will govern the Checking Account

splitConfigall of

The contracts split configuration

receiveCurrency*string

The currency in which the account will receive payments

addressAllowedOrignarray of string

The addresses of the crypto wallets that can send money to the Checking Account

isOffchain*boolean

Parameter that defines whether a Checking Account is off-chain or not

Response

201

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('/api/v1/checking-account', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "receiveCurrency": "text",
      "isOffchain": false
    }),
});
const data = await response.json();

Get detailed Account info

GET/api/v1/checking-account/{id}

Authorization

JWT

Path parameters

id*string

Response

200

Request

JavaScriptCurl

const response = await fetch('/api/v1/checking-account/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Get info from all of your Accounts

GET/api/v1/checking-account

Authorization

JWT

Query parameters

Response

200

Request

JavaScriptCurl

const response = await fetch('/api/v1/checking-account', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Get balance

GET/api/v1/checking-account/{id}/balance

Authorization

JWT

Path parameters

id*string

Query parameters

Response

200

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('/api/v1/checking-account/{id}/balance', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Withdrawn funds from an Account

POST/api/v1/checking-account/withdraw

Authorization

JWT

Body

application/json

id*string

Id of the Checking Account from which the withdrawal will be made

receiveAddress*string

Id of the address to which the funds will be sent (it must be one of the payees in the split configuration)

tokenAddressstring

Address of the token that will be transferred if its not a native currency of the network

Response

201

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('/api/v1/checking-account/withdraw', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "receiveAddress": "text"
    }),
});
const data = await response.json();

Update an Account

PATCH/api/v1/checking-account/{id}

Authorization

JWT

Path parameters

id*string

Body

application/json

deployedboolean

contractAddressstring

activeboolean

Response

200

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('/api/v1/checking-account/{id}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Cancel an account​

DELETE/api/v1/checking-account/{id}

Authorization

JWT

Path parameters

id*string

Response

200

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('/api/v1/checking-account/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();