Accept Online banking Czech Republic payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.
Requirements
| Requirement | Description |
|---|---|
| Integration type | Make sure that you have an existing API-only integration. |
| Setup steps | Before you begin, add in your test Customer Area. |
Build your payment form for Online banking Czech Republic
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'll 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.
In your /paymentMethods request, specify:
- countryCode: CZ
- amount.currency: CZK
- amount.value: The value of the payment.
The list of issuing banks are included in the object with type: onlineBanking_CZ.
Make sure that you ask the shopper to accept Online banking Czech Republic terms and conditions in your checkout.
Make a payment
In your /payments request, specify:
paymentMethod.type: onlineBanking_CZpaymentMethod.issuer: The Online banking Czech Republic issuer value of the shopper's selected 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.
In the /payments response, note the action object. This contains 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, 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.