Skip to main content

Get Products

This functionality returns a list of Products that currently can be used for the Partner.

Parameters#

Fieldmin OccursnillableMaxTypeDescription
Password1false50stringThe password used to authorize the request.
Username1false50stringThe username used to authorize the request.
CorrelationId1true50stringCorrelationID is sent back in the response.
CountryCode1false2stringThe country code (ISO 3166-1 alpha-2) for country.
Amount1true6,2decimalTotal amount of purchase. Used to receive PurchasePreview information
StoreId1true-intThe StoreId used for identification of store.

Response#

Fieldmin OccursnillableMaxTypeDescription
CorrelationID1true50stringCorrelationID from the request if any.
Products1true50Product []List of Products that currently can be used for the Partner. See below.

Product#

ParameterRequiredTypeMaxDescription
InvoiceTypeintInvoice type that the product is valid for
ProductCodestringProduct Code to use when using AddInvoice
ProductDescriptionstringDescription of the Product
PurchasePreviewPurchasePreview[]Detailed information about the terms of the Product. See “PurchasePreview” below.

PurchasePreview#

ParameterRequiredTypeMaxDescription
InitialNotificationFeedecimal6,2The notification fee
SecondaryNotificationFeedecimal6,2The notification fee on account invoices.
OriginationFeedecimal6,2The origination fee, used on Interest Free and Annuity accounts.
CampaignFeedecimal6,2The campaign fee
DueDatedatetime-The due date of the invoice.
CreditTimeintTShows set months for part payment. Only used if InvoiceType = PartPayment (2).
YearlyInterestRatedecimal6,2Shows the yearly interest rate.
LowestAmountToPaydecimal6,2Shows the invoice's lowest amount to pay/month.
MonthlyAmountdecimal6,2Shows the monthly amount to pay. Used on Annuity account (InvoiceType=5)
IsAllowedToSendNotificationByEmaildecimal6,2Shows if the invoice is allowed to be sent by email.
IsAllowedToSendNotificationByMaildecimal6,2Shows if the invoice is allowed to be sent by regular mail.

Example Requests#

 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
<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>

Error Codes#

Please see separate page Error Codes

Fault CodeDescription