Checking Account
This is our smart account where the funds will be held in custody.
Create an Account
post
Authorizations
Body
networkstring · enumOptionalPossible values:
The network on which the account will be deployed
contractIdstringOptional
The ID of the contract that will govern the Checking Account
splitConfigall ofOptional
The contracts split configuration
receiveCurrencystringRequired
The currency in which the account will receive payments
addressAllowedOrignstring[]Optional
The addresses of the crypto wallets that can send money to the Checking Account
isOffchainbooleanRequired
Parameter that defines whether a Checking Account is off-chain or not
Responses
201Success
application/json
Responseobject
post
POST /api/v1/checking-account HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 171
{
"network": "ethereum_mainnet",
"contractId": "text",
"splitConfig": {
"payees": [
"text"
],
"shares": [
1
]
},
"receiveCurrency": "text",
"addressAllowedOrign": [
"text"
],
"isOffchain": true
}
201Success
{}
Get detailed Account info
get
Authorizations
Path parameters
idstringRequired
Responses
200Success
get
GET /api/v1/checking-account/{id} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
200Success
No content
Get info from all of your Accounts
get
Authorizations
Query parameters
takenumberOptionalDefault:
36
skipnumberOptionalDefault:
0
Responses
200Success
get
GET /api/v1/checking-account HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
200Success
No content
Get balance
get
Authorizations
Path parameters
idstringRequired
Query parameters
receiveAddressstringOptional
payeeIdstringOptional
Responses
200Success
application/json
Responseobject
get
GET /api/v1/checking-account/{id}/balance HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
200Success
{}
Withdrawn funds from an Account
post
Authorizations
Body
idstringRequired
Id of the Checking Account from which the withdrawal will be made
receiveAddressstringRequired
Id of the address to which the funds will be sent (it must be one of the payees in the split configuration)
tokenAddressstringOptional
Address of the token that will be transferred if its not a native currency of the network
Responses
201Success
application/json
Responseobject
post
POST /api/v1/checking-account/withdraw HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"id": "text",
"receiveAddress": "text",
"tokenAddress": "text"
}
201Success
{}
Update an Account
patch
Authorizations
Path parameters
idstringRequired
Body
deployedbooleanOptional
contractAddressstringOptional
activebooleanOptional
Responses
200Success
application/json
Responseobject
patch
PATCH /api/v1/checking-account/{id} HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 56
{
"deployed": true,
"contractAddress": "text",
"active": true
}
200Success
{}
Cancel an account
delete
Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
Responseobject
delete
DELETE /api/v1/checking-account/{id} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
200Success
{}
Last updated