Before you start

This section lists the requirements and initial data that must be prepared before integrating with the HighHelp payment gateway.

Who is this section for?

This section is intended for developers and specialists who:

  • configure integration via API (H2H) and/or via widget;

  • are responsible for the configuration of cash registers and environments;

  • prepare the infrastructure for sending requests and receiving alerts.

Required accesses and accounts

Before integration can begin, the following conditions must be met:

  • An account has been created in the merchant's personal account.

  • At least one cash register has been created for the test environment.

  • The cash register has been verified and has the statusConfirmedin your personal account. Until verification is completed, any operations with the cash register and API calls will be unavailable. Verification is performed by HighHelp engineers after passing the KYB procedure.

  • API keys for the cash register were generated in the merchant’s personal account; the current signature algorithm (RSA-SHA256 or HMAC-SHA512) is known.

  • Contact persons on the merchant's side for operational and technical issues are indicated.

The procedure for creating a cash register and generating keys is described in the sectionAuthentication and Signature.

Product and business scenario solutions

Before development begins, it is necessary to agree on which scenarios will be implemented in the first iteration of integration:

  • Payment types:

    • incoming payments (payin);

    • outgoing payments (payout).

  • Products:

    • P2P transfers;

    • e-commerce payments (ECOM).

  • Integration channel:

    • H2H integration (server-server);

    • integration via widget (payment page).

A list of payment types is given in the sectionPayment types.

Selecting payment methods and payouts

For each selected scenario, it is necessary to agree on the methods that will be used first:

Additionally, you need to determine:

  • currencies in which transactions will be performed (see.Currency codes);

  • countries in which the service will be available (see.Country codes).

Merchant infrastructure requirements

The merchant's infrastructure must meet the following conditions:

  • The backend can initiate outgoing HTTPS requests tohttps://api.hh-processing.com.

  • There are publicly accessible HTTPS endpoints for receiving alerts.

  • The following are configured for notification endpoints:

    • HTTPS support;

    • logging of incoming requests and responses;

    • processing of repeated notifications (idempotency byproject_id:payment_id:status:sub_status).

  • The logging system allows you to save:

    • API request body (without sensitive payment card data);

    • body of responses and notifications;

    • technical identifier values ​​(request_id, payment_id, project_id).

It is recommended to coordinate the requirements for white lists of IP addresses and network restrictions with the responsible HighHelp specialist.

Data for setting up the cash register

Before integration begins, you need to prepare the data required to set up the cash register and routing payments:

  • Domain names from which requests will be sent and redirects performed.

  • List of URLs for alerts:

    • merchant_callback_url— informative alerts on intermediate statuses;

    • merchant_success_callback_url— notifications about successful operations;

    • merchant_decline_callback_url— notifications about unsuccessful operations.

  • List of currencies and countries used.

  • Restrictions and limits of the merchant on the amounts and number of transactions.

  • Requirements for routing requests (using the fieldextra_paramand other additional parameters).

This data is used to coordinate cash register settings and order routing configurations.

Environments and test data

Integration is carried out in stages:

  • in a test environment;

  • after testing is completed — in a production environment.

The test environment requires:

  • a set of test details (cards, accounts, status scenarios);

  • URL and header parameters for requests;

  • Example of alerts and statuses for basic scenarios.

Next steps

After preparing the data described above, you can proceed to:

  • performing a minimal integration scenario according to the steps described in sectionQuick start;

  • implementation of authentication mechanisms and request signing according to instructions fromAuthentication and Signature;

  • setting up processing of statuses and errors in accordance with sectionStatus codes.