Table of Content
Invoice added as entirely new payment method. Get Payment Methods will return only the active payment methods i.e. Leasing, Rental. The added method Get Leasing Payment Options will deliver the payment options including the contract lengths (This only applies to leasing, since Invoice has no contract lengths).
Create_checkout is set to deprecated since there are two new methods that replaces this method: create_invoice_checkout and create_leasing_checkout. Create_checkout will still work as it simply wraps create_leasing_checkout, for backwards compatibility.
TestMode is removed since we will no longer support test_mode header in the production environment. The consumer of this API will instead have to route their requests to a different URL when using test mode. To support this we have added a createClient factory method : ClientFactory.CreateClient() which has the testMode flag as a parameter. When passing testMode = true, this will set the test_base_url and test_access_token which will then be used when communicating with the test environment.
The Create Product Widget has got a replacement function called Get Monthly Cost Widget, which will result in a more clean and simple look that is easier to style to your needs.
Minor update with respect to a missing semicolon.
Added new operation "Get Payment Methods". This can be used for a more detailed description of the Wasa Kredit Checkout payment method.
Resolve an issue with session scoping when running multiple partners on the same session/domain.
New generic operation names matching api changes.
Added tracking of SDK and Plugin version to header of API calls.
Added support for the missing endpoints Get Order Status and Update Order Status. Also documentation for Add Order Reference is now in place.
Custom callbacks on events from the Checkout has been introduced.
The snippet from create_checkout will no longer auto initialize the checkout.
This to allow the integrating partner to be able to handle the callbacks manually.
This documentation is about the PHP SDK for communicating with Wasa Kredit checkout services.
- Partner credentials
- PHP 5.7 or above
You can apply to receive Partner credentials by sending a mail to [email protected].
Initialize the main Client class by using the provided factory method ClientFactory.CreateClient and provide your issued Client ID and Client Secret. You can optionally supply a Test Mode parameter. It will be default set to True, so for production purposes you will need to set the Test mode parameter to False. You will be provided ClientId and ClientSecret for testing purposes as well, so when creating client for testing purposes, you will need to provide those values and set the Test Mode parameter to True.
/**
* Checks if the input is valid JSON or not
* @param string clientId
* @param string clientSecret
* @param boolean testMode
*
* @return Client
*/
new Client({CLIENT ID}, {CLIENT SECRET}, {TEST MODE})
Orchestrates the main flow. Client will fetch and store an access token upon an initial request and save it in a PHP session for future requests.
$this->_client = new Client(clientId, clientSecret);
| Name | Type | Description |
|---|---|---|
| clientId | string (required) | The client id that has been issued by Wasa Kredit |
| clientSecret | string (required) | Your client secret issued by Wasa Kredit |
When presenting a product list view this method calculates the monthly price for each of the products.
public function calculate_monthly_cost({ITEMS})
| Name | Type | Description |
|---|---|---|
| items | array[Item] (required) | An array containing the data type Item |
| Name | Type | Description |
|---|---|---|
| financed_price | Price (required) | ... |
| product_id | string (required) | Your unique product identifier |
| Name | Type | Description |
|---|---|---|
| amount | string (required) | A string value that will be parsed to a decimal, e.g. 199 is '199.00' |
| currency | string (required) | The currency |
$payload = array(
'items' => array(
[0] => array(
'financed_price' => array(
'amount' => '14995.00',
'currency' => 'SEK'
),
'product_id' => '12345'
)
)
);
$response = $this->_client->calculate_monthly_cost($payload);
| Name | Type | Description |
|---|---|---|
| monthly_costs | array[Response Item] | An array containing the data type Response Item |
| Name | Type | Description |
|---|---|---|
| monthly_cost | Price | |
| product_id | string | Your unique product identifier |
| Name | Type | Description |
|---|---|---|
| amount | string (required) | A string value that will be parsed to a decimal, e.g. 199 is '199.00' |
| currency | string | The currency |
$response->data
{
'monthly_costs': [
{
'monthly_cost': {
'amount': '1152.00',
'currency': 'SEK'
},
'product_id': '12345'
}
]
}
deprecated Please use the new method Create Leasing Checkout for creating leasing Checkouts, and respectively Create Invoice Checkout for creating Invoice Checkouts.
The Checkout is inserted as a Payment Method in the checkout. It could be used either with or without input fields for address. Post the cart to Create Checkout to initiate the checkout.
An alternative use case for the Checkout is as a complete checkout if there is no need for other payment methods.
public function create_checkout({CHECKOUT})
| Name | Type | Description |
|---|---|---|
| payment_types | string | Selected payment type to use in the checkout, e.g. 'leasing' |
| order_references | array | The order reference of the partner |
| cart_items | array[Cart Item] (required) | An array of the items in the cart as Cart Item objects |
| shipping_cost_ex_vat | Price (required) | Price object containing the shipping cost excluding VAT |
| customer_organization_number | string | Optional customer organization number |
| purchaser_name | string | Optional name of the purchaser |
| purchaser_email | string | Optional e-mail of the purchaser |
| purchaser_phone | string | Optional phone number of the purchaser |
| billing_address | Address | Optional Address object containing the billing address |
| delivery_address | Address | Optional Address object containing the delivery address |
| recipient_name | string | Optional name of the recipient |
| recipient_phone | string | Optional phone number of the recipient |
| request_domain | string (required) | The domain of the partner, used to allow CORS |
| confirmation_callback_url | string (required) | Url to the partner's confirmation page |
| ping_url | string (required) | Receiver url for order status changes notifications |
| Name | Type | Description |
|---|---|---|
| product_id | string (required) | Id of the Product |
| product_name | string (required) | Name of the product |
| price_ex_vat | Price (required) | Price object containing the price of the product excluding VAT |
| quantity | int (required) | Quantity of the product |
| vat_percentage | string (required) | VAT percentage as a parsable string, e.g. '25' is 25% |
| vat_amount | Price (required) | Price object containing the calculated VAT of the product |
| image_url | string | An optional image url of the product |
| Name | Type | Description |
|---|---|---|
| amount | string (required) | A string value that will be parsed to a decimal, e.g. 199 is '199.00' |
| currency | string (required) | The currency |
| Name | Type | Description |
|---|---|---|
| company_name | string | Company name |
| street_address | string | Street address |
| postal_code | string | Postal code |
| city | string | City |
| country | string | Country |
The response will return a unique html snippet to be embedded in your checkout html.
| Name | Type | Description |
|---|---|---|
| HtmlSnippet | string | The checkout snippet for embedding. |
$payload = array(
'order_references' => array(
[0] => array(
'key' => 'magento_quote_id',
'value' => $orderId
)
),
'cart_items' => array(
array(
'product_id' => 'ez-3000b-1',
'product_name' =>'Kylskåp EZ3',
'price_ex_vat' => array(
'amount' => '11996.00',
'currency' => 'SEK'
),
'quantity' => 1,
'vat_percentage' => '25',
'vat_amount' => array(
'amount' => '2999.00',
'currency' => 'SEK'
)
)
),
'shipping_cost_ex_vat' => array(
'amount' => '448.00',
'currency' => 'SEK'
),
'request_domain' => 'https://YOUR-BASE-DOMAIN/',
'confirmation_callback_url' => 'https://YOUR-BASE-DOMAIN/payment-callback/',
'ping_url' => 'https://YOUR-BASE-DOMAIN/ping-callback/'
);
$response = $this->_client->create_checkout($payload);
After creating a Wasa Kredit Checkout by calling the create_checkout function and embedding the resulting html snippet in your web page, as described above, the checkout html snippet needs to be explicitly initialized through a javascript call to the global window.wasaCheckout.init() function. The init method call will populate the <div> contained in the html snippet and link it to an internal iframe.
<script>
window.wasaCheckout.init();
</script>Optionally, you're able to pass an options object to the init-function. Use this if you want to manually handle the onComplete, onRedirect and onCancel events.
<script>
var options = {
onComplete: function(orderReferences){
//[...]
},
onRedirect: function(orderReferences){
//[...]
},
onCancel: function(orderReferences){
//[...]
}
};
window.wasaCheckout.init(options);
</script>The onComplete event will be raised when a User has completed the checkout process. We recommend that you convert your cart/checkout to an order here if you haven't done it already.
The onRedirect event will be raised the user clicks the "back to store/proceed"-button. The default behaviour will redirect the user to the confirmation_callback_url passed into the create_checkout-function.
The onCancel event will be raised if the checkout process is canceled by the user or Wasa Kredit.
All callback functions will get the orderReferences parameter passed from the checkout. This parameter consists of an Array of KeyValue objects.
These are the same values as the ones that was passed to the create_checkout-function as the order_references property.
orderReferences = [
{ key: "partner_checkout_id", value: "900123" },
{ key: "partner_reserved_order_number", value: "123456" }
]; The Invoice Checkout is inserted as a Payment Method in the checkout. It could be used either with or without input fields for address. Post the cart to Create Invoice Checkout to initiate the checkout.
public function create_invoice_checkout({INVOICECHECKOUT})
| Name | Type | Description |
|---|---|---|
| order_references | array[OrderReference] | The order references of the partner |
| cart_items | array[InvoiceCartItem] (required) | An array of the items in the cart as Cart Item objects |
| total_price_incl_vat | Price (required) | Price object containing the total price of the cart including VAT |
| total_price_ex_vat | Price (required) | Price object containing the total price of the cart excluding VAT |
| total_vat | Price (required) | Price object containing the total VAT of the cart |
| customer_organization_number | string | Optional customer organization number |
| purchaser_name | string | Optional name of the purchaser |
| purchaser_email | string | Optional e-mail of the purchaser |
| purchaser_phone | string | Optional phone number of the purchaser |
| partner_reference | string | Optional reference to be included in the invoice as reference, could be a sales person reference for example |
| billing_details | BillingDetails | Optional BillingDetails object containing billing reference and billing tag |
| recipient_name | string | Optional name of the recipient |
| recipient_phone | string | Optional phone number of the recipient |
| request_domain | string (required) | The domain of the partner, used to allow CORS |
| confirmation_callback_url | string (required) | Url to the partner's confirmation page |
| ping_url | string (required) | Receiver url for order status changes notifications |
| Name | Type | Description |
|---|---|---|
| product_id | string (required) | Id of the Product |
| product_name | string (required) | Name of the product |
| price_ex_vat | Price (required) | Price object containing the price of the product excluding VAT |
| price_incl_vat | Price (required) | Price object containing the price of the product including VAT |
| quantity | int (required) | Quantity of the product |
| vat_percentage | string (required) | VAT percentage as a parsable string, e.g. '25' is 25% |
| vat_amount | Price (required) | Price object containing the calculated VAT of the product |
| total_price_incl_vat | Price (required) | Price object containing the calculated total prince including VAT of the product, e.g. quantity * price_incl_vat |
| total_price_ex_vat | Price (required) | Price object containing the calculated total prince excluding VAT of the product, e.g. quantity * price_ex_vat |
| total_vat | Price (required) | Price object containing the total calculated VAT of the product |
| Name | Type | Description |
|---|---|---|
| amount | string (required) | A string value that will be parsed to a decimal, e.g. 199 is '199.00' |
| currency | string (required) | The currency |
The response will return a unique html snippet to be embedded in your checkout html.
| Name | Type | Description |
|---|---|---|
| HtmlSnippet | string | The checkout snippet for embedding. |
$payload = array(
'order_references' => array(
[0] => array(
'key' => 'magento_quote_id',
'value' => $orderId
)
),
'cart_items' => array(
array(
'product_id' => 'ez-3000b-1',
'product_name' =>'Kylskåp EZ3',
'price_ex_vat' => array(
'amount' => '800.00',
'currency' => 'SEK'
),
'quantity' => 2,
'vat_percentage' => '25',
'vat_amount' => array(
'amount' => '200.00',
'currency' => 'SEK'
),
'total_price_incl_vat' => array(
'amount' => '2000.00',
'currency' => 'SEK'
),
'total_price_ex_vat' => array(
'amount' => '1800.00',
'currency' => 'SEK'
),
'total_vat' => array(
'amount' => '400.00',
'currency' => 'SEK'
)
),
array(
'product_id' => 'shipping_1234',
'product_name' =>'shipping',
'price_ex_vat' => array(
'amount' => '80.00',
'currency' => 'SEK'
),
'quantity' => 1,
'vat_percentage' => '25',
'vat_amount' => array(
'amount' => '24.00',
'currency' => 'SEK'
),
'total_price_incl_vat' => array(
'amount' => '99.00',
'currency' => 'SEK'
),
'total_price_ex_vat' => array(
'amount' => '80.00',
'currency' => 'SEK'
),
'total_vat' => array(
'amount' => '24.00',
'currency' => 'SEK'
)
)
),
'total_price_incl_vat' => array(
'amount' => '5999.00',
'currency' => 'SEK'
),
'total_price_ex_vat' => array(
'amount' => '4999.00',
'currency' => 'SEK'
),
'total_vat' => array(
'amount' => '500.00',
'currency' => 'SEK'
),
'billing_details => array(
'billing_reference':'furniture',
'billing_tag':'weekend deal'
),
'request_domain' => 'https://YOUR-BASE-DOMAIN/',
'confirmation_callback_url' => 'https://YOUR-BASE-DOMAIN/payment-callback/',
'ping_url' => 'https://YOUR-BASE-DOMAIN/ping-callback/'
);
$response = $this->_client->create_checkout($payload);
After creating a Wasa Kredit Checkout by calling the create_checkout function and embedding the resulting html snippet in your web page, as described above, the checkout html snippet needs to be explicitly initialized through a javascript call to the global window.wasaCheckout.init() function. The init method call will populate the <div> contained in the html snippet and link it to an internal iframe.
<script>
window.wasaCheckout.init();
</script>Optionally, you're able to pass an options object to the init-function. Use this if you want to manually handle the onComplete, onRedirect and onCancel events.
<script>
var options = {
onComplete: function(orderReferences){
//[...]
},
onRedirect: function(orderReferences){
//[...]
},
onCancel: function(orderReferences){
//[...]
}
};
window.wasaCheckout.init(options);
</script>The onComplete event will be raised when a User has completed the checkout process. We recommend that you convert your cart/checkout to an order here if you haven't done it already.
The onRedirect event will be raised the user clicks the "back to store/proceed"-button. The default behaviour will redirect the user to the confirmation_callback_url passed into the create_checkout-function.
The onCancel event will be raised if the checkout process is canceled by the user or Wasa Kredit.
All callback functions will get the orderReferences parameter passed from the checkout. This parameter consists of an Array of KeyValue objects.
These are the same values as the ones that was passed to the create_checkout-function as the order_references property.
orderReferences = [
{ key: "partner_checkout_id", value: "900123" },
{ key: "partner_reserved_order_number", value: "123456" }
]; Validates that the amount is within the min/max financing amount for the partner using Leasing as payment method.
public function validate_financed_amount($amount)
| Name | Type | Description |
|---|---|---|
| amount | string (required) | The amount excluding VAT to be validated as a string, e.g. 199 is '199.00' |
$amount = '14995.00';
$response = $this->_client->validate_financed_amount($amount);
| Name | Type | Description |
|---|---|---|
| validation_result | boolean | Amount sent is between min/max limit for the partner |
$response->data
{
"validation_result": true
}
Validates that the amount is within the min/max financing amount for the partner using Invoice as payment method.
public function validate_financed_invoice_amount($amount)
| Name | Type | Description |
|---|---|---|
| amount | string (required) | The amount excluding VAT to be validated as a string, e.g. 199 is '199.00' |
$amount = '14995.00';
$response = $this->_client->validate_financed_amount($amount);
| Name | Type | Description |
|---|---|---|
| validation_result | boolean | Amount sent is between min/max limit for the partner |
$response->data
{
"validation_result": true
}
To inform the customer about Wasa Kredit financing as a Payment Method the Monthly Cost Widget should be displayed close to the price information on the product details page.
public function get_monthly_cost_widget($amount)
| Name | Type | Description |
|---|---|---|
| amount | string (required) | A string value that will be parsed to a decimal, e.g. 199 is '199.00' |
$response = $this->_client->get_monthly_cost_widget('10275.00');
The response will return a unique html snippet to be embedded in your product view html.
$response->data
"<div> ... </div>"
| Name | Type | Description |
|---|---|---|
| order_id | string (required) | The id of the desired order object |
$orderId = 'f404e318-7180-47ab-91db-fbb66addf577'
$response = $this->_client->get_order($orderId);
{
"customer_organization_number": "222222-2222",
"delivery_address": {
"company_name": "Star Republic",
"street_address": "Ekelundsgatan 9",
"postal_code": "41118",
"city": "Gothenburg",
"country": "Sweden"
},
"billing_address": {
"company_name": "Star Republic",
"street_address": "Ekelundsgatan 9",
"postal_code": "41118",
"city": "Gothenburg",
"country": "Sweden"
},
"order_references": [
{
"key": "partner_order_number",
"value": "123456"
}
],
"purchaser_email": "[email protected]",
"recipient_name": "Anders Svensson",
"recipient_phone": "070-1234567",
"status": {
"status": "shipped"
},
"cart_items": [
{
"product_id": "ez-41239b",
"product_name": "Kylskåp EZ3",
"price_ex_vat": {
"amount": "14995.50",
"currency": "SEK"
},
"quantity": 1,
"vat_percentage": "25",
"vat_amount": {
"amount": "14995.50",
"currency": "SEK"
},
"image_url": "https://unsplash.it/500/500"
}
]
}
Gets the current status of a Wasa Kredit order.
When an order status change notification is received. This method may be called to check the current status of the order.
- initialized - The order has been created but the order agreement has not yet been signed by the customer.
- canceled - The purchase was not approved by Wasa Kredit or it has been canceled by you as a partner. If you have created an order in your system it can safely be deleted.
- pending - The checkout has been completed and a customer has signed the order agreement, but additional signees is required or the order has not yet been fully approved by Wasa Kredit.
- ready_to_ship - All necessary signees have signed the order agreement and the order has been fully approved by Wasa Kredit. The order must now be shipped to the customer before Wasa Kredit will issue the payment to you as a partner.
- shipped - This status is set by the partner when the order item(s) have been shipped to the customer.
| Name | Type | Description |
|---|---|---|
| order_id | string (required) | The id of the desired order object |
$orderId = 'f404e318-7180-47ab-91db-fbb66addf577';
$response = $this->_client->get_order_status($orderId);
{
"status": "shipped"
}
Changes the order status of the Wasa Kredit order to shipped.
| Name | Type | Description |
|---|---|---|
| order_id | string (required) | The id of the order object |
$orderId = 'f404e318-7180-47ab-91db-fbb66addf577';
$this->_client->ship_order($orderId);
Changes the order status of the Wasa Kredit order to cancelled.
| Name | Type | Description |
|---|---|---|
| order_id | string (required) | The id of the order object |
$orderId = 'f404e318-7180-47ab-91db-fbb66addf577';
$this->_client->cancel_order($orderId);
Adds a new order reference and appends it to the current order references of the order. The purpose of supporting multiple order references for a single order is to provide generic support for e-commerce platforms and solutions that use multiple references in their purchase and order flow.
| Name | Type | Description |
|---|---|---|
| order_id | string (required) | The id of the order object |
| order_reference | OrderReference-object (required) | The order reference that should be added to the order |
| Name | Type | Description |
|---|---|---|
| key | string (required) | The key of the order reference |
| value | string (required) | The value of the order reference |
$orderId = 'f404e318-7180-47ab-91db-fbb66addf577';
$orderReference = array(
'key' => 'Quote',
'value' => '0b5e6f69-20ac-45b1-93d5-2c1be556488b'
);
$response = $this->_client->add_order_reference($orderId, $orderReference);
{
"status": "shipped"
}
Get information from Wasa Kredit about the different payment methods available in the checkout. This can be used to compose a description of which options are available in the checkout before it's loaded.
| Name | Type | Description |
|---|---|---|
| total_amount | string (required) | A string value that will be parsed to a decimal, e.g. 19999 is '19999.00' |
| currency | string (required) | The currency |
$total_amount = "10000.00";
$currency = "SEK";
$response = $this->_client->get_payment_methods($total_amount, $currency);
{
"payment_methods": [
{
"id": "leasing",
"display_name": "Leasing",
"options": {
"default_contract_length": 24,
"contract_lengths": [
{
"contract_length": 12,
"monthly_cost": {
"amount": "802",
"currency": "SEK"
}
},
{
"contract_length": 24,
"monthly_cost": {
"amount": "442",
"currency": "SEK"
}
},
{
"contract_length": 36,
"monthly_cost": {
"amount": "321",
"currency": "SEK"
}
}
]
}
}
]
}
Get information from Wasa Kredit about the payment options available in the Leasing checkout. This can be used to compose a description of which options are available in the checkout before it's loaded.
| Name | Type | Description |
|---|---|---|
| total_amount | string (required) | A string value that will be parsed to a decimal, e.g. 19999 is '19999.00' |
| currency | string (required) | The currency |
$total_amount = "10000.00";
$currency = "SEK";
$response = $this->_client->get_leasing_payment_options($total_amount, $currency);
{
"default_contract_length": 24,
"contract_lengths": [
{
"contract_length": 12,
"monthly_cost": {
"amount": "802",
"currency": "SEK"
}
},
{
"contract_length": 24,
"monthly_cost": {
"amount": "442",
"currency": "SEK"
}
},
{
"contract_length": 36,
"monthly_cost": {
"amount": "321",
"currency": "SEK"
}
}
]
}
We are using a Response class when passing information through the SDK.
| Name | Type | Description |
|---|---|---|
| statusCode | string | Http status code of the response |
| data | string | Contains the body of the response |
| error | string | Error code passed from the API |
| errorMessage | string | Developer error message |
| curlError | string | Curl error message |
php vendor/bin/phpunit