You can add Online banking Poland to your existing integration. The following instructions show only what you must add to your integration specifically for Online banking Poland.
If an instruction on this page corresponds with a step in the main integration guide, it includes a link to corresponding step of the main integration guide.
Requirements
| Requirement | Description | |
|---|---|---|
| Integration type | Make sure that you have an existing API-only integration. | |
| Redirect handling | Make sure that your existing integration is set up to handle the redirect. action.type: redirect. |
|
| Setup steps | Before you begin, add Online banking Poland in your Customer Area. |
How it works
- The shopper selects Online banking Poland as the payment method.
- The shopper enters their details in the payment form that you build.
- When you make the payment request, you include additional information about the items that the shopper intends to purchase.
Build your payment form
Include Online banking Poland in the list of available payment methods.
In your /paymentMethods request, specify:
- countryCode: PL
- amount.currency: PLN
The list of issuing banks are included in the object with type: onlineBanking_PL.
Make sure that you ask the shopper to accept the Online banking Poland regulations and information obligation in your checkout flow.
You can download the logo for Online banking Poland to use in your form.
Get Online banking Poland as an available payment method
When you make the /paymentMethods to get available payment methods, specify the following so that Online banking Poland is included in the response.
| Parameter | Values |
|---|---|
| countryCode | PL |
| amount.currency | PLN |
Add additional parameters to your /payments request
When you make a payment, add the following parameters:
| Parameter | Required | Description |
|---|---|---|
| shopperEmail |  |
The shopper's email address. Must be 50 or less characters. |
paymentMethod.issuer |
The issuer ID of the shopper's selected bank. |
The response includes the action.type: redirect.
In the /payments response, check the action object for the information that you must use to redirect the shopper.
Handle the redirect
-
To complete the payment, redirect the shopper to the
action.urlreturned in the /payments response, taking into account the following recommendations:-
When using the HTTP GET method:
For security reasons, when showing the redirect in the app, we recommend that you use SFSafariViewController for iOS or Chrome Custom Tabs for Android, instead of WebView objects. Also refer to the security best practices for WebView. -
Redirection for mobile integrations:
For mobile integrations, we strongly recommended that you redirect the shopper to the default browser of their device. Redirecting to the default browser ensures the best compatibility, handling of multi-factor authentication, app-to-app redirection, and error handling.
-
-
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-decodedredirectResultreturned when the shopper was redirected back to your site.
-
In the response note the following:
resultCode: use this to present the result to your shopper.pspReference: our unique identifier for the transaction.
Present the payment result
Use the resultCode that you received in the /payments/details response to present the payment result to your shopper.
The resultCode values you can receive for Online banking Poland 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 2-3 days. |
| Pending or Received |
The shopper has completed the payment but the final result is not yet known. It may take minutes or hours for the Online banking Poland payments network to confirm this. | Inform the shopper that you have received their order, and are waiting for the payment to be completed. You will receive the final result of the payment in an 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. |
If a shopper completed the payment but failed to return to your website or app, you will receive the outcome of the payment in an AUTHORISATION webhook.
Test and go live
Check the status of Online banking Poland test payments in your Customer Area > Transactions > Payments.
Before you can accept live Online banking Poland payments, you need to submit a request for Online banking Poland in your live Customer Area.