More details about how to call API methods mentioned here can be found on: https://developer.wasakredit.se/api-documentation
Latest version of the API is v4
When performing calls to the API for most operations an access token is required in the Authorization header. An access token can be retrieved by calling our Authentication API with following parameters:
https://b2b.services.wasakredit.se/auth/connect/token/https://auth.inttest-b2b.wasakredit.se/connect/token/client_id=12983019283&client_secret=120csk20fa9g1350vm&grant_type=client_credentials
A successfull response body:
{
"access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjlFM0Q1Qjg1NUU0RTM4OTk3Q0Y5OTk4RkJEMDA5NzAyQzBGMzFFMkUiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJuajFiaFY1T09KbDgtWm1QdlFDWEFzRHpIaTQifQ.eyJuYmYiOjE1MDk1NDAzNzAsImV4cCI6MTUwOTU0Mzk3MCwiaXNzIjoiaHR0cDovL3drY2xvdWQtZnJvbnQtbGItMTI2ODc4NjA3MS5ldS1jZW50cmFsLTEuZWxiLmFtYXpvbmF3cy5jb206ODMiLCJhdWQiOlsiaHR0cDovL3drY2xvdWQtZnJvbnQtbGItMTI2ODc4NjA3MS5ldS1jZW50cmFsLTEuZWxiLmFtYXpvbmF3cy5jb206ODMvcmVzb3VyY2VzIiwicHVibGljLmNoZWNrb3V0LmFwaSJdLCJjbGllbnRfaWQiOiI0NzUwN2U5Ny1iZDBlLTQ4OGUtOWFkYi03ZDY0NGQyYmVmZGMiLCJzY29wZSI6WyJwdWJsaWMuY2hlY2tvdXQuYXBpLnJldGFpbGVyIl19.zuE5F6ChHLh5ZOT-CaaXAMLod6roalzz2DKu93_yKGQ-BzHRkgaDXQRMr4xKf5op-o990lW4Hp513vGXWOvIqYiWEV8fv49tw3jivpXm3els2ewebkTjeAptJ99_yKw58Qut9dLIreAX_x2PFH6i5nU7XZXJdx8vmspC1fSXOryuqSNU29pbqPwmRzZyi0qpo9LiDAkXdgm7e2hOilUOJEkdS708EugfT3qBEQ8ONLGUNCIq-q6aLoQEDq0dp_uR6EYDyEPRGG1paWy5Cp7cyD63aTpsXlgGCiIaPDA6O2PTogKw6HadTN4oKHxZ2sFyRPWqbtAe0VOOmSC-ErpZaw",
"expires_in": "3600",
"token_type": "\"Bearer\""
}
To validate whether the Wasa Kredit payment method should be displayed for a given cart amount or not, send a GET request to leasing/validate-financed-amount with the cart amount value specified in a request parameter called amount.
For example, the GET request
leasing/validate-financed-amount?amount=45000
will validate a cart amount value of 45000 SEK.
The response body will look something like this:
{
"validation_result": true
}
The Wasa Kredit payment method should only be displayed for the specified cart amount if the value of validation_result is true. If the value of validation_result is false, the Wasa Kredit payment method should not be displayed.
To validate whether the Wasa Kredit payment method should be displayed for a given cart amount or not, send a GET request to invoice/validate-financed-amount with the cart amount value specified in a request parameter called amount.
For example, the GET request
invoice/validate-financed-amount?amount=45000
will validate a cart amount value of 45000 SEK.
The response body will look something like this:
{
"validation_result": true
}
The Wasa Kredit payment method should only be displayed for the specified cart amount if the value of validation_result is true. If the value of validation_result is false, the Wasa Kredit payment method should not be displayed.
To get possible payment methods for a partner, send a GET request to payment-methods with the request parameter total_amount, which holds the total amount of the cart.
Note: At present, only SEK is handled.
For example, the GET request
payment-methods?total_amount=45000
will get payment methods for a cart amount value of 45000 SEK.
The response body will look something like this:
{
"payment_methods": [
{
"id": "leasing",
"display_name":"Leasing"
},
{
"id": "invoice",
"display_name":"Faktura"
}
]
}
The response above can be used to compose a description of which payment methods that are available in the checkout before it’s loaded.
To get possible leasing/rental payment options for a funded amount, send a GET request to leasing/payment-options with the request parameter total_amount, which holds the total amount of the cart. And the request parameter currency, which holds a currency code represented as an ISO 4217 currency code.
Note: At present, only SEK is handled.
For example, the GET request
leasing/payment-options?total_amount=45000¤cy=SEK
will get leasing/rental payment options for a cart amount value of 45000 SEK.
The response body will look something like this:
{
"default_contract_length": 36,
"contract_lengths": [
{
"contract_length": 24,
"monthly_cost": {
"amount": "555",
"currency": "SEK"
}
},
{
"contract_length": 36,
"monthly_cost": {
"amount": "426",
"currency": "SEK"
}
},
{
"contract_length": 48,
"monthly_cost": {
"amount": "346",
"currency": "SEK"
}
}
]
}
The first step is to POST to leasing/checkout with the following body:
{
"payment_types": "leasing",
"order_references": [
{
"key": "partner_order_number",
"value": "123456"
}
],
"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"
}
],
"shipping_cost_ex_vat": {
"amount": "14995.50",
"currency": "SEK"
},
"customer_organization_number": "222222-2222",
"purchaser_name": "Anders Svensson",
"purchaser_email": "purchaser@gmail.com",
"purchaser_phone": "070-1234567",
"billing_address": {
"company_name": "Customer Company Name",
"street_address": "Ekelundsgatan 9",
"postal_code": "41118",
"city": "Gothenburg",
"country": "Sweden"
},
"delivery_address": {
"company_name": "Customer Company Name",
"street_address": "Ekelundsgatan 9",
"postal_code": "41118",
"city": "Gothenburg",
"country": "Sweden"
},
"recipient_name": "Anders Svensson",
"recipient_phone": "070-1234567",
"request_domain": "https://YOUR-BASE-DOMAIN",
"confirmation_callback_url": "https://YOUR-BASE-DOMAIN/payment-callback/",
"ping_url": "https://YOUR-BASE-DOMAIN/order-updated/"
}
Note that the property order_references is a collection so that even if you don’t want to create an order in your system before creating a Wasa Kredit checkout you have the possibility to supply a temporary identifier to be able to match the Wasa Kredit order with some reference in your system. You also have the option to add additional reference identifiers at a later time, for example when your final order is created.
The URL that you supply through the ping_url property should be an endpoint that is set up to receive a POST message and return an http status code 200 response on success.
You will receive an html snippet which you should embed in your web page, inside of which the Wasa Kredit Checkout widget will handle the payment flow.
The first step is to POST to invoice/checkout with the following body:
{
"order_references": [
{
"key": "partner_order_number",
"value": "123456"
}
],
"cart_items": [
{
"product_id": "ez-41239b",
"product_name": "Kylskåp EZ3",
"price_ex_vat": {
"amount": "14995.50",
"currency": "SEK"
},
"price_incl_vat": {
"amount": "14995.50",
"currency": "SEK"
},
"quantity": 1,
"vat_percentage": "25",
"vat_amount": {
"amount": "14995.50",
"currency": "SEK"
},
"total_price_incl_vat": {
"amount": "14995.50",
"currency": "SEK"
},
"total_price_ex_vat": {
"amount": "14995.50",
"currency": "SEK"
},
"total_vat": {
"amount": "14995.50",
"currency": "SEK"
}
}
],
"total_price_incl_vat": {
"amount": "14995.50",
"currency": "SEK"
},
"total_price_ex_vat": {
"amount": "14995.50",
"currency": "SEK"
},
"total_vat": {
"amount": "14995.50",
"currency": "SEK"
},
"customer_organization_number": "222222-2222",
"purchaser_name": "Anders Svensson",
"purchaser_email": "purchaser@gmail.com",
"purchaser_phone": "070-1234567",
"partner_reference": "Salesman Svensson",
"billing_details": {
"billing_reference": "Billing reference",
"billing_tag": "Tag"
},
"recipient_name": "Anders Svensson",
"recipient_phone": "070-1234567",
"request_domain": "https://YOUR-BASE-DOMAIN",
"confirmation_callback_url": "https://YOUR-BASE-DOMAIN/payment-callback/",
"ping_url": "https://YOUR-BASE-DOMAIN/order-updated/"
}
Note that the property order_references is a collection so that even if you don’t want to create an order in your system before creating a Wasa Kredit checkout you have the possibility to supply a temporary identifier to be able to match the Wasa Kredit order with some reference in your system. You also have the option to add additional reference identifiers at a later time, for example when your final order is created.
The URL that you supply through the ping_url property should be an endpoint that is set up to receive a POST message and return an http status code 200 response on success.
You will receive an html snippet which you should embed in your web page, inside of which the Wasa Kredit Checkout widget will handle the payment flow.
After creating the Wasa Kredit checkout by POSTing to <leasing or invoice>/checkouts 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 (POST to checkouts) request.
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 through the Create Checkout request as the order_references property.
orderReferences = [
{ key: "partner_checkout_id", value: "900123" },
{ key: "partner_reserved_order_number", value: "123456" }
];
When calling the Create Checkout operation. When the order is created or when the order status is updated, you will receive a POST to the supplied ping_url, which contains the following body:
{
"order_id" : "9c722707-123a-44e7-9eba-93e3a372d57e",
"order_status": "initialized"
}
For further information about the order status flow, see the order flow chart.
Using the Wasa Kredit order id (order_id), provided in the pingback body, you are able to get the entire order object through a GET from orders/{order_id}, which will return the following response:
{
"customer_organization_number": "222222-2222",
"delivery_address": {
"company_name": "Customer Company Name",
"street_address": "Ekelundsgatan 9",
"postal_code": "41118",
"city": "Gothenburg",
"country": "Sweden"
},
"billing_address": {
"company_name": "Customer Company Name",
"street_address": "Ekelundsgatan 9",
"postal_code": "41118",
"city": "Gothenburg",
"country": "Sweden"
},
"order_references": [
{
"key": "partner_order_number",
"value": "123456"
}
],
"purchaser_email": "purchaser@gmail.com",
"recipient_name": "Anders Svensson",
"recipient_phone": "070-1234567",
"status": {
"status": "delivered"
},
"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"
}
]
}
Each time the order status is updated you will receive a pingback, enabling you to take action on the status change.
The possible order statuses are:
The preferred point in time to create the order in your system is when receiveing a pingback with order status “pending” for leasing and “ready_to_ship” for invoice.
To match the Wasa Kredit order against your internal cart/checkout/order, issue a GET against orders/{order_id} and use the order_references-object in the response.
To be able to match your internal cart/checkout/order against the Wasa Kredit order you are able to provide an unlimited set of order references. Order references might be provided in two ways.
<leasing or invoice>/checkouts).orders/{order_id}/order-references. This might be done at anytime as long as you have the Wasa Kredit order id. Notice that this operation will add the additional order references to any previous order references.The order reference object is a list of key-value pairs where the key is the reference identifier (i.e. describes the type of reference) and the value is the actual reference id.
[
{
"key" : "partner-cart-reference",
"value" : "56065dae-5d00-4ccd-aa8f-009ba8d0d137"
},
{
"key" : "partner-checkout-reference",
"value" : "d79903b0-108b-48f5-9ee1-6ca8062031e2"
}
]
Order references are added one at a time through POSTs to orders/{order_id}/order-references.
ready_to_ship. You should now ship the order items to the customer.orders/{order_id}/ship.shipped.To cancel an order, call the Update Order Status operation by issuing a PUT to orders/{order_id}/cancel. Orders that have already been shipped cannot be canceled.