API docs by Redocly

OP Online Payment - Browser flow API (1.1.1)

Download OpenAPI specification:Download

Support: onlinepayment@op.fi


OP Online Payment allows merchants and payment service providers to collect e-commerce payments as credit transfers to an OP account from both OP customers and other banks' customers (add-on service). The OP Online Payment service includes the collection of payments and the making of payment status requests and payment refunds.


OP Online Payment API's documentation consists of three parts:

  • REST API: initiation of online payments, refund and status query

  • Browser flow API: initiation of the payment flow in the browser

  • Merchant callback API: an optional service for receiving notifications on the payment status changes

Browser flow API

The API initiates a customer-facing browser interface for OP Online Payment. The merchant starts the flow by doing a full-page redirect in the browser to the API url so the customer can authenticate and confirm the payment.

OP payments are initiated with OP Payment flow, and payments with other supported banks are started with Multibank payment flow (OP not included). You can get the list of supported banks from the Other bank providers endpoint in the REST API.

Displaying the UI in an iframe element is not recommended and not supported.

Note that there is no test UI available in the sandbox environment. The browser UI is short-circuited and customer (browser) is taken directly to the last step of the flow (redirect back to merchant). The final payment status can be simulated by using the accountId values defined in the Sandbox section of the OP Online Payment API.

OP payment flow

Initiate OP payment flow in browser

This endpoint starts the OP payment process in the browser. The flow consists of the following phases:

  1. Authenticating the customer

    1. Selecting the account to pay from

      1. Confirming the payment

        1. Redirecting the customer back to the merchant’s service

Note: the API uses query parameters to send the paymentOperationId and paymentOperationValidation values to the server. Please make sure that the query parameters are properly URL encoded.

query Parameters
paymentOperationId
required
string <= 128 characters

Operation id received in the Create payment operation response

paymentOperationValidation
required
string <= 512 characters

Signature for the payment operation id received in the Create payment operation response

Responses

Request samples 

'https://api.smn-sandbox.aws.op-palvelut.fi/customer/payment/startPaymentConfirmation?paymentOperationId=d3582ce7-f764-4f77-9155-7c150bdf95a662c87691-a46f-4076-bdf3-e5b27d660205&paymentOperationValidation=GU%2F1O9CbEnGh9RxeJf4ElK0Wab4WqdFD2FRgS8k%2F0Rk%3D'

Multibank payment flow

Initiate multibank payment flow in browser

This endpoint starts the multibank payment process in the browser. The flow consists of the following phases:

  1. Accepting OP terms for multibank service

    1. Authenticating the customer in the selected bank

      1. Selecting the account to pay from in the selected bank

        1. Confirming the payment in the selected bank

  2. Redirecting the customer back to the merchant’s service

The endpoint does not provide a bank selection UI. Bank selection is done by using the bankId url path parameter when constructing the url for the Browser. OP payment flow is not supported with this endpoint.

Note: the API uses query parameters to send the paymentOperationId and paymentOperationValidation values to the server. Please make sure that the query parameters are properly URL encoded.

path Parameters
bankId
required
string <= 40 characters

Bank ID for the selected bank to initiate the payment from. Allowed bankId options are provided in the REST API

query Parameters
paymentOperationId
required
string <= 128 characters

Operation id received in the Create payment operation response

paymentOperationValidation
required
string <= 512 characters

Signature for the payment operation id received in the Create payment operation response

Responses

Request samples 

'https://api.smn-sandbox.aws.op-palvelut.fi/customer/payment/multibank/direct/BankoEnablado/startPaymentConfirmation?paymentOperationId=d3582ce7-f764-4f77-9155-7c150bdf95a662c87691-a46f-4076-bdf3-e5b27d660205&paymentOperationValidation=GU%2F1O9CbEnGh9RxeJf4ElK0Wab4WqdFD2FRgS8k%2F0Rk%3D'