The page you’re looking for does not exist. It may have been moved. You can return to the start page, or follow one of the links in the navigation to the left.
+If you arrived on this page by clicking on a link, please notify the owner of the site that the link is broken. +If you typed the URL of this page manually, please double check that you entered the address correctly.
+The link can be controlled based on the request field and what customer see in the checkout can be adjusted.
+There are two types of links that provide different checkout options:
+Create a simple link - the link is used when the merchant doesn’t have a basket and doesn’t need customer-specific shipping and billing data (except consumer e-mail) e.g. donations or membership fees for already existing customers.
+Create a complex link - the link is used if the merchant wants to provide and receive basket, shipping, and billing data from their customers.
+| Name | +Description | +
|---|---|
Basic-Auth (Test) |
+Credentials that integration specialist team provides. |
+
Secret Key (Test) |
+Provided by the integration specialist team. |
+
Base-URL |
+
|
+
| Name | +Description | +
|---|---|
Content-Type |
+
|
+
Authorization |
+
|
+
X-Signature |
+HMAC-SHA512 hashed request body with the cryptographic secret key. |
+
To receive a payment link or a QR code for the link send a POST request to the /links endpoint:
+https://api.qenta.com/link/links
{
+ "amount": "55.00",
+ "basket": {
+ "basketItems": []
+ },
+ "currency": "EUR",
+ "customer": {
+ "billingFirstName": "",
+ "billingLastName": "",
+ "billingPhone": "",
+ "email": "test@qenta.com"
+ },
+ "description": "Test:0000",
+ "displayBasketData": false,
+ "displayBillingData": false,
+ "displayShippingData": false,
+ "enabled": true,
+ "expirationStatus": "Valid",
+ "expired": false,
+ "linkCallLimit": 0,
+ "linkValidFrom": "2023-04-01T12:00",
+ "linkValidTo": "2028-04-01T23:59",
+ "orderReference": "1234512345",
+ "paymentType": "SELECT",
+ "cancelUrl": "https://payments.qenta.com/cancel/",
+ "confirmUrl": "https://yourconfirm.com",
+ "serviceUrl": "https://yourimprint.com",
+ "merchantLogoUrl": "",
+ "successUrl": "https://payments.qenta.com/success/",
+ "failureUrl": "https://payments.qenta.com/failure/",
+ "paymenttypeSortOrder": "CCARD, PayPal, SOFORTUEBERWEISUNG, EPS",
+ "title": "Link_Title"
+}| + + | ++Detailed description of parameters can be checked here. + | +
The payment link and QR code will be received in the response.
+{
+ "id": "{linkId}",
+ "title": "Link_Title",
+ "description": "Test:0000",
+ "expirationStatus": "Valid",
+ "lastPaymentStatus": "No payments",
+ "amount": 55.00,
+ "sales": 0,
+ "orderStats": {
+ "total": 0,
+ "successful": 0,
+ "pending": 0,
+ "inProgress": 0,
+ "canceled": 0,
+ "failed": 0
+ },
+ "clicks": 0,
+ "createdAt": "2023-04-27T06:00:00.000+00:00",
+ "orderReference": "1234512345",
+ "linkValidFrom": "2023-04-01T12:00:00.000+00:00",
+ "linkValidTo": "2028-04-01T23:59:00.000+00:00",
+ "linkCallLimit": 1,
+ "maxRetries": 0,
+ "displayBasketData": false,
+ "displayShippingData": false,
+ "displayBillingData": false,
+ "paymentType": "SELECT",
+ "paymentTypes": "No payments",
+ "paymenttypeSortOrder": "CCARD, PayPal, SOFORTUEBERWEISUNG, EPS",
+ "language": "en",
+ "currency": "EUR",
+ "customer": {
+ "billingFirstName": "",
+ "billingLastName": "",
+ "email": "test@qenta.com",
+ "billingPhone": ""
+ },
+ "basket": {
+ "basketItems": []
+ },
+ "cancelUrl": "https://payments.qenta.com/cancel/",
+ "confirmUrl": "https://yourconfirm.com",
+ "serviceUrl": "https://yourimprint.com",
+ "merchantLogoUrl": "",
+ "successUrl": "https://payments.qenta.com/success/",
+ "failureUrl": "https://payments.qenta.com/failure/",
+ "merchantConfigId": "{merchantConfigId}",
+ "enabled": true,
+ "expired": false,
+ "qrCode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAABtklEQVR4Xu2ZUW7DIBBEkTiAj8TVOZIPYInOm7WjJK3S34zkVUJgefkY7TI4bVufY7b3zFvcQMUNVNxAhYHZFNvq+9D8YDE81l4MoPexaZx9Fzk7yzMfBEiUMl2ZXRNhQ2PjK3EA6lQy5WuZCSxp1GLto1tsHLDccmbGtTzzQYCP/zRzvf7why8HruC8kOtVNUcOgEx04caMmncab2QB3dJ8Xnx89lFYFGDjshXrQiSHG6M0CziUV5k8Hr5QtOP2iwI2TOws2eJy9CQMsMCh0Z3GHI02gSxApUIXybNM67knE4BVDvDoPQpHBcOAHSsGo9kGc1tZFIDG5ZKVUhhfLlEAJnz4iZFdEtNX5MgCCKQVxq7I155MAGi5USbAFYkVzF89+eXAdI3ILxqPI/PWkxmACiSNFrjsZss+kAYwVp4Jj4s0Xhagd+MHLMkSS8mczwEqUMdnPWu5glHARNVGBoG0X6smzAJWPZAgU94Fw85ry30/cFhXp16cemtsry6XA1y/ZI01e0IesB6VklL+Ij2ygEXLncCy2HplAWowH38u9Pb4v8DTtZgAfIobqLiBihuo+B/4ATVh6kzRA/0OAAAAAElFTkSuQmCC",
+ "linkUrl": "https://api.qenta.com/link/pbl/checkout/5e5b54ef-3c57-4142-ba69-dd80fd9ef70b"
+}| + + | ++Detailed description of parameters can be checked here. + | +
{
+ "amount": "55.00",
+ "basket": {
+ "basketItems": [
+ {
+ "articleNumber": "123",
+ "description": "Product Description",
+ "name": "Product",
+ "quantity": "1",
+ "unitGrossAmount": 55.0,
+ "unitNetAmount": 50.0,
+ "unitTaxAmount": 5.0,
+ "unitTaxRate": 10.0
+ }
+ ]
+ },
+ "currency": "EUR",
+ "customer": {
+ "billingAddress": {
+ "city": "Graz",
+ "country": "AT",
+ "countryState": "Steiermark",
+ "street": "Street 1",
+ "zipCode": "8020"
+ },
+ "billingAddress2": {
+ "street": ""
+ },
+ "billingAddress3": {
+ "street": ""
+ },
+ "billingFirstName": "Max",
+ "billingLastName": "Mustermann",
+ "billingPhone": "+4312345678",
+ "email": "test@test.com",
+ "shippingAddress": {
+ "city": "Graz",
+ "country": "AT",
+ "countryState": "Steiermark",
+ "street": "Street 1",
+ "zipCode": "8020"
+ },
+ "shippingAddress2": {
+ "street": ""
+ },
+ "shippingFirstName": "Max",
+ "shippingLastName": "Mustermann",
+ "shippingPhone": "+4312345678"
+ },
+ "description": "Test:0000",
+ "displayBasketData": true,
+ "displayBillingData": true,
+ "displayShippingData": true,
+ "enabled": true,
+ "expirationStatus": "Valid",
+ "expired": false,
+ "linkCallLimit": 0,
+ "linkValidFrom": "2023-04-01T12:00",
+ "linkValidTo": "2028-04-01T23:59",
+ "maxRetries": 0,
+ "orderReference": "1234512345",
+ "paymentType": "SELECT",
+ "cancelUrl": "https://payments.qenta.com/cancel/",
+ "confirmUrl": "https://yourconfirm.com",
+ "serviceUrl": "https://yourimprint.com",
+ "merchantLogoUrl": "",
+ "successUrl": "https://payments.qenta.com/success/",
+ "failureUrl": "https://payments.qenta.com/failure/",
+ "paymenttypeSortOrder": "CCARD, PayPal, SOFORTUEBERWEISUNG, EPS",
+ "title": "Link_Title"
+}| + + | ++Detailed description of parameters can be checked here. + | +
The payment link and QR code will be received in the response.
+{
+ "id": "{linkId}",
+ "title": "Link_Title",
+ "description": "Test:0000",
+ "expirationStatus": "Valid",
+ "lastPaymentStatus": "No payments",
+ "amount": 55.00,
+ "sales": 0,
+ "orderStats": {
+ "total": 0,
+ "successful": 0,
+ "pending": 0,
+ "inProgress": 0,
+ "canceled": 0,
+ "failed": 0
+ },
+ "clicks": 0,
+ "createdAt": "2023-04-27T06:00:00.000+00:00",
+ "orderReference": "1234512345",
+ "linkValidFrom": "2023-04-01T12:00:00.000+00:00",
+ "linkValidTo": "2028-04-01T23:59:00.000+00:00",
+ "linkCallLimit": 0,
+ "maxRetries": 0,
+ "displayBasketData": true,
+ "displayShippingData": true,
+ "displayBillingData": true,
+ "paymentType": "SELECT",
+ "paymentTypes": "No payments",
+ "paymenttypeSortOrder": "CCARD, PayPal, SOFORTUEBERWEISUNG, EPS",
+ "language": "en",
+ "currency": "EUR",
+ "customer": {
+ "billingFirstName": "Max",
+ "billingLastName": "Mustermann",
+ "shippingFirstName": "Max",
+ "shippingLastName": "Mustermann",
+ "billingAddress": {
+ "street": "Street 1",
+ "city": "Graz",
+ "zipCode": "8020",
+ "country": "AT",
+ "countryState": "Steiermark"
+ },
+ "billingAddress2": {
+ "street": ""
+ },
+ "billingAddress3": {
+ "street": ""
+ },
+ "shippingAddress": {
+ "street": "Street 1",
+ "city": "Graz",
+ "zipCode": "8020",
+ "country": "AT",
+ "countryState": "Steiermark"
+ },
+ "shippingAddress2": {
+ "street": ""
+ },
+ "email": "test@test.com",
+ "billingPhone": "+4312345678",
+ "shippingPhone": "+4312345678"
+ },
+ "basket": {
+ "basketItems": [
+ {
+ "name": "Product",
+ "articleNumber": "123",
+ "description": "Product Description",
+ "quantity": 1,
+ "unitGrossAmount": 55.00,
+ "unitTaxAmount": 5.00,
+ "unitTaxRate": 10.0,
+ "unitNetAmount": 50.0
+ }
+ ]
+ },
+ "cancelUrl": "https://payments.qenta.com/cancel/",
+ "confirmUrl": "https://yourconfirm.com",
+ "serviceUrl": "https://yourimprint.com",
+ "merchantLogoUrl": "",
+ "successUrl": "https://payments.qenta.com/success/",
+ "failureUrl": "https://payments.qenta.com/failure/",
+ "merchantConfigId": "{merchantConfigId}",
+ "enabled": true,
+ "expired": false,
+ "qrCode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAABvklEQVR4Xu2YUY6DMAxEI3GAHilXz5E4AJJ33phuUVfq/nYkrIDAeXyMxk6AUZ9jjffMW9xAxw103ECHgTUUjzUeXG+MOkj1XAyg43iUpoQdY/Zt54MAiVJmjKlRO+cD1ZGAktsui6bOuUC1ZfuQa4nA75QulLdZZz4IoNUfSHsNUj2XAnSo3rrYqqz3zMYA9AtmUXsw1djFrAhgUG9Ts3QQLlmv1+QgwLdjYxFW75fLDbFRgHofpuwOeqm66b0+CZCic+2yWW7/eZWZACys8dliUarhJ5OADZnd/gSMjYsC6nC/IK2HJR+vzT0DcIa3xLPqvC22cUGA8nKH4WJT+wu4dlYEcC5ZO9KwSbOU3IoClgBrHO4dZPb3YBigPNsHs5LZNnUEAVQauuiabh8bN7MAT3kTwS9WM5x6NU4GoKOcdLFh3HDhZQHcomsCPzeUq1kJQIcsG091y7dZAKKGf5LglzfEg98LfiwH0HEAwJyWaebPT5IvB1DnV3cJLH9SKUzmAWr86s2d67qalQNUS2Md1lLGy/ybWd8OFCW38MtnAeWP9CwAh/g2n+SZHb2CRQGf4gY6bqDjBjr+B34AyJOJDtJVUa0AAAAASUVORK5CYII=",
+ "linkUrl": "https://api.qenta.com/link/pbl/checkout/c7910e30-ad50-4fe7-9ab7-eff841b63ffb"
+}| + + | ++Detailed description of parameters can be checked here. + | +
There are two ways for gathering information about created links and orders/payments:
+Data transfer object from link by ID - general information from link
+Orders for link - information about every order and/or payment
+| Name | +Description | +
|---|---|
Basic-Auth (Test) |
+Credentials that integration specialist team provides. |
+
Base-URL |
+
|
+
| Name | +Description | +
|---|---|
Content-Type |
+
|
+
Authorization |
+
|
+
For more information about a link send a GET request to the base URL and include the link ID. ID was provided in the initial response for creating a link and the path for orders (/links/{id}):
+https://api.qenta.com/link/links/{id}
{
+ "id": "{linkId}",
+ "title": "Link_Title",
+ "description": "Test:0000",
+ "expirationStatus": "Valid",
+ "lastPaymentStatus": "No payments",
+ "amount": 55.00,
+ "sales": 0,
+ "orderStats": {
+ "total": 0,
+ "successful": 0,
+ "pending": 0,
+ "inProgress": 0,
+ "canceled": 0,
+ "failed": 0
+ },
+ "clicks": 0,
+ "createdAt": "2023-04-27T06:00:00.000+00:00",
+ "orderReference": "1234512345",
+ "linkValidFrom": "2023-04-01T12:00:00.000+00:00",
+ "linkValidTo": "2028-04-01T23:59:00.000+00:00",
+ "linkCallLimit": 0,
+ "maxRetries": 0,
+ "displayBasketData": true,
+ "displayShippingData": true,
+ "displayBillingData": true,
+ "paymentType": "SELECT",
+ "paymentTypes": "No payments",
+ "paymenttypeSortOrder": "CCARD, PayPal, SOFORTUEBERWEISUNG, EPS",
+ "language": "en",
+ "currency": "EUR",
+ "customer": {
+ "billingFirstName": "Max",
+ "billingLastName": "Mustermann",
+ "shippingFirstName": "Max",
+ "shippingLastName": "Mustermann",
+ "billingAddress": {
+ "street": "Street 1",
+ "city": "Graz",
+ "zipCode": "8020",
+ "country": "AT",
+ "countryState": "Steiermark"
+ },
+ "billingAddress2": {
+ "street": ""
+ },
+ "billingAddress3": {
+ "street": ""
+ },
+ "shippingAddress": {
+ "street": "Street 1",
+ "city": "Graz",
+ "zipCode": "8020",
+ "country": "AT",
+ "countryState": "Steiermark"
+ },
+ "shippingAddress2": {
+ "street": ""
+ },
+ "email": "test@test.com",
+ "billingPhone": "+4312345678",
+ "shippingPhone": "+4312345678"
+ },
+ "basket": {
+ "basketItems": [
+ {
+ "name": "Product",
+ "articleNumber": "123",
+ "description": "Product Description",
+ "quantity": 1,
+ "unitGrossAmount": 55.00,
+ "unitTaxAmount": 5.00,
+ "unitTaxRate": 10.000,
+ "unitNetAmount": 50.00
+ }
+ ]
+ },
+ "cancelUrl": "https://payments.qenta.com/cancel/",
+ "confirmUrl": "https://yourconfirm.com",
+ "serviceUrl": "https://yourimprint.com",
+ "merchantLogoUrl": "",
+ "successUrl": "https://payments.qenta.com/success/",
+ "failureUrl": "https://payments.qenta.com/failure/",
+ "merchantConfigId": "{merchantConfigId}",
+ "enabled": true,
+ "expired": false,
+ "qrCode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAABuklEQVR4Xu2Yy43jMBBECTAAhaTUGZICINDbr0qD0fowc50C1KANqfh4aPSP9qifbY1P5cNewPYCthewCVij7VjjKK9ZtZG8FwP0Zx+9Fpj0frUeBLRTrczrHOPs9/42nAj0IkLHmtfIBUrRqeucrQQCpRybbKl2CNatBwGO0X4uJO+lALZF4agJ1PVQYwBXCh243AH0Wo9gJQA9PiR2dK7hVsYRNbQgAO/oXWz1g9INOAqgX7VfUhaT/fARjuYAem07HLVT5U/4ogC6VjHTybetqPXSySAA75RsMPZuqvajgGXRu4SpZcY9TA5AE+aW0qoybWssUkpJAG46x6b62KaC7qglAdyvbtc0SoZE9BzAycYopF7oAHf4sgBa8fcV5Q6TLQegFTtG/U03U/k4CYOAYhcdRuVDpP6vrAiAfLuTrb0u4McdJgJAxMeTIUKM1iBwZxRgu0V5t0pHogC2uJ98zRGKiL8XfCwG6I+SjSbmYLHzvMMkANvXqq8+vHF7iAwE9DD0PBn3FQiUZ0q5lfVk+QzWXweKlFsWN4vca3+zACKk/zy3fkwp686S5QA/2QvYXsD2ArbfgX+HOoq+BMD9uwAAAABJRU5ErkJggg==",
+ "linkUrl": "https://api.qenta.com/link/pbl/checkout/0bbc89de-ef46-4b01-a225-972b552c976e"
+}For more information about every order/payment processed with a link send a GET request to the base URL and include the link ID. ID was provided in the initial response for creating a link and the path for orders (/links/{id}/orders):
+https://api.qenta.com/link/links/{id}/orders
{
+ "items": [
+ {
+ "id": "{orderId}",
+ "linkConfigId": "{linkId}",
+ "amount": 55.00,
+ "currency": "EUR",
+ "paymentType": {
+ "id": 3,
+ "name": "CCARD",
+ "description": "Credit Card, Maestro SecureCode"
+ },
+ "financialInstitution": "Visa",
+ "language": "de",
+ "orderNumber": "13425114",
+ "paymentState": {
+ "id": 1,
+ "state": "SUCCESS"
+ },
+ "orderDescription": "Test:0000",
+ "purchaseInformation": {
+ "additionalParameters": [],
+ "orderDescription": "Test:0000",
+ "orderReference": "123451234557226",
+ "consumerIpAddress": "10.137.4.3",
+ "consumerUserAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:109.0) Gecko/20100101 Firefox/112.0",
+ "customerStatement": "123451234557226",
+ "consumerBillingFirstName": "Max",
+ "consumerShippingFirstName": "Max",
+ "consumerBillingLastName": "Mustermann",
+ "consumerShippingLastName": "Mustermann",
+ "consumerEmail": "test@test.com",
+ "consumerBillingAddress1": "Street 1",
+ "consumerShippingAddress1": "Street 1",
+ "consumerBillingCity": "Graz",
+ "consumerShippingCity": "Graz",
+ "consumerBillingCountry": "AT",
+ "consumerShippingCountry": "AT",
+ "consumerBillingZipCode": "8020",
+ "consumerShippingZipCode": "8020",
+ "basketItem": [
+ {
+ "name": "Product",
+ "articleNumber": "123",
+ "description": "Product Description",
+ "quantity": 1,
+ "unitGrossAmount": 55.00,
+ "unitTaxAmount": 5.00,
+ "unitTaxRate": 10.000,
+ "unitNetAmount": 50.00
+ }
+ ],
+ "basketItems": "1",
+ "consumerBillingAddress2": "",
+ "consumerBillingState": "Steiermark",
+ "consumerShippingAddress2": "",
+ "consumerShippingState": "Steiermark",
+ "consumerShippingPhone": "+4312345678",
+ "consumerBirthDate": "2002-04-27"
+ },
+ "timestamp": "2023-04-27T13:11:00.000+00:00",
+ "createdAt": "2023-04-27T13:10:00.000+00:00"
+ },
+ {
+ "id": "{orderId}",
+ "linkConfigId": "{linkId}",
+ "amount": 55.00,
+ "currency": "EUR",
+ "paymentType": {
+ "id": 3,
+ "name": "CCARD",
+ "description": "Credit Card, Maestro SecureCode"
+ },
+ "financialInstitution": "MC",
+ "language": "de",
+ "orderNumber": "7430895",
+ "paymentState": {
+ "id": 1,
+ "state": "SUCCESS"
+ },
+ "orderDescription": "Test:0000",
+ "purchaseInformation": {
+ "additionalParameters": [],
+ "orderDescription": "Test:0000",
+ "orderReference": "123451234519526",
+ "consumerIpAddress": "10.137.4.18",
+ "consumerUserAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:109.0) Gecko/20100101 Firefox/112.0",
+ "customerStatement": "123451234519526",
+ "consumerBillingFirstName": "Max",
+ "consumerShippingFirstName": "Max",
+ "consumerBillingLastName": "Mustermann",
+ "consumerShippingLastName": "Mustermann",
+ "consumerEmail": "test@test.com",
+ "consumerBillingAddress1": "Street 1",
+ "consumerShippingAddress1": "Street 1",
+ "consumerBillingCity": "Graz",
+ "consumerShippingCity": "Graz",
+ "consumerBillingCountry": "AT",
+ "consumerShippingCountry": "AT",
+ "consumerBillingZipCode": "8020",
+ "consumerShippingZipCode": "8020",
+ "basketItem": [
+ {
+ "name": "Product",
+ "articleNumber": "123",
+ "description": "Product Description",
+ "quantity": 1,
+ "unitGrossAmount": 55.00,
+ "unitTaxAmount": 5.00,
+ "unitTaxRate": 10.000,
+ "unitNetAmount": 50.00
+ }
+ ],
+ "basketItems": "1",
+ "consumerBillingAddress2": "",
+ "consumerBillingState": "Steiermark",
+ "consumerShippingAddress2": "",
+ "consumerShippingState": "Steiermark",
+ "consumerShippingPhone": "+4312345678",
+ "consumerBirthDate": "2002-04-27"
+ },
+ "timestamp": "2023-04-27T13:18:00.000+00:00",
+ "createdAt": "2023-04-27T13:17:00.000+00:00"
+ }
+ ],
+ "currentPage": 0,
+ "totalItems": 2,
+ "totalPages": 1
+}| + + | ++Detailed descriptions for parameters from the example are here. + | +
With the following commands, the merchant is able to alter the accessibility of their links, which are already created:
+Disable link by ID - PUT call for deactivation of an existing link.
+Reactivate link by ID - PUT call for reactivation an existing link.
+Delete link by ID - DELETE call for completely deleting an existing link.
+| Name | +Description | +
|---|---|
Basic-Auth (Test) |
+Credentials that integration specialist team provides. |
+
Base-URL |
+
|
+
| Name | +Description | +
|---|---|
Content-Type |
+
|
+
Authorization |
+
|
+
PUT request with whom the active link can be disabled, so the consumer is not able to call the link again. To check if a link is enabled or not the data transfer object from the link by ID command should be executed. In the response, the merchant will receive the parameter enabled with the value true or false.
Send a PUT request to the base URL and include the link ID, which was provided in the initial response for creating a link and the correct path (/links/disable/”id”).
+https://api.qenta.com/link/links/disable/{id}
PUT request with whom the active link can be reactivated using the link ID.
+| + + | +
+To check, if a link is disabled or not, send a data transfer object from link by ID request first and check the response field expirationStatus. If the value "Deactivated" is returned, the link is disabled and can be reactivated. If the returned value is "Expired", the link can’t be reactivated anymore.
+ |
+
If a link has already expired (expiry date for linkValidTo has passed), the link is not reachable either, even if the state "enabled" with the value "false" is set.
Send a PUT request to the base URL and include the link ID, which was provided in the initial response for creating a link and the correct path (/links/reactivate/”id”).
+https://api.qenta.com/link/links/reactivate/{id}
DELETE call with whom the link is completely deleted.
+| + + | ++If this command is executed, the information from the link can’t be gathered anymore. + | +
Send a DELETE request to the base URL and include the link ID, which was provided in the initial response for creating a link and the correct path (/links/”id”).
+https://api.qenta.com/link/links/{id}
With these commands, more than one link at once can be disabled or deleted.
+Disable batch - PUT call for deactivation of a batch of existing links.
+Delete batch - DELETE call for completely deleting a batch of existing links.
+| Name | +Description | +
|---|---|
Basic-Auth (Test) |
+Credentials that integration specialist team provides. |
+
Base-URL |
+
|
+
| Name | +Description | +
|---|---|
Content-Type |
+
|
+
Authorization |
+
|
+
PUT request with whom more than one link can be disabled at once using link IDs.
+Provide the link IDs in the request body and send a PUT request to the base URL and the correct path (/links/disable).
+https://api.qenta.com/link/links/disable
[
+ "{id}",
+ "{id}",
+ "{id}"
+]DELETE call with whom more than one link can be deleted at once using link IDs.
+| + + | ++If this command is executed, the information from the link can’t be gathered anymore. + | +
Send a HTTP DELETE request to the base URL and include the link ID, which was provided in the initial response for creating a link and the correct path (/links/delete).
+https://api.qenta.com/link/links/delete
[
+ "{id}",
+ "{id}",
+ "{id}"
+]| Name | +Description | +
|---|---|
|
+Title of the link that will be shown in the portal description. |
+
|
+Request parameter |
+
|
+Currency of the requested amount. Request parameter |
+
|
+Request parameter |
+
|
+Determines date and time from when the link is valid. |
+
|
+Determines date and time until the link is valid. |
+
|
+Determines how many times a link can be called. |
+
|
+Determines if basket data are shown in the checkout or not. If the consumer data are not needed, set to "false" for a simple link. |
+
|
+Determines if customer shipping data are shown in the checkout or not (will be shown anyway if it is sent within customer parameters). |
+
|
+Determines if customer shipping data are shown in the checkout or not (will be shown anyway if it is sent within customer parameters). |
+
|
+Shows if a link is enabled/accessible or not. |
+
|
+Request parameter |
+
|
+Determines the sort order of payment types, shown on the checkout page. |
+
|
+Amount to pay - needs to be sent, if the merchant doesn’t provide basket fields. Request parameter |
+
|
+Customer specific parameters - either provided in the request or entered by customers.
+Request parameters for consumerShipping and consumerBilling:
Request Parameters basketItems: |
+
|
+URL of online shop where the consumer is forwarded when the payment process has been completed. Request parameter |
+
|
+URL of the page where consumer is forwarded when the payment process has been canceled. Request parameter |
+
|
+URL of online shop where consumer is forwarded when the payment process has failed for some reason. Request parameter |
+
|
+URL of a web page in an online shop that informs the consumer about the different possibilities to get in contact with the merchant. Request parameter |
+
|
+URL to an image on the web server, that will be displayed during the payment process. Request parameter |
+
| Name | +Description | +
|---|---|
|
+Link ID created by QENTA. |
+
|
+Status that are showing if the link is still available to call or not. |
+
|
+Date and time of the last time the link has been called. |
+
|
+Date and time of the last successful payment of the link. |
+
|
+
+
+The last payment status can be: +
+
|
+
|
+Amount to pay within the link. |
+
|
+Sum of all successful payment amounts made with the link. |
+
|
+
+
+Shows the sums of transactions, depending on their states: +
+
|
+
|
+Number of how many times a link has been clicked/called. |
+
|
+Date and time the link has been created. |
+
|
+Payment type used by the customer. |
+
Parameters that will be received for gathering order specific commands (Orders for Link).
+| Parameter | +Description | +
|---|---|
| + | The financial institution, chosen by the customer. |
+
|
+The language on the checkout page, chosen by the customer. |
+
|
+Payment related orderNumber, created by the QENTA. |
+
|
+Fields that are indicating whether the payment was successful or not
|
+
|
+|
| + | Description of the order. |
+
|
+Consumer related parameter fields: |
+
basketItem |
+Contains more details about the basket fields: |
+
| + + | ++Detailed description of the consumer data parameters are here. + | +
Fm*l|0qgnMVVk{u0=EDX%!k_^oa
zNmq1L7vI?O(y9c)F19<%%CoMR^777TpbcKS!E5Cy{#T2d{*&mCfV!5?SFghJx+K5w
zHc&RKj3xWci&^|OQO=r)*z7OPKprGjfVX@zFm60;g6ZXRtTG)SskGbt$BLV)5|W#%
z@_>^b&0%r=4SjH`zd1F1PG8R0eS~6{XWBe>