Objects Overview
Each object in the CorePro API is intended to offer the appropriate level of visibility for functionality related to that object. However, we strive to maintain a level of consistency across all objects to make using the CorePro API as a whole a pleasant experience.
Common Properties
Property | Summary | Notes |
---|---|---|
customerId |
CorePro-generated unique Id for a customer . |
Used by almost every single route in CorePro. It is reccommended you store this in your system as well. |
tag |
A unique identifier for that object in your system. |
|
{object}Id |
The CorePro-generated unique identifier for {object} |
An integer returned when a /{object}/create or /{object}/initiate route is called. May be 32- or 64-bit, see specific route for details |
Common Actions
Action | Summary | Notes |
---|---|---|
/{object}/create |
Creates a new {object} in CorePro |
{object} will be created and is immediately available for use |
/{object}/initiate |
Initiates creation of a new {object} in CorePro |
|
/{object}/verify |
Verifies creation of a new {object} in CorePro |
|
/{object}/deactivate |
Permanently deactivates a specific {object} in CorePro |
|
/{object}/get |
Retrieves a single {object} based on a CorePro-generated {object}Id |
|
/{object}/getByTag |
Returns a single instace of an {object} based on the tag supplied when /{object}/create or /{object}/initiate was called |
|
/{object}/list |
Returns a list of {object} s based on supplied parameter(s) |
|