Open Banking in Latvia

Overview

Open Banking in Latvia is a payment method that uses the online banking mechanism for payments through Latvian banks. You can perform purchases through this method by using Payment Page and Gate.

General information

Payment method type online banking
Countries and regions LV
Payment currencies EUR
Currency conversion
Purchases +
Payouts
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Notes
  • Due to specifics of provider's operation, the merchant may be required to obtain additional consent of the customer for payment processing by using the Open Banking in Latvia method.
  • Payment Page supports configuration of different ways of displaying buttons of payment method and supported banks.
Onboarding and access fee refer to your ECommPay key account manager

Interaction diagram

Payment processing by using the Open Banking in Latvia payment method requires merchant's web service, one of the interfaces and the payment platform of ECommPay, as well as one of the bank services which supports this payment method.



Operations support

  Interfaces Amounts, EUR
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) Minimum Maximum
Purchases + + * *

* Amount limits depend on banks.

Processing scenarios

In the Open Banking in Latvia method, to perform a purchase operation, you need to redirect a customer to the provider service.

Supported banks

Payments through the Open Banking in Latvia method are carried out through banks that support the work with this method. Banks have their own identifiers, which are used to initiate purchases by using Gate, and to display banks on Payment Page when choosing a payment method.

The table below provides information on these banks for informational purposes, it may change without additional notice; for the most recent list of supported banks, contact your ECommPay Key Account Manager or POST the /v2/info/banks/latvia/sale/list request using Gate API. This request belongs to the following request group /v2/info/banks/{payment_method}/{operationType}/list.

The request must contain the project and payment IDs, signature, currency, and payment amount, as shown in the example. It is important to specify real payment data, but if the payment has not yet been generated, you can specify a random value for the payment ID in the request.

Figure: Example of requesting a list of banks

{
  "general": {
    "project_id": 200,
    "payment_id": "ORDER_155860015",
    "signature": "K6jllym+PtObocZtr345st...=="
  },
  "payment": {
    "amount": 1000,
    "currency": "EUR"
  }
}
Table 1. List of banks
Bank ID
SEB bank 1991
Swedbank 1981
Rietumu bank 2001

The sections that follow provide detailed information about what you need to perform payments and how you can analyse the information on payments and operations.

Purchases by using Payment Page

General information

In the Open Banking in Latvia method, to perform a purchase by using Payment Page, the merchant web service should send a request with all the required parameters and signature to the ECommPay URL and get the callback with the payment result from the payment platform. When opening Payment Page, you can either allow your customer to select the Open Banking in Latvia method from the list of other payment methods on Payment Page or have Payment Page opened with the Open Banking in Latvia method selected. For more information about preselecting payment methods, see in Preselecting payment methods.

Payment processing by using the Open Banking in Latvia method involves redirection of the customer to the provider service. In some cases, depending on the specifics of the provider's operation, the customer can also be redirected to the bank service to confirm the payment. Note that when the Open Banking in Latvia method is used, the merchant may be required to obtain additional consent of the customer for payment processing and, in some cases, collect additional customer data. For this purpose, corresponding page is displayed on Payment Page.

The full sequence and special aspects of the purchase processing are provided below.

Figure: Purchase processing by using Payment Page with redirecting the customer to provider service



