Set Reservation
Creates a new, or modifies an existing, reservation for a customer. A reservation is a fixed credit limit that a customer can make purchases within (AddInvoice) without additional credit checks.
A new reservation is created if no existing reservation is found and the customer passes the automatic credit check. An already existing reservation can be increased by requesting a higher amount, or decreased by requesting a lower. In the case of an increase a new credit check is performed and if successful the reserved amount is modified to match the new value. Decreasing the reservation amount will lower the reserved amount without triggering a new credit check.
Note that Walley's policy rules affects the lowest and highest amounts for which reservations can be created and modified. Contact Walley for details regarding these limits.
This functionality is only available in the following countries: Sweden, Norway, Finland and Denmark. The usage of this functionality must be agreed upon with Walley. Any purchases/invoices made before a reservation will be calculated into the AvailableAmount of the reservation.
This method is available in the following countries:
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. |
ClientIpAddress | 1 | false | 50 | string | The IP address of the customer performing the purchase at the partner's web shop. |
AdditionalInformation[] | 1 | true | - | AdditionalInformation[] | Used depending on agreement with Walley. |
CompanyEmailAuthorizedSignatory | 1 | true | 100 | string | Email to authorized signatory. |
CompanyPersonalGuarantee | 1 | true | - | boolean | Reg. no for authorized signatory. If CompanyPersonalGuarantee is enabled, the reg. no in this parameter will be used as personal guarantee reg. no. |
CompanyRegNoAuthorizedSignatory | 1 | true | 12 | string | Reg. no for authorized signatory. If CompanyPersonalGuarantee is enabled, the reg. no in this parameter will be used as personal guarantee reg. no. |
CorrelationId | 1 | false | 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. Only “SE” allowed. |
CurrencyCode | 1 | false | 2 | string | The ISO 4217 code representation for the currency. |
CustomerAddress | 1 | true | - | Address[] | The invoice address where the invoice should be sent to. For private persons this must be the address where the person is registered. |
CustomerNumber | 1 | true | 20 | string | If the e-store wants to search for a customer by their own customer id, this field can be used to specify that number. Also shown on invoice. |
1 | true | 100 | string | Customer's email address | |
IntegrationId | 1 | true | 128 | string | The integration ID can be assigned to customers in order to uniquely identify customers (instead of using Civic reg no). |
IntegrationIdDescription | 1 | true | 128 | string | A friendly description of the IntegrationId given. Shown on the invoice as the “buyer” instead of the IntegrationId value. Must be used in combination with IntegrationId. No separators should be used, for example: - , . |
MobilePhone | 1 | true | 20 | string | The customer's cellphone number. Must begin with “+” and country code e.g. +46. |
PhoneNumber | 1 | true | 20 | string | The customer's phone number |
ProductCode | 1 | true | 20 | string | The campaign product code. The product code is determined by Walley. To use campaign products an agreement with Walley must be made. |
RegNo | 1 | true | 12 | string | The customer civic registration number. Only nillable if an IntegrationId is set and has been assigned to the RegNo beforehand. |
ReservedAmount | 1 | false | 6,2 | decimal | The requested amount to reserve. If an existing reservation is found that reservations amount will be increased or decreased to the amount you send in. |
StoreId | 1 | false | - | int | The StoreId used for identification of store. |
Response​
The response indicates if the customer is approved for the credit amount requested. If the purchase is approved, proceed with the purchase by invoking AddInvoice.
Field | min Occurs | nillable | Max | Type | Description |
---|---|---|---|---|---|
CorrelationId | 1 | true | 50 | string | CorrelationID from the request if any. |
ReservedAmount | 1 | true | 6,2 | decimal | Total amount reserved. |
AvailableAmount | 1 | true | 6,2 | decimal | Available amount left on the reservation. |
ValidUntil | 1 | true | - | datetime | Date until the reservation is valid, null means indefinite. |
PendingUntil | 1 | true | - | 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). |
Status | 1 | true | - | string | Returns the handling status of a reservation, the status can be: PENDING = The reservation is still not active, must be activated with the ActivateReservation API. ACTIVE = The reservation is directly activated. NO_RESERVATION = There is no reservation. SIGNING = The reservation need to be signed, eg. by BankID. |
ReservationId | 1 | true | - | string | The reservation's unique id. |
Address | 1 | True | - | Address | Contains the address of the customer. |
Reservation status​
The reservation status type is an enumeration value. Defined values are:
- ACTIVE (0) – The reservation is active and ready to be used.
- PENDING (1) – The reservation is pending and need to be activated.
- NO_RESERVATION (2) – There is no reservation.
- SIGNING (3) – The reservation needs to be signed by end customer.
Example Requests​
 | Value |
