Currency details a Shopify store sent, forwarded from the settlement data. Absent for orders that
did not come from a Shopify store, and for Shopify orders whose merchant sent none of these values.
BaseCurrency and CurrencyConversionRate are order-level. BaseAmount is order-level or
transaction-level depending on what the merchant supplied - see its own description.

The Shopify amount in the store base currency: the order total, or - when the merchant supplied
a base amount for this particular transaction on the order-management call that created it - the
amount for this transaction alone. Nothing on this record says which of the two it is. An
order total will not equal the settled Amount on a partial capture, a refund or a fee row,
whereas a per-transaction amount describes exactly that row. Forwarded exactly as received and
never negated to follow the settlement's Action, so on a credit it does not mirror the sign of
Amount.

The Shopify store base currency, normally a three-letter ISO 4217 code. Forwarded as the store
sent it rather than validated, and a store base currency may sit outside the set of currencies
Qliro supports.

The Shopify rate from the order's presentment currency to the store base currency. The
presentment currency and amount are not carried on settlement data, so this rate applies to
neither the settled Amount nor the Fx values, and must not be applied to BaseAmount.

Summary of the pending transactions counts and sums.

Summary of the rejected transactions counts and sums.

Summary of the settlement transactions counts and sums.

The name of the payment provider from which settlements are expected to be received. For example: Bambora, Nets, Qliro, Trustly, PayPal, etc.

Two uppercase characters. In accordance with ISO 3166-1.

A string generated by the merchant to identify the order uniquely in their system.

The count of the number of credit transaction.

The count of the number of debit transaction.

The count of the number of fee transaction.

The settlement transaction action. Either 'Debit' or 'Credit'.

The amount of this particular settlement record.

The ID of the batch this settlement transaction belongs to.

Three uppercase characters, in accordance with ISO 4217.

Three uppercase characters, in accordance with ISO 4217

Date when Qliro Checkout processed the settlement.

The payment subtype that was used in this transaction (if any).

The payment method that was used in this transaction.

This ID is a reference to the particular request. Status of the relevant request will be notified with this ID.

Date of actual settlement from PSP provider.

Currency details a Shopify store sent, forwarded from the settlement data. Null unless the order
came from a Shopify store whose merchant sent at least one of these values. BaseCurrency and
CurrencyConversionRate are order-level; BaseAmount is the order total or this transaction's own
amount depending on what the merchant supplied, and the record does not say which.

Date when Qliro Checkout processed the transaction.

The type of this settlement entity. Either 'Transaction', 'Fee' or 'Chargeback'.

Will be provided by Qliro Checkout when setting up merchant account

A GUID formatted string used to avoid the same request being executed multiple times.The GUID will be stored for 7 days,
and during that time, any requests sent with the same GUID will be denied.https://guidgenerator.com/online-guid-generator.aspx

The reversal payment transaction id from the update items response

Array of additions to be made to the invoice.

Array of items that are to be added to the shipment.

The price per item excluding Value Added Tax. This can be specified with 0, 1 or 2 decimals, e.g. 99, 99.9 or 99.99. Defaults to 0 if not specified.

Two upper case characters. In accordance with ISO 3166-1.

Customer information. Not required for CreditCard payment, required otherwise. 

Locale indicative for language & other location-specific details. 

Qliro will use this URL to send notifications on payment status changes during the order management process

A string generated by the merchant to identify the order uniquely in their system. Maximum length is 25 characters.

Payment method for the specific purchase.

Customer shipping address. If shipping address not provided billing address will be used as shipping address.

The State/Province/Region of the address. Used in the following countries:
Australia, Bosnia and Herzegovina, Canada, Cyprus, Ireland, Italy, Lithuania,Luxembourg, Macedonia, Malta, Montenegro, Romania, US, Åland.

Geographical area code in ISO3166-2 format.

Used if the addressee doesn't have a standard address.

Address holders company name, only applicable for Company Customers.

The first name of a physical customer's address.

The Last name of a physical customer's address.

The street name and number of the address.

The secondary address line for apartment, suite, department, unit, building, floor etc. Used for company customers and for physical customers in the following countries:
Australia, Bosnia and Herzegovina, Canada, Croatia, Cyprus, Czech Rebublic, Estonia, France, Greece, Hungary, Iceland, Ireland, Italy, Lithuania,
Luxembourg, Macedonia, Malta, Montenegro, Poland, Portugal, Romania, Serbia, Slovakia, Slovenia, Spain, UK, US, Åland.

