Integration checklist
This step-by-step guide will help you set up your interaction with Tranzzo services, test all settings and start accepting payments from your customers.
Stage 1. Getting to know the merchant portal
Create an account
To connect to Tranzzo and work with payments, you need to register in the merchant portal
➡️ Registration instructions.Add other members of your team
You can give your team access to the account right away. Access levels can be controlled using a set of roles that are already provided in the merchant portal ➡️ Adding users.
Familiarize yourself with the test project and use its API keys
After registration, you will immediately have access to the test project and its authentication data - API keys. They are needed to set up and test payment before starting work on a live project
➡️ Test project.
Stage 2. Setting up the integration and making test payments
Before accepting payment on your live project, make sure that the settings and processes are correct.
Get onboarded
Contact our supports to complete data verification and determine the terms of cooperation
➡️ Tranzzo Support.Configure the integration
Choose the required integration method and make the appropriate settings using the data of the test project ➡️ Integration options.
Make test payments
Use test payment data and check different card payment scenarios ➡️ Test payment.
Handle errors and failed payments
ПMake sure that API requests are formed correctly and that you receive correct responses about failed payments and errors that may occur when creating or making a payment.
Make refund and void
Check how the refund and/or void functionality works (if you use two-step payment). You can test these features using the test payments you made earlier.
Set up payment card verification (optional)
This function allows you to make sure that the card specified by the payer is valid and its details are correct
➡️ Card verification.Set up alternative payment methods (optional)
If you plan to work not only with card payments, but also with other payment methods, see additional information about their settings ➡️ Payment methods.
Stage 3. Setting up webhooks
Webhooks are utilized by Tranzzo to transmit the information about various payment events such as the status of payments, successful completion of 3DS, charge or pre-authorization of payment, refund, payment capture or void when using two-step payment. Therefore, in order to receive this data, you need to integrate with the webhook service.
Define the structure of webhooks
Familiarize yourself with the mandatory and optional parameters of webhooks and determine the ones that you need
➡️ Webhooks.Create your endpoint for the webhooks
Provide the public URL of your endpoint so that it can receive the payload from the webhooks.
Receive and process notifications
Receive and process notifications with information about payments and individual transactions, as well as their status.
Stage 4. Work with reporting information
Control your account balance
Find out where and how to get information about your account balance.
Get more information on payments
Receipts, information on certain transactions, orders, etc. ➡️ Receiving information about payments.
Configure receiving of transaction registers (optional)
Receive transaction registers automatically via the за API or via the scheduler for sending out transaction registers in the merchant portal. You determine the amount of data, the date and time of sending, and the format of the registers yourself.
Stage 5. Go live
After testing the payment process with the test data, it's time to connect the live project and make a few additional settings for further work.
Create a live project
Go to the merchant portal and create a live project. On your side, replace the authentication data (API keys) of the test project with the credentials for the live project.
Improve account security
- Set up two-factor authentication (recommended).
- Define a list of allowed IP addresses to interact with the API (optional).
Set up a payment page, payment widget, or tokenization widget (optional) or tokenization widget (optional)
To accept payments, you can use:
- A payment widget integrated into your webpage.
- A widget that is added directly to your site.
- Ready-made Tranzzo payment page that can be designed in your corporate style.
- Mobile SDK with customization of payment screen color schemes.
Set up the software-based cash register (optional)
If you work in the Ukrainian market and you need to fiscalize online payments, use our ready-made solution ➡️ Software-based CR.
Conduct comprehensive testing
The final step of the integration is to verify that all stages and scenarios of your payment cycle are working correctly.