| Branch | Build status |
|---|---|
| master (latest release) |  |
| develop |  |
- Introduction
- Configuration
- 1. CreateOrder
- 2. GetPaymentPlanParams
- 3. GetAddresses
- 4. DeliverOrder
- 5. CloseOrder
- 6. Response handler
- APPENDIX
This integration package is built for developers to simplify the integration of Svea WebPay services. Using this package will make your implementation sustainable and unaffected for changes in our payment system. Just make sure to update the package regularly.
The API is built as a Fluent API so you can use method chaining when implementing it in your code. Make sure to open your implementation as a project in your IDE to make the code completion work properly. Package is developed and tested in NetBeans IDE 7.2.
Include the file Includes.php from the php integration package in your file. Call class WebPay and the suitable static function for your action.
require_once 'Includes.php';
$foo = WebPay::createOrder();
$foo = $foo->...
->..;The Configuration needed to be set differs of how many different paymentmethods and Countries you have i the same installation. The SveaConfig file can handle multiple paymentmethods and countries. The authorization values are recieved from Svea Ekonomi when creating an account. If no configuration is done, default settings and testdata found in SveaConfig::getDefaultConfig() will be used.
There are two ways to configure Svea authorization. Choose one of the following:
1 - Replace the file named SveaConfig.php in folder Config looking the same as existing file but with your own authorization values. Determining to use the test or the prod values there are two ways:
/**
* 1.
* Manually changing the getDefaultConfig() to return the getProdConfig() or the getTestConfig().
* In this case no parameter is neccesary when calling a function in WebPay.
*/
$foo = WebPay::createOrder(); /**
* 2.
* Giving either the getProdConfig() or the getTestConfig() as parameter when calling a function in WebPay.
* This way makes it possible to put a condition in implemantation code to check testmode.
*/
if($testmode == TRUE){
$config = SveaConfig::getTestConfig();
}else{
$config = SveaConfig::getProdConfig();
}
$foo = WebPay::createOrder($config);2 - If your have the authorization values saved in a database, probably using an administration interface in your shop. Create a class (eg. one for testing values, one for production) that implements the ConfigurationProvider Interface. Let the implemented functions return the authorization values asked for. The integration package will then call these functions to get the value from your database.
require_once Includes.php
class MyConfigTest implements ConfigurationProvider{
/**
* Constants for the endpoint url found in the class SveaConfig.php
* @param $type eg. HOSTED, INVOICE or PAYMENTPLAN
*/
public function getEndPoint($type){
if($type == "HOSTED"){
return SveaConfig::SWP_TEST_URL;;
}elseif($type == "INVOICE" || $type == "PAYMENTPLAN"){
return SveaConfig::SWP_TEST_WS_URL;
} else {
throw new Exception('Invalid type. Accepted values: INVOICE, PAYMENTPLAN or HOSTED');
}
}
/**
* get the return value from your database or likewise
* @param $type eg. HOSTED, INVOICE or PAYMENTPLAN
* $param $country CountryCode eg. SE, NO, DK, FI, NL, DE
*/
public function getMerchantId($type, $country){
//if you have different countries or types the parameters are a help to put up conditions
return $myMerchantId;
}
/**
* get the return value from your database or likewise
* @param $type eg. HOSTED, INVOICE or PAYMENTPLAN
* $param $country CountryCode eg. SE, NO, DK, FI, NL, DE
*/
public function getPassword($type, $country){
return $myPassword;
}
/**
* get the return value from your database or likewise
* @param $type eg. HOSTED, INVOICE or PAYMENTPLAN
* $param $country CountryCode eg. SE, NO, DK, FI, NL, DE
*/
public function getSecret($type, $country){
return $mySecret;
}
/**
* get the return value from your database or likewise
* @param $type eg. HOSTED, INVOICE or PAYMENTPLAN
* $param $country CountryCode eg. SE, NO, DK, FI, NL, DE
*/
public function getUsername($type, $country){
return $myUsername;
}
/**
* get the return value from your database or likewise
* @param $type eg. HOSTED, INVOICE or PAYMENTPLAN
* $param $country CountryCode eg. SE, NO, DK, FI, NL, DE
*/
public function getclientNumber($type, $country){
return $myClientNumber;
}
}Later when starting an WebPay action in your integration file, put an instance of your class as parameter to the constructor. If left blank, the default settings in the class SveaConfig will be used.
//Find your testmode settings
if($this->testmode == 1){
//if test, use your class that returns test authorization
$conf = new MyConfigTest();
}else{
//if production mode, use your class that returns production authorization
$conf = new MyConfigProd();
}
//Create your CreateOrder object and continue building your order. Se next steps.
$foo = WebPay::CreateOrder($conf);Creates an order and performs payment for all payment forms. Invoice and payment plan will perform a synchronous payment and return a response. Other hosted payments, like card, direct bank and other payments from the PayPage, on the other hand are asynchronous. They will return an html form with formatted message to send from your store. For every new payment type implementation, you follow the steps from the beginning and chose your payment type preffered in the end: Build order -> choose payment type -> doRequest/getPaymentForm
$response = WebPay::createOrder()
//For all products and other items
->addOrderRow(Item::orderRow()...)
//If shipping fee
->addFee(Item::shippingFee()...)
//If invoice with invoice fee
->addFee(Item::invoiceFee()
//If discount or coupon with fixed amount
->addDiscount(Item::fixedDiscount()
//If discount or coupon with percent discount
->addDiscount(Item::relativeDiscount()
//Individual customer values.
->addCustomerDetails(Item::individualCustomer()...)
//Company customer values
->addCustomerDetails(Item::companyCustomer()...)
//Other values
->setCountryCode("SE")
->setOrderDate("2012-12-12")
->setCustomerReference("33")
->setClientOrderNumber("nr26")
->setCurrency("SEK")
->setAddressSelector("7fd7768")
//Continue by choosing one of the following paths
//Continue as an invoice payment with instant response
->useInvoicePayment()
...
->doRequest();
//Continue as a payment plan payment with instant response
->usePaymentPlanPayment("campaigncode", 0)
...
->doRequest();
//Continue as a card payment with asynchronous response
->usePayPageCardOnly()
...
->getPaymentForm();
//Continue as a direct bank payment with asynchronous response
->usePayPageDirectBankOnly()
...
->getPaymentForm();
//Continue as a PayPage payment, where you can custom the alternatives on your paypage, with asynchronous response
->usePayPage()
...
->getPaymentForm();
//Go direct to specified paymentmethod, whithout stopping on the PayPage, with asynchronous response
->usePaymentMethod (PaymentMethod::SEB_SE) //see APPENDIX for Constants
...
->getPaymentForm();Set test mode while developing to make the calls to our test server. Remove when you change to production mode.
->setTestmode()Continue by adding values for products and other. You can add OrderRow, Fee and Discount. Chose the right Item object as parameter. You can use the add- functions with an Item object or an array of Item objects as parameters.
->addOrderRow(Item::orderRow()->...)
//or
$orderRows[] = Item::orderRow()->...;
->addOrderRow($orderRows);All products and other items. It´s required to have a minimum of one orderrow. The price can be set in a combination by using a minimum of two out of three functions: setAmountExVat(), setAmountIncVat() and setVatPercent().
->addOrderRow(
Item::orderRow()
->setQuantity(2) //Required
->setAmountExVat(100.00) //Optional, see info above
->setAmountIncVat(125.00) //Optional, see info above
->setVatPercent(25) //Optional, see info above
->setArticleNumber(1) //Optional
->setDescription("Specification") //Optional
->setName('Prod') //Optional
->setUnit("st") //Optional
->setDiscountPercent(0) //Optional
)The price can be set in a combination by using a minimum of two out of three functions: setAmountExVat(), setAmountIncVat()and setVatPercent().
->addFee(
Item::shippingFee()
->setShippingId('33') //Optional
->setName('shipping') //Optional
->setDescription("Specification") //Optional
->setAmountExVat(50) //Optional, see info above
->setAmountIncVat(62.50) //Optional, see info above
->setVatPercent(25) //Optional, see info above
->setUnit("st") //Optional
->setDiscountPercent(0) //Optional
)The price can be set in a combination by using a minimum of two out of three functions: setAmountExVat(), setAmountIncVat() and setVatPercent().
->addFee(
Item::invoiceFee()
->setName('Svea fee') //Optional
->setDescription("Fee for invoice") //Optional
->setAmountExVat(50) //Optional, see info above
->setAmountIncVat(62.50) //Optional, see info above
->setVatPercent(25) //Optional, see info above
->setUnit("st") //Optional
->setDiscountPercent(0) //Optional
)When discount or coupon is a fixed amount on total product amount.
->addDiscount(
Item::fixedDiscount()
->setAmountIncVat(100.00) //Required
->setDiscountId("1") //Optional
->setUnit("st") //Optional
->setDescription("FixedDiscount") //Optional
->setName("Fixed") //Optional
)When discount or coupon is a percentage on total product amount.
->addDiscount(
Item::relativeDiscount()
->setDiscountPercent(50) //Required
->setDiscountId("1") //Optional
->setUnit("st") //Optional
->setName('Relative') //Optional
->setDescription("RelativeDiscount") //Optional
)Customer identity is required for invoice and payment plan orders. Required values varies depending on country and customer type. For SE, NO, DK and FI NationalIdNumber (Social Security Number) or company id number is required. Email and ip address are desirable.
To make it easy to set the right data depending on the customer type this example
//create company or individual object
$foo = Item::individualCustomer();
if(*condition*){
$foo = $foo ->setEmail("[email protected]") ;
}
->addOrderRow($foo);####1.3.1 Options for individual customers
->addCustomerDetails(
Item::individualCustomer()
->setNationalIdNumber(194605092222) //Required for individual customers in SE, NO, DK, FI
->setInitials("SB") //Required for individual customers in NL
->setBirthDate(1923, 12, 20) //Required for individual customers in NL and DE
->setName("Tess", "Testson") //Required for individual customers in NL and DE
->setStreetAddress("Gatan", 23) //Required in NL and DE
->setZipCode(9999) //Required in NL and DE
->setLocality("Stan") //Required in NL and DE
->setEmail("[email protected]") //Optional but desirable
->setIpAddress("123.123.123") //Optional but desirable
->setCoAddress("c/o Eriksson") //Optional
->setPhoneNumber(999999) //Optional
)####1.3.2 Options for company customers
->addCustomerDetails(
Item::companyCustomer()
->setNationalIdNumber(2345234) //Required in SE, NO, DK, FI
->setVatNumber("NL2345234") //Required in NL and DE
->setCompanyName("TestCompagniet") //Required in NL and DE
->setStreetAddress("Gatan", 23) //Required in NL and DE
->setZipCode(9999) //Required in NL and DE
->setLocality("Stan") //Required in NL and DE
->setEmail("[email protected]") //Optional but desirable
->setIpAddress("123.123.123") //Optional but desirable
->setCoAddress("c/o Eriksson") //Optional
->setPhoneNumber(999999) //Optional
) ->setCountryCode("SE") //Required
->setCurrency("SEK") //Required for card payment, direct payment and PayPage payment.
->setClientOrderNumber("nr26") //Required for card payment, direct payment, PaymentMethod payment and PayPage payments.
->setAddressSelector("7fd7768") //Optional. Recieved from getAddresses
->setOrderDate("2012-12-12") //Required for synchronous payments
->setCustomerReference("33") //OptionalEnd process by choosing the payment method you desire.
Invoice and payment plan will perform a synchronous payment and return an object as response.
Other hosted payments(card, direct bank and other payments from the PayPage) on the other hand are asynchronous. They will return an html form with formatted message to send from your store. The response is then returned to the return url you have specified in function setReturnUrl(). If you use class Response with the xml response as parameter, you will receive a formatted object as well.
I am using invoice and/or payment plan payments.
The best way is to use [
->useInvoicePayment()] (https://github.com/sveawebpay/php-integration/tree/develop#154-invoicepayment) and [->usePaymentPlanPayment()] (https://github.com/sveawebpay/php-integration/tree/develop#154-paymentplanpayment). These payments are synchronous and will give you an instant response.
I am using card and/or direct bank payments.
You can go by PayPage by using [
->usePayPageCardOnly()] (https://github.com/sveawebpay/php-integration/tree/develop#151-paypage-with-card-payment-options) and [->usePayPageDirectBankOnly()] (https://github.com/sveawebpay/php-integration/tree/develop#152-paypage-with-direct-bank-payment-options).If you for example only have one specific bank payment, you can go direct to that specific bank payment by using [
->usePaymentMethod(PaymentMethod)] (https://github.com/sveawebpay/php-integration/tree/develop#154-paymentmethod-specified)
I am using all payments.
The most effective way is to use
->useInvoicePayment()and->usePaymentPlanPayment()for the synchronous payments, and use the PayPage for the asynchronous requests by using [->usePayPageCardOnly()] (https://github.com/sveawebpay/php-integration/tree/develop#151-paypage-with-card-payment-options) and [->usePayPageDirectBankOnly()] (https://github.com/sveawebpay/php-integration/tree/develop#152-paypage-with-direct-bank-payment-options).
I am using more than one payment and want them gathered on on place.
You can go by PayPage and choose to show all your payments here, or modify to exclude or include one or more payments. Use [
->usePayPage()] (https://github.com/sveawebpay/php-integration/tree/develop#153-paypagepayment) where you can custom your own PayPage.
Note that Invoice and Payment plan payments will return an asynchronous response from here.
The request gives an instant response.
Perform an invoice payment. This payment form will perform a synchronous payment and return a response. Returns CreateOrderResponse object. If Config/SveaConfig.php is not modified you can set your store authorization here.
$response = WebPay::createOrder()
->setTestmode()
->addOrderRow(
Item::orderRow()
->setArticleNumber(1)
->setQuantity(2)
->setAmountExVat(100.00)
->setDescription("Specification")
->setName('Prod')
->setUnit("st")
->setVatPercent(25)
->setDiscountPercent(0)
)
->setCountryCode("SE")
->setCustomerReference("33")
->setOrderDate("2012-12-12")
->setCurrency("SEK")
->useInvoicePayment()
->setPasswordBasedAuthorization("sverigetest", "sverigetest", 79021) //Optional on certain conditions, see chapter: Configuration
->doRequest();Only individual customers can use this payment type. Perform PaymentPlanPayment. This payment form will perform a synchronous payment and return a response. Returns a CreateOrderResponse object. Preceded by WebPay::getPaymentPlanParams(). If Config/SveaConfig.php is not modified you can set your store authorization here. Param: Campaign code recieved from getPaymentPlanParams().
$response = WebPay::createOrder()
->setTestmode()
->addOrderRow(
Item::orderRow()
->setArticleNumber(1)
->setQuantity(2)
->setAmountExVat(100.00)
->setDescription("Specification")
->setName('Prod')
->setUnit("st")
->setVatPercent(25)
->setDiscountPercent(0)
)
->setCountryCode("SE")
->setCustomerReference("33")
->setOrderDate("2012-12-12")
->setCurrency("SEK")
->usePaymentPlanPayment("camp1") //Parameter: campaign code recieved from getPaymentPlanParams
->setPasswordBasedAuthorization("sverigetest", "sverigetest", 79021) //Optional on certain conditions, see chapter: Configuration
->doRequest();Build order and recieve a PaymentForm object. Send the PaymentForm parameters: merchantid, xmlMessageBase64 and mac by POST to SveaConfig::SWP_TEST_URL or SveaConfig::SWP_PROD_URL. The PaymentForm object also contains a complete html form as string and the html form element as array. The response is returned as XML, but you can use our response handler to format the response.
<form name='paymentForm' id='paymentForm' method='post' action='SveaConfig::SWP_TEST_URL'>
<input type='hidden' name='merchantid' value='{$this->merchantid}' />
<input type='hidden' name='message' value='{$this->xmlMessageBase64}' />
<input type='hidden' name='mac' value='{$this->mac}' />
<input type="submit" name="submit" value="Submit" />
</form>PayPage with availible card payments only.
If Config/SveaConfig.php is not modified you can set your store authorization here.
$form = WebPay::createOrder()
->addOrderRow(
Item::orderRow()
->setArticleNumber(1)
->setQuantity(2)
->setAmountExVat(100.00)
->setDescription("Specification")
->setName('Prod')
->setUnit("st")
->setVatPercent(25)
->setDiscountPercent(0)
)
->setCountryCode("SE")
->setClientOrderNumber("33")
->setOrderDate("2012-12-12")
->setCurrency("SEK")
->usePayPageCardOnly()
->setMerchantIdBasedAuthorization(1200, "f78hv9") //Optional on certain conditions, see chapter: Configuration
->setPayPageLanguage("sv") //Optional, default english
->setReturnUrl("http://myurl.se") //Required
->setCancelUrl("http://myurl.se") //Optional
->setSimulatorCode(107) // Optional. Force SveaWebPay to return the error code 107 (only in testing mode)
->getPaymentForm();The values of xmlMessageBase64, merchantid and mac are to be sent as xml to SveaWebPay. Function getPaymentForm() returns object type PaymentForm with accessible members:
| Member | Description |
|---|---|
| xmlMessageBase64 | Payment information in XML-format, Base64 encoded. |
| xmlMessage | Payment information in XML-format. |
| merchantid | Authorization |
| secretWord | Authorization |
| mac | Message authentication code. |
| completeHtmlFormWithSubmitButton | A complete Html form with method= "post" with submit button to include in your code. |
| htmlFormFieldsAsArray | Array of Html form fields to include. |
| rawFields | Array of values to send in Html form. ($merchantid, $xmlMessageBase64, $mac) |
$form = ...
->getPaymentForm();
echo $form->completeHtmlFormWithSubmitButton; //Will render a hidden form with submit button in browserPayPage with available direct bank payments only.
If Config/SveaConfig.php is not modified you can set your store authorization here.
$form = WebPay::createOrder()
->setTestmode()
->addOrderRow(
Item::orderRow()
->setArticleNumber(1)
->setQuantity(2)
->setAmountExVat(100.00)
->setDescription("Specification")
->setName('Prod')
->setUnit("st")
->setVatPercent(25)
->setDiscountPercent(0)
)
->setCountryCode("SE")
->setCustomerReference("33")
->setOrderDate("2012-12-12")
->setCurrency("SEK")
->usePayPageDirectBankOnly()
->setMerchantIdBasedAuthorization(1200, "f78hv9") //Optional on certain conditions, see chapter: Configuration
->setPayPageLanguage("sv") //Optional, default english
->setReturnUrl("http://myurl.se") //Required
->setCancelUrl("http://myurl.se") //Optional
->getPaymentForm();Returns object type PaymentForm:
| Member | Description |
|---|---|
| xmlMessageBase64 | Payment information in XML-format, Base64 encoded. |
| xmlMessage | Payment information in XML-format. |
| merchantid | Authorization |
| secretWord | Authorization |
| mac | Message authentication code. |
| completeHtmlFormWithSubmitButton | A complete Html form with method= "post" with submit button to include in your code. |
| htmlFormFieldsAsArray | Array of Html form fields to include. |
| rawFields | Array of values to send in Html form. ($merchantid, $xmlMessageBase64, $mac) |
$form = ...
->getPaymentForm();
echo $form->completeHtmlFormWithSubmitButton; //Will render a hidden form with submit button in browserPayPage with all available payments. You can also custom the PayPage by using one of the methods for PayPagePayments: setPaymentMethod, includePaymentMethods, excludeCardPaymentMethods or excludeDirectPaymentMethods.
$form = WebPay::createOrder()
->setTestmode()
->addOrderRow(
Item::orderRow()
->setArticleNumber(1)
->setQuantity(2)
->setAmountExVat(100.00)
->setDescription("Specification")
->setName('Prod')
->setUnit("st")
->setVatPercent(25)
->setDiscountPercent(0)
)
->setCountryCode("SE")
->setCustomerReference("33")
->setOrderDate("2012-12-12")
->setCurrency("SEK")
->usePayPage()
->setMerchantIdBasedAuthorization(1200, "f78hv9") //Optional on certain conditions, see chapter: Configuration
->setPayPageLanguage("sv") //Optional, default english
->setReturnUrl("http://myurl.se") //Required
->setCancelUrl("http://myurl.se") //Optional
->getPaymentForm();Optional if you want to include specific payment methods for PayPage.
->usePayPage()
->setReturnUrl("http://myurl.se") //Required
->setCancelUrl("http://myurl.se") //Optional
->excludePaymentMethods(PaymentMethod::SEB_SE,PaymentMethod::INVOICE) //Optional
->getPaymentForm();Optional if you want to include specific payment methods for PayPage.
->usePayPage()
->setReturnUrl("http://myurl.se") //Required
->includePaymentMethods(PaymentMethod::SEB_SE,PaymentMethod::INVOICE) //Optional
->getPaymentForm();Optional if you want to exclude all cardpayment methods from PayPage.
->usePayPage()
->setReturnUrl("http://myurl.se") //Required
->excludeCardPaymentMethods() //Optional
->getPaymentForm();Optional if you want to exclude all direct bank payments methods from PayPage.
->usePayPage()
->setReturnUrl("http://myurl.se") //Required
->excludeDirectPaymentMethods() //Optional
->getPaymentForm();Returns object type PaymentForm:
| Member | Description |
|---|---|
| xmlMessageBase64 | Payment information in XML-format, Base64 encoded. |
| xmlMessage | Payment information in XML-format. |
| merchantid | Authorization |
| secretWord | Authorization |
| mac | Message authentication code. |
| completeHtmlFormWithSubmitButton | A complete Html form with method= "post" with submit button to include in your code. |
| htmlFormFieldsAsArray | Array of Html form fields to include. |
| rawFields | Array of values to send in Html form. ($merchantid, $xmlMessageBase64, $mac) |
$form = ...
->getPaymentForm();
echo $form->completeHtmlFormWithSubmitButton; //Will render a hidden form with submit button in browserGo direct to specified payment method without the step PayPage.
If Config/SveaConfig.php is not modified you can set your store authorization here.
$form = WebPay::createOrder()
->addOrderRow(
Item::orderRow()
->setArticleNumber(1)
->setQuantity(2)
->setAmountExVat(100.00)
->setDescription("Specification")
->setName('Prod')
->setUnit("st")
->setVatPercent(25)
->setDiscountPercent(0)
)
->setCountryCode("SE")
->setClientOrderNumber("33")
->setOrderDate("2012-12-12")
->setCurrency("SEK")
->usePaymentMethod(PaymentMethod::KORTCERT) //Se APPENDIX for paymentmethods
->setMerchantIdBasedAuthorization(1200, "f78hv9") //Optional on certain conditions, see chapter: Configuration
->setReturnUrl("http://myurl.se") //Required
->setCancelUrl("http://myurl.se") //Optional
->getPaymentForm();The values of xmlMessageBase64, merchantid and mac are to be sent as xml to SveaWebPay. Function getPaymentForm() returns Object type PaymentForm with accessible members:
| Member | Description |
|---|---|
| xmlMessageBase64 | Payment information in XML-format, Base64 encoded. |
| xmlMessage | Payment information in XML-format. |
| merchantid | Authorization |
| secretWord | Authorization |
| mac | Message authentication code. |
| completeHtmlFormWithSubmitButton | A complete Html form with method= "post" with submit button to include in your code. |
| htmlFormFieldsAsArray | Array of Html form fields to include. |
| rawFields | Array of values to send in Html form. ($merchantid, $xmlMessageBase64, $mac) |
$form = ...
->getPaymentForm();
echo $form->completeHtmlFormWithSubmitButton; //Will render a hidden form with submit button in browserRequest returns an instans response.
Use this function to retrieve campaign codes for possible payment plan options. Use prior to create payment plan payment. Returns PaymentPlanParamsResponse object. If Config/SveaConfig.php is not modified you can set your store authorization here.
$response = WebPay::getPaymentPlanParams()
->setTestmode()
->setPasswordBasedAuthorization("sverigetest", "sverigetest", 79021) //Optional on certain conditions, see chapter: Configuration
->doRequest();Returns getAddressesResponse object with an AddressSelector for the associated addresses for a specific security number. Can be used when creating an order. Only applicable for SE, NO and DK. If Config/Config.php is not modified you can set your store authorization here.
->setOrderTypeInvoice() //Required if this is an invoice order
or
->setOrderTypePaymentPlan() //Required if this is a payment plan order ->setIndividual(194605092222) //Required if this is an individual customer
or
->setCompany("CompanyId") //Required if this is a company customer $response = WebPay::getAddresses()
->setTestmode()
->setPasswordBasedAuthorization("sverigetest", "sverigetest", 79021) //Optional on certain conditions, see chapter: Configuration
->setOrderTypeInvoice() //See 3.1
->setCountryCode("SE") //Required
->setIndividual(194605092222) //See 3.2
->doRequest();Updates the status on a previous created order as delivered. Add rows that you want delivered. The rows will automatically be matched with the rows that was sent when creating the order. Only applicable for invoice and payment plan payments. Returns DeliverOrderResult object. If Config/SveaConfig.php is not modified you can set your store authorization here.
Set test mode while developing to make the calls to our test server. Remove when you change to production mode.
Ex.
->setTestmode()Continue by adding values for products and other. You can add OrderRow, Fee and Discount. Chose the right Item object as parameter. You can use the add- functions with an Item object or an array of Item objects as parameters.
->addOrderRow(Item::orderRow()->...)
//or
$orderRows[] = Item::orderRow()->...;
->addOrderRow($orderRows)All products and other items. It is required to have a minimum of one row.
->addOrderRow(
Item::orderRow()
->setQuantity(2) //Required
->setAmountExVat(100.00) //Required
->setVatPercent(25) //Required
->setArticleNumber(1) //Optional
->setDescription("Specification") //Optional
->setName('Prod') //Optional
->setUnit("st") //Optional
->setDiscountPercent(0) //Optional
)->addFee(
Item::shippingFee()
->setAmountExVat(50) //Required
->setVatPercent(25) //Required
->setShippingId('33') //Optional
->setName('shipping') //Optional
->setDescription("Specification") //Optional
->setUnit("st") //Optional
->setDiscountPercent(0)
)->addFee(
Item::invoiceFee()
->setAmountExVat(50) //Required
->setVatPercent(25) //Required
->setName('Svea fee') //Optional
->setDescription("Fee for invoice") //Optional
->setUnit("st") //Optional
->setDiscountPercent(0) //Optional
)Required is the order id received when creating the order. Required for invoice orders are InvoiceDistributionType. If invoice order is credit invoice use setCreditInvoice($invoiceId) and setNumberOfCreditDays($creditDaysAsInt)
->setOrderId($orderId) //Required. Received when creating order.
->setNumberOfCreditDays(1) //Use for Invoice orders.
->setInvoiceDistributionType('Post') //Use for Invoice orders. "Post" or "Email"
->setCreditInvoice //Use for invoice orders, if this should be a credit invoice.
->setNumberOfCreditDays(1) //Use for invoice orders. $response = WebPay::deliverOrder()
->setTestmode()
->addOrderRow(
Item::orderRow()
->setArticleNumber(1)
->setQuantity(2)
->setAmountExVat(100.00)
->setDescription("Specification")
->setName('Prod')
->setUnit("st")
->setVatPercent(25)
->setDiscountPercent(0)
)
->setOrderId("id")
->setInvoiceDistributionType('Post')
->deliverInvoiceOrder()
->setPasswordBasedAuthorization("sverigetest", "sverigetest", 79021) //Optional on certain conditions, see chapter: Configuration
->doRequest();Use when you want to cancel an undelivered order. Valid only for invoice and payment plan orders. Required is the order id received when creating the order. If Config/SveaConfig.php is not modified you can set your store authorization here.
->closeInvoiceOrder()
or
->closePaymentPlanOrder() $request = WebPay::closeOrder()
->setTestmode()
->setOrderId($orderId) //Required, received when creating an order.
->closeInvoiceOrder()
->setPasswordBasedAuthorization("sverigetest", "sverigetest", 79021)//Optional on certain conditions, see chapter: Configuration
->doRequest();All synchronous responses are handled through SveaResponse and structured into objects. Asynchronous responses recieved after sending the values merchantid and xmlMessageBase64 to hosted solutions can also be processed through the SveaResponse class.
The response from server will be sent to the returnUrl with POST or GET. The response contains the parameters: response and merchantid. Class SveaResponse will return a structured object similar to the synchronous answer instead. Params:
- The POST or GET message
- Your secret word. //Optional if set in SveaConfig.php
$respObject = new SveaResponse($_REQUEST,$secretWord); Used in usePaymentMethod($paymentMethod) and in usePayPage(), ->includePaymentMethods(...,...,...), ->excludeCardPaymentMethods(...,...,...), ->excludeDirectPaymentMethods(), ->excludeCardPaymentMethods().
| Payment method | Description |
|---|---|
| PaymentMethod::BANKAXESS | Direct bank payments, Norway |
| PaymentMethod::NORDEA_SE | Direct bank payment, Nordea, Sweden. |
| PaymentMethod::SEB_SE | Direct bank payment, private, SEB, Sweden. |
| PaymentMethod::SEBFTG_SE | Direct bank payment, company, SEB, Sweden. |
| PaymentMethod::SHB_SE | Direct bank payment, Handelsbanken, Sweden. |
| PaymentMethod::SWEDBANK_SE | Direct bank payment, Swedbank, Sweden. |
| PaymentMethod::KORTCERT | Card payments, Certitrade. |
| PaymentMethod::PAYPAL | Paypal |
| PaymentMethod::SKRILL | Card payment with Dankort, Skrill. |
| PaymentMethod::INVOICE | Invoice by PayPage. |
| PaymentMethod::PAYMENTPLAN | PaymentPlan by PayPage. |