Merchant API E-Commerce

Generic, explanational documentationPlease note that the flow and its requests below is an example and other flows or variations may exist. Please advice with onboarding@resurs.se regarding specific actions prior to mapping up any logic or beginning any coding.

What can I find here?

Basic API flow

Authentication

Every request requires an authorization header with a Bearer-token. A token lasts for 3599 seconds. To get a token you may use your test-credentials received from Resurs Bank.

URL to get token: https://merchant-api.integration.resurs.com/oauth2/token

  • Client ID
  • Client Secret
  • Scope= merchant-api

Link to the call in swagger documentation: Get Token

Curl to get token

curl –location –request POST ‘https://merchant-api.integration.resurs.com/oauth2/token’–header ‘accept: application/json’ \-header ‘Content-Type: application/x-www-form-urlencoded’ \-data-urlencode ‘client_id=fill out client_id’ \-data-urlencode ‘client_secret=fill out client_secret’ \-data-urlencode ‘scope=merchant-api’ \-data-urlencode ‘grant_type=client_credentials’

Get Store ID

Get available stores

A client may have access to multiple stores, therefore we need to know which store to make the application or payment for.
This can be done by getting the available stores. Each store has a store-id. This id will be used in the next step to specify for which store we would like to get the payment methods.

URL to get available stores: https://merchant-api.integration.resurs.com/v2/stores

Link to the call in swagger documentation: Get Stores

Curl to get available stores

curl –location –request GET ‘https://merchant-api.integration.resurs.com/v2/stores’–header ‘Authorization: Bearer <TOKEN>’

Get available payment methods

A store may have multiple payment methods available. The list of available payment methods will show what payment methods there are to use from at the chosen store. Do not forget to sort out the payment methods which min-/max purchase limit are outside the cart value. If you input an amont in the request, the API will automatically not show the unavailable payment methods for you - you do not need to sort out payment methods yourselves.
Each payment method has a paymentmethod id, which will be used in the next step, when the payment is created.
When presenting the payment methods to the customer, please note that by law you are required to display our terms/link to our terms regarding the credit payment methods. The link is found in this same request with “type: PRICE_INFO”

URL to get available payment methods: https://merchant-api.integration.resurs.com/v2/stores/{store_id}/payment_methods

Link to the call in swagger documentation: Get Payment Methods

Curl to get available payment methods

curl –location –request POST ‘https://merchant-api.integration.resurs.com/v2/stores/{store_id}/payment_methods’–header ‘Content-Type: application/json’ \-header ‘Authorization: Bearer <TOKEN>’

Create Payment

Create payment

The call below is used to create a new payment and authorize the payment.

  • orderReference = your internal order reference, if it’s not provided by you it will be set by Resurs Bank. Will be provided in accounting file if not another value is provided in capture-request later on.

  • initiatedOnCustomersDevice = true becuase the payment in the webshop’s checkout is initiated on the customers device
  • handleFrozenPayments = payments may be frozen for a short time due to fraud controls. When a payment is frozen the customer is informed that the purchase is ready, but the goods shall not be shipped until the payment is captured

For further information regarding initiatedOnCustomersDevice and handleFrozenPayments, please go to “Schema” → “CreatePaymentRequest” → “Options” ; Create Payment Options

URL to create payment: https://merchant-api.integration.resurs.com/v2/payments

Link to the call in swagger documentation: Create Payment

Create payment

Payload: application/json
{
  "storeId": "b7f88ac4-baa7-493b-a0a7-d4e14f91f555",
    "paymentMethodId": "7d63eb50-94b4-4238-8c0d-22d095bfe46b",
  "order": {
    "orderLines": [
      {
        "description": "Product 1",
        "quantity": 1,
        "type": "NORMAL",
        "quantityUnit": "st",
        "vatRate": 25,
        "totalAmountIncludingVat": 5000.00
      },
       {
        "description": "Product 2",
        "quantity": 1,
        "type": "NORMAL",
        "quantityUnit": "st",
        "vatRate": 25,
        "totalAmountIncludingVat": 800.00
      }
    ],
    "orderReference": "order12345"
             },
   "customer": {
    "customerType": "NATURAL", 
     "governmentId": "8305147715",
     "email": "testemail@testing.se",
    "mobilePhone": "0707123456",
    "deliveryAddress": {
      "fullName": "Peter Parker",
      "firstName": "Peter",
      "lastName": "Parker",
      "addressRow1": "Ekslingan 9",
      "postalArea": "12345",
      "postalCode": "Helsingborg",
      "countryCode": "SE"
    },
    "deviceInfo": {
      "ip": "192.168.0.1",
      "userAgent": "Test browser 1.2"
    }
  },
 "metadata": {
   "creator": "Plattform XYZ version 1.3"
  },
  "options": {
    "initiatedOnCustomersDevice": true,
    "deliverLinks": false,
      "handleFrozenPayments": true,
      "handleManualInspection": false,
      "automaticCapture": false,
    "callbacks": {
      "authorization": {
        "url": "https://webhook.site/f138234c-4061-4e60-bd5a-1b6c11341145"
      },
      "management": {
        "url": "https://webhook.site/f138234c-4061-4e60-bd5a-1b6c11341145"
      }
    },
    "redirectionUrls": {
      "customer": {
        "failUrl": "https://www.aftonbladet.se/",
        "successUrl": "https://www.resursbank.se/"
      }
    },
    "timeToLiveInMinutes": 120
  }
}

Create payment responses and what to do next

status: TASK_REDIRECTION_REQUIRED → redirect customer to “customerUrl” and await callback.
Callbacks with callback-status AUTHORIZED, REJECTED, FROZEN or CAPTURED can be received before or after redirection is performed. 

Copyright © Resurs Bank AB 2024