Figure: Purchase sequence by using Payment Page with redirecting the customer to provider service: Step-by-step description

  1. A customer initiates a purchase on the merchant's web service.
  2. The web service sends the request for Payment Page opening to the specified ECommPay URL.
  3. The request for opening is redirected to the payment platform.
  4. The payment platform performs the initial request processing that involves validation of the required parameters and signature.
  5. In the ECommPay payment platform Payment Page is generated based on the project settings and parameters specified in the request.
  6. Payment Page is displayed to the customer.
  7. The customer selects the Open Banking in Latvia method and one of the supported banks.
  8. The request for processing the payment through the selected bank is sent from Payment Page to the payment platform.
  9. The payment platform performs the internal processing of the purchase request. During this step, depending on the specifics of the provider processing the payment, the need for additional consent of the customer and additional customer data is identified. If customer's consent (and additional data) is required, the following steps are performed:
    • Notification about the need for additional consent of the customer and additional data (if needed) is sent from the payment platform to Payment Page.
    • A page with information about the need for customer's consent and additional data is displayed to the customer on Payment Page.
    • The customer gives their consent, provides the requested data and confirms purchase processing.
    • The information provided by the customer is sent from Payment Page to the payment platform.
    • The information is processed on the side of the payment platform.
  10. The data for redirecting the customer to the provider service is sent from the payment platform to Payment Page.
  11. The customer is redirected to the provider service, and payment instruction is displayed to the customer.
  12. The customer completes all the required payment steps.
  13. The request for processing the payment is sent from the provider service to the bank service.
  14. The payment is processed on the side of the bank service.
  15. The bank service sends the notification about the result to the provider service.
  16. The information about the result is displayed to the customer on the side of the provider service.
  17. The customer is redirected to Payment Page.
  18. The provider service sends the notification about the result to the payment platform.
  19. The payment platform sends a callback with information about the payment result to the web service.
  20. The payment platform sends information about the result to Payment Page.
  21. A page with information about the payment result is displayed to the customer on Payment Page.

Figure: Purchase sequence by using Payment Page with redirecting the customer to bank service



Figure: Purchase sequence by using Payment Page with redirecting the customer to bank service: Step-by-step description

  1. A customer initiates a purchase on the merchant's web service.
  2. The web service sends the request for Payment Page opening to the specified ECommPay URL.
  3. The request for opening is redirected to the payment platform.
  4. The payment platform performs the initial request processing that involves validation of the required parameters and signature.
  5. In the ECommPay payment platform Payment Page is generated based on the project settings and parameters specified in the request.
  6. Payment Page is displayed to the customer.
  7. The customer selects the Open Banking in Latvia method and one of the supported banks.
  8. The request for processing the payment is sent from Payment Page to the payment platform.
  9. The payment platform performs the internal processing of the purchase request. During this step, depending on the specifics of the provider processing the payment, the need for additional consent of the customer and additional customer data is identified. If customer's consent (and additional data) is required, the following steps are performed:
    • Notification about the need for additional consent of the customer and additional data (if needed) is sent from the payment platform to Payment Page.
    • A page with information about the need for customer's consent and additional data is displayed to the customer on Payment Page.
    • The customer gives their consent, provides the requested data and confirms purchase processing.
    • The information provided by the customer is sent from Payment Page to the payment platform.
    • The information is processed on the side of the payment platform.
  10. The data for redirecting the customer to the provider service is sent from the payment platform to Payment Page.
  11. The customer is redirected to the provider service, and then to the bank service, where payment instruction is displayed to the customer.
  12. The customer completes all the required payment steps.
  13. The payment is processed on the side of the bank service.
  14. The information about the result is displayed to the customer on the side of the bank service.
  15. The customer is redirected to Payment Page.
  16. The bank service sends the notification about the result to the provider service.
  17. The provider service sends the notification about the result to the payment platform.
  18. The payment platform sends a callback with information about the payment result to the web service.
  19. The payment platform sends information about the result to Payment Page.
  20. A page with information about the payment result is displayed to the customer on Payment Page.

The sections that follow provide details the request format and the Payment Page parameters to use in the Open Banking in Latvia payment method and provide the information on the format of callbacks with payment results. For the general information on how to use the API, see Payment Page API Description.

Request format

