Glossary
Basic Entities
- Payment gateway
-
HighHelp payment platform, which accepts requests from merchant systems, processes payments and transfers, interacts with banks and external payment providers and returns the result.
- Merchant
-
Payment gateway client — a company or service that integrates with an API and/or widget, to accept payments or make transfers.
- Payer
-
The end user (merchant's client) who initiates the payment or transfer.
- Recipient
-
The person to whose account the funds are credited (in P2P and payouts may differ from the merchant).
- Payment
-
Business scenario for moving funds (for example, payment for an order or transfer). Within the cash register, it is identified by the field
payment_id, specified by the merchant. - Operation
-
Technical unit of processing in a payment gateway (debit, credit, return, payout, etc.).
- Cashier
-
Merchant's internal settlement account in the payment gateway. In APIs and alerts, identified by the field
project_id. Credits, write-offs and payments for transactions are processed through the cash register. - Cash balance
-
The current cash balance in a specific currency. Includes the amount available for new transactions and the frozen part of the balance.
- Frozen Balance
-
Part of the cash register balance reserved for unfinished transactions (for example, authorizations before debiting).
- Project
-
Logical unit of merchant integration (online store, service, application), linked to the cash register. Payment methods, keys and URLs for notifications are configured for the project (
merchant_*_callback_url). In APIs and alerts, identified by the fieldproject_id. - Provider
-
An external payment partner (bank, payment system, etc.) through which the payment gateway conducts transactions.
- Request
-
A record of a transaction or payment in the HighHelp system. The application contains the parameters of the operation and its current status. Identified by field
request_id. - Appeal
-
An appeal regarding a completed transaction (dispute, request for clarification or revision of the result), created and processed in the system.
Widget and personal account
- Payment widget
-
Embedded HighHelp payment form, rendered and served on the HighHelp side. The payer enters the data on the payment page of the widget, and the payment data is sent directly to the payment gateway.
- Payment page
-
The interface that the payer sees when working with the HighHelp payment widget. It is acceptable to use the wording “widget payment page”.
- Merchant's personal account
-
HighHelp web interface for merchant employees. Through your personal account you can view balances and transactions, search for payments, manage projects and cash registers, configure keys and URLs for alerts.
Products
- P2P
-
Transfers between individuals (person-to-person / peer-to-peer), for example from card to card or from account to account, initiated through a payment gateway.
- ECOM
-
Internet payments for merchant goods and services (e-commerce scenario, Internet acquiring).
Payment types
- Payment (
payin) -
A type of payment in which funds are transferred from the user's account to the merchant's account.
- Payout (
payout) -
A type of payment in which funds are transferred from the merchant's account to the user's account.
Integration options
- H2H integration
-
Server-to-server integration (host-to-host), in which the merchant's backend directly calls the payment gateway API. The payment user interface is implemented on the merchant side.
- H2C integration
-
Integration using a widget (host-to-client), in which the payment form is submitted by the payment gateway, is embedded on the merchant’s website or application, and payment data is sent directly to the gateway.
Identifiers and data
project_id-
Identifier of the merchant's checkout in the HighHelp system. Sent in every request and notification.
payment_id-
Payment ID in the merchant system. Must be unique within one cash register.
request_id-
Application ID in the HighHelp system. Generated when a request is created and returned in responses and notifications.
Authentication and Signature
- API Keys
-
Data set for access to the cash register API: cash register identifier and keys that are used to generate a request signature (RSA keys for RSA-SHA256 or secret HMAC key for HMAC-SHA512).
- Request signature
-
A cryptographic signature generated on the merchant’s side based on the request data and the cash register key using the RSA-SHA256 or HMAC-SHA512 algorithm. Used to verify data integrity and sender authenticity on the payment gateway side.
- Request timestamp
-
A timestamp that is included in the request (for example, a header
x-access-timestamp) and is taken into account when verifying the signature to limit the validity period of the request and protect against repetitions.
Notifications
- Alert
-
HTTP notification (callback) from the payment gateway to the merchant side with notification of a change in the status of a payment or operation (success, refusal, completion of payment, etc.).
- Alert URL
-
Endpoint on the merchant side, to which the gateway sends alerts. The address is set in the project settings or in the parameters of a specific operation (
merchant_callback_url,merchant_success_callback_url,merchant_decline_callback_url).