Once the collana pay app has been successfully installed, all the necessary settings can be made in the collana pay Setup.
collana pay supports the three salutation types masculine, feminine and undefined. If more salutation types are configured in Business Central, these must be mapped to the three collana pay salutation types in the setup.
Environment
| API Version | Specifies which API version of collana pay should be used. collana pay supports two API versions: api and api/v2. The API version should be set to "api/v2" ("api" is the previous version). |
|
API Key |
An API key (Application Programming Interface) is a code used to identify and authenticate the tenant in collana pay. The code is generated automatically when the tenant is set up. This API key is required for all communication between the collana pay service platform and the collana pay application for Microsoft Business Central. Each customer has its own API key. This is normally not changed. |
| Callback Type | Specifies which format for callbacks should be send to collana pay. The value depends on the set up codeunit in the webservice (5516495 for SOAP, 5516518 for ODataV4). For BC SaaS ODataV4 should be set, because SOAP is no longer supported. For BC onPremise SOAP can still be an option. It is still recommended to set up the ODataV4 webservice and use it instead of SOAP. Remember to change the 'Callback URI' when changing this value. |
| Callback URI | The callback URI is the address of Business Central to which the (return) messages from collana pay are sent. A separate callback URI is assigned per tenant. In Business Central SaaS, a basic authentication (with username and password) is no longer permitted. Communication between the collana pay service platform and the collana pay application is exclusively asynchronous. Therefore, a callback URI is required for the notification that the service platform receives from the payment service providers and forwards to Business Central in processed form. |
| Use Authentication Id | Activates authentication with an authentication id. In a Business Central SaaS environment, basic authentication with username and password is no longer allowed. Instead, oAuth 2.0 authentication must be used. After this is set up, this option should be used in conjunction with a valid "authentication id" (sandbox or production). |
| Sandbox Mode | Specifies if you want to work in a sandbox environment. A sandbox is a safe environment for testing, that means it is a non-productive environment. When the sandbox mode is active, you work in a test environment. |
| Sandbox Base URL | The sandbox base URL for the collana pay service platform. https://sandbox.collanapay.com |
| Sandbox Authentication Id | Specifies the authentication id in the test environment. In a Business Central SaaS environment, basic authentication with username and password is no longer allowed. Instead, oAuth 2.0 authentication must be used. The Sandbox authentication id field appears once the slider in the Use Authentication id field is enabled. In the same step, the Sandbox username and Sandbox password fields are hidden. The authentication id is currently created and transmitted by a request to collana hive GmbH. |
|
Productive Base URL |
The productive Base URL of the collana pay service platform. https://live.collanapay.com |
|
Productive Authentication Id |
Specifies the authentication id in the live environment. In a Business Central SaaS environment, basic authentication with username and password is no longer allowed. Instead, oAuth 2.0 authentication must be used. The productive authentication id field appears once the slider in the Use Authentication id field is enabled. In the same step, the productive username and productive password fields are hidden. The productive authentication id is available after setting up authentification in the collana pay admin portal. |
Payment Methods
| Payment Method Code | Specifies the code for the respective form of payment that is authorised for transactions with collana pay. The payment forms must be created in the overview of payment forms. |
| Transaction Import Status | Indicates the status of a transaction started in the webshop for the respective payment method during import. "Not authorized" means that the reservation of the amount has not been made and must be initiated. "Authorized" means that the amount has already been reserved. The capture takes place at the time configured under "Capture". "Captured" means that the amount has already been captured when the information is retrieved from collana pay. |
| Use collana pay Importer |
Specifies if the collana pay importer should use the flag notification required or not. When selected, collana pay needs already a notification for some payment provider before the import is used. If collana pay has not yet received a notification, the import will be rejected. Further information on the connection types: |
|
Use Notification Required Flag |
Gibt an, ob der collana pay Importer die erforderliche Flag-Benachrichtigung verwenden soll oder nicht. Wenn diese Option ausgewählt ist, benötigt collana pay bereits eine Benachrichtigung für einen Zahlungsanbieter, bevor der Import verwendet wird. Liegt bei collana pay noch keine Benachrichtigung vor, wird der Import abgelehnt. |
| Use Net Amounts | Specifies if the calculation of the amount is with net amounts instead of gross amounts |
| Capture | Specifies when the capture (e.g. debiting the amount from the credit card) should take place. "Manually" means that the capture request is triggered manually in the backend (e.g. for clarification cases). "Release" means that the capture request is triggered when the sales order is released. The entire amount is captured here. "Posting" means that the capture request is triggered when the order is posted. Here, only the amount is captured from the items that are actually dispatched. "Job" means that the order can be posted and a capture entry with the status "New" is created until a job (job queue entry) in the background triggers the capture request at a later time. |
| Refund / Credit | Specifies when the refund/credit-call should be done. This can be processed manually, when the sales credit is posted, or by a job. |
| Start Payment in BC | Specifies if this payment method can start a payment process within Business Central. If activated, you can manually start a payment process from the sales order or sales invoice. |
| Allow Reservation Renewal | Specifies whether this payment method has reservation renewal enabled or not in the collana pay admin portal. If activated, reservation for this payment method can be extended. |
| Allow Cart Update | Specifies whether this payment method has cart updates enabled or not in the collana pay admin portal. If activated, the cart update endpoint can be used for this payment method. |
| Psp Auto Void Enabled | Specifies whether this payment method has PSP Auto Void enabled or not in the collana pay admin portal. If activated, no void interactions will be send at any point. |
| Communication Mode | Specifies if the communication should be simulated or done with the collana pay core API. |
| Payment Provider | Specifies the payment service provider (PSP) of the selected payment method. |
| Payment Method Type | Specifies the payment method type for the provider of the payment method. |
| Provider Subtype | Specifies the provider subtype for the provider. |
Provider Account Mapping
| Payment Method | Specifies the payment method. |
| Provider Reference |
Distinctive attribute for a specific payment method in a client setup (e.g. for several webshops), which must be included in the Business Central sales order if the same payment method is used in the same country for the same PSP with the same currency. The characteristic is user-defined. |
| Currency Code | Specifies the currency code. |
| Payment Country | Specifies the payment country. |
| Provider Account Id | Specifies the provider account ID. You can find the ID in the collana pay admin portal. |
Advanced
| Trigger following create interactions |
Due to the asynchronous nature of collana pay, approval processes can be interrupted. Whenever collana pay communicates, the order may be reset as it waits for a response from collana pay or the payment provider. This usually occurs during the import process, which is triggered upon release. The payment information must be requested from the payment provider and written to the collana pay database. Only then does the sales order receive its transaction ID and status. If this function is active, the order is immediately tried to be released again after processing the import notification. As a result, the order is released as originally planned. Regardless of the import process and if the capture is to take place on release, this process is also initiated automatically. Once the response from the payment provider has been received, the sales order is automatically released after successful processing.
Note: This function should be switched off if the release process in your system differs from the standard and it is important that an order should remain in open status in certain constellations. Please note that collana pay works with released orders and expects this. An application example here would be a partial delivery process with separate goods issues, where the order status must first be set to Open. |
| Trigger following posting interactions |
Analogous to the scenario described above, this function is intended to ensure that the booking process is automatically completed once the response from collana pay or the payment provider has been received for booking processes that require a response. Example: The capture is to be completed when the sales order is booked, but as you first have to wait for a positive response from collana pay or the payment provider, the booking process is only restarted and the sales invoice generated the next time the queue items are processed after a successful capture message. |
| No. of automatic repetitions | Automatic transactions are executed up to a maximum of this number. This prevents transactions from being executed unnecessarily often. |
|
Rounding Priority |
Specifies which value takes precedence when rounding tax and net amounts. The selected value defines, which amount is rounded up if both values are exactly .005. |
|
Redirect URI Success |
The URL to which the customer is redirected after a successful payment (e.g. https://collanapay.com/success). |
|
Redirect URI Failure |
The URL to which the customer is redirected after a failed payment (e.g. https://collanapay.com/failure). |
|
Redirect URI Cancellation |
The URL to which the customer is redirected after a cancelled payment (e.g. https://collanapay.com/cancellation). |
|
Number of days before the reservation expires |
Specifies the number of days after which the reservation renewal begins before the reservation expires. |
|
Number of days after the reservation expired |
Specifies the number of days after which the reservation renewal begins after the reservation expired. Some payment provider allow a longer reservation renewal than stated. |
|
Maximum number of failed reservation renewals |
Specifies the maximum amount of automatic attempts to try to renew a reservation. If kept low this can reduce the communication with the payment provider. |
Simulation
|
Communication Simulation Available |
Indicates whether the simulation is available. |
| Tenant Simulation |
Indicates whether the client simulation is available. |
| PSP Simulation | Indicates whether the PSP simulation is available. |
Please note that the job queue items must be activated in the collana pay setup. To do this, the job queue items can be accessed in the setup via Setup -> Job Queue Entries and the jobs can be activated via Set status to Ready.