Skip to main content

Get Reservations

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

Parameters#

Fieldmin OccursnillableMaxTypeDescription
Username1false50stringThe username used to authorize the request.
Password1false50stringThe password used to authorize the request.
StoreId1true4shortThe StoreId used for identification of store.
CorrelationId1true50stringCorrelationID is sent back in the response.
CountryCode1false2stringThe country code (ISO 3166-1 alpha-2) for the country.
IntegrationId1true128stringThe 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.
RegNo1true50stringEither civic registration number or organization number. Only nillable if an IntegrationId is set and has been assigned to the RegNo beforehand.
StoreId1true-intThe StoreId used for identification of store.

Response#

Fieldmin OccursnillableMaxTypeDescription
CorrelationId1true50stringCorrelationID from the request if any.
Reservations1true-Reservation[]A list of reservations for the customer associated with the given request. See “Reservation” under “Types” for more information.

Reservation#

ParameterTypeMaxDescription
AvailableReservationAmountdecimal6,2Available amount left on the reservation. If the reservation is pending then this will be zero.
CustomerNamestring50The name of the Customer.
CustomerRegNostring50The registration number of the Customer.
CustomerStatusstring-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.
PendingUntildatetime-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).
ProductCodestring50ProcuctCode used when creating the reservation if any.
ReservedAmountdecimal6,2The reserved amount.
Statusstring-Returns the handling status of a reservation, available statuses see below
StoreIdint-The storeId for where the reservation is available
ValidUntildatetime-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
<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>

Error Codes#

Please see separate page Error Codes

Fault CodeDescription