Secuconnect API (2.0.0)

Download OpenAPI specification:Download

Authentication

oauth_token

OAuth2 information

Security Scheme Type	OAuth2
clientCredentials OAuth Flow	Token URL: https://connect.secucard.com/oauth/token Scopes: `https://scope.secucard.com/e/smartdevice` - smart devices `https://scope.secucard.com/e/api` - shops and marketplaces `https://scope.secucard.com/e/app.main/secucard` - secuoffice `https://scope.secucard.com/e/app.mobile/secucard/user` - secucard mobile app

General Merchants

Contains all settings that are universally valid for the merchant. One merchant can have multiple contracts, and multiple stores.

GET General/Merchants

Get a list of general merchants

Authorizations:

oauth_token

query Parameters

count	integer The maximum number of items to return
offset	integer The position within the whole result set to start returning items (zero-based)
fields	string Example: fields=prop3,prop1.prop2 List of fields to include in the result. Nested properties can be accessed with this notation: `prop1.prop2`.
q	string A query string to restrict the returned items to given conditions. The query string must consist of any combination of single expressions in the form `property:condition`. Property names can be nested like `property.property`. Example: `customer.name:Meier` A condition may contain: `?` as wildcard for one character; `` as wildcard for any number of characters. You can also use value ranges in the form `[min TO max]`. Example: `customer.age:[30 TO 40]` You can combine expressions logically by `expr AND expr` and `{expr} OR {expr}`. You can also negate an expression using `NOT {expr}`. Parenthesis `(...)` can be used to control precedence. Example: `(NOT customer.name:meier) AND (customer.age:[30 TO 40] OR customer.age:[50 TO 60])`
sort	string Example: sort=contact.surname:asc,contact.companyname:desc String with comma separated pairs of `field:order`. Options for order: `asc` ascending; `dsc` descending.

Responses

200

Returns a list of general merchants

default

Response related to the error

get/General/Merchants

https://connect.secucard.com/api/v2/General/Merchants

Response samples

200
default

Content type

application/json

Copy

Expand all Collapse all


{"count": 1,
"data": 
[
{"object": "module.type",
"id": "OBJ_MNTPQ9IFD3V482Y6VMHJXERBYS4J1G",
"id_old": "2345678",
"type": "21",
"user": 
{"object": "general.merchant",
"id": "GCR_xxx",
"name": "Max Mustermann",
"companyname": "Musterfirma GmbH",
"address": 
[
{"type": "string",
"address_components": 
[
{"long_name": "string",
"short_name": "string",
"types": 
["string"
]
}
],
"address_formatted": "string",
"geometry": 
{"lat": "string",
"lon": "string"
}
}
]
},
"parent": 
{"object": "module.type",
"id": "OBJ_MNTPQ9IFD3V482Y6VMHJXERBYS4J1G",
"type": "21"
},
"assigned_by": 
[
{"object": "module.type",
"id": "OBJ_MNTPQ9IFD3V482Y6VMHJXERBYS4J1G",
"owner": false
}
],
"invited_by": 
[
{"object": "module.type",
"id": "OBJ_MNTPQ9IFD3V482Y6VMHJXERBYS4J1G",
"invited": "..."
}
],
"legal_details": 
[
{"url": "https://shop.example.com/privacy+policy",
"type": "policy",
"content_type": "application/pdf",
"language": "de"
}
],
"urls": 
[
{