'Physical' or 'Company'. If 'Company', the PersonalNumber parameter will be interpreted as an organization number.

A national identification number to identify the customer. Not required if Physical without personal number, required otherwise. 

Value added tax number for 'Company' customers. 

A string generated by the merchant to identify the order item. The combination of MerchantReference and PricePerItemIncVat is used to uniquely identify the order item. Maximum length is 200 characters.

The price per item excluding Value Added Tax. This can be specified with 0, 1 or 2 decimals, e.g. 99, 99.9 or 99.99.

The price per item including Value Added Tax. This can be specified with 0, 1 or 2 decimals, e.g. 99, 99.9 or 99.99.

Can be 'Product', 'Discount', 'Fee' or 'Shipping'

The VAT rate for the item. Always specified with 2 decimals, e.g. 25.00 = 2500.

Required if CREDITCARDS Will be used to identify customer. 

Can be ‘CREDITCARDS’ , ‘QLIRO_INVOICE’.

If QLIRO_INVOICE Select True if customers require a letter invoice instead of e-mail. Additional fee may apply to the order. Letter Invoice item with type Fee will be added to the order with price dependent of merchant configuration.

Can be 'INVOICE'. Required only if QLIRO_INVOICE.

Array of each shipment containing the order items and the payment reference.

Array of strings that will be displayed below the item on the invoice. Maximum number of strings is 5 and maximum length of each string is 115 characters.

Array of strings that will be displayed above the item on the invoice. Maximum number of strings is 5 and maximum length of each string is 115 characters.

Array of items that is included in the shipment.

The number of these items that should be added to the cart.

A GUID formatted string used to avoid the same request being executed multiple times. The GUID will be stored for 7 days, and during that time, any requests sent with the same GUID will be denied. https://guidgenerator.com/online-guid-generator.aspx

Id of the order for which to retry is to be performed.

The AreaCode in ISO3166-2 format. Meant to be used for USA and should look like this: 'US-CA'.

The name of an organization customer's address.

The last name of a physical customer's address.

Additional street information of the address.

A national identification number to identify the customer.

Required if CREDITCARDS Will be used to identify customer

Can be ‘CREDITCARDS’ , ‘QLIRO_INVOICE’

Required only if QLIRO_INVOICE. Value is 'INVOICE'.

An array of objects containing the order items, fees, discounts and PaymentTransactionId.

A name or description of the discount item.

A string generated by the merchant to identify the discount item. The combination of MerchantReference and PricePerItemIncVat is used to uniquely identify the discount item. Maximum length is 200 characters.

The price per item excluding Value Added Tax. This can be specified with 0, 1 or 2 decimals, e.g. -99, -99.9 or -99.99. Note: This value must be below zero.

The price per item including Value Added Tax. This can be specified with 0, 1 or 2 decimals, e.g. -99, -99.9 or -99.99. Note: This value must be below zero.

A string generated by the merchant to identify the fee item. The combination of MerchantReference and PricePerItemIncVat is used to uniquely identify the fee item. Maximum length is 200 characters.

Discounts that should be applied to the order.

Fees that should be applied to the order.

A reference to the payment transaction. This reference was communicated in the notification message after a MarkItemsAsShipped call was processed.

The settlement transaction action. Either Debit or Credit.

ID of the provider batch money transfer. Different payment methods can have the same BatchId.

The type of this settlement entity. Either Transaction, Fee or Chargeback.

The date when the batch was transferred to a merchants account.

Internal Qliro Checkout id to identify the batch we receive from a payment provider. Use this when querying GetSettlementsByBatchId.

The total amount of this particular settlement record.

The total fee amount of this particular settlement record.

A Summary of pending settlement transactions.

A Summary of rejected settlement transactions.

A Summary of accepted settlement transactions.

A Summary of all settlement transactions.

The total amount of the credit transactions.

The total amount of the debit transactions.

The total amount of the fee transactions.

An array of objects containing the order items and PaymentReference.

Array of items that is included in the update.

Qliro.Payments.AdminApi API

For Qliro payment methods, order items can be added to an invoice even after it has been activated. The total increase of the invoice amount is limited.

Request to add order items to existing purchase.

This only indicates that the request was successfully received by the Admin API. The actual status of the operation will be sent in a notification with the corresponding PaymentTransactionId.

See ErrorCode and ErrorMessage for more information.

This call is used to mark order items as shipped. For most payment methods, this will lead to a Capture or Activation and a money transfer.

Return items of an order and initiate a refund.

