No momento, esta página não está disponível em português
Payment-method icon

Online banking Poland for API only

Add Online banking Poland to an existing API-only integration.

Accept Online banking Poland 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 Poland 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 Poland integration:

  1. Make sure that you have set up your back end implementation.
  2. Add Online banking Poland in your test Customer Area.

Build your payment form for Online banking Poland

Include Online banking Poland in the list of available payment methods.

In your /paymentMethods request, specify:

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.

Make a payment

In your /payments request, specify:

  • paymentMethod.type: onlineBanking_PL
  • paymentMethod.issuer: The shopper's bank. Specify this with the Issuer value that corresponds to this bank.
  • returnUrl: The URL where the shopper will be redirected back to after they complete the payment. This URL can have a maximum of 1024 characters.
  • shopperEmail: The shopper's email address.

The /payments response contains an action object with the information needed to redirect the shopper.

Handle the redirect

  1. To complete the payment, redirect the shopper to the action.url returned in the /payments response.

When using the HTTP GET method:
For security reasons, when displaying 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.

  1. 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 redirectResult returned 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

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've 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.

See also