Rehive logo
Powered by Redocly

wallet-accounts

List company wallet-accounts

SecurityapiAuth
Request
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/3/admin/wallet-accounts/
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Create company wallet-account

SecurityapiAuth
Request
Request Body schema:
username
string or null <= 200 characters
email
string or null <email> <= 254 characters
mobile
string or null <= 24 characters
name
string or null <= 50 characters
type
string
  • paypal - Paypal
  • venmo - Venmo
  • other - Other
Enum: "paypal" "venmo" "other"
object or null
action
string or null
  • deposit - Deposit
Enum: "deposit" null
archived
boolean
Default: false
Responses
201
post/3/admin/wallet-accounts/
Request samples
{
  • "username": "string",
  • "email": "user@example.com",
  • "mobile": "string",
  • "name": "string",
  • "type": "paypal",
  • "metadata": {
    },
  • "action": "deposit",
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve company wallet-account

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Responses
200
get/3/admin/wallet-accounts/{id}/
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update company wallet-account

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Request Body schema:
username
string or null <= 200 characters
email
string or null <email> <= 254 characters
mobile
string or null <= 24 characters
name
string or null <= 50 characters
type
string
  • paypal - Paypal
  • venmo - Venmo
  • other - Other
Enum: "paypal" "venmo" "other"
object or null
action
string or null
  • deposit - Deposit
Enum: "deposit" null
archived
boolean
Default: false
Responses
200
put/3/admin/wallet-accounts/{id}/
Request samples
{
  • "username": "string",
  • "email": "user@example.com",
  • "mobile": "string",
  • "name": "string",
  • "type": "paypal",
  • "metadata": {
    },
  • "action": "deposit",
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Partially update company wallet-account

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Request Body schema:
username
string or null <= 200 characters
email
string or null <email> <= 254 characters
mobile
string or null <= 24 characters
name
string or null <= 50 characters
type
string
  • paypal - Paypal
  • venmo - Venmo
  • other - Other
Enum: "paypal" "venmo" "other"
object or null
action
string or null
  • deposit - Deposit
Enum: "deposit" null
archived
boolean
Default: false
Responses
200
patch/3/admin/wallet-accounts/{id}/
Request samples
{
  • "username": "string",
  • "email": "user@example.com",
  • "mobile": "string",
  • "name": "string",
  • "type": "paypal",
  • "metadata": {
    },
  • "action": "deposit",
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Delete company wallet-account

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Responses
200
delete/3/admin/wallet-accounts/{id}/
Response samples
application/json
{
  • "status": "sucess"
}

List company wallet-account currencies

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/3/admin/wallet-accounts/{id}/currencies/
Response samples
application/json
{}

Create company wallet-account currency

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Request Body schema:
required
currency
required
string
Responses
201
post/3/admin/wallet-accounts/{id}/currencies/
Request samples
{
  • "currency": "string"
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve company wallet-account currency

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
id
required
string^\d+$
Responses
200
get/3/admin/wallet-accounts/{id}/currencies/{code}/
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Delete company wallet-account currency

SecurityapiAuth
Request
path Parameters
code
required
string^\w+$
id
required
string^\d+$
Responses
200
delete/3/admin/wallet-accounts/{id}/currencies/{code}/
Response samples
application/json
{
  • "status": "sucess"
}
➔ Next to webhook-tasks