---|---|
Environment: | UAT |
Service: | PaymentService |
URL: | https://ecommercetest.collector.se/v3.0/PaymentServiceV10.svc?wsdl |
Function: | SetReservation |
Description: | The operation create a reservation for the customer |
Notes: | N/A |
- B2C Request
- B2C Response
<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>
<pay:ClientIpAddress>127.0.0.1</pay:ClientIpAddress>
</soapenv:Header>
<soapenv:Body>
<pay:SetReservationRequest>
<pay:AdditionalInformation>
</pay:AdditionalInformation>
<pay:CompanyEmailAuthorizedSignatory xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<pay:CompanyRegNoAuthorizedSignatory xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<pay:CorrelationId>SetReservationV10</pay:CorrelationId>
<pay:CountryCode>SE</pay:CountryCode>
<pay:CurrencyCode>SEK</pay:CurrencyCode>
<pay:CustomerAddress>
<pay:Address1>Teststreet 1</pay:Address1>
<pay:Address2 xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<pay:COAddress>C/O Address</pay:COAddress>
<pay:City>Test City</pay:City>
<pay:CompanyName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<pay:CountryCode>SE</pay:CountryCode>
<pay:Firstname>FirstName</pay:Firstname>
<pay:Lastname>LastName</pay:Lastname>
<pay:PostalCode>12345</pay:PostalCode>
</pay:CustomerAddress>
<pay:CustomerNumber xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<pay:Email>test@walley.se</pay:Email>
<pay:IntegrationId xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<pay:IntegrationIdDescription xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<pay:MobilePhone>+461234567890</pay:MobilePhone>
<pay:PhoneNumber xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<pay:ProductCode xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<pay:RegNo>195109212224</pay:RegNo>
<pay:ReservedAmount>5000</pay:ReservedAmount>
<pay:StoreId>1234</pay:StoreId>
</pay:SetReservationRequest>
</soapenv:Body>
</soapenv:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<SetReservationResponse xmlns="http://schemas.ecommerce.collector.se/v30/PaymentService">
<Address xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Address1>Teststreet 1</Address1>
<Address2 i:nil="true"/>
<COAddress i:nil="true"/>
<City>Test City</City>
<CompanyName i:nil="true"/>
<CountryCode>SE</CountryCode>
<Email>test@walley.se</Email>
<Firstname>FirstName</Firstname>
<Lastname>LastName</Lastname>
<MobilePhone>+461234567890</MobilePhone>
<PhoneNumber>+4631987654321</PhoneNumber>
<PostalCode>12345</PostalCode>
</Address>
<AvailableAmount>0</AvailableAmount>
<CorrelationId>SetReservationV10</CorrelationId>
<PendingUntil i:nil="true" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"/>
<ReservationId>9652602</ReservationId>
<ReservedAmount>10000.00</ReservedAmount>
<Status>SIGNING</Status>
<ValidUntil i:nil="true" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"/>
</SetReservationResponse>
</s:Body>
</s:Envelope>
- B2B Request
- B2B Response
<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>
<pay:ClientIpAddress>127.0.0.1</pay:ClientIpAddress>
</soapenv:Header>
<soapenv:Body>
<pay:SetReservationRequest>
<pay:AdditionalInformation>
</pay:AdditionalInformation>
<pay:CompanyEmailAuthorizedSignatory>person@company.com</pay:CompanyEmailAuthorizedSignatory>
<pay:CompanyPersonalGuarantee>true</pay:CompanyPersonalGuarantee>
<pay:CompanyRegNoAuthorizedSignatory>195109212224</pay:CompanyRegNoAuthorizedSignatory>
<pay:CorrelationId>SetReservationV10</pay:CorrelationId>
<pay:CountryCode>SE</pay:CountryCode>
<pay:CurrencyCode>SEK</pay:CurrencyCode>
<pay:CustomerAddress>
<pay:Address1>BOX 11914</pay:Address1>
<pay:Address2 xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<pay:COAddress xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<pay:City>Göteborg</pay:City>
<pay:CompanyName>Walley</pay:CompanyName>
<pay:CountryCode>SE</pay:CountryCode>
<pay:Firstname xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<pay:Lastname xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<pay:PostalCode>40439</pay:PostalCode>
</pay:CustomerAddress>
<pay:CustomerNumber xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<pay:Email>test@walley.se</pay:Email>
<pay:IntegrationId xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<pay:IntegrationIdDescription xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<pay:MobilePhone>+461234567890</pay:MobilePhone>
<pay:PhoneNumber xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<pay:ProductCode xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<pay:RegNo>556597-0513</pay:RegNo>
<pay:ReservedAmount>5000</pay:ReservedAmount>
<pay:StoreId>9666</pay:StoreId>
</pay:SetReservationRequest>
</soapenv:Body>
</soapenv:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<SetReservationResponse xmlns="http://schemas.ecommerce.collector.se/v30/PaymentService">
<Address xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Address1>Teststreet 1</Address1>
<Address2 i:nil="true"/>
<COAddress>C/O Address</COAddress>
<City>Test CIty</City>
<CompanyName i:nil="true"/>
<CountryCode>SE</CountryCode>
<Email>test@walley.se</Email>
<Firstname>FirstName</Firstname>
<Lastname>LastName</Lastname>
<MobilePhone>+461234567890</MobilePhone>
<PhoneNumber i:nil="true"/>
<PostalCode>12345</PostalCode>
</Address>
<AvailableAmount>-170.00</AvailableAmount>
<CorrelationId>SetReservationV10</CorrelationId>
<PendingUntil i:nil="true" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"/>
<ReservationId>9652660</ReservationId>
<ReservedAmount>5000.00</ReservedAmount>
<Status>ACTIVE</Status>
<ValidUntil i:nil="true" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"/>
</SetReservationResponse>
</s:Body>
</s:Envelope>
Error codes​
Fault Code | Description |
---|---|
AUTHORIZATION_FAILED | Could not authorize the request, check your login credentials. Please contact Walley for more help. |
INVALID_REGISTRATION_NUMBER | When the reg.no is not in a correct format. |
PERSONAL_GUARANTEE_NOT_ENABLED | Personal guarantee is enabled in the request, but Walley has not enabled the signing functionality. |
If the error code you are looking for is not in the list above Please see separate page Error Codes