Documentation Powered by ReDoc

Secuconnect API (2.0.0)

Download OpenAPI specification:Download

Authentication

oauth_token

Authorization header with Bearer token

Security Scheme Type HTTP
HTTP Authorization Scheme Bearer

Smart Transactions

In difference to a Payment Transaction, a Smart Transaction covers a wider range of use cases. It is also more connected to the business case than to the many details of the payment process. And it is the basis for Smart Checkout and Payment Link.

Smart Transactions can be used for e-commerce and cross channel scenarios, to integrate customer loyalty programmes at the POS, etc., etc. It is not predetermined to a specific payment method, and will manage the Payment Transaction for you.

Find Smart Transactions

Returns the Smart Transactions matching the given criteria.

Authorizations:
oauth_token
query Parameters
count
integer
Example: count=20

The maximum number of items to return

offset
integer
Example: offset=0

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, all others will be filtered out. Nested properties can be accessed with this notation: prop1.prop2.

q
string
Example: q=card.cardnumber:92760044

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;
  • desc descending.
aggregate
object (Aggregate)

Aggregation summarizes your data.

meta
any
Enum: "true" "only"

return field definitions

validate
any
Value: 1

Check syntax of a query string

scroll_expire
string
Example: scroll_expire=1m

How long it should keep the “search context” alive?

scroll_id
string
Example: scroll_id=DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==

Identifier of a previous search context.

preset
string
Example: preset=own

Query presets

Responses

200

Matching Smart Transactions

default

Response related to the error

get/Smart/Transactions

Production environment

https://connect.secucard.com/api/v2/Smart/Transactions

Testing environment

https://connect-testing.secupay-ag.de/api/v2/Smart/Transactions

Staging environment

https://connect-showcase.secupay-ag.de/api/v2/Smart/Transactions

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "value":
    {