Klarna Payments
1.1 General information about Klarna Payments
1.2 Process flow chart direct connection
2 1cs Online Payment System interface
2.2 Create Klarna Session for direct connection
2.4 Create Klarna session for the HPP
2.6 Create recurring order (Abo) with Klarna
2.7 Modify invoice and delivery address
2.8 Modify unique reference number
2.9 Modify order amount and article list
2.11 Resending an activated invoice
1 About Klarna Payments
1.1 General information about Klarna Payments
Logo
Info | Type |
The 1cs OPS 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. | Mixed payment methods |
Klarna offers three different payment methods in the new Klarna KP API via The First Cash Solution: Invoice and installment purchase (Pay Later & Pay over time) and Sofort + secured direct debit (Pay Now). For this, you only need to transfer all billing data to the service provider during the order process. The service provider then takes care of the entire invoicing process and downstream accounts receivable management. As a merchant, you get a payment guarantee; no matter which payment method your customer chooses. This gives your customers financial flexibility with Klarna, because they themselves can flexibly choose between invoice purchase or installment purchase. With installment purchase, you can also determine the amount of the installments and repayment dates yourself. They can also use the invoice solution for their B2B trade.
Installment purchase in the online store motivates your customers to order high-value baskets of goods. This also increases your turnover. Klarna grants an online approval for the installment purchase within seconds during the order process. A PostIdent procedure is not necessary. Klarna pays out the invoice amount to the merchant at short notice and bears the default risk itself. As a merchant, you benefit from quickly available liquidity.
All three payment methods are, with restrictions of the secured direct debit, available in the following countries in the respective local currency: Denmark (DKK), Germany (EUR), Finland (EUR), UK (GBP), Netherlands (EUR), Norway (NOK), Austria (EUR), Sweden (SEK) and USA (USD).
Further information can be found on Klarna’s website (https://www.klarna.de).
Klarna Payments distinguishes between a 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.
1.2 Process flow chart direct connection
Process flow Klarna Payments direct connection
1.3 Process flow chart HPP
With direct connection, a separate JavaScript widget is included for each payment method. Whereas 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.
2 1cs Online Payment System interface
2.1 Definitions
2.1.1 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) |
2.1.2 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.
2.2 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 go to the following URL:
https://www.computop-paygate.com/KlarnaPayments.aspx
Notice: For security reasons, the 1cs Online Payment System 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 | Format | CND | Description |
MerchantID | ans..30 | M | MerchantID, assigned by First Cash Solution. Additionally, this parameter must be passed in plain text too. |
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ns..30 | O | Merchants unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the 1cs support, if you want to capture amounts <100 (smallest currency unit). |
TaxAmount | n..10 | M | Gross amount of value added tax in the smallest currency unit (e.g. EUR Cent). The amount may not be negative. Notice: The VAT included is calculated for 19% with the formula =gross prices / 1.19 * 0.19. Please contact the 1cs support, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table EN |
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> and Poland <PL> |
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. Cannot be only numbers, must be more than 1 character. Allowed special characters: -‘’. |
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. pr Prof. |
bdStreet | a..32 | M | Street and street number, Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted. Allowed special characters: -‘´`”,.:;#&/()+@ °ºᵃª_ \ |
bdZip | n..5 | M | Postal code, Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted. |
bdCity | a..32 | M | 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> and Poland <PL> |
sdFirstName | ans..30 | O | First name. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. |
sdLastName | ans..30 | O | Last name. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. |
sdEmail | ans..80 | O | 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 | a..32 | O | Street and street number. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. |
sdZip | n..5 | O | Postal code. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. |
sdCity | a..32 | O | 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 |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify) |
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 First Cash Solution support. |
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 value may not be negative. 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’. type = type of item position. Possible entries are <physical>, <discount>, <shipping_fee>, <sales_tax>, <digital>, <gift_card>, <store_credit>, <surcharge> Example: 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. Example: 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. Example: 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 the 1cs Online Payment System calls up in order to notify the shop about the payment result. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead. Processing of PENDING transactions must be activated at First Cash Solution as well as Klarna. URLNotify can also be stored with First Cash Solution. |
PayType | enum | M | Customer selected Klarna payment method. Possible entries are Pay immediately (pay_now, direct_debit and direct_bank_transfer), Pay later (pay_later) and Pay in installments (pay_over_time). |
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 iodentity card may be used. |
LegalForm | ans..50 | O | Type of company. Following values are possible: · LIMITED_COMPANY · PUBLIC_LIMITED_COMPANY · ENTREPRENEURIAL_COMPANY · LIMITED_PARTNERSHIP_LIMITED_COMPANY · LIMITED_PARTNERSHIP · GENERAL_PARTNERSHIP · REGISTERED_SOLE_TRADER · SOLE_TRADER · CIVIL_LAW_PARTNERSHIP · PUBLIC_INSTITUTION · OTHER |
CompanyID | ans..15 | O | For companies: Register of Companies number only relevant but not mandatory for B2B. |
CompanyOrPerson | a2 | O | Indication whether it is e 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 that the 1cs online payment system returns as a response:
be prepared to receive additional parameters at any time and do not check the order of parameters
the parameters (e.g. MerchantId, RefNr) should not be checked case-sentive
Key | Format | CND | Description |
MID | ans..30 | M | MerchantID, assigned by First Cash Solution |
PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files. |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the 1cs Online Payment System |
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ns..30 | O | Merchant’s unique reference number |
Status | a..50 | M | AUTHORIZE_REQUEST (URLSuccess) and FAILED (URLFailure) |
Description | 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 the 1cs Online Payment System Response Codes (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 First Cash Solution support |
ErrorText | ans..1024 | O | Error text from Klarna, if agreed with First Cash Solution support |
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 | O | Customer selected Klarna payment method. Possible entries are Pay immediately (pay_now, direct_debit and direct_bank_transfer), Pay later (pay_later) and Pay in installments (pay_over_time). The returned value determines which widgets are allowed to be loaded. |
Response parameters for creating a session with Klarna Payments
2.3 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:
https://developers.klarna.com/documentation/klarna-payments/integration-guide/present-klarna-widget/
After successful authorisation you wil get an authorisation token (TokenExt) which has to be used for creating an order.
2.4 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, the 1cs Online Payment System 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 | Format | CND | Description |
MerchantID | ans..30 | M | MerchantID, assigned by First Cash Solution. Additionally, this parameter must be passed in plain text too. |
TransID | ans..64 | M | TransactionID which should be unique for each payment |
RefNr | ns..30 | O | Merchant’s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the 1cs support, if you want to capture amounts <100 (smallest currency unit). |
TaxAmount | n..10 | M | Gross amount of value added tax in the smallest currency unit (e.g. EUR Cent). The amount may not be negative. Notice: The VAT included is calculated for 19% with the formula =gross prices / 1.19 * 0.19. Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table EN |
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 I 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> and Poland <PL> <PT> Portugal, <FR> France and <CA> Canada. |
bdFirstName | ans..30 | M | 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 | M | 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 | M | Email address, Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted. Must include @ and domain. |
bdCompany | ans..200 | O | 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 | a..32 | M | Street and street number, Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted. Allowed special characters: -‘´`”,.:;#&/()+@ °ºᵃª_ \ |
bdZip | n..5 | M | Postal code. Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted |
bdCity | a..32 | M | Town/city. Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted |
bdAdressAddition | 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> and Poland <PL> |
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 | E-mail address. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. Must include @ and domain. |
sdCompany | ans..200 | O | 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 | a..32 | C | Street name and street number. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. Allowed special characters: -‘´`”,.:;#&/()+@ °ºᵃª_ \ |
sdZip | n..5 | C | Postcode. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. |
sdCity | a..32 | C | 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 HPP: DE – German, DK – Danish, FI – Finnish, SE – Swedish, NO – Norwegian, NL – Dutsch, FR – French, IT – Italian, EN – English, ES – Spanish, CA – Catalan, PL – Polish |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify) |
IPAddr | ans..15 | O | IP address of the client in the format IPv4 or IPv6 |
Account | ans..12 | M | Within 1cs OBS 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 First Cash Solution support. |
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 value may not be negative. 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’. type = type of item position. Possible entries are <physical>, <discount>, <shipping_fee>, <sales_tax>, <digital>, <gift_card>, <store_credit>, <surcharge> Example: 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. Example: Afterwards the additional information created in JSON format must be Base64 encoded. |
Layout | ans..2048 | O | Layout parameters for the HPP. This parameter must be created in JSON format. Example: { “options”: { “color_border”: “#FF9900”, “color_border_selected”: “#FF9900”, “color_button”: “#FF9900”, “color_button_text”: “#FF9900”, “color_checkbox”: “#FF9900”, “color_checkbox_checkmark”: “#FF9900”, “color_details”: “#FF9900”, “color_header”: “#FF9900”, “color_link”: “#FF9900”, “color_text”: “#FF9900”, “color_text_secondary”: “#FF9900”, “radius_border”: “5px” } } Afterwards the layout parameters created in JSON format must be Base64 encoded. |
Order | 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 1cs support directly and our team will store the required setting directly at your account. |
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 |
URLSuccess | ans..256 | M | Complete URL which calls up the 1cs Online Payment System 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 the 1cs Online Payment System and shop, please use the parameter UserData. Common Notes: We recommend to use parameter “response=encrypted” to get an encrypted response by Paygate However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess. Therefore ensure to check the “code”-value which indicates success/failure of the action. Only a result of “code=00000000” should be considered successful. |
URLFailure | ans..256 | M | Complete URL which calls up the 1cs Online Payment System 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 the 1cs Online Payment System and shop, please use the parameter UserData. Common Notes: We recommend to use parameter “response=encrypted” to get an encrypted response by Paygate However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess. Therefore ensure to check the “code”-value which indicates success/failure of the action. Only a result of “code=00000000” should be considered successful. |
Response | a7 | O | Status response sent by the 1cs Online Payment System to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter. |
URLNotify | ans..256 | O | Complete URL which the 1cs Online Payment System calls up in order to notify the shop when a PENDING transaction was finalised. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead. Processing of PENDING transactions must be activated at First Cash Solution as well as Klarna. URLNotify can also be stored with First Cash Solution. |
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 iodentity card may be used. |
LegalForm | ans..50 | O | Type of company. Following values are possible: · LIMITED_COMPANY · PUBLIC_LIMITED_COMPANY · ENTREPRENEURIAL_COMPANY · LIMITED_PARTNERSHIP_LIMITED_COMPANY · LIMITED_PARTNERSHIP · GENERAL_PARTNERSHIP · REGISTERED_SOLE_TRADER · SOLE_TRADER · CIVIL_LAW_PARTNERSHIP · PUBLIC_INSTITUTION · OTHER |
CompanyID | ans..15 | O | For companies: Register of Companies number |
CompanyOrPerson | a2 | O | Indication whether it is e 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
The following table describes the result parameters that the 1cs Online Payment System transmits to your URLSuccess, URLFailure or URLNotify. If you have specified the Response=encrypt parameter, the following parameters are forwarded Blowfish encrypted to your system:
Notice:
– 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 |
MID | ans..30 | M | MerchantID, assigned by First Cash Solution |
PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the 1cs Online Payment System |
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ns..30 | O | Merchant’s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify) |
Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
Description | 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 | n8 | M | Error code according to the 1cs Online Payment System Response Codes (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 First Cash Solution support |
ErrorText | ans..1024 | O | Error text from Klarna, if agreed with First Cash Solution support |
TokenExt | ans..36 | M | Authorisation token which is needed for creating an order |
Result parameters for URLNotify, URLSuccess and URLFailure
2.5 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 if 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, the 1cs Online Payment System 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 | Format | CND | Description |
MerchantID | ans..30 | M | MerchantID, assigned by First Cash Solution. Additionally, this parameter must be passed in plain text too. |
PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ns..30 | O | Merchant’s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the 1cs support, if you want to capture amounts <100 (smallest currency unit). |
TaxAmount | n..10 | M | Gross amount of value added tax in the smallest currency unit (e.g. EUR Cent). The amount may not be negative. Notice: The VAT included is calculated for 19% with the formula =gross prices / 1.19 * 0.19. Please contact the 1cs support, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table EN |
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). If this is an initial payment of a subscription the value I 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 value may not be negative. 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’. type = type of item position. Possible entries are <physical>, <discount>, <shipping_fee>, <sales_tax>, <digital>, <gift_card>, <store_credit>, <surcharge> Example: Afterwards the article list created in JSON format must be Base64 encoded. |
Layout | ans..2048 | O | Layout parameters for the HPP. This parameter must be created in JSON format. Example: { “options”: { “color_border”: “#FF9900”, “color_border_selected”: “#FF9900”, “color_button”: “#FF9900”, “color_button_text”: “#FF9900”, “color_checkbox”: “#FF9900”, “color_checkbox_checkmark”: “#FF9900”, “color_details”: “#FF9900”, “color_header”: “#FF9900”, “color_link”: “#FF9900”, “color_text”: “#FF9900”, “color_text_secondary”: “#FF9900”, “radius_border”: “5px” } } Afterwards the layout parameters 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> and Poland <PL> |
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. Cannot be only numbers, must be more than 1 character. Allowed special characters: -‘’. |
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. pr Prof. |
bdStreet | a..32 | M | Street and street number, Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted. Allowed special characters: -‘´`”,.:;#&/()+@ °ºᵃª_ \ |
bdZip | n..5 | M | Postal code, Optional – if submitted, all parameters bdFirstName, bdLastName, bdEmail, bdStreet, bdZip, bdCity must be submitted. |
bdCity | a..32 | M | 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> and Poland <PL> |
sdFirstName | ans..30 | O | First name. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. |
sdLastName | ans..30 | O | Last name. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. |
sdEmail | ans..80 | O | 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 | a..32 | O | Street and street number. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. |
sdZip | n..5 | O | Postal code. Optional – if submitted, all parameters sdFirstName, sdLastName, sdEmail, sdStreet, sdZip, sdCity must be submitted. |
sdCity | a..32 | O | 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 1cs Online Payment System responds to your system:
Notice:
– 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 |
MID | ans..30 | M | MerchantID, assigned by First Cash Solution |
PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the 1cs Online Payment System |
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ns..30 | M | Merchant’s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
Description | 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 | n8 | M | Error code according to the 1cs Online Payment System Response Codes (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 First Cash Solution support |
ErrorText | ans..1024 | O | Error text from Klarna, if agreed with First Cash Solution support |
Response parameters for creating an order with Klarna
2.6 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, the 1cs Online Payment System 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 | Format | CND | Description |
MerchantID | ans..30 | M | MerchantID, assigned by First Cash Solution. Additionally, this parameter has to be passed in plain text too. |
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ans..30 | O | Merchant’s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
Amount | n..10 | M | Total amount of the order in the smallest currency unit including taxes and all rebates (e.g. EUR Cent). The amount may not be negative. Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
TaxAmount | n..10 | M | Gross amount of value added tax in the smallest currency unit (e.g. EUR Cent). The amount may not be negative. Notice: The VAT included is calculated for 19% with the formula =gross prices / 1.19 * 0.19. Please contact the 1cs support, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency, three characters DIN / ISO 4217, e.g. EUR, USD, GBP Please find an overview here: A1 Currency table EN |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify) |
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 | With First Cash Solution it is possible to store details for several Klarna accounts (username and password). Account allows you to control which account data to use. The value of this parameter must be agreed with First Cash Solution support. |
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 value may not be negative. 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’. type = type of item position. Possible entries are <physical>, <discount>, <shipping_fee>, <sales_tax>, <digital>, <gift_card>, <store_credit>, <surcharge> Example: 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 1cs Online Payment System responds to your system:
Notice:
– 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 |
MID | ans..30 | M | MerchantID, assigned by First Cash Solution |
PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the 1cs Online Payment System |
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ans..30 | O | Merchant’s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
Description | 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 | n8 | M | Error code according to the 1cs Online Payment System Response Codes Excel file |
TransactionID | an12 | O | Reference number from Klarna system |
CodeExt | ans..50 | O | Error code from Klarna, if agreed with First Cash Solution support |
ErrorText | ans..1024 | O | Error text from Klarna, if agreed with First Cash Solution support |
Response parameters for a recurring order (Abo) with Klarna Payments
2.7 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, the 1cs Online Payment System 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 | Format | CND | Description |
MerchantID | ans..30 | M | MerchantID, assigned by First Cash Solution. Additionally, this parameter must be passed in plain text too. |
PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify) |
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 address | |||
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..50 | O | Company. Only for B2B relevant, must be the same as sbCompany. |
bdStreet | 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> and Poland <PL> |
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 | 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> and Poland <PL> |
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 1cs Online Payment System responds to your system:
Notice:
– 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 |
MID | ans..30 | M | MerchantID, assigned by First Cash Solution |
PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the 1cs Online Payment System |
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ans..30 | O | Merchant’s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
Description | 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 | n8 | M | Error code according to the 1cs Online Payment System Response Codes (Error Codes) |
CodeExt | ans..50 | O | Error code from Klarna, if agreed with First Cash Solution support |
ErrorText | ans..1024 | O | Error text from Klarna, if agreed with First Cash Solution support |
Response parameters for address modification with Klarna Payments
2.8 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, the 1cs Online Payment System 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 | Format | CND | Description |
MerchantID | ans..30 | M | MerchantID, assigned by First Cash Solution. Additionally, this parameter must be passed in plain text too. |
PayID | an32 | M | ID assigned by the 1cs Online Payment System 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. |
RefNr | ns..30 | M | Merchant’s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify) |
Parameters for modification of reference number with Klarna Payments
The following table describes the result parameters with which the 1cs Online Payment System responds to your system:
Notice:
– 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 |
MID | ans..30 | M | MerchantID, assigned by First Cash Solution |
PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the 1cs Online Payment System |
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ans..30 | O | Merchant’s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
Description | 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 | n8 | M | Error code according to the 1cs Online Payment System Response Codes (Error Codes) |
CodeExt | ans..50 | O | Error code from Klarna, if agreed with First Cash Solution support |
ErrorText | ans..1024 | O | Error text from Klarna, if agreed with First Cash Solution support |
Response parameters for modification of reference number with Klarna Payments
2.9 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, the 1cs Online Payment System 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 | Format | CND | Description |
MerchantID | ans..30 | M | MerchantID, assigned by First Cash Solution. Additionally, this parameter must be passed in plain text too. |
PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ans..30 | O | Merchant’s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
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. |
Currency | a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table EN |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify) |
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 | New 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 value may not be negative. 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’. type = type of item position. Possible entries are <physical>, <discount>, <shipping_fee>, <sales_tax>, <digital>, <gift_card>, <store_credit>, <surcharge> Example: 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 1cs Online Payment System responds to your system:
Notice:
– 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 |
MID | ans..30 | M | MerchantID, assigned by First Cash Solution |
PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the 1cs Online Payment System |
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ans..30 | O | Merchant’s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
Description | 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 | n8 | M | Error code according to the 1cs Online Payment System Response Codes Excel file |
CodeExt | ans..50 | O | Error code from Klarna, if agreed with First Cash Solution support |
ErrorText | ans..1024 | O | Error text from Klarna, if agreed with First Cash Solution support |
Response parameters for modification of order amount and article list with Klarna Payments
2.10 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, the 1cs Online Payment System 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 | Format | CND | Description |
MerchantID | ans..30 | M | MerchantID, assigned by First Cash Solution. Additionally, this parameter must be passed in plain text too. |
PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
TransID | 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. Please find an overview here: A1 Currency table EN |
RefNr | ns..30 | O | Merchant’s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify) |
ReqID | ans..32 | O | To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / action is submitted again with the same ReqID, 1cs OPS will not carry out the payment or new action, but will just return the status of the original transaction / action. Please note that the 1cs OPS must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
ShippingData | ans..2048 | O | Delivery information (e.g. tracking data). This parameter must be created in JSON format. { “shipping_info”: [ { “shipping_company”: “DHL US”, “shipping_method”: “Home”, “tracking_number”: “63456415674545679074”, “tracking_url”: “http://shipping.example/findmypackage?63456415674545679074“, “return_shipping_company”: “DHL US”, “return_tracking_number”: “93456415674545679000”, “return_tracking_url”: “http://shipping.example/findmypackage?93456415674545679000” } ] } 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 value may not be negative. 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’. type = type of item position. Possible entries are <physical>, <discount>, <shipping_fee>, <sales_tax>, <digital>, <gift_card>, <store_credit>, <surcharge> Example: 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> |
Parameters for captures with Klarna Payments
The following table describes the result parameters with which the 1cs Online Payment System responds to your system:
Hinweis:
– 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 |
MID | ans..30 | M | MerchantID, assigned by First Cash Solution |
PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the 1cs Online Payment System |
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ns..30 | O | Merchant’s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
Description | 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 | n8 | M | Error code according to the 1cs Online Payment System Response Codes Excel file |
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 First Cash Solution support |
ErrorText | ans..1024 | O | Error text from Klarna, if agreed with First Cash Solution support |
Response parameters for captures with Klarna Payments
2.11 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, the 1cs Online Payment System 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 | Format | CND | Description |
MerchantID | ans..30 | M | MerchantID, assigned by First Cash Solution. Additionally, this parameter must be passed in plain text too. |
PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify) |
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 1cs Online Payment System responds to your system:
Notice:
– 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
Parameter | Format | CND | Description |
MID | ans..30 | M | MerchantID, assigned by First Cash Solution |
PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the 1cs Online Payment System |
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ans..30 | O | Merchant’s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
Status | a..50 | M | OK (URL Success) or FAILED (URLFailure) |
Description | 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 | n8 | M | Error code according to the 1cs Online Payment System Response Codes (Error Codes) |
CodeExt | ans..50 | O | Error code from Klarna, if agreed with First Cash Solution support |
ErrorText | ans..1024 | O | Error text from Klarna, if agreed with First Cash Solution support |
2.12 Cred
it 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, the 1cs Online Payment System 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 | Format | CND | Description |
MerchantID | ans..30 | M | MerchantID, assigned by First Cash Solution. Additionally, this parameter must be passed in plain text too. |
PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
TransID | 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. Please find an overview here: A1 Currency table EN |
RefNr | ns..30 | O | Merchant’s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
ReqID | ans..32 | O | To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / action is submitted again with the same ReqID, 1cs OPS will not carry out the payment or new action, but will just return the status of the original transaction / action. Please note that the 1cs OPS must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
ArticleList | ans..2048 | M | Complete article list of returned articles. 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 value may not be negative. 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’. type = type of item position. Possible entries are <physical>, <discount>, <shipping_fee>, <sales_tax>, <digital>, <gift_card>, <store_credit>, <surcharge> Example: Afterwards the article list created in JSON format must be Base64 encoded. |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify) |
Parameters for credits of payments with Klarna Payments
The following table describes the result parameters with which the 1cs Online Payment System responds to your system:
Notice:
– 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 |
MID | ans..30 | M | MerchantID, assigned by First Cash Solution |
PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the 1cs Online Payment System |
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ns..30 | O | Merchant’s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
Description | 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 | n8 | M | Error code according to the 1cs Online Payment System Response Codes (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 First Cash Solution support |
ErrorText | ans..1024 | O | Error text from Klarna, if agreed with First Cash Solution support |
Response parameters for credits of payments with Klarna Payments
2.13 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.First Cash Solution-paygate.com/reverse.aspx
Notice: For security reasons, the 1cs Online Payment System 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 | Format | CND | Description |
MerchantID | ans..30 | M | MerchantID, assigned by First Cash Solution. Additionally, this parameter must be passed in plain text too. |
PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
TransID | 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 1cs support, 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. Please find an overview here: A1 Currency table EN |
RefNr | ans..30 | O | Merchant’s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
ReqID | ans..32 | O | To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / action is submitted again with the same ReqID, 1cs OPS will not carry out the payment or new action, but will just return the status of the original transaction / action. Please note that the 1cs OPS must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify) |
Parameters for reversal of payments with Klarna Payments
The following table describes the result parameters with which the 1cs Online Payment System responds to your system:
Notice:
-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 |
MID | ans..30 | M | MerchantID, assigned by First Cash Solution |
PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the 1cs Online Payment System |
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ns..30 | O | Merchant’s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
Description | 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 | n8 | M | Error code according to the 1cs Online Payment System Response Codes (Error Codes) |
CodeExt | ans..50 | O | Error code from Klarna, if agreed with First Cash Solution support |
ErrorText | ans..1024 | O | Error text from Klarna, if agreed with First Cash Solution support |
Response parameters for reversal of payments with Klarna Payments
3 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 / 2x. | 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:
HEAD,<MerchantID>,<Date>,<Version>
KLARNAPM,CAPTURE,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<InvNo>
KLARNAPM,CAPTURE,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<ArticleList>
KLARNAPM,CREDIT,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> KLARNAPM,CREDIT,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<ArticleList> KLARNAPM,REVERSE,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> FOOT,<CountRecords>,<SumAmount>
Example for Master MID function:
HEAD, [Master] MerchantID,Date,2.x
Type,Action, [Slave] MID,Amount,Currency,TransID,Data (depends on Action)
FOOT,CountRecords,SumAmount
The 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, KLARNA for Klarna Payments |
Action | a..20 | M | The parameter Action defines the type of transaction: Capture Credit Reverse (cancellation) |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the 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. Please find an overview here: A1 Currency table EN |
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
RefNr | ns..30 | O | Merchant’s unique reference number Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
PayID | an32 | M | ID assigned by the 1cs Online Payment System 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:
HEAD,<MerchantID>,<Date>,<Version>
KLARNAPM,CAPTURE,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<InvNo>,<Status>,<Code>
KLARNAPM,CAPTURE,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<ArticleList>,<Status>,<Code>
KLARNAPM,CREDIT,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> KLARNAPM,CREDIT,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<ArticleList>,<Status>,<Code> KLARNAPM,REVERSE,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> FOOT,<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) |
PayID | an32 | M | ID for this transaction given by the 1cs Online Payment System |
Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
Code | n8 | M | Error code according to the 1cs Online Payment System Response Codes (Error Codes) |
Description of result parameters within the record for Batch files