Open Banking EU

Interaction diagram

Payment processing by using the Open Banking EU payment method requires merchant web service, one of Monetix interfaces, and the Monetix payment platform, as well as provider's technical facilities.

Operations support

	Interfaces			Amounts, EUR		Times
	Payment Page	Gate	Dashboard	minimum	maximum	basic	threshold
Purchases				10.00	9999.00	10 minutes	30 minutes

You can check the payment amount limits in your project by using Dashboard. To check your payment amount limits, go to Dashboard, select the Projects section and click the Payment methods tab.

Processing scenarios

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

The sections that follow provide more information about what you need to perform payments and how you can analyze payments and operations information.

Supported banks

Payments with Open Banking EU are carried out through the banks that support this method. When using Payment Page, the customer generally selects a bank in the payment form, although in the payments that use Payment Page with the pre-selected payment method and bank or Gate, the customer must select the bank on the web service side and the request must contain the bank ID.

The tables below provide information about the supported banks. The list is provided for informational purposes only.

Note that the list of the supported banks may change without notice. To get the most recent list of the supported banks, use the Gate API to send a POST request to the /v2/info/banks/sepa/sale/list endpoint at Gate API. The endpoint is a part of the /v2/info/banks/{payment_method}/{operationType}/list group of endpoints.

The following objects and parameters must be specified in the request for the list of supported banks:

• general—object with general request information:
  • project_id—the project ID obtained from Monetix
  • payment_id—payment ID, unique within the project
  • signature—signature created after all the parameters are collected. For more information about signature generation, see Signature generation and verification
• payment—object with payment information:
  • amount—payment amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency have no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
  • currency—payment currency code in ISO-4217 alpha-3 format
• customer—object with customer information:
  • country—customer country code (For more information about the country, see Country codes).

Here is an example of the data from a request for the list of supported banks. 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.

{
  "general": {
    "project_id": 1234,
    "payment_id": "ORDER_155860015",
    "signature": "K6jllym+PtObocZtr345st...=="
  },
  "customer":
    "country": "PL"
  },
  "payment": {
    "amount": 10000,
    "currency": "EUR"
  }
}

[
    {
        "minAmount": 100, // Minimum payment amount allowed for the payment (in minor currency units)
        "maxAmount": 1000, // Maximum payment amount allowed for the payment (in minor currency units)
        "limitCurrency": "EUR", // Code of the currency used for the payment limits (minAmount and maxAmount) in the ISO-4217 alpha-3 format
        "id": 123, // Bank ID
        "abbr": "EXB", // Bank shortcut name (for internal use)
        "name": "Example Bank", // General bank name
        "nativeName": "Example Bank", // Native bank name
        "currencies": [ // Array with currencies supported by the bank
            {
                "id": 123, // Currency ID in the payment platform
                "alpha_3_4217": "EUR", // Alphabetic code of the payment currency in the ISO-4217 alpha-3 format
                "number_3_4217": "123", // Numeric code of the payment currency in the ISO-4217 alpha-3 format
                "currency_type": "fiat", // Type of the currency
                "exponent": 2 // Number of decimal places after decimal point
            }
        ]
    }
]

General information

In the Open Banking EU method, when processing a purchase by using Payment Page, the merchant web service sends a request with all the required parameters and signature to the Monetix URL and accepts the callback with the payment result from the payment platform. When opening Payment Page, you can have Payment Page opened with the Open Banking EU method pre-selected. (For more information about pre-selecting payment methods, see in Preselecting payment methods.)

The full sequence of the purchase workflow is provided below.

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

Request format

There are several things you need to consider when dealing with purchase requests in the Open Banking EU method:

1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are required for any payment method:
   • project_id—project ID you obtained from Monetix
   • payment_id—payment ID unique within the project
   • customer_id—the unique ID of the customer within your project
   • customer_email—customer email
   • customer_first_name—customer first name
   • customer_last_name—customer last name
   • customer_country — customer country code. For more information about the country, see Country codes
   • payment_currency—payment currency in ISO-4217 alpha-3 format
   • payment_amount—payment amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
2. In addition, the International Bank Account Number (IBAN) must be passed in the account.number parameter. This parameter can be specified both in the initial request and during the procedure of adding information about the payment. For more details on this procedure, see Submission of additional payment information.
3. If you need to have payment form displayed with the Open Banking EU method pre-selected, set the force_payment_method parameter to the code on the open-banking-sepa payment method.
4. You can also add any other additional parameters Payment Page supports. For more information about parameters supported by Payment Page, see Payment Page invocation parameters.
5. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign payment requests, see Signature generation and verification.

Here is an example of data from a request for Payment Page opening:

