API Release Notes

Upcoming changes

Legend

INFO there is no concrete release date yet, please get in contact with us to get more details

SOON these changes will be released within the next 2-4 weeks

NEXT these changes will be released within the next days

List of Upcoming changes

Date

Description

Adjustments to API integration

Adjustments to business process

INFO

We are looking for API users who like to use a JavaScript- or Typescript-SDK to get feedback for a new secuconnect-SDK for these programming languages.



INFO

A new payment method called "eps Überweisung" will be available via the smart transaction endpoints.



INFO

A new payment method called "giropay" will be available via the smart transaction endpoints.



SOON

Internal major-update of our system environments.


There will be a short maintenance window announced where transactions could fail or the system is not reachable. (The time range will be in the late evening.)

SOON

A new payment method called "Ratenkauf by easyCredit" will be available via the smart transaction endpoints.



SOON

The endpoint POST Payment/Secupaypayout will allow to specify an order_id for each item in the transaction_list.



Latest changes

Date

Description

Adjustments to API integration

Adjustments to business process

22.09.2022

A new element "purpose" will be added to the GET Loyalty/Transactions endpoints.



22.09.2022

Push-Notifications for partial refunds will be send for the main payment transaction.

When the application receives a push notification for a payment transaction, the application should check for a changed status and also for new related_transactions (of ref_type_id: 19) as the status will change only if there is a complete refund.


Sample response of GET /payment/transactions/PCI_...

"object": "payment.transactions",
"id": "PCI_79RJHWF6AGQ59KDTA9V0S9E9X60QOX",
"merchant": {...},
"related_transactions": [
{
"object": "payment.transactions",
"id": "PCI_2CE2MDVAW64NANVTJVT0WPW90E63OX",
"hierarchy": "child",
"ref_type_id": 19,
"ref_type_raw": "Gutschrift / Refund",
"trans_id": 21314564
}
],
"trans_id": 21313900
"product": "Payment in advance",
"status": 6,
"status_text": "abgeschlossen",
...


31.08.2022

If the given push_url begins with https:// the server needs to send a valid certificate, which can be validated correctly.

Make sure that the application does not use self-signed certificates and that all required intermediate certificates are also send by the server.

You can use https://www.sslshopper.com/ssl-checker.html or a similar service to check the server settings.




2022

Date

Description

Adjustments to API integration

Adjustments to business process

02.08.2022

New endpoints Smart/Articles to setup articles for the terminal application.



19.07.2022

The new endpoint POST General/Contracts/GCR_.../terminate can be used to dismiss a specific (sub-)contract.

To use this functions an update of the SDK would be necessary.


04.07.2022

The all endpoints of Loyalty/Beacons and Loyalty/Checkins has been removed, as they were deprecated and not in use anymore.



30.06.2022

The endpoint POST Smart/Transactions/STX_.../prepare returns a more accurate error message if the basket_sum is 0.


30.06.2022

The endpoint POST Smart/Transactions got a new parameter "accrual", which allows to set the accrual-flag individually for each transaction.

The payload for create Smart Transaction can contain:

"payment_context": {
"accrual": true,
}


28.06.2022

The endpoint GET /Payment/Transactions/me/CrowdFundingData/MRC_... got new response fields.

If you are using our SDKs you need to update to the newest version.

If you are using a customized integration this would be a sample of the new response:

{
"project": {
"currency": "CHF",
"debit": {
"count": 0,
"amount": 0
},
"credit_card": {
"count": 27,
"amount": 464000
},
"prepay": {
"count": 17,
"amount": 205000
},
"sofort": {
"count": 0,
"amount": 0
},
"twint": {
"count": 123,
"amount": 1251500
}
},
"deposited_amount": 2002000,
"paid_out": 1982000,
"deducted_amount": 8000,
"open": {
"total": 12000,
"outside_cancellation_period": {
"total": 8900
},
"inside_cancellation_period": {
"total": 3100,
"debit": 500,
"credit_card": 0,
"prepay": 2000,
"sofort": 0,
"twint": 600
}
}
}


13.06.2022

The endpoint POST Payment/PaymentSecupaydebits will now return the error "Payment method not available (for this customer)" (Code 3006) when the scoring logic denies to complete the transaction.

It's now the same behavior as for the endpoint POST Payment/PaymentSecupayinvoices. No adjustments are necessary.


03.05.2022

Validation rules will be extended for the parameter reason at the endpoint POST Payment/Transactions/PCI_.../cancel:

  • maximum of 100 valid chars

  • valid chars:

    • a - z

    • A - Z

    • 0 - 9

    • special characters: / ? : ( ) . , ' + -

    • spaces

In order to avoid validation errors from the secuconnect API, your application needs to filter or replace other characters from the input.

Allowed Characters:

