You can add Online banking Czech Republic to your existing integration. The following instructions show only what you must add to your integration specifically for Online banking Czech Republic.
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 Czech Republic in your Customer Area. |
How it works
- The shopper selects Online banking Czech Republic 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
To show Online banking Czech Republic in your payment form, you need to:
- Show a list of available banks to your shopper.
- After the shopper selects a bank, pass the corresponding Issuer value to your server. You will need this to make a payment.
| Bank name | Issuer ID |
|---|---|
| Česká spořitelna | cs |
| Komercní banka | kb |
| mTransfer | mp |
| Fio banka | pf |
| Moneta Money Bank | pg |
| Raiffeisenbank ePlatby | rf |
You can also get the issuer list from the /paymentMethods response, as explained in the API-only integration guide.
Get Online banking Czech Republic as an available payment method
When you make the /paymentMethods to get available payment methods, specify the following so that Online banking Czech Republic is included in the response.
| Parameter | Values |
|---|---|
| countryCode | CZ |
| amount.currency | CZK |
| amount | The value of the payment. |
Add additional parameters to your /payments request
You do not need to add any additional parameters when you make a payment.
The response includes action.type: redirect.
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 Czech Republic 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. |
| Cancelled | The shopper cancelled the payment while on their bank's website. | 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 refusalReason, indicating the cause of the error. |
| 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 Czech Republic 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. If the transaction is not authorised within 30 minutes, the offer will close. Optionally, you can be informed of this through an OFFER_CLOSED 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 the shopper closed the browser and failed to return to your website, wait for webhooks to know the outcome of the payment:
| 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. |
Test and go live
Test Online banking Czech Republic payments with real payment details and small amounts.
Check the status of your test Online banking Czech Republic payments in your Customer Area > Transactions > Payments.
To accept live Online banking Czech Republic payments, add it as a payment method in your Customer Area.