For Qliro payment methods: Orders that have not been cancelled and that have at least one item that has not been marked as shipped, can be updated. Increasing the previously reserved amount could trigger a credit check, possibly resulting in a declined request. Multiple items with the same signature (MerchantReference + PricePerItemIncVat) but different PricePerItemExVat are not allowed. Changes in PricePerItemExVat should be sent as a new item. It is also not allowed to update PricePerItemExVat or Description of an item if that item is already fully or partially shipped with a different PricePerItemExVat or Description.
For non Qliro payment methods: Orders that have not been cancelled and that have no items marked as shipped can be updated.If at least one item on the order has been marked as shipped, update items can no longer be used for that order.
Note: Updating an order with the TRUSTLY payment method may result in additional transactions.
Note: The OrderItems list will replace the previous list of order items, so if you want to remove one item from the order, send all other items in the UpdateItems request.

This only indicates that the request was successfully received by the Admin API. The actual status of the operation will be sent in a notification with the corresponding PaymentTransactionId. <br/><br/>If update items was done on an order with the TRUSTLY payment method and the order amount changed, an extra reversal transaction will be performed. Status for the reversal transaction will be notified as a normal transaction through Order Management Status. If the reversal transaction fails it can be retried using the Retry Reversal Payment request.

Orders that still have a reserved amount and items that are not yet marked as shipped can be cancelled.
            Note: Cancelling an order with the TRUSTLY payment method, results in an additional refund transaction.

Request to cancel full order or partial order

When it is time to create the recurring order use method MerchantPayment. This call is used to initiate the purchase on behalf of the customer.

This only indicates that the request was successfully received by the Admin API. The actual status of the operation will be sent in a notification with the corresponding OrderId, PaymentTransactionId.

The endpoint returns an array of addresses, one if the customer is a Physical customer and all known addresses of a Company customer. Qliro only supports Swedish Addresses at this time.

JuridicalType

PersonalNumber

'SE' or 'NO'. If country code not provided parameter will be interpreted as 'SE'.

CountryCode

If a payment for an existing order has failed, it is possible to retry the payment using a different payment method.

This call can be used to get detailed information about the order.

merchantReference

This call can be used to get the status of a specific order management call.

Used if a reversal transaction was initiated from an update items call and failed, needing to be retried.

Retry reversal payment transaction request

This call can be used to retrieve settlement records for a given period of time. The settlements include all the credit/debit transactions occurred during the period specified.
            The response will be a list of settlement records.

Date in format yyyy/mm/dd (2017/11/30) from which settlements will be included. Today’s date will result in a PERIOD_NOT_SETTLED error.

FromDate

Date in format yyyy/mm/dd (2017/11/30) to which settlements will be included. If not provided, it will default to yesterdays date.
The maximum period allowed is 61 days, exceeding 61 days will result in a PERIOD_INVALID error.

ToDate

Two upper case characters. In accordance with ISO 3166-1. If specified Rejected and Pending settlements will not be included in the response.

If specified, the response will only include records for this specific payment method.

PaymentMethodType

Three upper case characters, in accordance with ISO 4217.

CurrencyCode

Array of settlement types Transaction, Fee and Chargeback. Defaults to only using Transaction.

Types

ID of the provider batch money transfer.Different payment methods can have the same BatchId

BatchId

Array of settlement statuses Accepted, Rejected and Pending. Defaults to only using Accepted. Response will only include specified types.

SettlementStatuses

Includes accepted, pending and rejected settlements

This call can be used to get batch details from bank transfers. The batch details contain three lists of all transaction types (settlements, pending and rejected) and a summary per type.

Date in format yyyy/mm/dd (2020/12/31) from which batches will be included.

FromBatchDate

Date in format yyyy/mm/dd (2020/12/31) to which batches will be included. Can be a maximum of 60 days from fromBatchDate or PERIOD_LIMIT_EXCEEDED error will be thrown.

ToBatchDate

Comma-separated list of payment methods. If specified, the response will only include records for these payment methods.

PaymentMethodTypes

Comma-separated list of settlement types 'Transaction', 'Fee' and 'Chargeback'. Defaults to all types.

An arrays of accepted, pending and rejected settlements along with summary of total settlements and total settled amount.

This call can be used to retrieve a list of settlement batches for a given period of time. The settlement batches list will include sums for the transactions that occurred during the period specified. The response will be a list of settlement batches.

An array of strings with the AcquirerName (The name of the payment provider from which settlements are expected to be received. For example: Bambora, Nets, Qliro, Trustly, PayPal, etc).

