Integration checklist - Checkout documentation

Create your account

Fill out the contact form on get.zen.com, through which a account manager will get touch with you. Together, you will go through the onboarding process, during which you will choose the type of integration and Payment methods you wish to have on your Shop. Decide which integration method will be suitable for you.

Think about Payment method are necessary for your business and which ones your Customers will most frequently use.

Ensure that you have completed all necessary steps with your account manager

Ask the account manager about testing the account.

You will receive login Credentials for your test account on the my.zen-test.com platform.

CAUTION

In the Store settings you will find credentials and you should have two Payment methods Blik and Card - these are the only available methods for the test environment. Refunds are only available for Card method. You should receive information about the test Blik and test Card Credentials for your test environment via mail along with your logs Credentials.

CAUTION

For the test account registration, we will need information about IP adress you will be using during testing.

WARNING

Remember that Credentials for the test and production accounts are different!

Build your integration

Depending of your integration type, build all necessary elements on your side.

Test your integration

Make test Payment depending on the integration method you have chosen, whether it's checkout or API, according to the instructions for the respective method you need to perform a test Payment. To test your integration, initiate a test Payment. Your Payment can be accepted or rejected. Handle errored or refused Payments. It is crucial to understand how the Payment system works when a Payment is declined or encounters an error. Refer to our documentation for assistance in conducting such a Payment.

Make test Refund. In the plug in and checkout integration, you can only process Refunds through the my.zen-test.com platform, whereas in the API integration, in addition to processing refunds through the ZEN.COM platform, you can also do so via a POST to the ZEN.COM test URL https://api.zen-test.com/v1/transactions/refund. According to our API documentation field transactionId - id of Transaction to be Refunded provided in ZEN.COM, you can check value in my.zen-test.com.

Check IPN configuration. After a successful Payment or Refund, an Instant Payment Notification (IPN) with information about the Payment and Refund should be sent to the declared URL address. If you receive a notification after completing a test Transaction, the configuration was successful.

Configure integration on production environment

INFO

Check on your zen account (my.zen.com) you have all required Payment methods are visible, and you can click to activate them.
Follow our integration documentation to have the opportunity to process Payments and repeat the steps from the test environment with the corresponding URL address as listed in our documentation.

Check whether additional set up need to be done. For each type of integration, there are certain Payment methods that need to be integrated additionally: Apple Pay, Google Pay or PayPal.

Make a Payment. Test various Payment methods in the production environment. You will have access to all configured methods.

Additional steps for API integration only:

Make a Refund. You can perform partial and full Refund, whether partial Refunds are possible depends on the Payment method. Partial Refunds are not available for the Pay by Link method.

IPN configuration. Configure IPN in the production environment. Make sure you acknowledge IPN using the HTTP protocol with a 200 status. However, if you do this incorrectly, IPNs will be sent to you queued. Check if you're receiving all IPNs for you account.