Prepare the communication
JSON format
All request should be prepared as JSON and send with application/json header. Mandatory parameters that you must send to ZEN.COM when initiating a API call varies depending on type of request and endpoint address. We recommend that all parameters listed in our API reference documentation be sent in API call.The API is case-sensitive at every level, both in parameter names and parameter values. Spaces in parameter names and special characters are not allowed. The values of the transmitted parameters should be encoded in UTF-8, along with handling the transport protocol in compliance with standard HTTPs service calls.
WARNING
WARNING
Allowed HTTPs requests
Communication with the ZEN.COM API is based on sending (for requests) and receiving (for responses) messages in a properly formatted structure to and from predefined endpoints. Allowed HTTPs requests:
| Type | Description |
|---|---|
POST | To create a resource |
PATCH | To update a resource |
GET | To get a resource or a list of resources |
DELETE | To delete a resource |
Available endpoints
Each functionality available within the ZEN.COM API is assigned to a specific endpoint with its unique address. Note that endpoints may require different types of HTTPS requests and can include specific, unique IDs that must be passed in the You can find the full list of functionalities (endpoints) available for Merchants in our API Reference documentation.
PATH.INFO
Required parameters
Depending on the HTTPs request type and the specific functionality (endpoint), various parameters and methods of data transmission may be required. Before sending a request to the ZEN.COM API, ensure that it includes all required parameters, uses the correct HTTP request type, and follows the appropriate syntax.Request header with The address of each endpoint, the type of HTTPS request, and the designation of all required parameters in the request are detailed in our API Reference documentation. Note that some required parameters may vary depending on the values provided in the objects. For example, different parameters are required for Card OneClick Transactions, others for BLIK Transactions, and others for Card Recurring Data Transactions. Please refer to Certain Payment methods / Payment channels necessitate the provision of additional parameters at the initiation of the Transaction, beyond those specified above. Please consult the list of Payment methods / Payment channels that require these additional parameters in order for the Transaction to be successfully registered. Failure to provide the required parameters at the start of the transaction will result in an error being returned by our system due to the absence of the necessary parameters.
Authorization parameter is obliged for all requests sent to ZEN.COM API. Authorization value is the Terminal API key parameter you can find in your my.zen.com Merchant portal.INFO
paymentSpecificData parameter used in https://api.zen.com/v1/transactions to get all required parameters depending on Payment channel / Payment method.Correct actions order
It is important to maintain the correct sequence when sending requests to the ZEN.COM API. For example, for a one click Payments, or recurring card Transaction, you must first create a Customer, save a card assigned to the Customer, and tokenize it before sending a request to the Create Transaction endpoint.Similarly, to execute a Capture Transaction, it is necessary to first send a request to the Create Transaction endpoint and get the valid confirmation status.
Mandatory features
API integration requires some mandatory features, some of them depends on the country context, type of Transaction or type of Payment method / Payment channel. For example, for all types of Transactions Fraud collector feature is mandatory. Full list of mandatory / optional features can be found here
Modified at 2025-05-05 07:14:00