AcquirerNames

The response will be a list of settlement batches where each batch consists of sums of the transactions that occurred during the period specified.

This call can be used to retrieve settlements belonging to a specific Qliro Checkout BatchId

QliroOne Id to identify the batch we receive from a payment provider.

This call can be used to update the MerchantReference of the order.

If the order was paid with a Qliro payment method, a new transaction will be created and the PaymentTransactionId will be in the response. Otherwise the response will just be a 200 OK status code if the update was successful.

See ErrorCode and ErrorMessage for more details.

This field represent the estimated delivery date of the order, with this selected. Will override the delivery date on Shipping Option

Use to provide information about delivery date.

An array of (String) descriptions, presented as extra lines of information to the customer. Maximum length is 100 characters per line and up to 3 lines.

The name of the additional shipping service, presented to the customer.

A string generated by the merchant to identify the additional shipping service uniquely. Maximum length is 200 characters.

The price excluding Value Added Tax. This can be specified with 0, 1 or 2 decimals, e.g. 99, 99.9 or 99.99.

The price including Value Added Tax. This can be specified with 0, 1 or 2 decimals, e.g. 99, 99.9 or 99.99.

Address holders company name, only applicable for Company Customers

Currently only used for US. Will contain the ISO-3166-2 code for the current state (Area)

A Dictionary of string and Array of Fees, the key should be the name of a PaymentMethod for which the Array of Fees is applicable

Use when additional shipping services are available for the shipping option.

A brand connected to the shipping method. If supported by Qliro Checkout, a logotype will be shown in the shipping methods list.

Can be used to group shipping methods. If used it must be set on all included shipping methods. Only 2 category values can be used for a list of shipping methods. Recommended values to use are "HOME_DELIVERY" and "PICKUP" so Qliro Checkout can handle the localizations. Other values will be used as is. Maximum length is 50 characters.

This field represent the estimated delivery date of the order. If the date provided is older than today the value will be ignored.

An array of (String) descriptions, presented as extra lines of information to the customer. Maximum length is 200 characters per line and up to 3 lines.

The name of the shipping method, presented to the customer.

Use to mark a shipping method as eco friendly.

To be used with categories. Only use 3 or less different labels for all shipping options. Recommended values: "Express", "Free" and "Economy". Maximum length is 50 characters.

A string generated by the merchant to identify the shipping method uniquely. Maximum length is 450 characters.

Use to mark a shipping method with labels.

Use when updating the price of a shippingOption if the old price should be displayed, e.g. to point out shipping was made free because of total price over a certain value.

An array of additional options of the shipping method. See details below.

When the customer chooses a shipping method in Qliro Checkout, an order item will be added to the cart, including the shipping fee for that particular shipping method. By default, the merchantReference of this fee item will be copied from the selected shipping option. If the ShippingFeeMerchantReference parameter is provided, the merchantReference will be overridden. Maximum length is 450 characters.

If provided and true, a field will be presented so that the customer can enter an access code. The access code will be optional and have maximum 50 characters. Suitable for home delivery methods.

If provided and true, a request to MerchantOrderAvailableShippingMethodsUrl will be sent every time the customer clicks on this shipping option. If MerchantOrderAvailableShippingMethodsUrl is not provided, selected shipping option will not be updated with secondary options list.

Use to provide Geographical location of delivery.

User friendly description of the Shipping option

User friendly title of the Shipping option

A string generated by the merchant to identify the Shipping option.

Consent ID that the contact will be updated with.

If true the checkbox will be checked by default.

Customer information used to try to identify the customer without user interaction. 

Locale indicative for language & other location-specific details.

Qliro will use this URL to send customer checkout status updates. For example when the checkout status switches from OnHold to Completed. Info about authentication for this request can be found below. Should use https.

A URL where the customer can find the merchant's integrity policy.

Qliro will use this URL to send notifications on payment status changes during the order management process, for example when the payment created by MarkItemsAsShipped call becomes successful. Info about authentication for this request can be found below. Should use https.

If specified, Qliro will use this URL to try to validate the order before completing the purchase. Info about authentication for this request can be found below. Should use https.

A URL where the customer can find the merchant's terms and conditions.

If specified, the customer will have to be at least this old to complete a purchase with Qliro Checkout. This will prevent the customer from authenticating as a company.

List of items customer added to the cart. 

Customer information used to try to identify the customer without user interaction.

A URL to where Qliro will redirect the the customer once the payment is completed.

Qliro will use this URL to send notifications on saved merchant credit card.