There are several things you must consider when performing a purchase through the Open Banking in Latvia method:

  1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
    • project_id—the project ID obtained from ECommPay
    • payment_id—payment ID unique within the project
    • payment_currency—payment currency in ISO-4217 alpha-3 format
    • payment_amount—purchase amount in minor currency units
    • customer_id—the unique ID of the customer within your project
  2. The currency of payment can only be EUR.
  3. It is recommended to specify the first and last names of the customer in the customer_first_name and customer_last_name additional parameters. If the request is missing the parameters, the additional fields are displayed to the customer on Payment Page to input missing data. For more details, see Submission of additional payment information.

    Additionally, when selecting certain banks the customer can be required to specify the International Bank Account Number (IBAN) on Payment Page, while selecting other banks the IBAN is specified on the provider side. Due to the specifics of the payment method this number can only be specified by the customer and can't be used in requests.

  4. If customer's consent for payment processing is required, it is recommended to specify in the request the merchant_return_url parameter with the URL for redirecting the customer to the web service, so that the customer can return to the web service by clicking the corresponding button on the payment form in case the customer does not grant their consent for payment processing. The URL should lead to the checkout page to avoid repeated ordering on the side of the web service.
  5. You can customise the selecting payment method page on Payment Page.

    By default, banks that support Open Banking in Latvia payment method are grouped in one button on Payment Page, so the selection of a bank is carried out in two steps. First, the Open Banking in Latvia method is chosen among others, and then a particular bank is selected on the next page with the list of the group banks. There are several options for displaying the page with the selecting of payment method on Payment Page:

    • To display each bank of the Open Banking in Latvia group with a separate buttons, pass split_banks=true in the request for opening in the payment_methods_options string.
      payment_methods_options={"latvia": {"split_banks": true}}
      
    • To display a button of a specific bank (one or several) from Open Banking in Latvia group on Payment Page in the list of payment methods, pass the bank identifier in the banks_id parameter. If it is necessary to display several banks from a group, pass the identifiers of these banks separated by a comma with a space.
      payment_methods_options={"latvia": {"split_banks": true, "banks_id": [2001, 1981]}}
    • To preselect Open Banking in Latvia as the payment method on Payment Page for customers, pass the code latvia in the force_payment_method parameter in the request for opening. The list of the banks from Open Banking in Latvia group is displayed to a customer on Payment Page bypassing the page with the payment method selection.
    • To preselect a particular bank from the Open Banking in Latvia group on Payment Page, pass the code latvia in the force_payment_method parameter and the bank identifier banks_id in the payment_methods_options string.

      Figure: Example of the purchase request with displaying a preselected bank

          {
            payment_id: 'X03936', 
            payment_amount: 1000, 
            payment_currency: 'EUR', 
            project_id: 123,
            customer_id: 'customer1',
            force_payment_method: 'latvia',
            payment_methods_options={"latvia": {"banks_id": [2001]}},
            signature: "kUi2x9dKHAVNU0FYlSCQ9vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
          }
  6. If required, you can also add any other additional parameters Payment Page supports. For information about all parameters available in the Open Banking in Latvia method, see Payment Page invocation parameters.
  7. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

Thus, a correct payment request in the Open Banking in Latvia method must include project, customer, and payment IDs, the currency and the amount of a payment, first and last names of the customer, and URL for redirection, as shown in the following example:

    {
      payment_id: 'X03936', 
      payment_amount: 1000, 
      payment_currency: 'EUR', 
      project_id: 123,
      customer_id: 'customer1',
      customer_first_name: 'John',
      customer_last_name: 'Doe',
      merchant_return_url: 'http://example.com/return',
      signature: "kUi2x9dKHAVNU0FYldJrxh4...zUCwX6R\/ekpZhkIQg=="
    }

Callback format

The standard format for callbacks is used to deliver purchase results from Open Banking in Latvia. For more information, see Callbacks.

Here is the example of a callback with an information about successful 10,00 EUR purchase made in the 200 project.

Figure: Example of a succeed purchase callback

