Accept Online banking Finland payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.
Before you begin
These instructions explain how to add Online banking Finland to your existing API-only integration. The API-only integration works the same way for all payment methods. If you haven't done this integration yet, refer to our API-only integration guide.
Before starting your Online banking Finland integration:
- Make sure that you have set up your back end implementation.
- Add Online banking Finland in your Customer Area.
Build your payment form for Online banking Finland
Include Online banking Finland in the list of available payment methods.
We provide logos for Online banking Finland which you can use on your payment form. For more information, refer to Downloading logos.
If you are using the /paymentMethods to show available payment methods to the shopper, specify the following:
- countryCode: Any supported country. For example, FI.
- amount.currency: Any supported currency. For example, .
- amount.value: The value of the payment, in minor units.
- channel: Specify Web, iOS, or Android.
The response contains
Make a payment
From your server, make a /payments request, specifying:
shopperEmail: The shopper's email address. This is where Online banking Finland will send the payment instructions.
The /payments response contains an
action object with the information needed to redirect the shopper.
Handle the redirect
- To complete the payment, redirect the shopper to the
action.urlreturned in the /payments response.
After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:
details: Object that contains the URL-decoded
redirectResultreturned when the shopper was redirected back to your site.
You receive a response containing:
resultCode: Use this to present the result to your shopper.
pspReference: Our unique identifier for the transaction.
Present the payment result
resultCode values you can receive for Online banking Finland are:
|resultCode||Description||Action to take|
|Authorised||The payment was successful.||Inform the shopper that the payment has been successful.
You will receive the funds in 3 days.
|Cancelled||The shopper canceled the payment while they were on the Online banking Finland-hosted payment page.||Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.|
|Error||There was an error when the payment was being processed.||Inform the shopper that there was an error processing their payment. The response contains a
|The shopper has completed the payment but the final result is not yet known.||Inform the shopper that you've received their order, and are waiting for the payment to be completed.
To know the final result of the payment, wait for the AUTHORISATION webhook.
|Refused||The payment was refused by the shopper's bank.||Ask the shopper to try the payment again using a different payment method.|
|eventCode||success field||Description||Action to take|
|AUTHORISATION||false||The transaction failed.||Cancel the order and inform the shopper that the payment failed.|
|AUTHORISATION||true||The shopper successfully completed the payment.||Inform the shopper that the payment has been successful and proceed with the order.|
|OFFER_CLOSED||true||The shopper did not complete the payment.||Cancel the order and inform the shopper that the payment timed out.|
Test and go live
Before accepting live payments, test your integration using the test environment and sample data provided by Paytrail.
Testing multiple partial refunds is currently not available.