regular expression
[0-9a-zA-Z .,+\-:?()\/']*

Additional information: https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best


03.05.2022

Validation rules will be extended for the parameter nationality at the endpoint POST Payment/Contracts/.../requestId and POST Payment/Contracts/.../clone:

  • ISO 3166-1 alpha-2

  • One of the iso_code from the endpoint GET Public/Website/me/AvailableCountries

The application should send correct values or skip this input field.


03.05.2022

New Input fields are added to the endpoint POST Loyalty/MerchantCards/MRC/createMerchantcards to send additional information of the related customer.

To use this functions an update of the SDK would be necessary.


03.05.2022

The payment methods sofort and paypal will also allow loyalty transactions within the checkout of a smart transaction with assigned smart device.



04.04.2022

In order to simplify the API (by removing not used functions), the endpoint POST Payment/Contracts/.../requestId will NOT allow to send a CNT_... ID instead of the contact data anymore.

Your implementation MUST NOT use any CNT_... IDs (which is normally the case).


24.03.2022

The endpoints of the Smart/Transactions will also pass non-numeric article numbers.



21.03.2022

Google Pay and Apple Pay support for payment containers and smart transactions.



14.03.2022

The endpoints for Payment/Contracts will only provide GCR-IDs.
The endpoints will still work with existing PCR-IDs but they will not create or return new PCR-IDs anymore.

If you validate the IDs you need to adjust your validation rules to allow "GCR_..." values too.


08.03.2022

The application_context in the Smart Transaction object allows now to send details about the used shop plugin to for a better integration/customer support.


If you are a vendor of shop plugin please get in contact with us to get more details about this feature.

01.03.2022

There is a new endpoint POST Payment/Transactions/PCI_.../increaseAmount to change the amount for existing prepay transactions.


It's now possible to change the amount for an open (not paid) prepaid transaction, f.e. in case the payer wants to add something afterwards, or want to change the shipping method.

23.02.2022

The endpoint GET Services/Identcontracts will return some new fields, to support external Post-Ident settings.

The endpoint POST Services/Identrequests will allow the new provider type "post_ident_extern".



08.02.2022

The endpoints for Smart/Transactions will also provide the payment_links if there was no customer data given.


The payment customer data could be collected within the checkout process on the smart checkout page.

26.01.2022

revision of the endpoints "Services/Ident..."

The request and response elements has been changed and needs to be adjusted.


18.01.2022

The endpoint PUT Payment/Transactions/.../shippingInformation now also accepts the "order_id" to provide the order number in case it is not yet available at the time of submission.



18.01.2022

The product PayPal via secupay changes its name to PayPal Collecting in order to achieve a uniform name for similar products.

The endpoint POST General/Contracts/GCR_.../GetAvailablePaymentMethods then returns a new value PayPal instead of PayPal via secupay.

The endpoint GET Payment/Transactions/ is also affected by this and now returns the name PayPal Collecting.


05.01.2022

The endpoint GET /Payment/Transactions/me/CrowdFundingData/MRC_... now returns the currency and other payment types such as PayPal.




2021

Date

Description

Adjustments to API integration

Adjustments to business process

30.11.2021

The Smart Transaction object now contains the creditcard_schemes activated on the contract (e.g. VISA).

To get this additional data in the STX response, an SDK update may be necessary.


25.11.2021

The unused function "Unique Order ID", which could only be used with the POST /Payment/Secupay... endpoints, after prior activation on the access data, will be removed.

-

As a possible alternative, the status query or the search function of the API at the GET /Payment/Transactions endpoint should be used to check whether a transaction with the same order ID exists.

25.11.2021

The unused function "Create demo transactions only", which could only be used with the POST /Payment/Secupay... endpoints, after prior activation on the access data, will be removed.

For demo transactions, the "demo" parameter should always be transmitted when submitting the respective transaction.

As a possible alternative, we can also set up a separate contract and corresponding API access for you with demo payment products only. Or you can use our testing server.

25.11.2021

Unification of the logic for the POST Payment/Contracts/me/RequestId and POST Payment/Contracts/me/clone endpoints

-

-

22.11.2021

The "Warnmail" function is no longer automatically set for new subcontracts as soon as it is no longer active on the main contract.

-

If applicable, the "warning mail" status is no longer set for the first transactions of the subcontracts and no e-mail ("warning mail") is sent for these transactions.


22.11.2021

Improvements in the cancellation/refund of PayPal payments

-

If applicable, further status changes to the payment transactions occur.

18.11.2021

Adjustments to the logic for idempotent operations

If the "X-Action" header is also sent, each further call with the same header value is now delayed by up to 15 seconds, provided the first call has not yet been processed. If the first call has already been processed, the previous result is returned directly without delay as before.


18.11.2021

Correction for the endpoint GET General/Contracts/GCR_.../availableCurrencies, which in rare cases did not return any values.

-

-

18.11.2021

Preventing possible double charging PayPal subscriptions.

-

-

15.11.2021

Changes to the payer-to-merchant redirection for Smart Transactions

-

As soon as the payment has been successfully confirmed (pre-authorised or completed), the redirection to the merchant always takes place via the stored "url_success", even if the payment provider (e.g. PayPal) calls up the error page, e.g. because an attempt was made to confirm the payment twice or the payer accidentally clicked the back button.

15.11.2021

Improvements to Instant Integration

-

-

15.11.2021

Generated shop modules now contain the GCR of the main contract

-

-

15.11.2021

Improvements to the PayPal integration in Smart Checkout

-

-

11.11.2021

Improvements to the PayPal integration (regarding the PayPal webhooks)

-

If applicable, further status changes to the payment transactions occur.

11.11.2021

Improvements in the cancellation/refund of PayPal payments


If applicable, further status changes to the payment transactions occur.