{
        "project_id": 200,
        "payment": {
            "id": "E2E_deploy_S05_0.04896200_1584714117",
            "type": "purchase",
            "status": "success",
            "date": "2020-03-20T14:22:06+0000",
            "method": "Latvian Banks",
            "sum": {
                "amount": 1000,
                "currency": "EUR"
            },
            "description": "Success"
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 9529253065607,
            "type": "sale",
            "status": "success",
            "date": "2020-03-20T14:22:06+0000",
            "created_date": "2020-03-20T14:22:00+0000",
            "request_id": "f1de353331a01fd14163fe4226-00009530",
            "sum_initial": {
                "amount": 1000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1914,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "giRT+RB/rG5JrSMjb/...DaHDxz+JukI2+7HhMivMlmbhQ=="
    }

Here is the example of a callback for a declined purchase.

Figure: Example of a declined purchase callback

{
        "project_id": 200,
        "payment": {
            "id": "E2E_deploy_S05_0.04896200_1584714118",
            "type": "purchase",
            "status": "decline",
            "date": "2020-03-20T14:22:07+0000",
            "method": "Latvian Banks",
            "sum": {
                "amount": 1000,
                "currency": "EUR"
            },
            "description": "Decline"
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 9529253065608,
            "type": "sale",
            "status": "decline",
            "date": "2020-03-20T14:22:07+0000",
            "created_date": "2020-03-20T14:22:00+0000",
            "request_id": "f1de353331a01fd14163fe4226-00009531",
            "sum_initial": {
                "amount": 1000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "EUR"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 1914,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "giRT+RB/rG5JrSMjb/...DaHDxz+JukI2+7HhMivM2mbhQ=="
    }

Related topics

The following topics might be useful when implementing payments through Payment Page:

Purchases by using Gate

General information

In the Open Banking in Latvia method, when processing a purchase by using Gate, the merchant web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ECommPay URL.
  2. Redirect the customer to the website of the provider which supports payment processing by using the Open Banking in Latvia method.
  3. Get the callback with the payment result from the payment platform.

Payment processing by using the Open Banking in Latvia method involves redirection of the customer to the provider service. In some cases, depending on the specifics of the provider's operation, the customer can also be redirected to the bank service to confirm the payment. Note that when the Open Banking in Latvia method is used, the merchant may be required to obtain additional consent of the customer for payment processing and, in some cases, collect additional customer data. The information about the required steps to perform on the side of the merchant web service is provided in the Formats of the data for obtaining customer's consent section, and the diagrams below provide the detailed picture of the payment processing procedure.

Figure: Purchase sequence by using Gate with redirecting the customer to provider service



Figure: Purchase sequence by using Gate with redirecting the customer to provider service: Step-by-step description

  1. A customer initiates a purchase through one of the Open Banking in Latvia group banks on the merchant's web service side.
  2. The web service sends the request for processing the purchase by using Gate to the specified ECommPay URL.
  3. The payment platform receives the request for processing the purchase from Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
  6. The payment platform performs the internal processing of the purchase request. During this step, depending on the specifics of the provider processing the payment, the need for additional consent of the customer and additional customer data is identified. If customer's consent (and additional data) is required, the following steps are performed:
    • Notification about the need for additional consent of the customer and additional data (if needed) is sent from the payment platform to the web service.
    • Customer's consent and additional data (if needed) is requested on the side of the web service.
    • The customer grants their consent, provides requested data and confirms purchase processing.
    • The information provided by the customer is sent from the web service to the payment platform.
    • The information is processed on the side of the payment platform.
  7. The data for redirecting the customer to the provider service is sent from the payment platform to the web service.
  8. The customer is redirected to the provider service, and payment instruction is displayed to the customer.
  9. The customer completes all the required payment steps.
  10. The request for processing the payment is sent from provider service to the bank service.
  11. The payment is processed on the side of the bank service.
  12. The bank service sends the notification about the result to the provider service.
  13. The information about the result is displayed to the customer on the side of the provider service.
  14. The customer is redirected to the web service.
  15. The provider service sends the notification about the result to the payment platform.
  16. The payment platform sends a callback with information about the payment result to the web service.
  17. The customer receives information about the payment result on the web service.

Figure: Purchase sequence by using Gate with redirecting the customer to the bank service



Figure: Purchase sequence by using Gate with redirecting the customer to the bank service: Step-by-step description

  1. A customer initiates a purchase through one of the Open Banking in Latvia group banks on the merchant's web service side.
  2. The web service sends the request for processing the purchase by using Gate to the specified ECommPay URL.
  3. The payment platform receives the request for processing the purchase from Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
  6. The payment platform performs the internal processing of the purchase request. During this step, depending on the specifics of the provider processing the payment, the need for additional consent of the customer and additional customer data is identified. If customer's consent (and additional data) is required, the following steps are performed:
    • Notification about the need for additional consent of the customer and additional data (if needed) is sent from the payment platform to the web service.
    • Customer's consent and additional data (if needed) is requested on the side of the web service.
    • The customer grants their consent, provides requested data and confirms purchase processing.
    • The information provided by the customer is sent from the web service to the payment platform.
    • The information is processed on the side of the payment platform.
  7. The data for redirecting the customer to the provider service is sent from the payment platform to the web service.
  8. The customer is redirected to the provider service, and then to the bank service, where payment instruction is displayed to the customer.
  9. The customer completes all the required payment steps.
  10. The payment is processed on the side of the bank service.
  11. The information about payment result is displayed to the customer on the side of the bank service.
  12. The customer is redirected to the web service.
  13. The bank service sends the notification about the result to the provider service.
  14. The provider service sends the notification about the result to the payment platform.
  15. The payment platform sends a callback with information about the payment result to the web service.
  16. The customer receives the information about payment result on the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Open Banking in Latvia payment method and provide the information about formats of the data for redirecting customers and the information about the format of callbacks with payment results. The general information about working with API see in the API Description section.

Request format

There are several things you must consider when using purchase requests in the Open Banking in Latvia method:
  1. You perform purchase by sending the /v2/payment/banks/latvia/sale request by using POST (HTTP) method. This is an online banking request group: /v2/payment/banks/{payment_method}/sale
  2. The following objects and parameters must be specified in the request:
    • Object general—general request identification information:
      • project_id—the project ID obtained from ECommPay
      • payment_id—payment ID unique within the project
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.
    • Object payment—purchase information:
      • amount—purchase amount in minor currency units
      • currency—purchase currency in ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—identifier unique within the project
      • ip_address—customer IP address
    • Object account—customer account information:
      • bank_id—bank identifier
    • Object return_url—URLs for redirecting a customer from the bank website:
      • return—URL for redirecting a customer during any step of the purchase by pressing a button
  3. It is recommended to specify the additional parameters. If the request is missing the parameters, the list of parameters is sent in the clarification callback. For more details, see Submission of additional payment information.

    There is the list of recommended objects and parameters:

    • Object customer—customer information:
      • first_name—first name
      • last_name—last name

    Additionally, when selecting certain banks it may be required to specify the International Bank Account Number (IBAN), while selecting other banks the IBAN is specified on the provider side. In cases when the account number needs to be specified before the customer is redirected to the provider side, the clarification callback contains the number parameter of the number object; and if the initial request did not contain the first_name and last_name parameters of the customer object, all three of these parameters are sent in the clarification callback. Due to the specifics of the payment method, if this number is sent in the initial request, it is not taken into account during the initial payment processing, and can either be specified on the web service side after receiving the clarification callback or on the provider side after customer redirection.

  4. The currency of a purchase can only be EUR.
  5. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request through the Open Banking in Latvia method must include project, payment, customer, and bank IDs, customer IP-address, signature, currency and amount of the purchase, first and last names of the customer, and URL for redirection, as shown in the following example:

Figure: Purchase request example

{
    "general": {
      "project_id": 2990,
      "payment_id": payment_id,
      "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 1000,
      "currency": "EUR"
      },
    "customer": {
      "id": "customer123",  
      "ip_address": "1.2.3.4",
      "first_name": "John",
      "last_name": "Doe"
    },
    "account":{
      "bank_id": 140
    },
    "return_url":{
      "return": "http://example.com/return"
 }
}

Formats of the data for obtaining customer's consent

When the Open Banking in Latvia method is used, the merchant may be required to obtain additional consent of the customer for processing payment. To do so, the merchant web service is required to do the following:

  1. Receive callback informing about the necessity of obtaining customer's consent (and collecting additional data for payment processing, if needed).
  2. Obtain customer's consent (and collect additional data, if needed).
  3. Send request with information about customer's consent (and additional data, if needed) to the payment platform.

The clarification_fields.customer.properties.psu_consent_text.default parameter in the callback from the payment platform contains the text that must be displayed to the customer in order to obtain their consent for purchase processing.

The following is a fragment of a callback informing about the necessity of obtaining customer's consent.

{
    "clarification_fields": {
        "customer": {
            "type": "object",
            "description": "",
            "properties": {
                "psu_consent": {
                    "type": "string",
                    "description": "Need to request the users consent to make a payment"
                 },
                "psu_consent_text": {
                    "type": "string",
                    "description": "The text to be displayed on the payment form",
                    "default": "=== The PSU consent text to be displayed on payment page ==="  
}
The request for continuation of payment processing with regard to customer's consent (and additional payment information, if needed) should be sent to the /v2/payment/clarification endpoint by using the POST HTTP method. The request must contain the following objects and parameters:
  • general—object that contains general request identification information:
    • project_id—project ID which is relevant to the payment.
    • payment_id—payment ID which is relevant to the data being sent.
    • signature—signature generated after all of the required parameters are specified. For more information about signature generation, see Signature generation and verification.
  • additional_data—object that contains information about customer's consent for purchase processing (and additional payment information, if needed):
  • customer—object that contains customer information:
    • psu_consent—information about obtainment of customer's consent for purchase processing. If the customer granted their consent for purchase processing, the value for this parameter must be 1. If the value is different, customer's consent is requested again.
    • psu_consent_text—the text of the request for customer's consent for purchase processing displayed to the customer. The text specified as the value of this parameter must be exactly the same as the text received in the callback informing the merchant about the necessity of obtaining customer's consent. If the specified text is different, customer's consent is requested again.

Along with the information about customer's consent, it may be required to specify in the request additional customer data described in the Request format section.

Thus, a correct request must include project and payment IDs, information about customer's consent and text displayed to the customer, additional customer data (if needed), and signature, as shown in the following example:

{
    "general": {
        "project_id": 10571,
        "payment_id": "1234567890",
        "signature": "=== signature ==="
    },
    "additional_data": {
        "customer": {
            "psu_consent": "1",
            "psu_consent_text": "=== The PSU consent text to be displayed on payment page ===",
            "first_name": "Firstname",
            "last_name": "Lastname"
        "account": {
            "number": "AB123456789"
        }
    }
}

Formats of the customer redirection data

Depending on the specifics of the provider, two versions of notifications with redirection data can be sent from the payment platform to the web service. For information about the version used for a particular project, contact ECommPay technical support.

Version 1

In the Open Banking in Latvia method, to redirect a customer to the provider website, it is required to do the following:

  1. Receive the callback from the payment platform which includes the redirect_data object. This object contains the object body with the data necessary to reference the provider's JavaScript library and call the function that redirects the customer to the provider website.
  2. Reference provider's JavaScript library using the URL received in the widget_url parameter of the body object.
  3. Call the function that redirects the customer to the provider website using the parameters received in the body object (according to the provider requirements).

The body object contains the following mandatory parameters:

  • widget_url—URL of provider's JavaScript library
  • widget_host—hostname of the provider server
  • token—token which is used in data.token in the function that redirects the customer
  • other—determines the possibility of payment by using banks that are not supported by default on the provider side; this option is not supported in this technical implementation, the value of the parameter is always off
  • callback_url—URL for customer redirection to the web service side after successful payment

The body object can also contain the following optional parameters:

  • creditor—bank identifier code (BIC); the parameter is used when the bank is selected on the web service side
  • css—link to the CSS file with styles which allows the merchant to alter the appearance of the provider website
  • default_country—code of the country with the banks which are available for payment processing; the code must be specified in the ISO 3166-1 alpha-2 format

Figure: Example of customer redirection data

  "redirect_data": {
    "url": "http://pay.test/example",
        "method": "POST",
    "body": {
      "widget_url":"https://psd2.neopay.lt/widget.js",
      "widget_host":"https://psd2.neopay.lt/",
            "token": "eyJhbGciOiJIUzI1NiIsInR5cCIp0cnVlLCJpYXQiOjE0OTMyMD",
            "other": "off",
            "creditor": "HABALV22",
            "css": "https://css.test.org",
            "default_country": "LV",
            "callback_url": "https://callback.url.org"
    }
  }

The following is the example of the URL which is used to reference the provider's JavaScript library and the example of call of the function which redirects the customer the provider website. Both of these examples are based on the example of customer redirection data provider above.

Figure: Example of URL of provider's JavaScript library

<script type="text/javascript" src="https://psd2.neopay.lt/widget.js"></script> 

Figure: Example of call of the function which redirects the customer to the provider website

var NEOWidgetHost = "https://psd2.neopay.lt";
NEOWidget.initialize(
    NEOWidgetHost,
    data.token,
    {
    'other':'off',
    'creditor': 'HABALV22',
    'css':'https://css.test.org',
    'default_country':'LV',
    'callback_url':'https://callback.url.org'
    }
); 

Version 2

To redirect a customer from the web service to the Open Banking in Latvia site, you must receive a callback from the payment platform containing the URL for redirection in the redirect_data.url parameter and data to be sent in the request body in the redirect_data.body parameter, and use these parameters when opening the HTML page using the method specified in the redirect_data.method parameter.

The following is the callback fragment containing the redirection data.

"redirect": {
        "method": "POST",
        "encrypted": [],
        "url": "https://web-app.example.com/app/request-token/rq:3R123"
    }

Callback format

In the Open Banking in Latvia method, the callbacks that deliver purchase results use the standard format described in Callbacks.

The following is the example of a callback with the information about successful 10.00 EUR purchase made in the 200 project.

Figure: Example of a succeed purchase callback

{
        "project_id": 200,
        "payment": {
            "id": "E2E_deploy_S05_0.04896200_1584714117",
            "type": "purchase",
            "status": "success",
            "date": "2020-03-20T14:22:06+0000",
            "method": "Latvian Banks",
            "sum": {
                "amount": 1000,
                "currency": "EUR"
            },
            "description": "Success"
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 9529253065607,
            "type": "sale",
            "status": "success",
            "date": "2020-03-20T14:22:06+0000",
            "created_date": "2020-03-20T14:22:00+0000",
            "request_id": "f1de353331a01fd14163fe4226-00009530",
            "sum_initial": {
                "amount": 1000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1914,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "giRT+RB/rG5JrSMjb/...DaHDxz+JukI2+7HhMivMlmbhQ=="
    }

The following is the example of a callback for a declined purchase.

Figure: Example of a declined purchase callback

{
        "project_id": 200,
        "payment": {
            "id": "E2E_deploy_S05_0.04896200_1584714118",
            "type": "purchase",
            "status": "decline",
            "date": "2020-03-20T14:22:07+0000",
            "method": "Latvian Banks",
            "sum": {
                "amount": 1000,
                "currency": "EUR"
            },
            "description": "Decline"
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 9529253065608,
            "type": "sale",
            "status": "decline",
            "date": "2020-03-20T14:22:07+0000",
            "created_date": "2020-03-20T14:22:00+0000",
            "request_id": "f1de353331a01fd14163fe4226-00009531",
            "sum_initial": {
                "amount": 1000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "EUR"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 1914,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "giRT+RB/rG5JrSMjb/...DaHDxz+JukI2+7HhMivM2mbhQ=="
    }

Related topics

The following topics might be useful when implementing payments through Gate:

Analysis of payments results

As with other payment methods ECommPay offers, when using the Open Banking in Latvia method, you have several options to analyse the information about payments and operations performed by using the method—alone or in conjunction with other methods.

You can load and analyse all the necessary information in Dashboard (Old Dashboard), for instance you can use the analytic panels on the Analytics tab to this end.

Also, you can export the information for further analysis by using third party analytical tools. The following options are available:

  • Dashboard (Old Dashboard) allows you to download reports in CSV and XLS formats—by using the tools on the Payments tab. You can perform export as a one-time download to your local computer or have payment data regularly exported and delivered to email addresses you specify.
  • Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by using the /operations/get queries.

If you have any further questions regarding payment data analysis, contact ECommPay technical support.