API Overview Resources Schemas

External accounts

Access to external accounts

Get account id by external id

Returns account id given by account external id

GET /orgs/{org_id}/external-accounts/{account_external_id}

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
account_external_id	path	string	true	External id of account to return

Request example

1
2
3
4
5



curl -X GET https://customers.sta.masstack.com/v4/orgs/telco/external-accounts/214748364 \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
200	OK	successful operation	AccountId
400	Bad Request	Invalid request body	ErrorResponse
401	Unauthorized	Unauthorized	ErrorResponse
403	Forbidden	Forbidden resource	ErrorResponse
404	Not Found	Resource not found	ErrorResponse
409	Conflict	Conflict	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
503	Service Unavailable	Service unavailable	ErrorResponse
504	Gateway Time-out	Repository timeout	ErrorResponse

Get all contracts by account external id

Returns all contracts by account external id

GET /orgs/{org_id}/external-accounts/{account_external_id}/contracts

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
account_external_id	path	string	true	External id of account to return

Request example

1
2
3
4
5



curl -X GET https://customers.sta.masstack.com/v4/orgs/telco/external-accounts/214748364/contracts \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
200	OK	successful operation	Contracts
400	Bad Request	Invalid request body	ErrorResponse
401	Unauthorized	Unauthorized	ErrorResponse
403	Forbidden	Forbidden resource	ErrorResponse
404	Not Found	Resource not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
503	Service Unavailable	Service unavailable	ErrorResponse
504	Gateway Time-out	Repository timeout	ErrorResponse

Get active contract by account external id

Returns active contract by account external id

GET /orgs/{org_id}/external-accounts/{account_external_id}/contracts/active

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
account_external_id	path	string	true	External id of account to return

Request example

1
2
3
4
5



curl -X GET https://customers.sta.masstack.com/v4/orgs/telco/external-accounts/214748364/contracts/active \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
200	OK	successful operation	Contract
400	Bad Request	Invalid request body	ErrorResponse
401	Unauthorized	Unauthorized	ErrorResponse
403	Forbidden	Forbidden resource	ErrorResponse
404	Not Found	Resource not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
503	Service Unavailable	Service unavailable	ErrorResponse
504	Gateway Time-out	Repository timeout	ErrorResponse

Endpoints

Accounts

External accounts

Customers

External customers