Card

Manage Billing Cards.

Create

Add a credit card.

Cards must be added via the UI which uses the entered CVC and obtains a Stripe token. The last 4 digits of the number are saved.

Endpoint

POST /card/create

Authorized User Role

owner

Request Body

Field	Type	Required	Notes
current	boolean		Current card.
name	string	yes	Card name.
number	string	yes	Card number.
month	string	yes	Card month.
year	string	yes	Card year.
stripeToken	string	yes	Stripe token.

Response

Field	Type
accountId	string
current	boolean
error	string
failures	number
id	string
name	string
number	string
month	string
submitted	date
year	string

Find

Get a list of all the cards added.

Endpoint

POST /card/find

Authorized User Role

admin

Request Body

None.

Query String Options

Field	Type
filter	string
hidden	boolean
index	string
limit	number
log	boolean
next	object
prev	object
where	string

Response

Paged response.

Field	Type	Notes
data	array	A list of cards.
next	string	Paged cursor to use for the next page of items.
prev	string	Pages cursor to use for the previous page of items.

Card

Field	Type
accountId	string
current	boolean
error	string
failures	number
id	string
name	string
number	string
month	string
submitted	date
year	string

Get

Get a card by ID.

Endpoint

POST /card/get

Authorized User Role

admin

Request Body

Field	Type	Required	Notes
id	string	yes	Card ID.

Response

The requested card.

Field	Type
accountId	string
current	boolean
error	string
failures	number
id	string
name	string
number	string
month	string
submitted	date
year	string

Remove

Endpoint

POST /card/remove

Authorized User Role

owner

Request Body

Field	Type	Required	Notes
id	string	yes	Card ID.

Response

Field	Type
accountId	string
current	boolean
error	string
failures	number
id	string
name	string
number	string
month	string
submitted	date
year	string

UpdateCurrent

Endpoint

POST /card/updateCurrent

Authorized User Role

owner

Request Body

Field	Type	Required	Notes
id	string	yes	Card ID.
current	boolean		Current card.

Response

Field	Type
accountId	string
current	boolean
error	string
failures	number
id	string
name	string
number	string
month	string
submitted	date
year	string

GetStripe

Endpoint

POST /card/getStripe

Authorized User Role

admin

Response

None.