MasCustomer API v3
I am the MasCustomer API version 3.0.
NOTE: The examples provided here are made up and should not be used for testing purposes. Make sure to change all parameters before attempting to make any request.
Resources
Resource | Description |
---|---|
Customers | Access to customers |
Events | private service to events |
Memos | Gate to access memos information. |
Typifications | Access to ms-typifications api |
Invoices | Access to invoices |
Accounts |
Security
Authentication
All MasStack APIs uses JWT tokens to authorize all the requests. Following this, an Auhtorization
with a Bearer JWT token
is needed in all the requests.
In the Authorization Guides you can find documentation about JWT Tokens and how to get them in MasStack.
Base URLs
Environment | Base Path |
---|---|
staging | https://customers.sta.masstack.com/v3/ |
production | https://customers.masstack.com/v3/ |
Release details
Release Notes * 3.10.0: Add field financed_by new in get devices response inside InstallmentPlan object
- financed_by
-
3.9.1: Add fields new in get devices response
- category_type
- start_date
-
3.9.0: Add endpoint to update invoice delivery mode. updateInvoiceConfiguration
- PATCH /orgs/{orgId}/accounts/{accountId}/invoices
-
3.8.0: Add endpoint to fetch customer typifications. getTypifications
- GET /orgs/{orgId}/customers/{customerId}/typifications
-
3.7.0: Add endpoint to create typifications. postTypifications
- POST /orgs/{orgId}/customers/{customerId}/typifications
-
3.6.0: Delete endpoint to get customer
- Deleted GET /orgs/{orgId}/customers/{customerId}
-
3.5.0: Add endpoint to update account payment method
- New endpoint
- /orgs/{orgId}/accounts/{accountId}/payment-method
- New endpoint
-
3.4.0: Add endpoint to get customer details by customerId
- New endpoint
- /orgs/{orgId}/customers/{customerId}
- New endpoint
-
3.3.0: Change GET devices response
- Adds new field to
- /orgs/{orgId}/customers/{customerId}/devices
- Adds new field to
-
3.2.0: Add endpoint to get customer credentials
- New endpoint
- /orgs/{orgId}/customers/{customerId}/credentials
- New endpoint
-
3.0.4: Bug fix documentation to Memos Api .
- Make query field optional
- Examples with real data
-
3.0.3: Fix devices field name.
- Changed
terminals
field todevices
- Changed
-
3.0.2: Add documentation to Memos Api .
- /orgs/{orgId}/memos
- /orgs/{orgId}/memos/hosttable/{hosttable}
- /orgs/{orgId}/memos/customers/{customerId}
- /orgs/{orgId}/memos/hosttable/{hosttable}/customers/{customerId}
-
3.0.1: Add Memos Api endPoints to access memorandum backend.
- New endpoints
- /orgs/{orgId}/memos
- /orgs/{orgId}/memos/hosttable/{hosttable}
- /orgs/{orgId}/memos/customers/{customerId}
- /orgs/{orgId}/memos/hosttable/{hosttable}/customers/{customerId}
- New endpoints
-
3.0.0: First version to v3
- New endpoint
- /orgs/{orgId}/customers/{customerId}/devices
- New endpoint
More information
More info
Api private to publish events:
- /orgs/{orgId}/event