---
id: getproducts
title: Get Products
hide_title: true
description: "Getting the configured products"
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Flag from '../../../../src/components/flag/flag';
import Ingress from '../../../../src/components/ingress/ingress.react';

<Ingress title="Get Products">
This functionality returns a list of Products that currently can be used for the Partner.
</Ingress>

## Parameters

| Field         | min Occurs | nillable | Max | Type    | Description                                                           |
| :------------ | :--------- | :------- | :-- | :------ | :-------------------------------------------------------------------- |
| Password      | 1          | false    | 50  | string  | The password used to authorize the request.                           |
| Username      | 1          | false    | 50  | string  | The username used to authorize the request.                           |
| CorrelationId | 1          | true     | 50  | string  | CorrelationID is sent back in the response.                           |
| CountryCode   | 1          | false    | 2   | string  | The country code (ISO 3166-1 alpha-2) for country.                    |
| Amount        | 1          | true     | 6,2 | decimal | Total amount of purchase. Used to receive PurchasePreview information |
| StoreId       | 1          | true     | -   | int     | The StoreId used for identification of store.                         |

## Response

| Field         | min Occurs | nillable | Max | Type                   | Description                                                             |
| :------------ | :--------- | :------- | :-- | :--------------------- | :---------------------------------------------------------------------- |
| CorrelationID | 1          | true     | 50  | string                 | CorrelationID from the request if any.                                  |
| Products      | 1          | true     | 50  | [Product[]](#product)  | List of Products that currently can be used for the Partner. See below. |

### Product

| Parameter          | Required | Type                                  | Max | Description                                                                       |
| :----------------- | :------- | :------------------------------------ | :-- | :-------------------------------------------------------------------------------- |
| InvoiceType        |          | int                                   |     | Invoice type that the product is valid for                                        |
| ProductCode        |          | string                                |     | Product Code to use when using AddInvoice                                         |
| ProductDescription |          | string                                |     | Description of the Product                                                        |
| PurchasePreview    |          | [PurchasePreview[]](#purchasepreview) |     | Detailed information about the terms of the Product. See “PurchasePreview” below. |

### PurchasePreview

| Parameter                          | Required | Type     | Max | Description                                                                     |
| :--------------------------------- | :------- | :------- | :-- | :------------------------------------------------------------------------------ |
| InitialNotificationFee             |          | decimal  | 6,2 | The notification fee                                                            |
| SecondaryNotificationFee           |          | decimal  | 6,2 | The notification fee on account invoices.                                       |
| OriginationFee                     |          | decimal  | 6,2 | The origination fee, used on Interest Free and Annuity accounts.                |
| CampaignFee                        |          | decimal  | 6,2 | The campaign fee                                                                |
| DueDate                            |          | datetime | -   | The due date of the invoice.                                                    |
| CreditTime                         |          | int      |     | TShows set months for part payment. Only used if InvoiceType = PartPayment (2). |
| YearlyInterestRate                 |          | decimal  | 6,2 | Shows the yearly interest rate.                                                 |
| LowestAmountToPay                  |          | decimal  | 6,2 | Shows the invoice's lowest amount to pay/month.                                 |
| MonthlyAmount                      |          | decimal  | 6,2 | Shows the monthly amount to pay. Used on Annuity account (InvoiceType=5)        |
| IsAllowedToSendNotificationByEmail |          | decimal  | 6,2 | Shows if the invoice is allowed to be sent by email.                            |
| IsAllowedToSendNotificationByMail  |          | decimal  | 6,2 | Shows if the invoice is allowed to be sent by regular mail.                     |

### Example Requests

| &nbsp;       | Value                                                              |
| :----------- | :----------------------------------------------------------------- |
| Environment: | UAT                                                                |
| Service:     | PaymentService                                                     |
| URL:         | https://ecommercetest.collector.se/v3.0/PaymentServiceV10.svc?wsdl |
| Function:    | GetProducts                                                        |
| Description: | The operation fetchs all products for the specified merchant       |
| Notes:       | N/A                                                                |

<Tabs defaultValue="reqB2C" values={[
{ label: 'B2C Request', value: 'reqB2C', },
{ label: 'B2C Response', value: 'resB2C', }]}>
<TabItem value="reqB2C">

```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pay="http://schemas.ecommerce.collector.se/v30/PaymentService">
   <soapenv:Header>
      <pay:Username>USERNAME</pay:Username>
      <pay:Password>PASSWORD</pay:Password>
   </soapenv:Header>
   <soapenv:Body>
      <pay:GetProductsRequest>
         <pay:Amount>100</pay:Amount>
         <pay:CorrelationId>GetProductsV10</pay:CorrelationId>
         <pay:CountryCode>SE</pay:CountryCode>
         <pay:StoreId>1234</pay:StoreId>
      </pay:GetProductsRequest>
   </soapenv:Body>
</soapenv:Envelope>

```

</TabItem>
<TabItem value="resB2C">

```xml

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <GetProductsResponse xmlns="http://schemas.ecommerce.collector.se/v30/PaymentService">
         <CorrelationId>GetProcuctsV10</CorrelationId>
         <Products xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Product>
               <InvoiceType>0</InvoiceType>
               <ProductCode>DI_60_001</ProductCode>
               <ProductDescription>Walley Faktura 60 dagar</ProductDescription>
               <PurchasePreview>
                  <CampaignFee>0</CampaignFee>
                  <CreditTime>1</CreditTime>
                  <DueDate>2020-06-19T23:59:59</DueDate>
                  <InitialNotificationFee>40.00</InitialNotificationFee>
                  <IsAllowedToSendNotificationByEmail>true</IsAllowedToSendNotificationByEmail>
                  <IsAllowedToSendNotificationByMail>true</IsAllowedToSendNotificationByMail>
                  <LowestAmountToPay>140.00</LowestAmountToPay>
                  <MonthlyAmount i:nil="true"/>
                  <OriginationFee>0</OriginationFee>
                  <SecondaryNotificationFee i:nil="true"/>
                  <YearlyInterestRate i:nil="true"/>
               </PurchasePreview>
            </Product>
            <Product>
               <InvoiceType>1</InvoiceType>
               <ProductCode>I_1_001</ProductCode>
               <ProductDescription>Konto (Faktura nästa månad via post)</ProductDescription>
               <PurchasePreview>
                  <CampaignFee>0</CampaignFee>
                  <CreditTime>1</CreditTime>
                  <DueDate i:nil="true"/>
                  <InitialNotificationFee>29.00</InitialNotificationFee>
                  <IsAllowedToSendNotificationByEmail>true</IsAllowedToSendNotificationByEmail>
                  <IsAllowedToSendNotificationByMail>true</IsAllowedToSendNotificationByMail>
                  <LowestAmountToPay>129.00</LowestAmountToPay>
                  <MonthlyAmount i:nil="true"/>
                  <OriginationFee>0</OriginationFee>
                  <SecondaryNotificationFee i:nil="true"/>
                  <YearlyInterestRate i:nil="true"/>
               </PurchasePreview>
            </Product>
         </Products>
      </GetProductsResponse>
   </s:Body>
</s:Envelope>

```

</TabItem>
</Tabs>

### Error Codes

Please see separate page [Error Codes](/docs/paymentsApi/integration/error-codes)

| Fault Code | Description |
| :--------- | :---------- |