Get Reservations

This functionality returns information about previously made reservations. Several reservations can be returned.

Parameters

Field	min Occurs	nillable	Max	Type	Description
Username	1	false	50	string	The username used to authorize the request.
Password	1	false	50	string	The password used to authorize the request.
StoreId	1	true	4	short	The StoreId used for identification of store.
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 the country.
IntegrationId	1	true	128	string	The integration ID is used to uniquely identify customers. Civic reg. numbers can be used for this, but are not mandatory. As long as the value entered is unique. No separators should be used, for example: - , . Only nillable if Regno is set.
RegNo	1	true	50	string	Either civic registration number or organization number. Only nillable if an IntegrationId is set and has been assigned to the RegNo beforehand.
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.
Reservations	1	true	-	Reservation[]	A list of reservations for the customer associated with the given request. See “Reservation” under “Types” for more information.

Reservation

Parameter	Type	Max	Description
AvailableReservationAmount	decimal	6,2	Available amount left on the reservation. If the reservation is pending then this will be zero.
CustomerName	string	50	The name of the Customer.
CustomerRegNo	string	50	The registration number of the Customer.
CustomerStatus	string	-	Blocking status for the customer, e.g. blocked for purchase etc. If empty, customer is not blocked. BLOCKED = The customer is now blocked from making purchases.
PendingUntil	datetime	-	The date and time when a pending reservation will be removed if no activation of the reservation has been done. Only used when a reservation need to be activated with the ActivateReservation API. Null means the reservation don’t have a pending state (directly activated).
ProductCode	string	50	ProcuctCode used when creating the reservation if any.
ReservedAmount	decimal	6,2	The reserved amount.
Status	string	-	Returns the handling status of a reservation, available statuses see below
StoreId	int	-	The storeId for where the reservation is available
ValidUntil	datetime	-	The date and time when the reservation will be removed. Only used when a reservation exists for a limited time period. Null means the reservation has no timelimit.

Status codes

• NO_RESERVATION = There is no reservation.
• PENDING = The reservation is still not active and must be activated with the ActivateReservation API.
• SIGNING = The reservation need to be signed, e.g. the agreement needs to be signed, and then activated with the ActivateReservation API.
• REQUIRE_STRONG_CUSTOMER_VERIFICATION = The reservation need to be signed using BankID. Reservation is then automatically activated.
• ACTIVE = The reservation is activated and can be used.

Example Requests

	Value
Environment:	UAT
Service:	PaymentService
URL:	https://ecommercetest.collector.se/v3.0/PaymentServiceV10.svc?wsdl
Function:	GetReservation
Description:	The operation fetchs all reservations for a customer
Notes:	N/A

B2C Request

<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:GetReservationsRequest>
         <pay:CorrelationId>GetReservationsV10</pay:CorrelationId>
         <pay:CountryCode>SE</pay:CountryCode>
         <pay:IntegrationId xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
         <pay:RegNo>195001182046</pay:RegNo>
         <pay:StoreId>1234</pay:StoreId>
      </pay:GetReservationsRequest>
   </soapenv:Body>
</soapenv:Envelope>

B2C Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <GetReservationsResponse xmlns="http://schemas.ecommerce.collector.se/v30/PaymentService">
         <CorrelationId>GetReservationsV10</CorrelationId>
         <Reservations xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <ReservationV4>
               <AvailableReservationAmount>10460.00</AvailableReservationAmount>
               <CustomerName>FirstName LastName</CustomerName>
               <CustomerRegNo>5001182046</CustomerRegNo>
               <CustomerStatus/>
               <PendingUntil i:nil="true"/>
               <ProductCode i:nil="true"/>
               <ReservedAmount>10000.00</ReservedAmount>
               <Status>ACTIVE</Status>
               <StoreId>1234</StoreId>
               <ValidUntil i:nil="true"/>
            </ReservationV4>
         </Reservations>
      </GetReservationsResponse>
   </s:Body>
</s:Envelope>

Error Codes

Please see separate page Error Codes

Fault Code	Description