Release Notes for secuconnect API

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

SOON

Improved Push-Notification system.

(The change is backward compatible)

  • It's possible to provide push notifications for Payment/Payouts objects.

  • It's possible to provide customized push notifications, which f.e. contains the changed data directly.

SOON

The POST Payment/Transactions/{id}/Capture endpoint allows to c apture a pre-authorized credit card transaction with a smaller amount, without having to adjust the amount beforehand.



Latest changes

Date

Description

Adjustments to API integration

Adjustments to business process

16.11.2023

The credit card frame ( https://cc.secupay.com/?view=compact ) now supports small screens/inline-frames.



13.11.2023

New endpoints in Event/Actions to process specific API requests in background/in parallel.



09.11.2023

Assignment of IBANs on a payer base.


Make sure that your application is using the provided payment instructions form the Smart-Transaction or Payment-Transaction, not static values.

This change is available for selected customers as of now.

06.11.2023

The Smart/Transactions endpoint allows to process loyalty transactions if the loyalty card number syntax is different than secucard BIN/EAN.

The idents property could contain numbers which are not starting with 9276 and are longer than 13 digits.


09.10.2023

Internal improvements in the address validation.



09.10.2023

The response of Payment/Invoices contains the currency property.



05.10.2023

Google Pay and Apple Pay are available on the smart checkout pages by default if your contract and the device support it.



27.09.2023

API adjustments to improve the mapping of transactions between PayPal and secupay.

The (existing) property payment_data of the endpoint GET Payment/Transactions will contain the PayPal-Transaction-ID for PayPal transactions.


27.09.2023

The response of Payment/Transactions contains the contract property.



27.09.2023

Internal improvements in the assignment of the property related_transactions of the GET Payment/Transactions endpoint – some rare incorrect assignments will be fixed.



20.09.2023

API adjustments in order to improve the self on-boarding process of merchants by broker.

New property pricing for the endpoint POST Payment/Contracts/.../requestId



2023

Date

Description

Adjustments to API integration

Adjustments to business process

04.09.2023

New property payment_config in GET General/Contracts/GCR_.../IframeOptions



31.08.2023

New property project_name for endpoint GET General/Accounts .



29.08.2023

Invoice payment transactions with demo were accepted without confirmation, this is now fixed.



23.08.2023

The masking method for IBAN was unified.

In some cases the data was masked to "DE91 XXXX XXXX 7700" and now to "DE91 XXXX XXXX XXXX XX77 00" for all cases.


31.07.2023

Integration of a new payment acquirer for GooglePay and ApplePay.



27.07.2023

The property payment_context.merchant_initiated in the Smart Transactions object needs to be enabled in the contract.



26.07.2023

New property invoice_reference for the endpoint POST Payment/Contracts/.../requestId



13.07.2023

New method POST Smart/Transactions/STX_.../start/cashless_direct to be able to create POS payment transactions without smartZVT.



13.07.2023

Customer data from PayPal is fetched and the payment customer is created and added to smart transaction after successful authorisation (/prepare call). This allows to show a summary before final confirmation by the buyer.



05.07.2023

API adjustments for managing (external) SEPA mandates.

New endpoints GET/POST Payment/Mandates.


29.06.2023

Improvements for TWINT: If the payer opens the redirect URL a second time, they are redirected to the given success or failure page, depending on the status of the TWINT transaction. Before, the payer was always redirected to the failure page.



28.06.2023

API adjustments for a new self on-boarding process of merchants by broker.

  • New endpoint GET General/Merchants/me/Merchantcategories

  • New properties for the endpoint POST Payment/Contracts/.../requestId

    • merchant_category

    • tid

    • notes

    • account_statement_text

  • New field description in GET General/Contracts endpoint.


28.06.2023

The endpoints of Smart/Transactions validate the parameter is_demo more strictly.

Sending this parameter as string is no longer allowed. Only boolean is accepted.


28.06.2023

The endpoint Smart/Transactions/STX_.../prepare and Smart/Transactions/STX_.../start validate if all sub-contracts have the payment product enabled.

If you are using mixed baskets you could get an error if the sub-contract does not allow this payment method.


26.06.2023

The property application_context.language of the Smart/Transactions endpoint will be transmitted to PayPal and Sofort.

It's also possible to transmit "de_DE", "de-DE" or "de". So you can use the language of your application directly.


24.05.2023

The Smart/Transaction endpoint uses the PayPal intent AUTHORIZE if the property payment_context.auto_capture is set to false.


This allows to capture the payment up to 29 days, instead of 3 hours after the confirmation.

Please note that we are not doing a re-authorize on PayPal. A fter the three-day honor period, the original authorized payment expires and a capture could fail.

19.05.2023

Internal update of the TWINT integration.

The property iframe_url of the endpoint POST Payment/Transactions contains the direct URL to Saferpay/TWINT.

The process for the payer is now faster and there are less redirects in the browser.

15.05.2023

The parent element/object is included on each merchant element in the API response.



26.04.2023

Live-Sync of Card Processing transactions.


New card processing transactions will now be visible within minutes instead of 2 days.

26.04.2023

More refund transaction types (product id: 93) are available via GET Payment/Transactions endpoint.



05.04.2023

The reference between Payout (POU_...) and Refund transactions (PCI_...) at payment transaction object includes now "related_transactions" with "ref_type_id": 14 ("Abzug von Auszahlung").



03.04.2023

New release of secuconnect/secuconnect-java-sdk

see https://github.com/secuconnect/secuconnect-java-sdk/releases/tag/3.14.0

or https://github.com/secuconnect/secuconnect-java-sdk/blob/3.14.0/CHANGELOG.md


28.03.2023

Introducing "prepayments for API payouts":

  • New endpoints

    • GET General/Contracts/GCR_.../getTransferBalance

    • POST Payment/Transactions/PCI_.../assignTransferBalance

  • New product IDs

  • New relation types in payment.transactions



28.03.2023

Internal update of the TWINT integration.



20.03.2023

New password policy for secuOffice.



13.03.2023

New release of secucard/secucard-connect-php-sdk

see https://github.com/secucard/secucard-connect-php-sdk/releases/tag/1.25.0

or https://github.com/secucard/secucard-connect-php-sdk/blob/master/CHANGELOG.md


06.03.2023

Introducing "debit collecting without payment guarantee":

  • New product IDs

    • debit collecting (ID 459)

    • Returned debit (ID 501)

  • New relation types in payment.transactions

    • ID 19

    • ID 125

It will behave similar to the other debit products in the Smart/Transactions and Payment/Transactions endpoints.


23.02.2023

New release of secuconnect/secuconnect-php-sdk

see https://github.com/secuconnect/secuconnect-php-sdk/releases/tag/2.19.0

or https://github.com/secuconnect/secuconnect-php-sdk/blob/master/CHANGELOG.md


15.02.2023

The endpoint GET /api/v2/Payment/Transactions/PCI_.../checkStatus will return 3 new properties:

  • status_text

  • status_simple

  • status_simple_text



08.02.2023

In order to solve the inaccurate purpose of the amount parameter in the endpoint POST Payment/Transactions/{paymentTransactionId}/cancel this parameter is marked as deprecated. Please use the new reduce_amount_by parameter instead.

Use the new parameter reduce_amount_by, which will deduct the payment by this value.

An empty value will (still) cancel/refund the complete transaction.


31.01.2023

The validation of the endpoint PUT Smart/Transactions/STX_... is extended to avoid invalid transaction data.

Make sure that every time you are updating the smart transaction, the data you send is up to date.


23.01.2023

New release of secuconnect/secuconnect-php-sdk

see https://github.com/secuconnect/secuconnect-php-sdk/releases/tag/2.18.0

or https://github.com/secuconnect/secuconnect-php-sdk/blob/master/CHANGELOG.md


11.01.2023

The validation of the endpoint PUT Smart/Transactions/STX_... was extended. Changing the basket of a payed transaction is no longer possible.



11.01.2023

New release of secucard/secucard-connect-php-sdk to support new PHP versions.

see https://github.com/secucard/secucard-connect-php-sdk/releases/tag/1.24.0

or https://github.com/secucard/secucard-connect-php-sdk/blob/master/CHANGELOG.md


06.01.2023

New release of secucard/secucard-connect-javascript-sdk to remove unneeded dependencies.

see https://github.com/secucard/secucard-connect-javascript-sdk/releases/tag/0.7.0

or https://github.com/secucard/secucard-connect-javascript-sdk/blob/master/CHANGELOG.md


2022

Date

Description

Adjustments to API integration

Adjustments to business process

19.12.2022

New release of secuconnect/secuconnect-php-sdk to support the aggregation features of the API and to add missing Smart/Transaction endpoints.

see https://github.com/secuconnect/secuconnect-php-sdk/releases/tag/2.17.0

or https://github.com/secuconnect/secuconnect-php-sdk/blob/master/CHANGELOG.md


08.12.2022

The endpoint GET /api/v2/Payment/Transactions/PCI_.../checkStatus allows also the old id/hash format:
GET /api/v2/Payment/Transactions/abcdefg123456/checkStatus



07.12.2022

Improved support for PayPal subscriptions with digital goods and a new field name " product_type" in the /Subscription/Plans endpoints.



30.11.2022

The Endpoint Smart/Transactions will allow a new "item_type": " reauthorization".

A new endpoint POST Smart/Transactions/SUB_.../UpdatePaymentContainer is added to update the payment instrument of a subscription (with debit and credit card).



30.11.2022

Unification of the field "object" in push notifications.

Push notifications with the following object will be send in lower case:

  • payments.subscriptions (before Payments.Subscriptions)

  • general.contracts (before General.Contracts)

  • payments.transactions (before Payments.Transactions for PayPal transactions)


The deprecated push notification for "payment.contracts" will be removed, as this one was replaced with the "general.contracts" push notification, which is send out in the same time.


15.11.2022

JAVA and PHP-SDK update

https://github.com/secuconnect/secuconnect-java-sdk/releases/tag/3.13.0

https://github.com/secuconnect/secuconnect-php-sdk/releases/tag/2.16.0



14.11.2022

The endpoint POST Services/Identrequests (and related) will allow the new provider type "3rdParty".



24.10.2022

Push-Notifications for partial amount reduction will be send too.

When the application receives a push notification for a payment transaction, the application should check for a changed amount as the status will change only if there is a complete cancellation.


10.10.2022

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



10.10.2022

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



10.10.2022

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



10.10.2022

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



22.09.2022

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



22.09.2022

Push-Notifications for partial refunds are 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.


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.