Operators

Retrieve operators

GET

https://partner-api.monta.com

/api/v1/operators

Required scope: operators

Retrieve operators › query Parameters

page

integer · int32

page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

number of items per page (between 1 and 100, default 10)

Default: 10

Retrieve operators › Responses

List of operators that match the criteria

OffsetBasedResponse_76

Operator[] · required

MontaPage.Meta · required

Retrieve third-party integration status for the calling operator

GET

https://partner-api.monta.com

/api/v1/operators/third-party-integrations

Required scope: operators:read
Organization authorization: supported

Retrieve third-party integration status for the calling operator › Responses

Third-party integration status for the calling operator

Status of third-party integrations for the calling operator

ThirdPartyIntegrationsDto

object · required

AllStar integration status

Connect a third-party integration for the calling operator

POST

https://partner-api.monta.com

/api/v1/operators/third-party-integrations

Required scope: operators:write
Organization authorization: supported

Connect a third-party integration for the calling operator › Request Body

Request body for connecting a third-party integration

ConnectThirdPartyIntegrationDto

name

string · enum · minLength: 1 · required

Name of the third-party integration to connect. Currently only allStar is supported.

Enum values:

allStar

Example: allStar

Connect a third-party integration for the calling operator › Responses

Third-party integration connected

No data returned

Retrieve an operator

GET

https://partner-api.monta.com

/api/v1/operators/{id}

Required scope: operators

Retrieve an operator › path Parameters

id

integer · int64 · required

Retrieve an operator › Responses

operator with provided id

Operator

name

string · required

Name of operator

Example: Monta

identifier

string · required

Identifier of operator

Example: monta

id

integer · int64

ID of the operator

Example: 14

partnerId

integer | null · int64

Id of the partner

Example: 1

vatNumber

string | null

VAT number

Example: FOO-123-ABC

Patch an operator

PATCH

https://partner-api.monta.com

/api/v1/operators/{id}

Required scope: operators:write. Only name, email, financeEmail and financeCommunicationEmail may be updated; VAT number, EAN/CIF and logo are read-only via this endpoint.

Patch an operator › path Parameters

id

integer · int64 · required

Patch an operator › Request Body

PatchOperator

name

string | null · maxLength: 191

Updated name of the operator

Example: Monta

email

string | null · email · minLength: 1 · maxLength: 191

Primary contact email for the operator

Example: contact@example.com

financeEmail

string | null · email · minLength: 1 · maxLength: 191

Finance / billing email for the operator

Example: finance@example.com

financeCommunicationEmail

string | null · email · minLength: 1 · maxLength: 255

Recipient for important payment notices (late payment, freeze warning, frozen). When not set, these go to financeEmail.

Example: billing_notices@example.com

Patch an operator › Responses

Updated operator

Operator

name

string · required

Name of operator

Example: Monta

identifier

string · required

Identifier of operator

Example: monta

id

integer · int64

ID of the operator

Example: 14

partnerId

integer | null · int64

Id of the partner

Example: 1

vatNumber

string | null

VAT number

Example: FOO-123-ABC

Retrieve the sub-operators of an operator

GET

https://partner-api.monta.com

/api/v1/operators/{id}/sub-operators

Required scope: operators

Retrieve the sub-operators of an operator › path Parameters

id

integer · int64 · required

Retrieve the sub-operators of an operator › query Parameters

page

integer · int32

page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

number of items per page (between 1 and 100, default 10)

Default: 10

Retrieve the sub-operators of an operator › Responses

Page of sub-operators belonging to the operator

OffsetBasedResponse_76

Operator[] · required

MontaPage.Meta · required

Operator Lists Payment Terminals