About Klarna Payments
General information about Klarna Payments
Klarna offers three different payment methods within the new Klarna KP API via Computop: Invoice and hire purchase (Pay Later & Pay over time) as well as Sofort + secured direct debit (Pay Now). Merchants pass on all the invoice data during the order to the service provider, who then takes over the complete billing and debtor management. That than takes over the complete billing and downstream debtor management. As merchant you get a payment guarantee; no matter what payment method the customer chooses. Thereby your customers get financial flexibility with Klarna, as they can choose themselves between invoice purchase and hire purchase. In the case of purchase by instalment merchants can also specify the instalment amounts and dates of repayment. Merchants can use the billing solution also for their B2B commerce.
Rate payment at the online shop motivates your customers to order high value baskets. This also increases your turnover. Klarna guarantees online consents in seconds for purchases by instalment during the order process. A PostIdent-process is not necessary. Klarna transfers the invoice amount to the merchant and bears the non-payment risk themselves. As merchant you benefit from rapidly available liquidity.
Notice: All three payment methods with restrictions of secured direct debit are available in the following countries with their respective domestic currency: Germany, Austria, Netherlands, Danmark, Sweden, Norway, Finland, United Kingdom, USA, Switzerland, Australia, Belgium, Spain, Italy, Ireland, Poland, Portugal, France und Canada.
Logo |
|
Info | Paygate can handle purchase on account and financing from Klarna. Merchants benefit from a payment guarantee and short payment due dates. As third possibility Klarna integrated the payment with Sofort transfer and secured direct debit. |
Type |
Further information can be found on Klarna's website (https://www.klarna.de).
Klarna Payments distinguishes between direct connection and the Klarna Hosted Payment Page (HPP).
Notice about Capture
Please note that the capture (capture.aspx) has to be done manually in order to process the payment and to initiate the money flow.
Process flow chart direct connection
Process flow Klarna Payments direct connection
Process flow chart HPP
Process flow Klarna Payments HPP
With direct connection a separate JavaScript widget is included for each payment method. With the HPP a complete checkout page will be displayed where all or some selected payment methods are displayed. Widgets as well as the HPP are loaded from a Klarna server.
Paygate interface
Definitions
Data formats
Format | Description |
a | alphabetical |
as | alphabetical with special characters |
n | numeric |
an | alphanumeric |
ans | alphanumeric with special characters |
ns | numeric with special characters |
bool | boolean expression (true or false) |
3 | fixed length with 3 digits/characters |
..3 | variable length with maximum 3 digits/characters |
enum | enumeration of allowed values |
dttm | ISODateTime (YYYY-MM-DDThh:mm:ss) |
Abbreviations
Abbreviation | Description | Comment |
CND | condition | |
M | mandatory | If a parameter is mandatory, then it must be present |
O | optional | If a parameter is optional, then it can be present, but it is not required |
C | conditional | If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional |
Notice: Please note that the names of parameters can be returned in upper or lower case.
Create Klarna session for direct connection
Before Klarna widgets can be loaded a Klarna session must be created which returns an AccessToken. This AccessToken has to be used for loading the widgets. In order to start a Klarna session via server-to-server communication, please use the following URL:
https://www.computop-paygate.com/KlarnaPayments.aspx
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | ||
ans..64 | M | TransactionID provided by you which should be unique for each payment | ||
ans..30 | O | Merchant’s unique reference number | ||
n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). | ||
TaxAmount | n..10 | OC | Gross amount of value added tax in the smallest currency unit (e.g. EUR Cent). The amount may not be negative. Mandatory if tax_rate and total_tax_amount is given within parameter ArticleList. Notice: The VAT included is calculated for 19% with the formula =gross prices / 1.19 * 0.19. Please contact the Computop Helpdesk, if you want to capture amounts < 100 (smallest currency unit). | |
a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table | ||
bdCountryCode | a2 | M | Country code for the invoicing address, 2 characters according to ISO 3166-1. Allowed are Germany <DE>, Austria <AT>, Netherlands <NL>, Denmark <DK>, Sweden <SE>, Norway <NO>, Finland <FI>, Great Britain <GB>, USA <US>, Switzerland (CH), Australia (AU), Belgium <BE>, Spain (ES), Italy <IT>, Ireland <IE>, Poland <PL>, <PT> Portugal, <FR> France and <CA> Canada. | |
bdFirstName | ans..30 | C | First name. Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted. Cannot be only numbers, must be more than 1 character. Allowed special characters: -'’. | |
bdLastName | ans..30 | C | Last name. Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted. Cannot be only numbers, must be more than 1 character. Allowed special characters: -'’. | |
bdEmail | ans..80 | C | Email address. Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted. Must include @ and domain. | |
bdCompany | ans..200 | C | Company name, mandatory for B2B, must be the same as sdCompany. | |
bdRegion | ans..40 | O | Region | |
bdTitle | ans..20 | O | Title of customer or contact person, e.g. Dr. or Prof. | |
bdStreet | "billing": {"addressInfo": { "addressLine1": {"street+streetNumber": "..." }}} | a..32 | C | Street and street number. Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted. Allowed special characters: -'´‘",.:;#&/()+@ °ºᵃª_ \ |
bdZip | n..5 | C | Postal code. Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted. | |
bdCity | a..32 | C | Town/city. Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted. | |
bdAddressAddition | ans..60 | O | Additional/supplementary address line | |
sdCountryCode | a2 | O | Country code for the delivery address, 2 characters according to ISO 3166-1. Allowed are Germany <DE>, Austria <AT>, Netherlands <NL>, Denmark <DK>, Sweden <SE>, Norway <NO>, Finland <FI>, Great Britain <GB>, USA <US>, Switzerland (CH), Australia (AU), Belgium <BE>, Spain (ES), Italy <IT>, Ireland <IE>, Poland <PL>, <PT> Portugal, <FR> France and <CA> Canada. | |
sdFirstName | ans..30 | C | First name. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. Cannot be only numbers, must be more than 1 character. Allowed special characters: -'’. | |
sdLastName | ans..30 | C | Last name. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. Cannot be only numbers, must be more than 1 character. Allowed special characters: -'’. | |
sdEmail | ans..80 | C | Email address. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. Must include @ and domain. | |
sdCompany | ans..200 | C | Company name, mandatory for B2B, must be the same as bdCompany. | |
sdRegion | ans..40 | O | Region | |
sdTitle | ans..20 | O | Title of customer or contact person, e.g. Dr. or Prof. | |
sdStreet | "shipping": {"addressInfo": { "addressLine1": {"street+streetNumber": "..." }}} | a..32 | C | Street and street number. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. Allowed special characters: -'´‘",.:;#&/()+@ °ºᵃª_ \ |
sdZip | n..5 | C | Postal code. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. | |
sdCity | a..32 | C | Town/city. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. | |
sdAddressAddition | ans..60 | O | Additional/supplementary address line | |
Language | a2 | M | Language for displaying the widgets: DE - German, DK - Danish, FI - Finnish, SE - Swedish, NO - Norwegian, NL - Dutsch, FR - French, IT - Italian, EN - English, ES - Spanish, CA - Catalan, PL - Polish | |
––– | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. | ||
IPAddr | ans..15 | O | IP address of the client in the format IPv4 or IPv6 | |
Account | ans..12 | M | Within Paygate several Klarna user names can be stored on one MerchantID and controlled by the parameter Account. By default, please use the value "0", if you have several Klarna accounts, the values must be agreed with Computop Helpdesk. | |
ArticleList | ans..2048 | M | Complete article list of the order. This parameter must be created in JSON format. The individual parameters in JSON format are following: name = Product name (mandatory) quantity = item quantity. The value may not be negative. (mandatory) unit_price = unit price inclusive taxes but without rebates. (mandatory) total_amount = total amount of iarticles inclusive taxes and rebates. (mandatory) image_url = URL for an image that can be embedded later in agreement with Klarna. (max. 1024 characters) merchant_data = "pass-through parameter" (max. 255 characters). Merchant must agree with Klarna what will be transmitted here. product_identifiers.brand = product brand product_identifiers.category_path = path of product category. As separator '>' has to be used. product_identifiers.global_trade_item_number = article number (e.g. EAN, ISBN or UPC). product_identifiers.manufacturer_part_number = manufacturer’s number product_url = URL to product image quantity_unit = unit of quantity (e.g. kg) reference = article number (e.g. SKU) tax_rate = tax rate as percentage (e.g. 25%). The percent sign must be replaced with two zeros, thus for example 2500. The value may not be negative. (Mandatory, if total_tax_amount or parameter TaxAmount is given.) total_discount_amount = total amount of rebate. The value may not be negative. total_tax_amount = total amount of taxes. The value may be negative, if type is 'discount'. (Mandatory, if tax_rate or parameter TaxAmount is given.) type = type of item position. Possible entries are <physical>, <discount>, <shipping_fee>, <sales_tax>, <digital>, <gift_card>, <store_credit>, <surcharge> Afterwards the article list created in JSON format must be Base64 encoded. | |
EnhancedData | ans..2048 | O | Additional customer and order information for Klarna risk management. Merchant must agree with Klarna which data will be transmitted here. This parameter must be created in JSON format. Afterwards the additional information created in JSON format must be Base64 encoded. | |
Layout | ans..2048 | O | Layout parameters for Klarna widgets. This parameter must be created in JSON format. Afterwards the layout parameters created in JSON format must be Base64 encoded. | |
URLConfirm | ans..256 | M | Final URL for order confirmation to which Klarna forwards the customer after the order is successfully created within the Klarna system | |
URLNotify | ans..256 | O | Complete URL which Paygate calls up in order to notify the shop about the payment result, if a PENDING transaction was finalized. The URL may be called up only via port 443 It may not contain parameters: Use the parameter UserData instead. Processing of PENDING transactions must be activated at Computop as well as Klarna. URLNotify can also be stored with Computop. | |
PayType | enum | M | Customer selected Klarna payment method. Possible entries are Pay immediately (pay_now, direct_debit or direct_bank_transfer), Pay later (pay_later), Pay in installments (pay_over_time or One Klarna (klarna). | |
Personal details of customer | ||||
DateOfBirth | dttm | O | Date of birth in the format YYYY-MM-DD | |
Gender | a..15 | O | Gender <female> for female, <male> for male | |
Title | a..12 | O | Salutation | |
SocialSecurityNumber | a..5 | O | Private individuals: The last four or five digits of the social security number. Not in DE, AT and NL. Obligatory field in SE, FI, DK with 4-digit value (NNNN). Obligatory field in NO with 5-digit value (NNNNN). | |
PersonID | ans..15 | O | National identity number. Is necessary for example for a visa to entry the USA. For that purpose the serial number on the upper right side of the identity card may be used. | |
LegalForm | ans..50 | C | Type of company. Mandatory for B2B. Following values are possible:
| |
CompanyID | "billing": {"business": { "companyRegistrationNumber": "..." }} | ans..15 | O | For companies: Register of Companies number, only relevant but not mandatory for B2B. |
CompanyOrPerson | a2 | O | Indication whether it is a company or a person. <C> for companies, <P> for persons Please note that Klarna does not allow B2B transactions by default. Please contact Klarna if you also want to use the payment method for B2B transactions. | |
VatID | ans..15 | O | VAT identification number, only relevant but not mandatory for B2B. |
Parameters for creating a session with Klarna Payments
The following table describes the result parameters with which the Computop Paygate responds to your system
pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | ||
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | ||
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | ||
ans..64 | M | TransactionID provided by you which should be unique for each payment | ||
ans..30 | O | Merchant’s unique reference number | ||
Status | a..50 | M | AUTHORIZE_REQUEST (URLSuccess) and FAILED (URLFailure) | |
ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! | ||
ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. | ||
Code | n1..8 | M | Error code according to Paygate Response Codes (A4 Error codes). Code "0": Please make now the authorisation via Klarna widget within the frontend. | |
CodeExt | ans..50 | O | Error code from Klarna, if agreed with Computop Helpdesk | |
ErrorText | ans..1024 | O | Error text from Klarna, if agreed with Computop Helpdesk | |
AccessToken | ans..2048 | O | Client token from Klarna. In order to be able to subsequently show the Klarna widgets, the Klarna JavaScript-API must be initialized with this token. | |
PayType | enum | M | Customer selected Klarna payment method. Possible entries are Pay immediately (pay_now, direct_debit or direct_bank_transfer), Pay later (pay_later), Pay in installments (pay_over_time or One Klarna (klarna). The returned value determines which widgets are allowed to be loaded. |
Response parameters for creating a session with Klarna Payments
Show Klarna widgets
Klarna uses widgets in order to show customers the possible payment methods. The available payment methods for selecting depend on the previously selected category (see Create Klarna Session, PayType). The widget integration is done with the AccessToken (see Create Klarna Session, AccessToken) and the Klarna JavaScript SDK. How to integrate and initialise the Klarna JavaScript SDK and how to load the widgets is described on Klarna webpage:
After successful authorisation you will get an authorisation token (TokenExt) which has to be used for creating an order.
Create Klarna session for the HPP
In order to process a payment via Klarna HPP, please use the following URL:
https://www.computop-paygate.com/KlarnaPaymentsHPP.aspx
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | ||
ans..64 | M | TransactionID provided by you which should be unique for each payment | ||
ans..30 | O | Merchant’s unique reference number | ||
n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). | ||
TaxAmount | n..10 | OC | Gross amount of value added tax in the smallest currency unit (e.g. EUR Cent). The amount may not be negative. Mandatory if tax_rate and total_tax_amount is given within parameter ArticleList. Notice: The VAT included is calculated for 19% with the formula =gross prices / 1.19 * 0.19. Please contact the Computop Helpdesk, if you want to capture amounts < 100 (smallest currency unit). | |
a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table | ||
RTF | ––– | a1 | O | For repeat payments (subscriptions): I = Initial payment of a new subscription, R = Routine payment (Recurring). Due to the call of the HPP is always an initial payment of a subscription the value must be transferred. |
bdCountryCode | a2 | M | Country code for the invoicing address, 2 characters according to ISO 3166-1. Allowed are Germany <DE>, Austria <AT>, Netherlands <NL>, Denmark <DK>, Sweden <SE>, Norway <NO>, Finland <FI>, Great Britain <GB>, USA <US>, Switzerland (CH), Australia (AU), Belgium <BE>, Spain (ES), Italy <IT>, Ireland <IE>, Poland <PL>, <PT> Portugal, <FR> France and <CA> Canada. | |
bdFirstName | ans..30 | C | First name. Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted. Cannot be only numbers, must be more than 1 character. Allowed special characters: -'’. | |
bdLastName | ans..30 | C | Last name. Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted. Cannot be only numbers, must be more than 1 character. Allowed special characters: -'’. | |
bdEmail | ans..80 | C | Email address. Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted. Must include @ and domain. | |
bdCompany | ans..200 | C | Company name, mandatory for B2B, must be the same as sdCompany. | |
bdRegion | ans..40 | O | Region | |
bdTitle | ans..20 | O | Title of customer or contact person, e.g. Dr. or Prof. | |
bdStreet | "billing": {"addressInfo": { "addressLine1": {"street+streetNumber": "..." }}} | a..32 | C | Street and street number. Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted. Allowed special characters: -'´‘",.:;#&/()+@ °ºᵃª_ \ |
bdZip | n..5 | C | Postal code. Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted. | |
bdCity | a..32 | C | Town/city. Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted. | |
bdAddressAddition | ans..60 | O | Additional/supplementary address line | |
sdCountryCode | a2 | O | Country code for the delivery address, 2 characters according to ISO 3166-1. Allowed are Germany <DE>, Austria <AT>, Netherlands <NL>, Denmark <DK>, Sweden <SE>, Norway <NO>, Finland <FI>, Great Britain <GB>, USA <US>, Switzerland (CH), Australia (AU), Belgium <BE>, Spain (ES), Italy <IT>, Ireland <IE>, Poland <PL>, <PT> Portugal, <FR> France and <CA> Canada. | |
sdFirstName | ans..30 | C | First name. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. Cannot be only numbers, must be more than 1 character. Allowed special characters: -'’. | |
sdLastName | ans..30 | C | Last name. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. Cannot be only numbers, must be more than 1 character. Allowed special characters: -'’. | |
sdEmail | ans..80 | C | Email address. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. Must include @ and domain. | |
sdCompany | ans..200 | C | Company name, mandatory for B2B, must be the same as bdCompany. | |
sdRegion | ans..40 | O | Region | |
sdTitle | ans..20 | O | Title of customer or contact person, e.g. Dr. or Prof. | |
sdStreet | "shipping": {"addressInfo": { "addressLine1": {"street+streetNumber": "..." }}} | a..32 | C | Street and street number. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. Allowed special characters: -'´‘",.:;#&/()+@ °ºᵃª_ \ |
sdZip | n..5 | C | Postal code. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. | |
sdCity | a..32 | C | Town/city. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. | |
sdAddressAddition | ans..60 | O | Additional/supplementary address line | |
Language | a2 | M | Language for displaying the widgets: DE - German, DK - Danish, FI - Finnish, SE - Swedish, NO - Norwegian, NL - Dutsch, FR - French, IT - Italian, EN - English, ES - Spanish, CA - Catalan, PL - Polish | |
––– | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. | ||
IPAddr | ans..15 | O | IP address of the client in the format IPv4 or IPv6 | |
Account | ans..12 | M | Within Paygate several Klarna user names can be stored on one MerchantID and controlled by the parameter Account. By default, please use the value "0", if you have several Klarna accounts, the values must be agreed with Computop Helpdesk. | |
ArticleList | ans..2048 | M | Complete article list of the order. This parameter must be created in JSON format. The individual parameters in JSON format are following: name = Product name (mandatory) quantity = item quantity. The value may not be negative. (mandatory) unit_price = unit price inclusive taxes but without rebates. (mandatory) total_amount = total amount of iarticles inclusive taxes and rebates. (mandatory) image_url = URL for an image that can be embedded later in agreement with Klarna. (max. 1024 characters) merchant_data = "pass-through parameter" (max. 255 characters). Merchant must agree with Klarna what will be transmitted here. product_identifiers.brand = product brand product_identifiers.category_path = path of product category. As separator '>' has to be used. product_identifiers.global_trade_item_number = article number (e.g. EAN, ISBN or UPC). product_identifiers.manufacturer_part_number = manufacturer’s number product_url = URL to product image quantity_unit = unit of quantity (e.g. kg) reference = article number (e.g. SKU) tax_rate = tax rate as percentage (e.g. 25%). The percent sign must be replaced with two zeros, thus for example 2500. The value may not be negative. (Mandatory, if total_tax_amount or parameter TaxAmount is given.) total_discount_amount = total amount of rebate. The value may not be negative. total_tax_amount = total amount of taxes. The value may be negative, if type is 'discount'. (Mandatory, if tax_rate or parameter TaxAmount is given.) type = type of item position. Possible entries are <physical>, <discount>, <shipping_fee>, <sales_tax>, <digital>, <gift_card>, <store_credit>, <surcharge> Afterwards the article list created in JSON format must be Base64 encoded. | |
EnhancedData | ans..2048 | O | Additional customer and order information for Klarna risk management. Merchant must agree with Klarna which data will be transmitted here. This parameter must be created in JSON format. Afterwards the additional information created in JSON format must be Base64 encoded. | |
Layout | ans..2048 | O | Layout parameters for Klarna widgets. This parameter must be created in JSON format. Afterwards the layout parameters created in JSON format must be Base64 encoded. | |
Order | "payment": {"klarnaHpp": { "automaticOrderCreation": "..." }} | ans..6 | O | Activates the automatic order creation. If this parameter is used an explicit order creation is not necessary. If a BillingAgreementID for recurring payments should be created, also the parameter RTF=I must be submitted. Only possible value: AUTO If you would like to use the automatic order processing direct through Paygate (request parameter does not have to be sent), please contact the Computop Merchant Service directly (Computop Sales) and our team will store the required setting directly at your account.| |
ans..256 | M | Complete URL which calls up Paygate if payment has been successful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData. Common notes:
| ||
ans..256 | M | Complete URL which calls up Paygate if payment has been unsuccessful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData. Common notes:
| ||
––– | a7 | O | Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter. | |
URLNotify | ans..256 | O | Complete URL which Paygate calls up in order to notify the shop about the payment result, if a PENDING transaction was finalized. The URL may be called up only via port 443 It may not contain parameters: Use the parameter UserData instead. Processing of PENDING transactions must be activated at Computop as well as Klarna. URLNotify can also be stored with Computop. | |
Personal details of customer | ||||
DateOfBirth | dttm | O | Date of birth in the format YYYY-MM-DD | |
Gender | a..15 | O | Gender <female> for female, <male> for male | |
Title | a..12 | O | Salutation | |
SocialSecurityNumber | a..5 | O | Private individuals: The last four or five digits of the social security number. Not in DE, AT and NL. Obligatory field in SE, FI, DK with 4-digit value (NNNN). Obligatory field in NO with 5-digit value (NNNNN). | |
PersonID | ans..15 | O | National identity number. Is necessary for example for a visa to entry the USA. For that purpose the serial number on the upper right side of the identity card may be used. | |
LegalForm | ans..50 | C | Type of company. Mandatory for B2B. Following values are possible:
| |
CompanyID | "billing": {"business": { "companyRegistrationNumber": "..." }} | ans..15 | O | For companies: Register of Companies number, only relevant but not mandatory for B2B. |
CompanyOrPerson | a2 | O | Indication whether it is a company or a person. <C> for companies, <P> for persons Please note that Klarna does not allow B2B transactions by default. Please contact Klarna if you also want to use the payment method for B2B transactions. | |
VatID | ans..15 | O | VAT identification number, only relevant but not mandatory for B2B. |
Parameters for calling the Klarna HPP
In case of using REST API
In case of using REST API you will always receive a link where the merchant has to redirect the consumer to complete the payment.
REST | Format | CND | Description |
"paymentId": "..." | an32 | M | May be "00000000000000000000000000000000" if not yet set by Computop Paygate |
"_Links.self.type": "..." | an..20 | M | "application/json" |
"_Links.redirect.href": "..." | an..1024 | M | Merchant needs to redirect consumer to this URL to complete payment |
"_Links.redirect.type": "..." | an..20 | M | "text/html" |
Merchant can use inquire.aspx
In case of using Key-Value-Pair API
The following table gives the result parameters which Computop Paygate transmits to URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | |
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | |
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | |
ans..64 | M | TransactionID provided by you which should be unique for each payment | |
ans..30 | O | Merchant’s unique reference number | |
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. | |
a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | |
ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! | |
Code | n1..8 | M | Error code according to Paygate Response Codes (A4 Error codes). Code "0": Please make now the authorisation via Klarna widget within the frontend. |
BillingAgreementID | ans..50 | O | Token-ID (Consumer Token) from Klarna which must be additionally transferred for recurring payments. The value is returned only if request was made with RTF=I. |
CodeExt | ans..50 | O | Error code from Klarna, if agreed with Computop Helpdesk |
ErrorText | ans..1024 | O | Error text from Klarna, if agreed with Computop Helpdesk |
TokenExt | ans..36 | M | Authorisation token which is needed for creating an order |
Result parameters for URLNotify, URLSuccess and URLFailure
Create order with Klarna
In order to create the order within Klarna system via a server-to-server connection, please use the following URL:
https://www.computop-paygate.com/KlarnaPayments.aspx
If this is an initial order of a recurring order (RTF=I), then only the billing address can be submitted, not the delivery adress.
If the address data differs from the address data transferred from the JavaScript widget during authorization, the order will be rejected.
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | ||
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | ||
ans..64 | M | TransactionID provided by you which should be unique for each payment | ||
ans..30 | O | Merchant’s unique reference number | ||
n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). | ||
TaxAmount | n..10 | OC | Gross amount of value added tax in the smallest currency unit (e.g. EUR Cent). The amount may not be negative. Mandatory if tax_rate and total_tax_amount is given within parameter ArticleList. Notice: The VAT included is calculated for 19% with the formula =gross prices / 1.19 * 0.19. Please contact the Computop Helpdesk, if you want to capture amounts < 100 (smallest currency unit). | |
a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table | ||
TokenExt | ans..36 | M | Authorisation token which is returned from Klarna within JavaScript Authorize-Call. Please note, the authorization token from the previous step is valid for 60 minutes. If you attempt to place an order with this after that time has passed, it will be rejected by Klarna. | |
EventToken | enum | M | Defines which Klarna API-Call request will be initiated. For creating a Klarna order the value CNO must be transferred. | |
RTF | ––– | a1 | O | For repeat payments (subscriptions): I = Initial payment of a new subscription, R = Routine payment (Recurring). Due to the call of the HPP is always an initial payment of a subscription the value must be transferred. |
RequestReason | a..20 | O | Intended usage of „Consumer Token“. Possible value is SUBSCRIPTION. | |
Note | ans..50 | O | Description for the purpose of token (e.g. Abo) | |
ArticleList | ans..2048 | M | Complete article list of the order. This parameter must be created in JSON format. The individual parameters in JSON format are following: name = Product name (mandatory) quantity = item quantity. The value may not be negative. (mandatory) unit_price = unit price inclusive taxes but without rebates. (mandatory) total_amount = total amount of iarticles inclusive taxes and rebates. (mandatory) image_url = URL for an image that can be embedded later in agreement with Klarna. (max. 1024 characters) merchant_data = "pass-through parameter" (max. 255 characters). Merchant must agree with Klarna what will be transmitted here. product_identifiers.brand = product brand product_identifiers.category_path = path of product category. As separator '>' has to be used. product_identifiers.global_trade_item_number = article number (e.g. EAN, ISBN or UPC). product_identifiers.manufacturer_part_number = manufacturer’s number product_url = URL to product image quantity_unit = unit of quantity (e.g. kg) reference = article number (e.g. SKU) tax_rate = tax rate as percentage (e.g. 25%). The percent sign must be replaced with two zeros, thus for example 2500. The value may not be negative. (Mandatory, if total_tax_amount or parameter TaxAmount is given.) total_discount_amount = total amount of rebate. The value may not be negative. total_tax_amount = total amount of taxes. The value may be negative, if type is 'discount'. (Mandatory, if tax_rate or parameter TaxAmount is given.) type = type of item position. Possible entries are <physical>, <discount>, <shipping_fee>, <sales_tax>, <digital>, <gift_card>, <store_credit>, <surcharge> Afterwards the article list created in JSON format must be Base64 encoded. | |
bdCountryCode | a2 | M | Country code for the invoicing address, 2 characters according to ISO 3166-1. Allowed are Germany <DE>, Austria <AT>, Netherlands <NL>, Denmark <DK>, Sweden <SE>, Norway <NO>, Finland <FI>, Great Britain <GB>, USA <US>, Switzerland (CH), Australia (AU), Belgium <BE>, Spain (ES), Italy <IT>, Ireland <IE>, Poland <PL>, <PT> Portugal, <FR> France and <CA> Canada. | |
bdFirstName | ans..30 | C | First name. Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted. Cannot be only numbers, must be more than 1 character. Allowed special characters: -'’. | |
bdLastName | ans..30 | C | Last name. Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted. Cannot be only numbers, must be more than 1 character. Allowed special characters: -'’. | |
bdEmail | ans..80 | C | Email address. Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted. Must include @ and domain. | |
bdCompany | ans..200 | C | Company name, mandatory for B2B, must be the same as sdCompany. | |
bdRegion | ans..40 | O | Region | |
bdTitle | ans..20 | O | Title of customer or contact person, e.g. Dr. or Prof. | |
bdStreet | "billing": {"addressInfo": { "addressLine1": {"street+streetNumber": "..." }}} | a..32 | C | Street and street number. Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted. Allowed special characters: -'´‘",.:;#&/()+@ °ºᵃª_ \ |
bdZip | n..5 | C | Postal code. Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted. | |
bdCity | a..32 | C | Town/city. Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted. | |
bdAddressAddition | ans..60 | O | Additional/supplementary address line | |
sdCountryCode | a2 | O | Country code for the delivery address, 2 characters according to ISO 3166-1. Allowed are Germany <DE>, Austria <AT>, Netherlands <NL>, Denmark <DK>, Sweden <SE>, Norway <NO>, Finland <FI>, Great Britain <GB>, USA <US>, Switzerland (CH), Australia (AU), Belgium <BE>, Spain (ES), Italy <IT>, Ireland <IE>, Poland <PL>, <PT> Portugal, <FR> France and <CA> Canada. | |
sdFirstName | ans..30 | C | First name. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. Cannot be only numbers, must be more than 1 character. Allowed special characters: -'’. | |
sdLastName | ans..30 | C | Last name. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. Cannot be only numbers, must be more than 1 character. Allowed special characters: -'’. | |
sdEmail | ans..80 | C | Email address. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. Must include @ and domain. | |
sdCompany | ans..200 | C | Company name, mandatory for B2B, must be the same as bdCompany. | |
sdRegion | ans..40 | O | Region | |
sdTitle | ans..20 | O | Title of customer or contact person, e.g. Dr. or Prof. | |
sdStreet | "shipping": {"addressInfo": { "addressLine1": {"street+streetNumber": "..." }}} | a..32 | C | Street and street number. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. Allowed special characters: -'´‘",.:;#&/()+@ °ºᵃª_ \ |
sdZip | n..5 | C | Postal code. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. | |
sdCity | a..32 | C | Town/city. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. | |
sdAddressAddition | ans..60 | O | Additional/supplementary address line |
Parameters for creating an order with Klarna
The following table describes the result parameters with which the Computop Paygate responds to your system
pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | ||
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | ||
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | ||
ans..64 | M | TransactionID provided by you which should be unique for each payment | ||
ans..30 | O | Merchant’s unique reference number | ||
a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | ||
ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! | ||
an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | ||
TransactionID | an12 | O | Reference number from Klarna system | |
BillingAgreementID | ans..50 | O | Token-ID (Consumer Token) from Klarna which must be additionally transferred for recurring payments. The value is returned only if request was made with RTF=I. | |
RedirectURL | ans..256 | O | The customer must be forwarded to this URL so that Klarna can place a Cookie. The customer remains unaware of this process. | |
CodeExt | ans..50 | O | Error code from Klarna, if agreed with Computop Helpdesk | |
ErrorText | ans..1024 | O | Error text from Klarna, if agreed with Computop Helpdesk |
Response parameters for creating an order with Klarna
Create recurring order (Abo) with Klarna
In order to create a recurring order (e.g. Abo) with Klarna, please use the following URL:
https://www.computop-paygate.com/KlarnaPayments.aspx
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | ||
ans..64 | M | TransactionID provided by you which should be unique for each payment | ||
ans..30 | O | Merchant’s unique reference number | ||
n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). | ||
TaxAmount | n..10 | OC | Gross amount of value added tax in the smallest currency unit (e.g. EUR Cent). The amount may not be negative. Mandatory if tax_rate and total_tax_amount is given within parameter ArticleList. Notice: The VAT included is calculated for 19% with the formula =gross prices / 1.19 * 0.19. Please contact the Computop Helpdesk, if you want to capture amounts < 100 (smallest currency unit). | |
a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table | ||
––– | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
EventToken | enum | M | Defines which Klarna API-Call request will be initiated. For creating a Klarna order the value CNO must be transferred. | |
BillingAgreementID | ans..50 | M | Token-ID (Consumer Token) from Klarna which must be additionally transferred for recurring payments. | |
RTF | ––– | a1 | M | For repeat payments (subscriptions): I = Initial payment of a new subscription, R = Routine payment (Recurring). For this request the value R must be transferred. |
Account | ans..12 | M | Within Paygate several Klarna user names can be stored on one MerchantID and controlled by the parameter Account. By default, please use the value "0", if you have several Klarna accounts, the values must be agreed with Computop Helpdesk. | |
ArticleList | ans..2048 | M | Complete article list of the order. This parameter must be created in JSON format. The individual parameters in JSON format are following: name = Product name (mandatory) quantity = item quantity. The value may not be negative. (mandatory) unit_price = unit price inclusive taxes but without rebates. (mandatory) total_amount = total amount of iarticles inclusive taxes and rebates. (mandatory) image_url = URL for an image that can be embedded later in agreement with Klarna. (max. 1024 characters) merchant_data = "pass-through parameter" (max. 255 characters). Merchant must agree with Klarna what will be transmitted here. product_identifiers.brand = product brand product_identifiers.category_path = path of product category. As separator '>' has to be used. product_identifiers.global_trade_item_number = article number (e.g. EAN, ISBN or UPC). product_identifiers.manufacturer_part_number = manufacturer’s number product_url = URL to product image quantity_unit = unit of quantity (e.g. kg) reference = article number (e.g. SKU) tax_rate = tax rate as percentage (e.g. 25%). The percent sign must be replaced with two zeros, thus for example 2500. The value may not be negative. (Mandatory, if total_tax_amount or parameter TaxAmount is given.) total_discount_amount = total amount of rebate. The value may not be negative. total_tax_amount = total amount of taxes. The value may be negative, if type is 'discount'. (Mandatory, if tax_rate or parameter TaxAmount is given.) type = type of item position. Possible entries are <physical>, <discount>, <shipping_fee>, <sales_tax>, <digital>, <gift_card>, <store_credit>, <surcharge> Afterwards the article list created in JSON format must be Base64 encoded. |
Parameters for a recurring order (Abo) with Klarna Payments
The following table describes the result parameters with which the Computop Paygate responds to your system
pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | ||
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | ||
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | ||
ans..64 | M | TransactionID provided by you which should be unique for each payment | ||
ans..30 | O | Merchant’s unique reference number | ||
a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | ||
ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! | ||
an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | ||
TransactionID | an12 | O | Reference number from Klarna system | |
CodeExt | ans..50 | O | Error code from Klarna, if agreed with Computop Helpdesk | |
ErrorText | ans..1024 | O | Error text from Klarna, if agreed with Computop Helpdesk |
Response parameters for a recurring order (Abo) with Klarna Payments
Modify invoice and delivery address
Invoice and delivery information was transferred within Klarna widget. As long as no capture is made invoice and/or delivery address can be modified subsequently. For this purpose please use the following URL:
https://www.computop-paygate.com/KlarnaPayments.aspx
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | ||
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | ||
––– | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
EventToken | enum | M | Defines which Klarna API-Call request will be initiated. For updating invoice and/or delivery address the value UCA must be transferred. | |
Invoicing adress | ||||
bdTitle | a..12 | O | Salutation | |
bdFirstName | ans..30 | O | First name. Cannot be only numbers, must be more than 1 character. Allowed special characters: -'’. | |
bdLastName | ans..30 | O | Last name. Cannot be only numbers, must be more than 1 character. Allowed special characters: -'’. | |
bdCompany | ans..30 | O | Company. Only for B2B relevant, must be the same as sdCompany. | |
bdStreet | "billing": {"addressInfo": { "addressLine1": {"street+streetNumber": "..." }}} | a..32 | O | Street name and street number. Allowed special characters: -'´‘",.:;#&/()+@ °ºᵃª_ \ |
bdAddressAddition | ans..50 | O | Address line 2 | |
bdZip | n..5 | O | Postcode | |
bdCity | a..32 | O | City | |
bdRegion | a..32 | O | Region | |
bdCountryCode | a2 | O | Country code for the invoicing address, 2 characters according to ISO 3166-1. Allowed are Germany <DE>, Austria <AT>, Netherlands <NL>, Denmark <DK>, Sweden <SE>, Norway <NO>, Finland <FI>, Great Britain <GB>, USA <US>, Switzerland (CH), Australia (AU), Belgium <BE>, Spain (ES), Italy <IT>, Ireland <IE>, Poland <PL>, <PT> Portugal, <FR> France and <CA> Canada. | |
bdEmail | ans..80 | O | E-mail address. Must include @ and domain. | |
bdPhone | n..20 | O | Phone number or mobile phone number | |
Delivery address | ||||
sdTitle | a..12 | O | Salutation | |
sdFirstName | ans..30 | O | First name. Cannot be only numbers, must be more than 1 character. Allowed special characters: -'’. | |
sdLastName | ans..30 | O | Last name. Cannot be only numbers, must be more than 1 character. Allowed special characters: -'’. | |
sdCompany | ans..50 | O | Company. Only for B2B relevant, must be the same as bdCompany. | |
sdStreet | "shipping": {"addressInfo": { "addressLine1": {"street+streetNumber": "..." }}} | a..32 | O | Street name and street number. Allowed special characters: -'´‘",.:;#&/()+@ °ºᵃª_ \ |
sdAddressAddition | ans..50 | O | Address line 2 | |
sdZip | n..5 | O | Postcode | |
sdCity | a..32 | O | City | |
sdRegion | a..32 | O | Region | |
sdCountryCode | a2 | O | Country code for the delivery address, 2 characters according to ISO 3166-1. Allowed are Germany <DE>, Austria <AT>, Netherlands <NL>, Denmark <DK>, Sweden <SE>, Norway <NO>, Finland <FI>, Great Britain <GB>, USA <US>, Switzerland (CH), Australia (AU), Belgium <BE>, Spain (ES), Italy <IT>, Ireland <IE>, Poland <PL>, <PT> Portugal, <FR> France and <CA> Canada. | |
sdEmail | ans..80 | O | E-mail address. Must include @ and domain. | |
sdPhone | n..20 | O | Phone number or mobile phone number |
Parameters for address modification with Klarna Payments
The following table describes the result parameters with which the Computop Paygate responds to your system
pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | ||
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | ||
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | ||
ans..64 | M | TransactionID provided by you which should be unique for each payment | ||
ans..30 | O | Merchant’s unique reference number | ||
a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | ||
ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! | ||
an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | ||
CodeExt | ans..50 | O | Error code from Klarna, if agreed with Computop Helpdesk | |
ErrorText | ans..1024 | O | Error text from Klarna, if agreed with Computop Helpdesk |
Response parameters for address modification with Klarna Payments
Modify unique reference number
As long as no capture is made the unique reference number which already was sent along within parameter RefNr for creating the Klarna session can be modified subsequently. For this purpose please use the following URL:
https://www.computop-paygate.com/KlarnaPayments.aspx
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | ||
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | ||
EventToken | enum | M | Defines which Klarna API-Call request will be initiated. For updating the unique reference number the value UMR must be transferred. | |
ans..30 | O | Merchant’s unique reference number | ||
––– | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Parameters for modification of reference number with Klarna Payments
The following table describes the result parameters with which the Computop Paygate responds to your system
pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | ||
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | ||
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | ||
ans..64 | M | TransactionID provided by you which should be unique for each payment | ||
ans..30 | O | Merchant’s unique reference number | ||
a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | ||
ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! | ||
an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | ||
CodeExt | ans..50 | O | Error code from Klarna, if agreed with Computop Helpdesk | |
ErrorText | ans..1024 | O | Error text from Klarna, if agreed with Computop Helpdesk |
Response parameters for modification of reference number with Klarna Payments
Modify order amount and article list
As long as no capture is made the order amount as well as the whole article list can be modified subsequently. For this purpose please use the following URL:
https://www.computop-paygate.com/KlarnaPayments.aspx
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | ||
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | ||
ans..64 | M | TransactionID provided by you which should be unique for each payment | ||
ans..30 | O | Merchant’s unique reference number | ||
Amount | n..10 | M | New total amount in the smallest currency unit (e.g. EUR Cent) The amount may not be negative. Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). Notice: The new amount may not be higher than the amount transferred within the initial request. | |
a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table | ||
––– | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
EventToken | enum | M | Defines which Klarna API-Call request will be initiated. For modifying of order amount and article list the value UEO must be transferred. | |
ArticleList | ans..2048 | M | Complete article list of the order. This parameter must be created in JSON format. The individual parameters in JSON format are following: name = Product name (mandatory) quantity = item quantity. The value may not be negative. (mandatory) unit_price = unit price inclusive taxes but without rebates. (mandatory) total_amount = total amount of iarticles inclusive taxes and rebates. (mandatory) image_url = URL for an image that can be embedded later in agreement with Klarna. (max. 1024 characters) merchant_data = "pass-through parameter" (max. 255 characters). Merchant must agree with Klarna what will be transmitted here. product_identifiers.brand = product brand product_identifiers.category_path = path of product category. As separator '>' has to be used. product_identifiers.global_trade_item_number = article number (e.g. EAN, ISBN or UPC). product_identifiers.manufacturer_part_number = manufacturer’s number product_url = URL to product image quantity_unit = unit of quantity (e.g. kg) reference = article number (e.g. SKU) tax_rate = tax rate as percentage (e.g. 25%). The percent sign must be replaced with two zeros, thus for example 2500. The value may not be negative. (Mandatory, if total_tax_amount or parameter TaxAmount is given.) total_discount_amount = total amount of rebate. The value may not be negative. total_tax_amount = total amount of taxes. The value may be negative, if type is 'discount'. (Mandatory, if tax_rate or parameter TaxAmount is given.) type = type of item position. Possible entries are <physical>, <discount>, <shipping_fee>, <sales_tax>, <digital>, <gift_card>, <store_credit>, <surcharge> Afterwards the article list created in JSON format must be Base64 encoded. |
Parameters for modifying order amount and article list with Klarna Payments
The following table describes the result parameters with which the Computop Paygate responds to your system
pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | ||
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | ||
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | ||
ans..64 | M | TransactionID provided by you which should be unique for each payment | ||
ans..30 | O | Merchant’s unique reference number | ||
a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | ||
ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! | ||
an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | ||
CodeExt | ans..50 | O | Error code from Klarna, if agreed with Computop Helpdesk | |
ErrorText | ans..1024 | O | Error text from Klarna, if agreed with Computop Helpdesk |
Response parameters for modification of order amount and article list with Klarna Payments
Capture
Captures are possible via a Server-to-Server connection. To carry out a complete or partial capture for Klarna Payments via a Server-to-Server connection, please use the following URL:
https://www.computop-paygate.com/capture.aspx
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | ||
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | ||
ans..64 | M | TransactionID provided by you which should be unique for each payment | ||
Amount | n..10 | M | Amount to be captured in the smallest currency unit including taxes and rebates (e.g. EUR Cent). Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). Notice: It depends on the amount whether a full or partial capture is made. | |
Currency | a..3 | M | Currency, three characters DIN / ISO 4217, permitted are: AUD, CHF, DKK, EUR, GBP, NOK, SEK, USD. | |
ans..30 | O | Merchant’s unique reference number | ||
––– | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
ans..32 | O | To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly. Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate. | ||
ShippingData | ans..2048 | O | Delivery information (e.g. tracking data). This parameter must be created in JSON format. Afterwards the delivery information created in JSON format must be Base64 encoded. | |
ArticleList | ans..2048 | O | Complete article list of the order. This parameter must be created in JSON format. The individual parameters in JSON format are following: name = Product name (mandatory) quantity = item quantity. The value may not be negative. (mandatory) unit_price = unit price inclusive taxes but without rebates. (mandatory) total_amount = total amount of iarticles inclusive taxes and rebates. (mandatory) image_url = URL for an image that can be embedded later in agreement with Klarna. (max. 1024 characters) merchant_data = "pass-through parameter" (max. 255 characters). Merchant must agree with Klarna what will be transmitted here. product_identifiers.brand = product brand product_identifiers.category_path = path of product category. As separator '>' has to be used. product_identifiers.global_trade_item_number = article number (e.g. EAN, ISBN or UPC). product_identifiers.manufacturer_part_number = manufacturer’s number product_url = URL to product image quantity_unit = unit of quantity (e.g. kg) reference = article number (e.g. SKU) tax_rate = tax rate as percentage (e.g. 25%). The percent sign must be replaced with two zeros, thus for example 2500. The value may not be negative. (Mandatory, if total_tax_amount or parameter TaxAmount is given.) total_discount_amount = total amount of rebate. The value may not be negative. total_tax_amount = total amount of taxes. The value may be negative, if type is 'discount'. (Mandatory, if tax_rate or parameter TaxAmount is given.) type = type of item position. Possible entries are <physical>, <discount>, <shipping_fee>, <sales_tax>, <digital>, <gift_card>, <store_credit>, <surcharge> Afterwards the article list created in JSON format must be Base64 encoded. | |
CompleteType | a3 | O | With this parameter during a partial capture it is possible to reverse the remaining amount simultaneously. Possible value <YES>. If the order was processed completely this parameter will cause an error, because a remaining amount of 0 cannot be reversed. |
Parameters for captures with Klarna Payments
The following table describes the result parameters with which the Computop Paygate responds to your system
pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | ||
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | ||
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | ||
ans..64 | M | TransactionID provided by you which should be unique for each payment | ||
ans..30 | O | Merchant’s unique reference number | ||
a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | ||
ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! | ||
an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | ||
InvoiceNr | ans..30 | M | Invoice/booking number from Klarna. This number is needed for example for resending the E-Mail with payment and order information. | |
CodeExt | ans..50 | O | Error code from Klarna, if agreed with Computop Helpdesk | |
ErrorText | ans..1024 | O | Error text from Klarna, if agreed with Computop Helpdesk |
Response parameters for captures with Klarna Payments
Resending an activated invoice
It may happen that a customer hasn’t received the E-Mail with payment and order information. This request is possible only if a capture was already made. For resending this E-Mail, please use the following URL:
https://www.computop-paygate.com/KlarnaPayments.aspx
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | ||
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | ||
––– | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: | |
EventToken | enum | M | Defines which Klarna API-Call request will be initiated. For resending the E-Mail the value RCC must be transferred. | |
InvoiceNr | ans..30 | M | Invoice/booking number from Klarna which is returned for all captures within response parameter InvoiceNr |
Parameters for resending an activated invoice with Klarna Payments
The following table describes the result parameters with which the Computop Paygate responds to your system
pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | ||
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | ||
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | ||
ans..64 | M | TransactionID provided by you which should be unique for each payment | ||
ans..30 | O | Merchant’s unique reference number | ||
a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | ||
ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! | ||
an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | ||
CodeExt | ans..50 | O | Error code from Klarna, if agreed with Computop Helpdesk | |
ErrorText | ans..1024 | O | Error text from Klarna, if agreed with Computop Helpdesk |
Response parameters for resending an activated invoice with Klarna Payments
Credit with reference and partial credit
Credits (refunds) are possible via a Server-to-Server connection. To carry out a partal or full credit with a reference transaction, please use the following URL:
https://www.computop-paygate.com/credit.aspx
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | ||
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | ||
ans..64 | M | TransactionID provided by you which should be unique for each payment | ||
Amount | n..10 | M | Total amount to be credited in the smallest currency unit including taxes and rebates (e.g. EUR Cent). Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). Notice: It depends on the amount whether a full or partial credit is made. | |
Currency | a..3 | M | Currency, three characters DIN / ISO 4217, permitted are: AUD, CHF, DKK, EUR, GBP, NOK, SEK, USD. | |
ans..30 | O | Merchant’s unique reference number | ||
ans..32 | O | To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly. Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate. | ||
ArticleList | ans..2048 | O | Complete article list of the order. This parameter must be created in JSON format. The individual parameters in JSON format are following: name = Product name (mandatory) quantity = item quantity. The value may not be negative. (mandatory) unit_price = unit price inclusive taxes but without rebates. (mandatory) total_amount = total amount of iarticles inclusive taxes and rebates. (mandatory) image_url = URL for an image that can be embedded later in agreement with Klarna. (max. 1024 characters) merchant_data = "pass-through parameter" (max. 255 characters). Merchant must agree with Klarna what will be transmitted here. product_identifiers.brand = product brand product_identifiers.category_path = path of product category. As separator '>' has to be used. product_identifiers.global_trade_item_number = article number (e.g. EAN, ISBN or UPC). product_identifiers.manufacturer_part_number = manufacturer’s number product_url = URL to product image quantity_unit = unit of quantity (e.g. kg) reference = article number (e.g. SKU) tax_rate = tax rate as percentage (e.g. 25%). The percent sign must be replaced with two zeros, thus for example 2500. The value may not be negative. (Mandatory, if total_tax_amount or parameter TaxAmount is given.) total_discount_amount = total amount of rebate. The value may not be negative. total_tax_amount = total amount of taxes. The value may be negative, if type is 'discount'. (Mandatory, if tax_rate or parameter TaxAmount is given.) type = type of item position. Possible entries are <physical>, <discount>, <shipping_fee>, <sales_tax>, <digital>, <gift_card>, <store_credit>, <surcharge> Afterwards the article list created in JSON format must be Base64 encoded. | |
––– | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Parameters for credits of payments with Klarna Payments
The following table describes the result parameters with which the Computop Paygate responds to your system
pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | ||
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | ||
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | ||
ans..64 | M | TransactionID provided by you which should be unique for each payment | ||
ans..30 | O | Merchant’s unique reference number | ||
a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | ||
ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! | ||
an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | ||
InvoiceNr | ans..30 | M | Number of invoice/credit note from Klarna Payments | |
CodeExt | ans..50 | O | Error code from Klarna, if agreed with Computop Helpdesk | |
ErrorText | ans..1024 | O | Error text from Klarna, if agreed with Computop Helpdesk |
Response parameters for credits of payments with Klarna Payments
Reversal
Reversals are possible via a Server-to-Server connection. With this request merchants can reverse the total authorisation amount in case of no capture was made or can reverse the remaining authorisation amount if a partial capture was already made. For this purpose please use the following URL:
https://www.computop-paygate.com/reverse.aspx
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | ||
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | ||
ans..64 | M | TransactionID provided by you which should be unique for each payment | ||
Amount | n..10 | M | Amount to be reversed in the smallest currency unit including taxes and rebates (e.g. EUR Cent). Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). Notice: If no capture was made the amount must equals the previously authorised amount. If a partial capture already was made the amount must equals the remaining authorised amount. A reversal for an already completely captured order will be refused with an error also if an amount 0 is used. | |
Currency | a..3 | M | Currency, three characters DIN / ISO 4217, permitted are: AUD, CHF, DKK, EUR, GBP, NOK, SEK, USD. | |
ans..30 | O | Merchant’s unique reference number | ||
ans..32 | O | To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly. Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate. | ||
––– | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Parameters for reversal of payments with Klarna Payments
The following table describes the result parameters with which the Computop Paygate responds to your system
pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
| Key | REST | Format | CND | Description |
|---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | ||
an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. | ||
an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | ||
ans..64 | M | TransactionID provided by you which should be unique for each payment | ||
ans..30 | O | Merchant’s unique reference number | ||
a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | ||
ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! | ||
an8 | M | Error code according to Paygate Response Codes (A4 Error codes) | ||
CodeExt | ans..50 | O | Error code from Klarna, if agreed with Computop Helpdesk | |
ErrorText | ans..1024 | O | Error text from Klarna, if agreed with Computop Helpdesk |
Response parameters for reversal of payments with Klarna Payments
Batch processing via the interface
Basic information about using Batch files and about their structure can be found in the Batch Manager manual. Within batch processing not alle functions are available which are usually available for the online interface.
This section describes the parameters which must be transferred within the data set (Record) for executing a payment with Klarna Payments and which information can be found within the response file about the payment status.
When capturing there is a need to differentiate between complete and partial activation requests. In the case of part capturing you need also to transfer the article list with <ArticleList>. The <ArticleList> parameter is also required if a partial credit is made on a full activation. The two parameters <ArticleList> and <InvNo> are also required in the case of a partial credit on a partial activation. All additional parameters are also returned in the response file.
Following table gives an overview of all batch versions that are possible for a specific action and their specialities:
Action | Version | Description |
Capture | 1.0 / 2.0 | Standard version without return of parameter Code |
1.x / 2.x | with RefNr (valid for all versions other than 1.0) | |
Credit | 1.0 / 2.0 | Standard version without return of parameter Code |
1.x / 2.x | with RefNr (valid for all versions other than 1.0) | |
Reverse | 1.0 / 2.0 | Standard version without return of parameter Code |
1.x / 2.x | with RefNr (valid for all versions other than 1.0) |
Description of the possible batch versions
The structure for a payment with Klarna Payments within a Batch file to be submitted is the following:
1HEAD,<MerchantID>,<Date>,<Version>2KLARNAPM,CAPTURE,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>3KLARNAPM,CAPTURE,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<ArticleList>4KLARNAPM,CREDIT,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>5KLARNAPM,CREDIT,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<ArticleList>6KLARNAPM,REVERSE,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>7FOOT,<CountRecords>,<SumAmount>Example for Master MID function:
1HEAD,[Master]MerchantID,Date,2.x2Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action)3FOOT,CountRecords,SumAmountThe following table describes the individual fields and values used within the data set (record) in the batch file:
| Key | Format | CND | Description |
|---|---|---|---|
Type | a..11 | M | HEAD for Header, FOOT for Footer, KLARNAPM for Klarna Payments |
Action | a..20 | M | The parameter Action defines the type of transaction: Capture Credit Reverse (cancellation) |
n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). | |
Currency | a3 | M | Currency, three characters DIN / ISO 4217, permitted are: AUD, CHF, DKK, EUR, GBP, NOK, SEK, USD. |
ans..64 | M | TransactionID provided by you which should be unique for each payment | |
ans..30 | O | Merchant’s unique reference number | |
an32 | M | ID assigned by Paygate for this transaction | |
InvNo | ans..30 | O | Invoice number for a part activation or part credit. Longest InvNo so far had 17 digits. |
Description of fields within the record for Batch files
The record area within the response file for Batch transactions looks as follows:
1HEAD,<MerchantID>,<Date>,<Version>2KLARNAPM,CAPTURE,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>3KLARNAPM,CAPTURE,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<ArticleList>,<InvNo>,<Status>,<Code>4KLARNAPM,CREDIT,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>5KLARNAPM,CREDIT,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<ArticleList>,<InvNo>,<Status>,<Code>6KLARNAPM,REVERSE,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>7FOOT,<CountRecords>,<SumAmount>The following table describes the response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> and request parameters are returned unchanged and correspond to the call as specified before):
| Key | Format | CND | Description |
|---|---|---|---|
Action | a..20 | M | The parameter Action defines the type of transaction: Capture Credit Reverse (cancellation) |
an32 | M | ID assigned by Paygate for this transaction | |
a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | |
an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
Description of result parameters within the record for Batch files