EPayWidget.run(
    {
        project_id: 1234,
        payment_id: 'payment_47',
        customer_id: 'customer_123',
        customer_first_name: 'John',
        customer_last_name: 'Doe',
        customer_email: 'johndoe@example.com',
        customer_country: 'PL',
        payment_currency: 'EUR',
        payment_amount: 100000,    
        signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO\/RLUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

Callback format

The Open Banking EU method uses the standard format for callbacks to deliver purchase results. For more information about callbacks, see Callbacks in Payment Page.

The following is an example of a callback with an information about successful 1000.00 EUR purchase.

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "method": "OpenBanking Sepa",
        "sum": {
            "amount": 100000,
            "currency": "EUR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 28,
        "type": "sale",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "created_date": "2022-03-25T11:08:05+0000",
        "request_id": "9e32835fb27907e0b08569d7d150e387a16a80e336c5117242b5cf60a4e17839",
        "sum_initial": {
            "amount": 100000,
            "currency": "EUR"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "EUR"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-321",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "method": "OpenBanking Sepa",
        "sum": {
            "amount": 100000,
            "currency": "EUR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 31,
        "type": "sale",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "created_date": "2022-03-25T11:19:53+0000",
        "request_id": "fff3d5f8d5d31bc460b68b57dc63f4b482e906eb",
        "sum_initial": {
            "amount": 100000,
            "currency": "EUR"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "EUR"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 15923,
            "payment_id": "0cf4215c-8978",
            "auth_code": ""
        }
    },
    "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlfqz8155QSlXJKR4m8C4z2iFYv58P4VnHANu445/jmY+g=="
}

Related topics

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

• Integration procedure
• Payment types, operations and payments
• Signature generation and verification
• Operation statuses and response codes

General information

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

1. Send request with all the required parameters and signature to the Monetix URL.
2. Redirect the customer to the provider service.
3. Accept the callback with the payment result from the payment platform.

The following diagram provides the detailed picture of the payment processing procedure.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Open Banking EU payment method and provide the information about the format of callbacks with purchase results. For the general information on how to use the Gate API, see API Description.

Request format

There are several things you need to consider when dealing with purchase requests in the Open Banking EU method:

1. You initiate purchase by submitting a purchase request to the /v2/payment/banks/sepa/sale endpoint by using HTTP method POST. This endpoint belongs to the following group of endpoints: /v2/payment/banks/{payment_method}/sale
2. The following objects and parameters must be specified in any request:
   • general—object with general request identification information:
     • project_id—the project ID you obtained from Monetix
     • 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.
   • customer—object with customer information:
     • id—the unique ID of the customer within your project
     • ip_address—IP address of the customer's device
     • email—customer email
     • first_name—customer first name
     • last_name—customer last name
     • country — customer country code. For more information about the country, see Country codes.
   • account — object with customer's bank account information:
     • bank_id — bank identifier. This parameter may not be mandatory. Refer to your Key Account Manager at Monetix for details.
   • payment—object with purchase information:
     • amount—purchase amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
     • currency—code of purchase currency in the ISO-4217 alpha-3 format
3. The following parameters with the return URLs are optional, but we strongly advise you to specify them in the request to provide your customer a better user experience. If you don't specify any parameters of the return_url object in the request, by default Gate will redirect the customer to the URL specified in your project in Monetix.
   • return_url—object with the information where to redirect the customer to when the payment is completed or prematurely terminated by the customer:
     • success—the URL to redirect the customer to after the payment is successfully completed.
     • decline—the URL to redirect the customer to after the payment is declined.
     • return—the URL to redirect the customer to when they prematurely terminate the payment. This URL is also used if the success and decline parameters are not specified in the request.
4. In addition, the International Bank Account Number (IBAN) must be passed in the account.number parameter. This parameter can be specified both in the initial request and during the procedure of adding information about the payment. For more details on this procedure, see Submission of additional payment information.
5. If required, you can add any other additional (optional) parameters Gate supports.

Here is an example of data from a purchase request in the Open Banking EU method.

{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com",
        "country": "PL"
    },
    "account": {
        "bank_id": "22541"
    },
    "payment": {
        "amount": 100000,
        "currency": "EUR"
    },
    "return_url": {
        "success": "https://example.com/success/",
        "decline": "https://example.com/decline/",
        "return": "https://example.com/return/"
    }
}

Format of customer redirection data

After receiving and processing your purchase request, the payment platform sends a callback to your web service containing the data to redirect the customer to the provider service.

To redirect the customer, use the values of the following parameters in the redirect_data object:

• url—the URL to redirect the customer to
• body—the data to be sent in the request body
• method—the HTTP method to get an HTML page of the website (for example, POST or GET)
• encrypted—this is the service parameter. Ignore the data it contains.

Here is an example of a piece of callback containing the data to redirect the customer.

"redirect_data": {
    "method": "GET",
    "body": [],
    "encrypted": [],
    "url": "https://example.com/redirect"
}

Callback format

The Open Banking EU method uses the standard format for callbacks to deliver purchase results. For more information about callbacks, see Callbacks in Gate.

The following is an example of a callback with an information about successful 1000.00 EUR purchase.

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "method": "OpenBanking Sepa",
        "sum": {
            "amount": 100000,
            "currency": "EUR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 28,
        "type": "sale",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "created_date": "2022-03-25T11:08:05+0000",
        "request_id": "9e32835fb27907e0b08569d7d150e387a16a80e336c5117242b5cf60a4e17839",
        "sum_initial": {
            "amount": 100000,
            "currency": "EUR"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "EUR"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-321",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "method": "OpenBanking Sepa",
        "sum": {
            "amount": 100000,
            "currency": "EUR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 31,
        "type": "sale",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "created_date": "2022-03-25T11:19:53+0000",
        "request_id": "fff3d5f8d5d31bc460b68b57dc63f4b482e906eb",
        "sum_initial": {
            "amount": 100000,
            "currency": "EUR"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "EUR"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 15923,
            "payment_id": "0cf4215c-8978",
            "auth_code": ""
        }
    },
    "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlfqz8155QSlXJKR4m8C4z2iFYv58P4VnHANu445/jmY+g=="
}

Related topics

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

• Synchronous and asynchronous message processing
• Payment types, operations and payments
• Signature generation and verification
• Operation statuses and response codes

As with other payment methods Monetix offers, when using this method, you have several options to analyze the information about payments and operations.

You can load and analyze all the necessary information in Dashboard (dash-light.trxhost.com), for instance you can use the analytic panels in the Analytics section for this purpose.

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

• Dashboard allows you to download reports in CSV format by using the tools in the Reports section. You can perform export as a one-time or regular download of data to your local computer.
• 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 means of sending requests to the /operations/get endpoint.

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